2.23.1 list-batch-job-executions
Lists the batch job executions and execution details.
Synopsis
asadmin [asadmin-options] list-batch-job-executions [--help] [--target target] [--executionid execution-id] [--long={false|true}] [--output output] [--header={false|true}] [instance_ID]
Storage location
Application Server installation directory/javaee/glassfish/bin
Function
The list-batch-job-executions subcommand lists the batch job executions and execution details.
Precondition
Domain Administration Server (DAS) is running.
Arguments
- --help | -?
-
Displays the help text for the subcommand.
- --target target
-
Specifies the target for which to list batch job executions and execution details.
Type: String
The following values can be specified:
-
server
Lists executions for the default server instance server and is the default value.
-
cluster-name
Lists executions for every server instance in the cluster.
-
instance-name
Lists executions for a particular server instance.
Default value: server
-
- --executionid execution-id | -x execution-id
-
Specifies the execution ID of a specific batch job execution.
Type: String
The following values can be specified:
-
The ID of the job instance
Default value: N/A
-
- --long={false|true} | -l={false|true}
-
Displays detailed information about batch job executions. The default value is false.
Type: Boolean
The following values can be specified:
-
true
-
false
Default value: false
-
- --output output | -o output
-
Displays specific details about batch job executions. Use a comma-separated list to specify the details to display and their order. The values are case-insensitive.
Type: String
The following values can be specified:
-
jobname
Displays the name of the job.
-
executionid
Displays the ID assigned to the execution of the batch job. A new execution is created the first time a job is started and every time the existing execution is restarted.
-
starttime
Displays the start time of the execution.
-
endtime
Displays the finish time of the execution.
-
batchstatus
Displays the status of the execution as set by the batch runtime.
-
exitstatus
Displays the status of the execution as set by the Job XML for the job or by the batch application. By default, the exitstatus and the batchstatus are the same unless the exitstatus is explicitly overridden.
-
jobparameters
Displays the properties passed to the batch runtime for the batch job execution, listed as name/value pairs.
-
stepcount
Displays the number of steps in the batch job execution.
Default value: A subset of all possible headings is displayed by default.
-
- --header={false|true} | -h={false|true}
-
Specifies whether column headings are displayed when the --long option is used. The default value is true. To suppress the headings, set the --header option to false.
Type: Boolean
The following values can be specified:
-
true
-
false
Default value: true
-
- instance_ID
-
Specifies the ID of the job instance for which to list execution details.
Type: Integer
The following values can be specified:
-
The ID of the job instance
Default value: N/A
-
Examples
The following example lists batch job executions for the server instance instance1 and displays specific details.
asadmin list-batch-job-executions --target instance1 -o=jobname,executionid,batchstatus,exitstatus
Exit Status
Exit Status |
Explanation |
---|---|
0 |
subcommand executed successfully. |
1 |
error in executing the subcommand. |