Manage admin jobs using scripting
Use wsadmin and the commands in the AdministrativeJobs command group to manage admin jobs in the flexible management environment.
Set a job manager, administrative agent, and register managed nodes with the job manager to set up a flexible management environment.
Use this topic to manage admin jobs that you submit to the job manager.
- Display the status of a job. Use the getOverallJobStatus command to display the overall job status for a specific job or a list of jobs of interest.
The following command example displays the job status for a specific job:
AdminTask.getOverallJobStatus(['-jobTokenList "[myJobToken]"]')
The following command example displays the overall job status for multiple jobs:
AdminTask.getOverallJobStatus('-jobTokenList "[myJobToken, myJobToken2, myJobToken3]"')The command returns job status information for the job or jobs of interest. The system displays the following information in the overall job status:
- The STATE attribute specifies the current state of the job.
- The TOTAL_RESULTS attribute specifies the total number of jobs.
- The DISTRIBUTED attribute specifies the number of distributed jobs.
- The ASYNC_IN_PROGRESS attribute specifies the number of asynchronous jobs in progress.
- The SUCCEEDED attribute specifies the number of successful jobs.
- The PARTIALLY_SUCCEEDED attribute specifies the number of partially successful jobs. Partial success can occur, for example, when a node represents multiple servers, and only some of the servers on the node complete successfully.
- The FAILED attribute specifies the number of failed jobs.
- The REJECTED attribute specifies the number of rejected jobs.
- The NOT_ATTEMPTED attribute specifies the number of jobs that the system has not attempted.
- Suspend a job. Use the suspendJob command to suspend a job on the job manager, as the following command demonstrates:
AdminTask.suspendJob('-jobToken myToken')- Resume a job. Use the resumeJob command to resume a suspended job, as the following command demonstrates:
AdminTask.resumeJob('-jobToken myToken')- Delete a job. Use the deleteJob command to delete an existing job from the job manager. If the job is running when you invoke the command, the system still returns the job results regardless of whether the job is deleted.
The following command example deletes a job from the job manager:
AdminTask.deleteJob('-jobToken myToken -deleteResults true')
Related tasks
Running admin jobs using scripting
Related
AdministrativeJobs
JobManagerNode
ManagedNodeGroup
ManagedNodeAgent