GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
pbs_statnode(3B) PBS pbs_statnode(3B)

pbs_statnode - obtain status of pbs nodes

#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)

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 connect which is the return value of pbs_connect().

The id is the name of a node or the null string. If id specifies a node name, the status of that node will be returned. If the id 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 id 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, attrib, 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 attrib list is terminated by the first entry where next is a null pointer. If attrib 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 attrib list is specified, the name 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 resource member is not used and must be a pointer to a null string. The value member should aways be a pointer to a null string.

The parameter, extend, 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().

qstat(1B) and pbs_connect(3B)

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.

Local

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.