pbs_statnode(3B)

okay bestie, this is pbs_statnode(3B) from PBS Professional — the glow-up manual for getting status of PBS execution host(s) 💅✨

🌸 NAME 🌸

pbs_statnode — get status of PBS execution host(s) 🫶

✨ SYNOPSIS ✨

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

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

💖 DESCRIPTION 💖

okay so this function issues a batch request to get the status of PBS execution hosts. It generates a Status Node (58) batch request and sends it to the server over the connection specified by connect.

It returns specified attributes or all attributes of specified execution host or all execution hosts. If an execution host has multiple vnodes, this command reports aggregated information from the vnodes for that host. no cap 🦋

It’s identical to pbs_stathost(); retained for backward compatibility. periodt 💀

🎀 ARGUMENTS 🎀

• connect — return value of pbs_connect(). Specifies the connection handle over which to send the batch request to the server. 🔌
• target — name of the execution host whose attributes are to be reported. If this argument is a null pointer or points to a null string, returns attributes of all execution hosts known to the server. 👑
• output_attribs — pointer to a list of attributes to return. If this argument is null, 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. 🙈

🫶 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. Used only when the specified attribute contains resource information. Otherwise, resource should be a null pointer.
• 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 execution host(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 🧚

You must free the list of batch_status structures when no longer needed, by calling pbs_statfree(). do not forget this, bestie 😭💅

⭐ SEE ALSO ⭐

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

cute sign-off 🎀: source/version Local, date 15 November 2019, manual pbs_statnode(3B). mwah 💋