2.23.3 list-batch-jobs
Lists the batch jobs.
Synopsis
asadmin [asadmin-options] list-batch-jobs [--help] [--target target] [--long={false|true}] [--output output] [--header={false|true}] [job_name]
Storage location
Application Server installation directory/javaee/glassfish/bin
Function
The list-batch-jobs subcommand lists the batch jobs and job details.
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 batch jobs and job details.
Type: String
The following values can be specified:
-
server
Lists batch jobs for the default server instance server and is the default value.
-
cluster-name
Lists batch jobs for every server instance in the cluster.
-
instance-name
Lists batch jobs for a particular server instance.
Default value: server
-
- --long={false|true} | -l={false|true}
-
Displays detailed information about batch jobs. 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 jobs. Use a comma-separated list to specify the details to display and their order. The values are case-insensitive. The jobname and instancecount column headings are displayed by default.
Type: String
The following values can be specified:
-
jobname
Displays the name of the job.
-
appname
Displays the name of the application.
-
instancecount
Displays the number of job instances.
-
instanceid
Displays the ID assigned to the job instance.
-
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.
-
batchstatus
Displays the status of the job as set by the batch runtime.
-
starttime
Displays the start time of the job.
-
endtime
Displays the finish time of the job.
-
exitstatus
Displays the status of the job 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: jobname, instancecount
-
- --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
-
- job_name
-
Specifies the name of the job for which to list details.
Type: String
The following values can be specified:
-
Name of the job
Default value: N/A
-
Examples
The following example lists batch jobs for the server instance instance1.
asadmin list-batch-jobs --target instance1
Exit Status
Exit Status |
Explanation |
---|---|
0 |
subcommand executed successfully. |
1 |
error in executing the subcommand. |