1pbs_alterjob(3B) PBS pbs_alterjob(3B)
2
6 pbs_alterjob - alter pbs batch job
7
9 #include <pbs_error.h>
10 #include <pbs_ifl.h>
11 int pbs_alterjob(int connect, char *job_id, struct attrl *attrib,
13 char *extend)
14 int pbs_alterjob_async(int connect, char *job_id, struct attrl *attrib,
16 char *extend)
17
19 Issue a batch request to alter a batch job.
20 A Modify Job batch request is generated and sent to the server over the
22 connection specified by connect which is the return value of pbs_con‐
23 nect(). When the asynchronous pbs_alterjob_async() call is used, the
24 server will validate the request and reply before modifying the job.
25 This version of the call can be used to reduce latency in scheduling,
26 especially when the scheduler must modify a large number of jobs.
27 The argument, job_id, identifies which job is to be altered, it is
29 specified in the form:
30 sequence_number.server
31 The parameter, attrib, is a pointer to an attrl structure which is
33 defined in pbs_ifl.h as:
34 struct attrl {
36 char *name;
37 char *resource;
38 char *value
39 struct attrl *next;
40 };
41 The attrib list is terminated by the first entry where next is a null
43 pointer.
44 The name member points to a string which is the name of the attribute.
46 The value member points to a string which is the value of the
47 attribute. The attribute names are defined in pbs_ifl.h:
48 #define ATTR_a "Execution_Time"
50 Alter the job's execution time.
51 #define ATTR_A "Account_Name"
53 Alter the account string.
54 #define ATTR_c "Checkpoint"
56 Alter the checkpoint interval.
57 #define ATTR_e "Error_Path"
59 Alter the path name for the standard error of the job.
60 #define ATTR_g "Group_List"
62 Alter the list of group names under which the job may
63 execute.
64 #define ATTR_h "Hold_Types"
66 Alter the hold types.
67 #define ATTR_j "Join_Path"
69 Alter if standard error and standard output are joined
70 (merged).
71 #define ATTR_k "Keep_Files"
73 Alter which output of the job is kept on the execution
74 host.
75 #define ATTR_l "Resource_List"
77 Alter the value of a named resource.
78 #define ATTR_m "Mail_Points"
80 Alter the points at which the server will send mail about
81 the job.
82 #define ATTR_M "Mail_Users"
84 Alter the list of users who would receive mail about the
85 job.
86 #define ATTR_N "Job_Name"
88 Alter the job name.
89 #define ATTR_o "Output_Path"
91 Alter the path name for the standard output of the job.
92 #define ATTR_p "Priority"
94 Alter the priority of the job.
95 #define ATTR_r "Rerunable"
97 Alter the rerunable flag.
98 #define ATTR_S "Shell_Path_List"
100 Alter the path to the shell which will interprets the job
101 script.
102 #define ATTR_u "User_List"
104 Alter the list of user names under which the job may exe‐
105 cute.
106 #define ATTR_v "Variable_List"
108 Alter the list of environmental variables which are to be
109 exported to the job.
110 #define ATTR_depend "depend"
112 Alter the inter-job dependencies.
113 #define ATTR_stagein "stagein"
115 Alter the list of files to be staged-in before job execu‐
116 tion.
117 #define ATTR_stageout "stageout"
119 Alter the list of files to be staged-out after job execu‐
120 tion.
121 If attrib itself is a null pointer, then no attributes are altered.
123 Associated with an attribute of type ATTR_l (the letter ell) is a
125 resource name indicated by resource in the attrl structure. All other
126 attribute types should have a pointer to a null string ("") for
127 resource.
128 If the resource of the specified resource name is already present in
130 the job's Resource_List attribute, it will be altered to the specified
131 value. If the resource is not present in the attribute, it is added.
132 Certain attributes of a job may or may not be alterable depending on
134 the state of the job; see qalter(1B).
135 The parameter, extend, is reserved for implementation defined exten‐
138 sions.
139
141 qalter(1B), qhold(1B), qrls(1B), qsub(1B), pbs_connect(3B), pbs_hold‐
142 job(3B), and pbs_rlsjob(3B)
143
145 When the batch request generated by the pbs_alterjob() or pbs_alter‐
146 job_async() function has been completed successfully by a batch server,
147 the routine will return 0 (zero). Otherwise, a non zero error is
148 returned. The error number is also set in pbs_errno.
149Local pbs_alterjob(3B)