pbs_statnode (3) - Linux Manuals

pbs_statnode: obtain status of pbs nodes

NAME

pbs_statnode - obtain status of pbs nodes

SYNOPSIS

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

struct batch_status *pbs_statnode(int connect, char *id, struct attrl *attrib, char *extend)

void pbs_statfree(struct batch_status *psj)

DESCRIPTION

Issue a batch request to obtain the status of a PBS node or nodes.

A Status Node batch request is generated and sent to the server over the connection specified by which is the return value of pbs_connect().

The is the name of a node or the null string. If specifies a node name, the status of that node will be returned. If the is a null string (or null pointer), the status of all nodes at the server will be returned.

In TORQUE 2.1.0, if the starts with a ":" and followed by a node property, all nodes with that property are returned; creating a "node group" functionality. The string ":ALL" is specially handled and is the same as passing a null string.

The parameter, is a pointer to an attrl structure which is defined in pbs_ifl.h as:

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

The list is terminated by the first entry where is a null pointer. If is given, then only the attributes in the list are returned by the server. Otherwise, all the attributes of a node are returned. When an list is specified, the member is a pointer to a attribute name. The supported attribute names relating to nodes are "state", "properties", "np", "ntype", "jobs", "status", and "note". The member is not used and must be a pointer to a null string. The member should aways be a pointer to a null string.

The parameter, is reserved for implementation defined extensions.

The return value is a pointer to a list of batch_status structures, which is defined in pbs_ifl.h as:

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

It is up the user to free the structure when no longer needed, by calling pbs_statfree().

DIAGNOSTICS

When the batch request generated by pbs_statnode() function has been completed successfully by a batch server, the routine will return a pointer to the batch_status structure. Otherwise, a null pointer is returned and the error code is set in the global integer pbs_errno.