Section 3: library functions
pbs_statjob – obtain status of pbs batch jobs 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…
pbs_stagein – request that files for a pbs batch job be staged in. Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_stagein(int connect, char *job_id, char *location, char *extend) Description Issue a batch request to start the stage in of files specified in the stagein attribute of a batch job. A stage in batch request is generated and sent to…
pbs_sigjob – send a signal to a pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_sigjob(int connect, char *job_id, char *signal, char *extend) int pbs_sigjobasync(int connect, char *job_id, char *signal, char *extend) Description Issue a batch request to send a signal to a batch job. A Signal Job batch request is generated and sent to the server over the connection…
pbs_selstat – obtain status of selected pbs batch jobs Synopsis #include <pbs_error.h> #include <pbs_ifl.h> struct batch_status *pbs_selstat(int connect, struct attropl *sel_list, char *extend) void pbs_statfree(struct batch_status *psj) Description Issue a batch request to examine the status of jobs which meet certain criteria. pbs_selstat() returns a list of batch_status structures for those jobs which met the selection criteria….
pbs_selectjob – select pbs batch jobs Synopsis #include <pbs_error.h> #include <pbs_ifl.h> char **pbs_selectjob(int connect, struct attropl *attrib, char *extend) Description Issue a batch request to select jobs which meet certain criteria. pbs_selectjob() returns a array of job identifiers which met the criteria. Initially all batch jobs are selected for which the user is authorized to query status….
pbs_runjob – run a pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_runjob(int connect, char *job_id, char *location, char *extend) int pbs_asyrunjob(int connect, char *job_id, char *location, char *extend) Description Issue a batch request to run a batch job. For pbs_runjob() a "Run Job" batch request is generated and sent to the server over the connection specified by which is…
pbs_rlsjob – release a hold on a pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_rlsjob(int connect, char *job_id, char *hold_type, char *extend) Description Issue a batch request to release a hold from a job. A Release Job batch request is generated and sent to the server over the connection specified by which is the return value…
pbs_rescreserve, pbs_rescrelease – reserve/free batch resources Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_rescreserve(int connect, char **resourcelist, int arraysize, resource_t *resource_id) int pbs_rescrelease(int connect, resource_t resource_id) Description pbs_rescreserver Issue a request to the batch server to reserve specified resources. is the connection returned by pbs_connect(). is an array of one or more strings specifying the resources to…
pbs_rescquery, avail, totpool, usepool – query resource availability Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_rescquery(int connect, char **resourcelist, int arraysize, int *available, int *allocated, int *reserved, int *down ) char *avail(int connect, char *resc) int totpool(int connect, int update) int usepool(int connect, int update) Description pbs_rescquery Issue a request to the batch server to query the…
pbs_rerunjob – rerun a pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_rerunjob(int connect, char *job_id, char *extend) Description Issue a batch request to rerun a batch job. A Rerun Job batch request is generated and sent to the server over the connection specified by which is the return value of pbs_connect(). If the job is…
pbs_orderjob – reorder pbs batch jobs in a queue Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_orderjob(int connect, char *job_id1, char *job_id2, char *extend) Description Issue a batch request to swap the order of two jobs with a single queue. An Order Job batch request is generated and sent to the server over the connection specified by which is…
pbs_msgjob – record a message for a running pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_msgjob(int connect, char *job_id, int file, char *message, char *extend) Description Issue a batch request to write a message in an output file of a batch job. A Message Job batch request is generated and sent to the server over the…
pbs_movejob – move a pbs batch job to a new destination Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_movejob(int connect, char *job_id, char *destination, char *extend) Description Issue a batch request to move a job to a new destination. The job is removed from the present queue and instantiated in a new queue. A Move Job batch request is…
pbs_manager – administrator a pbs batch object Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_manager(int connect, int command, int obj_type, char *obj_name, struct attropl *attrib, char *extend) Description Issue a batch request to perform administration functions at a server. With this request server objects such as queues can be created and deleted, and have their attributes set and unset….
pbs_locjob – locate current location of a pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> char *pbs_locjob(int connect, char *job_id, char *extend) Description Issue a batch request to locate a batch job. If the server currently manages the batch job, or knows which server does currently manage the job, it will reply with the location of the…
pbs_holdjob – place a hold on a pbs batch job Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_holdjob(int connect, char *job_id, char *hold_type, char *extend) Description Issue a batch request to place a hold upon a job. A Hold Job batch request is generated and sent to the server over the connection specified by which is the return value…
pbs_ gpureset – reset GPU error counts Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_ gpureset(int connect, char *mom_node, int gpu_id, int ecc_perm, int ecc_vol) Description Issue a batch request for the pbs_mom to reset the ECC counts on one of it’s Nvidia GPUs. The GPU’s error count is reset by sending a GPU Control batch request…
pbs_gpumode – change GPU mode Synopsis #include <pbs_error.h> #include <pbs_ifl.h> int pbs_gpumode(int connect, char *mom_node, int gpu_id, int gpu_mode) Description Issue a batch request for the pbs_mom to change the mode on one of it’s Nvidia GPUs. The GPU’s mode is changed by sending a GPU Control batch request to the batch server. This call requires…
pbs_geterrmsg – get error message for last pbs batch operation Synopsis #include <pbs_error.h> #include <pbs_ifl.h> char *pbs_geterrmsg(int connect) Description Return the error message text associated with a batch server request. If the preceding batch interface library call over the connection specified by resulted in an error return from the server, there may be an associated…
pbs_get_server_list – get a list of pbs server names Synopsis #include <pbs_error.h> #include <pbs_ifl.h> char pbs_get_server_list() Description A character string is returned containing the names of the PBS servers. See Also pbs_connect(3B), pbs_default(3B), pbs_fbserver(3B) Diagnostics If the servers cannot be determined, a NULL value is returned.