qalter | qdel | qhold | qmsg | qmove | qrls | qrerun | qselect | qsig | qstat | qsub
Back to xpbs and PBS Commands

pbs_job_attributes Manual Page


     NAME
	  pbs_job_attributes - PBS job attributes

     DESCRIPTION
	  A batch job has the following	attributes shown in the
	  following list.  The attributes marked with the section
	  symbol f are required by POSIX 1003.2d:  If an attribute is
	  unset, the indicated default value is	assumed.

	    Account_Name f
		 Used for accounting on	some hosts.  Format: string;
		 default value:	none, not used.

	    Checkpoint f
		 If supported by the server implementation and the
		 host operating	system,	the checkpoint attribute
		 determines when checkpointing will be performed by
		 PBS on	behalf of the job.  The	legal values for
		 checkpoint are	described under	the qalter and qsub
		 commands.  Format: the	strings	"n", "s", "c",
		 "c=mmmm"; default value: "u", which is	unspecified.

	    depend
		 The type of inter-job dependencies specified by the
		 job owner.  Format: "type:jobid[,jobid...]"; default
		 value:	no dependencies.

	    Error_Path f
		 The final path	name for the file containing the job's
		 standard error	stream.	 See the qsub and qalter
		 command description for more detail.  Format:
		 "[hostname:]pathname";	default	value:
		 (job_name).e(job_number).

	    Execution_Time f
		 The time after	which the job may execute.  The	time
		 is maintained in seconds since	Epoch.	If this	time
		 has not yet been reached, the job will	not be
		 scheduled for execution and the job is	said to	be in
		 wait state.  Format: "[[CCwYY]MMDDhhmm[.ss]"; default
		 value:	time 0,	no delay.

	    group_list f
		 A list	of group_names@hosts which determines the
		 group under which the job is run on a given host.
		 [internal type: array of strings] When	a job is to be
		 placed	into execution,	 the server will select	a
		 group name according to the following ordered set of
		 rules:

		 1. Select the group name from the list	for which the
		    associated host name matches the name of the
		    execution host.

		 2. Select the group name which	has no associated host
		    name, the wild card	name.

		 3. Use	the login group	for the	user name under	which
		    the	job will be run.

		 Format: "group_name[@host][,group_name[@host]...]".

	    Hold_Types f
		 The set of holds currently applied to the job.	 If
		 the set is not	null, the job will not be scheduled
		 for execution and is said to be in the	hold state.
		 Note,	the hold state takes precedence	over the wait
		 state.	 Format: string	made up	of the letters 'u',
		 's', 'o'; default value:  no hold.

	    interactive
		 True if the job is an interactive PBS job.  Format:
		 boolean, see Join_Paths; default value: false.

	    Job_Name f
		 The name assigned to the job by the qsub or qalter
		 command.  Format: string up to	15 characters, first
		 character must	be alphabetic; default value: the base
		 name of the job script	or STDIN.

	    Join_Path f
		 If the	Join_Paths attribute is	{TRUE},	then the job's
		 standard error	stream will be merged, inter-mixed,
		 with the job's	standard output	stream and placed in
		 the file determined by	the Output_Path	attribute.
		 The Error_Path	attribute is maintained, but ignored.
		 Format: boolean, values accepted are "True", "TRUE",
		 "true", "Y", "y", "1",	"False", "FALSE", "false",
		 "N", "n", "0";	default	value: false.

	    Keep_Files f
		 If Keep_Files contains	the values "o" and/or "e" the
		 corresponding streams of the batch job	will be
		 retained on the execution host	upon job termination.
		 Keep_Files overrides the Output_Path and Error_Path
		 attributes.  Format: "o", "e",	"oe" or	"eo"; default
		 value:	no keep, return	files to submission host.

	    Mail_Points	f
		 Identifies at which state changes the server will
		 send mail about the job.  Format: string made up of
		 the letters 'a' for abort, 'b'	for beginning, and
		 default value:	'a', send on job abort.

	    Mail_Users f
		 The set of users to whom mail may be sent when	the
		 job makes certain state changes.  Format:
		 "user@host[,user@host]";  default value: job owner
		 only.

	    Output_Path	f
		 The final path	name for the file containing the job's
		 standard output stream.  See the qsub and qalter
		 command description for more detail.  Format: see
		 error_path, default value: (job_name).o(job_number).

	    Priority f
		 The job scheduling priority assigned by the user.
		 Format: "[+|-]nnnnn"; default value: undefined.

	    Rerunable f
		 The rerunable flag given by the user.	Format:	"y" or
		 "n", see Join_Path; default value: y, job is
		 rerunable.

	    Resource_List f
		 The list of resources required	by the job.  The
		 resource list is a set	of name=value strings.	The
		 meaning of name and value is server dependent.	 The
		 value also establishes	the limit of usage of that
		 resource.  If not set,	the value for a	resource may
		 be determined by a queue or server default
		 established by	the administrator.  Default value: no
		 usage or no limit depending on	specific resource.

	    Shell_Path_List f
		 A set of absolute paths of the	program	to process the
		 job's script file.  The list is in the	format:
		 "path[@host][,path[@host]...]".  If this is null,
		 then the user's login shell on	the host of execution
		 will be used.	Default	value: null, login shell.

	    User_List f
		 The list of user@hosts	which determines the user name
		 under which the job is	run on a given host.
		 [internal type: array of strings] When	a job is to be
		 placed	into execution,	 the server will select	a user
		 name from the list according to the following ordered
		 set of	rules:

		 1. Select the user name from the list for which the
		    associated host name matches the name of the
		    execution host.

		 2. Select the user name which has no associated host
		    name, the wild card	name.

		 3. Use	the Job_Owner as the user name.

		 Default value:	job owner name.

	    Variable_List f
		 This is the list of environment variables passed with
		 the Queue Job batch request.  Format:
		 "name=value[,name=value...]".

	  The following	attributes require system, manager, or
	  operator privilege to	set.  They are visible to any client
	  but cannot be	set by a non-privileged	client.

	    comment
		 An attribute for displaying comments about the	job
		 from the system.  Format: any string; default value:
		 none.

	  The following	attributes are read-only, they are established
	  by the server	and are	visible	to the client but cannot be
	  set by a client.

	    ctime
		 The time that the job was created.

	    exec_host
		 If the	job is running,	this is	set to the name	of the
		 host on which the job is executing.

	    egroup
		 If the	job is queued in an execution queue, this
		 attribute is set to the group name under which	the
		 job is	to be run.  This is available only to the
		 batch administrator.

	    euserIf the	job is queued in an execution queue, this
		 attribute is set to the user name under which the job
		 is to be run.	This is	available only to the batch
		 administrator.

	    Job_Owner f
		 The login name	on the submitting host of the user who
		 submitted the batch job.

	    job_state
		 The state of the job.

		 E    for exiting, the job has completed execution,
		      with or without errors, and the batch system is
		      doing post-execution clean-up.

		 H    for Held,	one or more holds have been applied to
		      the job.

		 Q    for Queued, the job resides in a execution or
		      routing queue pending execution or routing.  It
		      is not in	held or	waiting	state.

		 R    for Running, the job resides in a	execution
		      queue and	has been placed	into execution.

		 S    for Suspend (Job running on Unicos only),	the
		      job was executing	and has	been suspended.	  The
		      job retains its assigned resources but does not
		      use cpu cycle or walltime.

		 T    for Transiting, the job is in process of being
		      routed or	moved to a new destination.

		 W    for Waiting, the job is not held but the
		      Execution_Time attribute contains	a time which
		      has not yet been reached.

	    mtime
		 The time that the job was last	modified, changed
		 state,	or changed locations.

	    qtime
		 The time that the job entered the current queue.

	    queue
		 The name of the queue in which	the job	currently
		 resides.

	    resources_used f
		 The amount of resources used by the job.  This	is
		 provided as part of job status	information if the job
		 is running.

	    server
		 The name of the server	which is currently managing
		 the job.

	    session_id
		 If the	job is running,	this is	set to the session id
		 of the	executing job.

     SEE ALSO
	  PBS ERS, qsub(1B), qalter(1B)


qalter | qdel | qhold | qmsg | qmove | qrls | qrerun | qselect | qsig | qstat | qsub
Back to xpbs and PBS Commands