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


Manual Reference Pages  -  PBS_STATJOB (3)


.Ig
.Ig

NAME

pbs_statjob - obtain status of pbs batch jobs

CONTENTS

Synopsis
Description
Diagnostics

SYNOPSIS

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

struct batch_status *pbs_statjob(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 specified batch job or a set of jobs at a destination.

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

The parameter, may be either a job identifier or a destination identifier. If the string starts with a number, it is a job identifier. If it starts with a alphabetic character, it is a destination identifier.
.Ig

If is a job identifier, it is the identifier of the job for which status is requested. It is specified in the form:

If is a destination identifier, it specifies that status of all jobs at the destination (queue) which the user is authorized to see be returned. If is the null pointer or a null string, the status of each job at the server which the user is authorized to see is returned.

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 job are returned. When an list is specified, the member is a pointer to a attribute name as listed in pbs_alter(3) and pbs_submit(3). The member is only used if the name member is ATTR_l, otherwise it should 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. TORQUE 2.0.0p1 added the #define’d constant string EXECQUEONLY to only retrieve jobs in execution queues.

The return value is a pointer to a list of batch_status structures or the null pointer if no jobs can be queried for status. 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;
    }

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

SEE ALSO

qstat(1B) and pbs_connect(3B)

DIAGNOSTICS

When the batch request generated by pbs_statjob() function has been completed successfully and the status of each job has been returned by the batch server, the routine will return a pointer to the list of batch_status structures. If no jobs were available to query or an error occurred, a null pointer is returned. The global integer pbs_errno should be examined to determine the cause.

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


Local PBS_STATJOB (3B)

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