pbs_sigjob(3B)

🎀 NAME 🎀

pbs_sigjob — send a signal to a PBS batch job. This is the pbs_sigjob(3B) page from PBS Professional, and yes bestie, it’s giving “poke the job with a signal” energy 💅✨

🌸 SYNOPSIS 🌸

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

int pbs_sigjob(int connect, char *jobID, char *signal, char *extend)

🦋 DESCRIPTION 🦋

okay so pbs_sigjob issues a batch request to send a signal to a batch job. It generates a Signal Job (18) batch request and sends it to the server over the connection specified by connect. iconic behavior, no cap 💖

You can send a signal to a job, job array, subjob, or range of subjobs. The batch server sends the job the specified signal.

🚨 important vibe check: the job must be in the running or suspended state. that part is not optional, bestie 😭

💅 ARGUMENTS 💅

• connect — Return value of pbs_connect(). Specifies connection handle over which to send batch request to server.
• jobID — ID of job to be signaled. The formats are:
  • Format for a job: <sequence number>.<server name>
  • Format for a job array: <sequence number>[].<server name>
  • Format for a subjob: <sequence number>[<index>].<server name>
  • Format for a range of subjobs: <sequence number>[<index start>-<index end>].<server name>
• signal — Name of signal to send to job. Can be alphabetic, with or without SIG prefix. Can be signal number.

The following special signals are all lower-case, and have no associated signal number:

• admin-suspend — Suspends a job and puts its vnodes into the maintenance state. The job is put into the S state and its processes are suspended.
• admin-resume — Resumes a job that was suspended using the admin-suspend signal, without waiting for scheduler. Cannot be used on jobs that were suspended with the suspend signal. When the last admin-suspend ed job has been admin-resume d, the vnode leaves the maintenance state.
• suspend — Suspends specified job(s). Job goes into suspended (S) state.
• resume — Marks specified job(s) for resumption by scheduler when there are sufficient resources. Cannot be used on jobs that were suspended with the admin_suspend signal.

If the signal is not recognized on the execution host, no signal is sent and an error is returned. sad but true 🫶

• extend — Character string for extensions to command. Not currently used.

✨ RETURN VALUE ✨

The routine returns 0 (zero) on success. slay 💖

If an error occurred, the routine returns a non-zero exit value, and the error number is available in the global integer pbs_errno. keep that in your notes, bestie 📝

🌈 SEE ALSO 🌈

qsig(1B), pbs_connect(3B)

💖 okay that’s the whole page! source/version: Local; date: 15 November 2019; manual: pbs_sigjob(3B). mwah, bestie 💋🎀