pbs_statsched(3B)

🌸 NAME 🌸

pbs_statsched — get status of PBS schedulers.

okay bestie, this is the pbs_statsched(3B) page from PBS Professional, and it's literally your cheat code for grabbing scheduler status. slay. 💅

✨ SYNOPSIS ✨

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

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

💖 DESCRIPTION 💖

okay so this routine issues a batch request to get the status of the PBS schedulers.

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

This command returns status of the default scheduler and all multischeds. periodt. 👑

🎀 ARGUMENTS 🎀

• connect — Return value of pbs_connect(). Specifies connection handle over which to send batch request to server.
• output_attribs — Pointer to a list of attributes to return. If this argument is a null pointer or points to a null string, 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. Should always be a pointer to a null string.
• 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 default scheduler and all multischeds.

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().

bestie, this is not optional. free the list when you're done, okay? 💖

🌈 SEE ALSO 🌈

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

xoxo, your Local girlie 💖 — source/version: Local, date: 15 November 2019, page: pbs_statsched(3B) out 🌈