1pbs_submit(3B) PBS pbs_submit(3B)
2
6 pbs_submit - submit a pbs batch job
7
9 #include <pbs_error.h>
10 #include <pbs_ifl.h>
11 char *pbs_submit(int connect, struct attropl *attrib,
13 char *script, char *destination, char *extend)
14
16 Issue a batch request to submit a new batch job.
17 A Queue 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(). The job will be submitted to the queue specified by destina‐
21 tion.
22 The parameter, attrib, is a list of attropl structures which is defined
24 in pbs_ifl.h as:
25 struct attrl {
27 char *name;
28 char *resource;
29 char *value;
30 struct attrl *next;
31 enum batch_op op;
32 };
33 The attrib list is terminated by the first entry where next is a null
35 pointer.
36 The name member points to a string which is the name of the attribute.
38 The value member points to a string which is the value of the
39 attribute. The attribute names are defined in pbs_ifl.h:
40 #define ATTR_a "Execution_Time"
42 Defines the job's execution time.
43 #define ATTR_A "Account_Name"
45 Defines the account string.
46 #define ATTR_c "Checkpoint"
48 Defines the checkpoint interval.
49 #define ATTR_e "Error_Path"
51 Defines the path name for the standard error of the job.
52 #define ATTR_g "Group_List"
54 Defines the list of group names under which the job may
55 execute.
56 #define ATTR_h "Hold_Types"
58 Defines the hold types, the only allowable value string
59 is "u".
60 #define ATTR_j "Join_Paths"
62 Defines whether standard error and standard output are
63 joined (merged).
64 #define ATTR_k "Keep_Files"
66 Defines which output of the job is kept on the execution
67 host.
68 #define ATTR_l "Resource_List"
70 Defines a resource required by the job.
71 #define ATTR_m "Mail_Points"
73 Defines the points at which the server will send mail
74 about the job.
75 #define ATTR_M "Mail_Users"
77 Defines the list of users who would receive mail about
78 the job.
79 #define ATTR_N "Job_Name"
81 Defines the job name.
82 #define ATTR_o "Output_Path"
84 Defines the path name for the standard output of the job.
85 #define ATTR_p "Priority"
87 Defines the priority of the job.
88 #define ATTR_r "Rerunable"
90 Defines the rerunable flag.
91 #define ATTR_S "Shell_Path_List"
93 Defines the path to the shell which will interpret the
94 job script.
95 #define ATTR_t "job_array_request"
97 Requests specific array IDs. Makes this submission a job
98 array submit.
99 #define ATTR_u "User_List"
101 Defines the list of user names under which the job may
102 execute.
103 #define ATTR_v "Variable_List"
105 Defines the list of additional environment variables
106 which are exported to the job.
107 #define ATTR_depend "depend"
109 Defines the inter-job dependencies.
110 #define ATTR_stagein "stagein"
112 Defines the list of files to be staged in prior to job
113 execution.
114 #define ATTR_stageout "stageout"
116 Defines the list of files to be staged out after job exe‐
117 cution.
118 If an attribute is not named in the attrib array, the default action
120 will be taken. It will either be assigned the default value or will
121 not be passed with the job. The action depends on the attribute. If
122 attrib itself is a null pointer, then the default action will be taken
123 for each attribute.
124 Associated with an attribute of type ATTR_l (the letter ell) is a
126 resource name indicated by resource in the attrl structure. All other
127 attribute types should have a pointer to a null string for resource.
128 The op member is forced to a value of SET by pbs_submit().
130 The parameter, script, is the path name to the job script. If the path
132 name is relative, it will be expanded to the processes current working
133 directory. If script is a null pointer or the path name pointed to is
134 specified as the null string, no script is passed with the job.
135 The destination parameter specifies the destination for the job. It is
137 specified as: [queue] If destination is the null string or the queue is
138 not specified, the destination will be the default queue at the con‐
139 nected server.
140 The parameter, extend, is reserved for implementation defined exten‐
142 sions.
143 The return value is a character string which is the job_identifier
145 assigned to the job by the server. The space for the job_identifier
146 string is allocated by pbs_submit() and should be released via a call
147 to free() by the user when no longer needed.
148
150 qsub(1B) and pbs_connect(3B)
151
153 When the batch request generated by pbs_submit() function has been com‐
154 pleted successfully by a batch server, the routine will return a
155 pointer to a character string which is the job identifier of the sub‐
156 mitted batch job. Otherwise, a null pointer is returned and the error
157 code is set in pbs_error.
158Local pbs_submit(3B)