Display on-line information.
The DIRECTORY command will display all or just selected portions of the scheduling database. There are three modes of operation for this command.
Line mode: select columns of information are requested.
Full mode: the /full =all (includes all lists) qualifier requests a complete listing of all the information about the job.
General Format
directory/job job_name [/qualifiers]
Alternate
lsjob job_name [-qualifiers]
Qualifier Summary
/check
/output = file_spec
/node = target_node
/noheading
/notrailing
/columns = number
/symbol [= prefix_string,format] (default = sc)
/full [= list_name or (name,name,...)] names are all, notices, initiates prerequisites, commands, distribution, holds_up, activated_by
/resources=
disk_space
file
measured
estimated
/notify=
submitted
started
delayed
completed
failed
/process=
cli
node
characteristics
cputime
flags
log_file
queue
printer
name
parameter
priority
account
variable
wsdefault
wsextent
wsquota
/general=
comment
next_submit
last_start
last_submit
last_completed
restart_count
up_count
down_count
user
owner
protection
acl
status
job_tag
pre_com_file
post_com_file
/rescheduling
Examples
C:\> schedule directory/job \demo\a\start
\demo\a\start
C:\> schedule directory/job \demo\a\* /reso=measure /gen=status
Job directory \demo\a
FAILED 5,145,297,4 %x00030001
FINISHED 3,132,246,356 %x00030001
Qualifiers
/check
Workgroup Jobs Only. The CHECK option displays the designated object's status on the nodes in the current workgroup. Any differences are displayed as:
<node_name>: different
Adding the -log qualifier displays the specific differences between the object(s) on specific nodes.
Ex:
\least_busy_4\job_job1.hdr
CWG: okay
DWG: different
Prv_Owner (215)= /0xc000000e/
Owner (015)= /0xc000000d/
AWG: okay
/columns=number
The COLUMNS qualifier specifies how many columns to use when listing just the item name. The default is four columns.
/node=node_name
The NODE qualifier specifies what node (either local or remote) you want the operation performed on.
/noheading
The NOHEADING removes the heading information from the directory listing.
/notrailing
The NOTRAILING removes the trailing information from the directory listing.
/full [= list_name or (name,name,...)]
The FULL qualifier requests that all the known attributes of a file be displayed. An optional list name(s) can be specified with this qualifier . If a list is specified then that information is display after all the other attributes of the job have been displayed. When the FULL qualifier is used together with the SYMBOL qualifier the lists are put into .
/general=comment
The COMMENT field is any useful description that you may want to add. This is an 80 character option.
/general=down_count
The DOWN_COUNT field indicates the remaining number of times a job is to be executed. This is automatically updated. When zero is reached no further jobs will be submitted automatically.
/general=execute_window
The EXECUTE_WINDOW displays the interval in which a job is allowed to have all requirements met and execute. This is the time it takes a job to move from scheduling queue C or D to M. Any job that exceeds this interval will have none of its initiates activated. This interval is designed to prevent a run away catch up mode from happening if the system is down for a long period. The interval time check is suppressed if this field is set to zero (i.e. the window is infinite).
/general=flags
The HISTORY flag indicates whether or not history data is to be recorded for this job. A job that runs very frequently generates a lot of history data. To reduce the growth of this history file specify the NOHISTORY flag.
The FIXED_SET_ID flag forces a job to always use a constant set id.
The operating system flags determine the operating system the job was created to run on: OPEN_VMS for an Open VMS job, UNIX for a UNIX job or NT for a Windows NT job.
The BLOCKED flag is used to block a job from running. The job will not run until this flag is set to the default noblocked.
The DELETE_UPON_COMPLETION flag is used to delete a job once it has completed and is removed from the P queue. The interval that it will remain in the P queue is normally 15 hours. When that time elapses, the job will be deleted from the database.
/general=job_tag
The JOB_TAG field specifies the initial value for the SET_TAG value when the job is first entered into the scheduling queues.
/general=last_completed
The LAST_COMPLETED field indicates when a job was last completed. This is automatically updated.
/general=last_start
The LAST_START field indicates the last time a job was started. This is automatically updated.
/general=last_submit
The LAST_SUBMIT field indicates when a job was last submitted. This is automatically updated.
/general=next_submit
The NEXT_SUBMIT field allows the user to specify the next job start date. A job will start on its own only if this date and time are set.
/general=owner
The OWNER field indicates the owner UIC code for the job.
/general=post_com_file
The POST_COM_FILE field indicates that a batch file is to be executed after the scheduled job has run to completion. The batch file and the job are run in the same batch job.
The "I" indicates that the contents of "myfile.bat" will be included into the temporary batch file that is submitted.
/general=pre_com_file
The PRE_COM_FILE field indicates that a batch file is to be executed prior to running the scheduled job. The batch file and the job are run in the same batch job.
The "I" indicates that the contents of "myfile.com" will be included into the temporary batch file that is submitted.
/general=protection
The PROTECTION field specifies the UIC based access rights for the file.
/general=restart_count
A nonzero RESTART_COUNT allows the job to be restarted (up to the specified number of times) if it is terminated with a failure status code.
/general=startup_window
The STARTUP_WINDOW specifies the interval after which a job in schedule queue B will not be initiated. This only occurs if the system is down when a job would have had a time based start. If the system comes up within this interval then the job will start immediately. After this interval this immediate initial run is not done.
The interval time check is suppressed if this field is set to zero (i.e. the window is infinite).
/general=status
The STATUS field is a full 32 bit integer status code that indicates the success (odd) or failure (even) of a job execution. This field is automatically updated each time a job completes.
/general=up_count
The UP_COUNT field indicates how many times a job has been submitted for execution. This is automatically updated.
/notify=after_delayed
The AFTER_DELAYED datum specifies a time limit so that any job that has waited longer than this interval for prerequisites, disk space, or a file is considered delayed. At this time a notification is sent.
/notify=completed
The COMPLETED field will notify the creator of a job when the job is completed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this. If MAIL is set a mail message is sent. Use NOMAIL to disable this. If more then one user name is specified surround the names with parentheses and separate with commas.
/notify=delayed
The DELAYED field will notify the creator of a job if and when the job is delayed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this function. If MAIL is set a mail message is sent. Use NOMAIL to disable this function. If more then one user name is specified surround the names with parentheses and separate with commas.
/notify=failed
The FAILED field will notify the creator of a job if and when the job failed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this. If MAIL is set a mail message is sent. Use NOMAIL to disable this. If more then one user name is specified surround the names with parentheses and separate with commas.
/notify=started
The STARTED field will notify the creator of a job when the job is started. If BROADCAST is set then a logged in user will get a broadcast message. If MAIL is set a mail message is sent. If more then one user name is specified surround the names with parentheses and separate with commas.
/notify=submitted
The SUBMITTED field will notify the creator of a job when the job is submitted. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this function. If MAIL is set amail message is sent. Use NOMAIL to disable this function. If more then one user name is specified surround the names with parentheses and separate with commas.
/resources=disk_space
The DISK_SPACE resource specifies how many blocks must be available before the job is submitted for execution.
/resources=estimated
The ESTIMATED datum allows for establishing an initial estimate of cpu_time, elapse_time, and io_count. These estimated values are not used1 for any computation. Their purpose is to assist in planning and initially setting up the job.
Field |
Description |
cpu |
estimated number of seconds |
elapse |
estimated number of seconds |
io |
estimated number of buffered and direct I/O |
/resources
The FILE data indicates which file, if any, must be present prior to a job being submitted for execution.
/resources=measured
The MEASURED data displays information about cpu_time, elapse_time, io_count, and num_count. It is usually modified automatically as a job completes.
Field |
Description |
cpu |
average number of seconds |
elapse |
average number of seconds |
io |
average number of buffered and direct I/O |
count |
number of times average is based on |
/rescheduling
The rescheduling option displays the method used to calculate the next automatic start time.
/submit=account
The ACCOUNT field will specify which account to charge the batch job to when submitted. This is an eight-character field. The privilege CMKRNL is required to use this qualifier .
/process=characteristics
The CHARACTERISTICS field will specify the number of a characteristic to be associated with the job.
/process=cputime
CPUTIME displays the CPU time limit for the job.
/process=flags
The FLAGS option displays what special features are enabled. The various flags are:
Flag |
Default |
Description |
[NO]HOLD |
NOHOLD |
Hold job in queue until released |
[NO]KEEP |
KEEP |
Keep log file |
[NO]DELETE |
DELETE |
Delete COM file |
[NO]RESTART |
NORESTART |
Flag as restartable |
/process=log_file
The LOG_FILE option displays the name of the log file for the jobs.
/process=name
The NAME option displays the name of the job in the execution queues.
/process=node
The NODE option displays the node on which each schedule is to be processted.
/process=parameter
The PARAMETER option displays any queue parameters that have been specified for a schedule definition.
/process=printer
The PRINTER will queue the job log file for printing when the job is completed. PRINTER allows the user to specify a particular printer.
/process=priority
The PRIORITY field will specify what queue priority level to use when entering the job into an execution queue.
/process=queue
The QUEUE field will identify the batch queue on which the job will be entered. The default queue is SYS$BATCH.
/process=retain
The RETAIN flag determines whether the job will be retained if delete_upon_completion is ON and the job fails.
/process=user
The USER field indicates on who's behalf the job is to be processted for execution. Normally this user name is the same as person who owns the job. To change this field requires CMKRNL privilege.
/process=variable
The VARIABLE qualifier creates or modifies one or more existing job variables.
/process=wsdefault
The WSDEFAULT field will define for a batch job a working set default, the default number of physical pages that the job can use. If the queue on which the job is executed has a nonzero working set default, the smaller of the specified job and queue values is used. If the default set is 0, the smaller of the specified job and user authorization file (UAF) values is used.
/process=wsextent
The WSEXTENT field will define for a batch job a working set extent, the maximum amount of physical memory that the job can use. The job uses the maximum amount of physical memory only when the system has excess free pages. If the queue on which the job is executed has a nonzero working set extent, the smaller of the specified job and queue values is used. If the default set is 0, the smaller of the specified job and user authorization file (UAF) values is used.
/process=wsquota
The WSQUOTA field will define for a batch job a working set quota, the amount of physical memory that the job is guaranteed. If the queue on which the job is executed has a nonzero working set quota, the smaller of the specified job and queue values is used. If the default set is 0, the smaller of the specified job and user authorization file (UAF) values is used.
/symbol[=prefix_string]
The SYMBOL command requests that all job information be output to environmental variables. The environmental variable is constructed by prefixing the field name with the provided string. If none is provided a default value of SC is used. To display the environmental variables output from the /symbol qualifier use:
set prefix_string
/template=<schedule_directory>template_db.schedule
The TEMPLATE qualifier formats the directory output as it is defined in the template file. This output can be used for a variety of reasons and can be output to a file using the OUTPUT . The supplied template file extracts all database information into a format suitable for insertion if desired.