pbs_stathost(3B)

💖 pbs_stathost(3B) 💖

okay bestie, welcome to the pbs_stathost(3B) page from the PBS Professional manual — this is the one where we go ask the server for the status of PBS execution hosts. no cap, it’s lowkey iconic. 💅

✨ NAME ✨

pbs_stathost — get status of PBS execution host(s).

🎀 SYNOPSIS 🎀

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

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

🌸 DESCRIPTION 🌸

Here’s the vibe: you issue a batch request to get the status of PBS execution hosts.

Under the hood, this 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. And if an execution host has multiple vnodes, this command reports aggregated information from the vnodes for that host. fr fr, it rolls them up. 🫶

💅 ARGUMENTS 💅

• connect — return value of pbs_connect(). Specifies connection handle over which to send batch request to server.
• target — name of 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(). yes bestie, clean up after yourself — don’t leave it lying around. 💅

🦋 SEE ALSO 🦋

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

okay that’s the whole page — source/version: Local; date: 15 November 2019; page: pbs_stathost(3B). mwah 💋