pbs_holdjob(3B)

✨ pbs_holdjob ✨

ok so this is a page from the PBS Professional manual, bestie — pbs_holdjob(3B), aka the little function that puts a whole entire hold on a PBS batch job. sit down, grab a strawberry drink 🍓, and let's get into it.

🎀 NAME 🎀

pbs_holdjob — place a hold on a PBS batch job. that's it, that's the vibe. it holds the job. iconic behavior honestly. 👑

🦋 SYNOPSIS 🦋

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

int pbs_holdjob(int connect, char *jobID, char *hold_type,
                char *extend)

like, copy it exactly please, don't freestyle the signature, i'm begging 🙈

💜 DESCRIPTION 💜

okay so what this does: it issues a batch request to place a hold on a job or a job array. that's the whole plot.

this function generates a Hold Job batch request and sends it off to the server over the connection you passed in as connect. literally just vibes and a request going over the wire. ✨

🌸 ARGUMENTS 🌸

• connect — this is the return value of pbs_connect(). it specifies the connection over which to send the batch request to the server. no connection, no slay. 🔌
• jobID — the ID of the job that's getting held. 🫶 format for a job:

<sequence number>.<server name>

format for a job array:

<sequence number>[].<server name>

• hold_type — the type of hold you're applying to the job or job array. valid values are defined in pbs_ifl.h — go look, they're right there. and here's the little detail: if hold_type is a null pointer or points to a null string, PBS applies a User hold to the job or job array. default behavior, we love her. 💅
• extend — a character string for extensions to the command. not currently used. it's giving "reserved for later", iykyk 🧚

⭐ RETURN VALUE ⭐

the routine returns 0 (zero) on success. zero, bestie, we ate. 🔥

if an error occurred, the routine returns a non-zero exit value, and the error number is available in the global integer pbs_errno. so when it goes wrong (and 😭 it might), that's where you look.

🌈 SEE ALSO 🌈

qhold(1B), pbs_connect(3B), pbs_alterjob(3B), pbs_rlsjob(3B)

like, the whole friend group. go say hi. 🫶

ngl, quick vibe check: this page is the Local version, dated 11 December 2019, and it belongs to pbs_holdjob(3B). 💖 that's the sign-off, mwah, go hold some jobs 🎀✨