pbs_statvnode(3B)

💅 NAME

okay bestie, you're looking at the pbs_statvnode(3B) page from PBS Professional, and this function is literally here to get the status of PBS vnode(s) on execution hosts. no cap. 🫶

🧚 SYNOPSIS

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

struct batch_status *
pbs_statvnode(int connect, char *target, struct attrl *output_attribs,
              char *extend)

✨ DESCRIPTION

so the vibe is: this routine issues a batch request to get the status of PBS vnodes on execution hosts.

It generates a Status Node (58) batch request and sends it to the server over the connection specified by connect. slay.

What comes back? Either the specified attributes, or all attributes of a specified execution host vnode, or all attributes of all execution host vnodes. choose your adventure. 🌈

🌸 ARGUMENTS

• connect — this is the return value of pbs_connect(), fr fr. It specifies the connection handle over which to send the batch request to the server. 💫
• target — the name of the execution host vnode whose attributes are to be reported. If this argument is a null pointer or points to a null string, it returns attributes of all execution host vnodes known to the server. all the vnodes, periodt. 🍓
• output_attribs — pointer to a list of attributes to return. If this argument is null, it returns all attributes. Each attribute is described in an attrl structure, defined in pbs_ifl.h as:

struct attrl {
        char         *name;
        char         *resource;
        char         *value;
        struct attrl *next;
};

• extend — character string for extensions to command. Not currently used. (it's giving "reserved for later" energy, but that's what the page says. 🍵)

🎀 Members of attrl Structure

• name — points to a string containing the name of the attribute. 💅
• resource — points to a string containing the name of a resource. It's used only when the specified attribute contains resource information. Otherwise, resource should be a null pointer. important. ⚠️
• value — points to a string containing the value of the attribute or resource. ✨
• next — points to next attribute in list. A null pointer terminates the list. 🛑

🦋 RETURN VALUE

Returns a pointer to a list of batch_status structures describing the vnode(s). 💖

If an error occurred, the routine returns a null pointer, and the error number is available in the global integer pbs_errno. 😭

👑 The batch_status Structure

The batch_status structure is defined in pbs_ifl.h as:

struct batch_status {
        struct batch_status *next;
        char                *name;
        struct attrl        *attribs;
        char                *text;
}

💅 CLEANUP

bestie, you MUST free the list of batch_status structures when no longer needed — by calling pbs_statfree(). no leaks, no excuses, okay? 🧚✨

🌈 SEE ALSO

• qstat(1B)
• pbs_connect(3B)
• pbs_statfree(3B)

that's the pbs_statvnode(3B) page — from PBS Professional / Local, dated 15 November 2019. bye bestie, mwah 💖🫶