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
16 Issue a batch request to alter a batch job.
17 A Modify Job batch request is generated and sent to the server over the
19 connection specified by connect which is the return value of pbs_con‐
20 nect().
21 The argument, job_id, identifies which job is to be altered, it is
23 specified in the form:
24 sequence_number.server
25 The parameter, attrib, is a pointer to an attrl structure which is
27 defined in pbs_ifl.h as:
28 struct attrl {
30 char *name;
31 char *resource;
32 char *value
33 struct attrl *next;
34 };
35 The attrib list is terminated by the first entry where next is a null
37 pointer.
38 The name member points to a string which is the name of the attribute.
40 The value member points to a string which is the value of the
41 attribute. The attribute names are defined in pbs_ifl.h:
42 #define ATTR_a "Execution_Time"
44 Alter the job's execution time.
45 #define ATTR_A "Account_Name"
47 Alter the account string.
48 #define ATTR_c "Checkpoint"
50 Alter the checkpoint interval.
51 #define ATTR_e "Error_Path"
53 Alter the path name for the standard error of the job.
54 #define ATTR_g "Group_List"
56 Alter the list of group names under which the job may
57 execute.
58 #define ATTR_h "Hold_Types"
60 Alter the hold types.
61 #define ATTR_j "Join_Path"
63 Alter if standard error and standard output are joined
64 (merged).
65 #define ATTR_k "Keep_Files"
67 Alter which output of the job is kept on the execution
68 host.
69 #define ATTR_l "Resource_List"
71 Alter the value of a named resource.
72 #define ATTR_m "Mail_Points"
74 Alter the points at which the server will send mail about
75 the job.
76 #define ATTR_M "Mail_Users"
78 Alter the list of users who would receive mail about the
79 job.
80 #define ATTR_N "Job_Name"
82 Alter the job name.
83 #define ATTR_o "Output_Path"
85 Alter the path name for the standard output of the job.
86 #define ATTR_p "Priority"
88 Alter the priority of the job.
89 #define ATTR_r "Rerunable"
91 Alter the rerunable flag.
92 #define ATTR_S "Shell_Path_List"
94 Alter the path to the shell which will interprets the job
95 script.
96 #define ATTR_u "User_List"
98 Alter the list of user names under which the job may exe‐
99 cute.
100 #define ATTR_v "Variable_List"
102 Alter the list of environmental variables which are to be
103 exported to the job.
104 #define ATTR_depend "depend"
106 Alter the inter-job dependencies.
107 #define ATTR_stagein "stagein"
109 Alter the list of files to be staged-in before job execu‐
110 tion.
111 #define ATTR_stageout "stageout"
113 Alter the list of files to be staged-out after job execu‐
114 tion.
115 If attrib itself is a null pointer, then no attributes are altered.
117 Associated with an attribute of type ATTR_l (the letter ell) is a
119 resource name indicated by resource in the attrl structure. All other
120 attribute types should have a pointer to a null string ("") for
121 resource.
122 If the resource of the specified resource name is already present in
124 the job's Resource_List attribute, it will be altered to the specified
125 value. If the resource is not present in the attribute, it is added.
126 Certain attributes of a job may or may not be alterable depending on
128 the state of the job; see qalter(1B).
129 The parameter, extend, is reserved for implementation defined exten‐
132 sions.
133
135 qalter(1B), qhold(1B), qrls(1B), qsub(1B), pbs_connect(3B), pbs_hold‐
136 job(3B), and pbs_rlsjob(3B)
137
139 When the batch request generated by pbs_alterjob() function has been
140 completed successfully by a batch server, the routine will return 0
141 (zero). Otherwise, a non zero error is returned. The error number is
142 also set in pbs_errno.
143Local pbs_alterjob(3B)