The command line interface interacts with the long-running scheduler to submit and manipulate a long-running job. It is located in the was_root/bin directory as the lrcmd.sh or lrcmd.bat script and can be invoked from any location in the WebSphere cell.
Use the lrcmd script to perform the following commands:
Command | Arguments | Description | Additional Information |
Display usage information for lrcmd. | None | This command displays usage information for the lrcmd command. | Example: lrcmd |
Submit a job to the long-running scheduler. | -cmd=submit -xJCL=<xjcl_filename> [-job= <job_name> (-add | -replace)] [-startDate=<startDate> -startTime=<startTime>] [-host=<host>] [-port=<port>], or -cmd=submit -job=<job_name> [-startDate=<startDate> - startTime=<startTime>] [-host=<host>] [-port=<port>] |
When an XML Job Control Language (xJCL) file
is specified, -xJCL=<xjcl_filename> specifies
the path of the xJCL to be submitted from the file system and optionally
saved. Optional arguments:
Both variations of the command return a job ID for the submitted job. |
Examples:
|
Cancel a previously submitted job. | -cmd=cancel -jobid=<jobid> [-<host>] [-port=<port>] |
This command cancels the start of a previously
submitted job, or cancels the execution of an executing job. Use -jobid=<jobid> as the job ID assigned to the job by the long-running scheduler. The job ID is returned by the lrcmd -cmd=submit command that initially submitted the job. The -cmd=status command can also be used to identify the job ID for a particular job. Optional arguments:
|
Example: lrcmd -cmd=cancel -jobid=myjob:2 -host=myLRShost -port=9083 |
Restart a job. | -cmd=restart -jobid=<jobid> [-host=<host>] [-port=<port>] |
This command restarts the start of a job. Only
jobs in restartable state can be restarted. Use -jobid=<jobid> as the job ID assigned to the job by the long-running scheduler. The job ID is returned by the lrcmd -cmd=submit command that initially submitted the job. The -cmd=status command can also be used to identify the job ID for a particular job. Optional arguments:
|
Only a long-running job associated
with batch applications can be restarted. When a batch job is canceled
using the -cmd=cancel command, its state is changed to restartable. When the job is restarted, processing resumes from the last successfully committed checkpoint. Example: lrcmd -cmd=restart -jobid=myjob:2 -host=myLRShost -port=9081 |
Purge job information. | -cmd=purge -job=<jobid> [-host=<host>] [-port=<port>] |
This command purges job information from the long-running scheduler and execution environments. Use -jobid=<jobid> as the job ID assigned to the job by the long-running scheduler. The job ID is returned by the lrcmd -cmd=submit command that initially submitted the job. The -cmd=status command can also be used to identify the job ID for a particular job. Optional arguments:
|
The long-running scheduler maintains information
about a job after the job has completed. The purge command
permanently deletes job information from the long-running scheduler and execution environment databases. The command
also purges the job's job log. Example: lrcmd -cmd=purge -jobid=myjob:2 |
Save an xJCL to the job repository. | -cmd=save -xJCL=<xjcl_filename> -job=<job_name> [-host=<host>] [-port=<port>] |
This command saves an xJCL document in the job
repository for use by future -cmd=submit commands.
Optional arguments:
|
Examples:
|
Remove a job from the job repository. | -cmd=remove -job=<job_name> [-host=<host>] [-port=<port>] |
This command removes a previously saved xJCL
document from the job repository. Use -job=<job_name> to specify the name assigned to the job when you previously saved the file to the job repository.
|
Example: lrcmd -cmd=remove -jobid=myjob:2 -host=myhost -port=9083 |
Show xJCL stored in the job repository. | -cmd=show -job=<job_name> |
This command displays xJCL stored in the job
repository. Use -job=<job_name> to specify the name assigned to the job when it was saved to the job repository. |
Examples:
|
Show the status of a long-running job. | -cmd=statusor -cmd=status -jobid=<jobid> [-host=<host>] [-port=<port>] |
This command displays status information about
one or more jobs in the long-running scheduler database. Optional argument: -job=<jobid>, if specified, indicates that only job information for the specified job is displayed. |
Examples:
|
Suspend a job. | -cmd=suspend -jobid=<jobid> -seconds=<seconds> [-host=<host>] [-port=<port>] |
This command suspends the start of a grid batch
job for the specified number of seconds. Unless manually resumed
(with lrcmd -cmd=resume, for example), the job automatically resumes
running after the specified number of seconds. Use -jobid=<jobid> as the job ID assigned to the job by the long-running scheduler. The job ID is returned by the lrcmd -cmd=submit command that initially submitted the job. The -cmd=status command can also be used to identify the job ID for a particular job. Optional arguments: Use -seconds=<seconds> to indicate the number of seconds that the job start is suspended. If not specified, the default value of 15 seconds is used. If -seconds=0 is specified, the job does not start until manually resumed.
|
Examples: lrcmd -cmd=submit -xJCL=myxjcl.xml (returns job id myjob:23) Once job myjob:23 has begun execution, it can be suspended for five minutes (for example), with: lrcmd -cmd=suspend -jobid=myjob:23 -seconds=300 -port=81 -host=myODRHost Execution of the job can be resumed before the five minutes expires with: lrcmd -cmd=resume -jobid=myjob:23 |
Resume start of a previously suspended job. | -cmd=resume -jobid=<jobid> [-host=<host>] [-port=<port>] |
This command resumes start of a previously suspended
batch job. Use -jobid=<jobid> as the job ID assigned to the job by the long-running scheduler. The job ID is returned by the lrcmd -cmd=submit command that initially submitted the job. The -cmd=status command can also be used to identify the job ID for a particular job. |
See description of -cmd=suspend. |
Display the output for a job. | -cmd=output -jobid=<jobid> [-host=<host>] [-port=<port>] |
Displays the output generated by the long-running scheduler and execution environment during the execution
of the specified job. Use -jobid=<jobid> as the ID assigned to the job by the long-running scheduler. The job ID is returned by the lrcmd -cmd=submit command that initially submitted the job. The -cmd=status command can also be used to identify the job ID for a particular job. |
(none) |
Displays the return code of a batch job. | -cmd=getBatchJobRC -jobid=<jobid> [-host=<host>] [-port=<port>] |
Displays the overall return code produced by
a grid batch job. Use -jobid=<jobid> as the ID assigned
to the job by the long-running scheduler.
The job ID is returned by the lrcmd -cmd=submit command that
initially submitted the job. The -cmd=status command can also
be used to identify the job ID for a particular job.
|
(none) |
Submit a recurring job request to the long-running scheduler . | -cmd=submitRecurringRequest -xJCL=<XML file name> -request=<name of request> -startDate=<date where first job gets submitted> -startTime=<time where job gets submission> -interval=<time period between job submissions> [-host=<host>] [-port=<port>]or -cmd=submitRecurringRequestjo b=<job_name> -request=<name of request> -startDate=<date where first job gets submitted> -startTime=<time where job gets submission> -interval=<time period between job submissions> [-host=<host>] [-port=<port>] |
Submits a recurring job request to the job scheduler.
The job scheduler submits a long-running job against
the specified xJCL at time intervals indicated by the arguments.
Optional arguments:
|
Examples:
|
Modify an existing recurring job request. | lrcmd -cmd=modifyRecurringRequest -request=<name of request> -xJCL=<XML file name> -interval=<time period between job submissions> -startDate=<date where first job gets submitted> -startTime=<time where job gets submission> |
Arguments:
Optional arguments:
|
Examples: lrcmd -cmd=modifyRecurringRequest -request=MyWeeklyReport -xJCL=C:\\myNewXJCL -port=80 lrcmd -cmd=modifyRecurringRequest -request=MyWeeklyReport -startDate=2006-02-02 -startTime=22:30:00 -xJCL=C:\\myFebXJCL -port=80 |
Cancel an existing recurring job request. | Arguments:
|
Example: lrcmd-cmd=cancelRecurringRequest -request=MyWeeklyReport -port=80 | |
Show details of an existing recurring job request. | lrcmd -cmd=getRecurringRequestDetails -request=<name of request> |
Use <name of request> as the unique name of the request used to identify this recurring job submission request. Optional arguments:
|
Example: lrcmd -cmd=getRecurringRequestDetails -request=MyWeeklyReport-port=80 |
List all existing recurring job requests. | lrcmd -cmd=showAllRecurringRequests |
none | Example: lrcmd -cmd=showAllRecurringRequests -port=80 |
Show all recurring jobs of a request. | lrcmd -cmd=showRecurringJobs -request=<name of request> |
Use <name of request> as
the unique name of the request used to identify this recurring job
submission request. Optional arguments:
|
Examples: lrcmd -cmd=showRecurringJobs -request=MyWeeklyReport -port=81lrcmd -cmd=status -jobid=<job identifier>-port=80 -host=myodrhost.comlrcmd -cmd=status -port=80-host=myodrhost.com |
Example of retrieving output of a batch job:
lrcmd -cmd=output -jobid=mybatchjob:63 -host=myLRSHost -port=9081
CWLRB4940I: com.ibm.websphere.batch.wsbatch : -cmd=output -jobid=mybatchjob:63 CWLRB5000I: Wed Jun 15 17:55:36 EDT 2005 : com.ibm.websphere.batch.wsbatch : response to output CWLRB1740I: [Wed Jun 15 17:55:36 EDT 2005] Job [mybatchjob:63] is in job setup. CWLRB1760I: [Wed Jun 15 17:55:37 EDT 2005] Job [mybatchjob:63] is submitted for execution. CWLRB2420I: [Wed Jun 15 17:55:37 EDT 2005] Job [mybatchjob:63] Step [Step1] is in step setup. CWLRB2440I: [Wed Jun 15 17:55:38 EDT 2005] Job [mybatchjob:63] Step [Step1] is dispatched. CWLRB2460I: [Wed Jun 15 17:55:38 EDT 2005] Job [mybatchjob:63] Step [Step1] is in step breakdown. CWLRB2600I: [Wed Jun 15 17:55:38 EDT 2005] Job [mybatchjob:63] Step [Step1] completed normally rc=0. CWLRB2420I: [Wed Jun 15 17:55:39 EDT 2005] Job [mybatchjob:63] Step [Step2] is in step setup. CWLRB2440I: [Wed Jun 15 17:55:39 EDT 2005] Job [mybatchjob:63] Step [Step2] is dispatched. CWLRB2460I: [Wed Jun 15 17:55:40 EDT 2005] Job [mybatchjob:63] Step [Step2] is in step breakdown. CWLRB2600I: [Wed Jun 15 17:55:40 EDT 2005] Job [mybatchjob:63] Step [Step2] completed normally rc=4. End