2.23.2 list-batch-job-steps
Lists the steps for a specific batch job execution.
Synopsis
asadmin [asadmin-options] list-batch-job-steps [--help] [--long={false|true}] [--target target] [--output output] [--header={false|true}] execution_id
Storage location
Application Server installation directory/javaee/glassfish/bin
Function
The list-batch-job-steps subcommand lists the steps for a specific batch job execution.
Precondition
Domain Administration Server (DAS) is running.
Arguments
- --help | -?
-
Displays the help text for the subcommand.
- --target target
-
Specifies the target for which the subcommand must list the batch job steps.
Type: String
The following values can be specified:
-
server
Lists steps for the default server instance server and is the default value.
-
cluster-name
Lists steps for every server instance in the cluster.
-
instance-name
Lists steps for a particular server instance.
Default value: server
-
- --long={false|true} | -l={false|true}
-
Displays detailed information about batch job steps.
Type: Boolean
The following values can be specified:
-
true
-
false
Default value: false
-
- --output output | -o output
-
Displays specific details about batch job steps. Use a comma-separated list to specify the details to display and their order. The values are case-insensitive. A subset of all possible headings is displayed by default.
Type: String
The following values can be specified:
-
stepname
Displays the name of the step.
-
stepid
Displays the step ID.
-
starttime
Displays the start time of the step.
-
endtime
Displays the finish time of the step.
-
batchstatus
Displays the status of the step as set by the batch runtime.
-
exitstatus
Displays the status of the step 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.
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
-
- execution_id
-
Specifies the ID of the execution for which subcommand must list batch job steps and 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 steps and specific step details for a job execution with the execution ID of 7. The target is the server instance instance1.
asadmin list-batch-job-steps --target instance1 o=stepname,stepid,batchstatus, 7
Exit Status
Exit Status |
Explanation |
---|---|
0 |
subcommand executed successfully. |
1 |
error in executing the subcommand. |