NAME¶

pbs_deljob - delete a pbs batch job

SYNOPSIS¶

#include <pbs_error.h>
#include <pbs_ifl.h>

int pbs_deljob(int connect, char *job_id, char *extend)

DESCRIPTION¶

Issue a batch request to delete a batch job. If the batch job is running, the execution server will send the SIGTERM signal followed by SIGKILL .

A Delete Job batch request is generated and sent to the server over the connection specified by connect which is the return value of pbs_connect().

The argument, job_id, identifies which job is to be deleted, it is specified in the form: sequence_number.server

The argument, extend, is overloaded to serve two purposes. If the pointer extend points to a string of the form:
deldelay=nnnn,
it is used to provide control over the delay between sending SIGTERM and SIGKILL signals to a running job. The characters nnnn specify a unsigned decimal integer time delay in seconds. If extend is the null pointer or points to a null string, the administrator established default time delay is used.

If extend points to a string other than the above, it is taken as text to be appended to the message mailed to to the job owner. This mailing occurs if the job is deleted by a user other than the job owner.

SEE ALSO¶

qdel(1B) and pbs_connect(3B)

DIAGNOSTICS¶

When the batch request generated by the pbs_deljob() function has been completed successfully by a batch server, the routine will return 0 (zero). Otherwise, a non zero error is returned. The error number is also set in pbs_errno.