13.15 dcmstat.exe (acquiring job execution status)
This section describes the dcmstat command, which acquires the execution results of jobs.
Function
This command acquires (on the managing server) the status of the jobs specified in a parameter file. Job status is indicated by the return code output by this command.
Job execution status |
Return code |
---|---|
All jobs have ended normally. |
0 |
Some jobs have resulted in an error. |
30 |
Jobs are being executed. |
31 |
Jobs are being executed, and some jobs have resulted in an error. |
32 |
Jobs are being deleted, and some jobs are waiting for the completion of deletion. |
33 |
On the managing server of JP1/IT Desktop Management 2 - Manager, specify job execution status in this command to check the number of hosts that are in the specified job execution status. The number of hosts in the specified execution status is obtained by subtracting 10,000 from the value of the return code.
Format
dcmstat.exe [job-execution-status] /i parameter-file-name [/LC {ON|OFF}]
Arguments
-
job-execution-status
In this argument, specify job execution status to check the number of hosts that are in the specified job execution status. Specify one or more values of job execution status among those listed below immediately after the command name. This command returns a return code of which the value is the sum of 10,000 and the total number of hosts in the specified job execution status.
The following table lists the specifiable values of job execution status:
Job execution status
Description
TRANS_WAIT
The job is waiting for transmission at the managing server.
TRANSMITTED
The job is being transmitted to managed computers or being executed.
REGISTERED
An ID group job is being transmitted to the relay managing the ID.
CLT_NOTREADY
Startup of the job failed.
CLT_SERVICE_OFF#
Startup of the job failed because the agent stopped.
CLT_POWER_OFF#
Startup of the job failed because the PC power was off.
CLT_NETWORK_ERR#
Startup of the job failed because of a network error or for other reasons.
SUSPENDED
A suspension instruction was issued.
INST_WAIT
The job is waiting for installation or collection.
HOLD_EXEC
The job was held.
ID_NOPKG
In an ID group job, the package stored at the relay system was deleted.
CONNECT_ERROR
A communication error occurred.
ERROR
A job execution error occurred.
DELETING
The job is being deleted at the relay system or managed computers.
When you do not specify any job execution status, this command checks the execution status of the job specified in the parameter file, and returns a return code (0 to 33) corresponding to the execution status.
-
/i
In the argument /i, specify the full path name of the parameter file to be used.
You can use also the output file output by the dcmcoll command (without /s specified), dcminst command (without /s specified), dcmjexe command, or dcmsusp command (without /s specified) as the parameter file.
-
/LC
In the argument /LC, write ON or OFF to specify whether to continue command processing even if you log off from Windows while executing this command as a background service by using the Task Scheduler or JP1/AJS.
-
ON
Continues command processing even when you log off from Windows.
-
OFF
Forcibly ends command processing when you log off from Windows.
This argument is effective when this command is executed from a service on the following OS:
-
Windows Server 2003
When you enter this command from the command prompt, this command is executed as a foreground program. Therefore, in such a case, do not specify /LC ON.
You can also use a registry to set whether to continue command processing even if you log off from Windows.
Note that the command operation differs depending on the combination of the specification of the argument /LC and the setting in the registry. For details, see 13.20 Command operation at logoff according to registry setting and logoff option.
-
Specification contents of parameter file
The table below shows the specification contents of the parameter file for the dcmstat command. The contents of the parameter file for this command cannot be specified by using command arguments.
Specification content of parameter file |
Content |
Whether to specify |
Command argument |
|
---|---|---|---|---|
Tag |
Parameter |
|||
job_generator |
Job name |
N |
-- |
|
jobno |
Job number |
Y |
-- |
|
job_folder |
Path name of job storage folder |
Y/N# |
-- |
|
unsuspended |
Whether to distribute during suspension |
N |
-- |
Return codes
The following table lists the return codes that are output when the dcmstat command is executed:
Code |
Meaning |
Action to be taken |
---|---|---|
0 |
All jobs have ended normally. |
None |
1 |
The parameter file cannot be opened, or the file format is incorrect. |
Check the specification of the parameter file or its description format. |
2 |
An invalid value was specified in the parameter file. |
Check the values specified in the parameter file. |
3 |
Connection to the database failed. |
Check database settings in the setup of the managing server. |
5 |
Connection to the JP1/IT Desktop Management 2 service failed. |
Check whether the service of JP1/IT Desktop Management 2 - Manager has started. |
12 |
Restoration of one or more archive files failed. |
Reference the event log. |
30 |
At least some jobs have resulted in an error. |
None |
31 |
Jobs are being executed, and no job error has been detected. |
None |
32 |
Jobs are being executed, and some jobs have resulted in an error. |
None |
33 |
Jobs are being deleted, and some jobs are waiting for the completion of deletion. |
None |
When you specify job execution status, this command returns a return code of which the value is the sum of 10,000 and the total number of hosts in the specified job execution status.
Notes
-
In the parameter file, specify the job number that was output to the output file by the dcmcoll command (without /s specified), dcminst command (without /s specified), dcmjexe command, or dcmsusp command (without /s specified).
-
If the job number of the job of which to acquire job status is unknown, you cannot execute the dcmstat command. In such cases, in the Job Status window of the managing server, check the status of the job that has the job name of the job of which to acquire job status.
Example
The following example shows use of this command to acquire the status of the Collect-slip-file-0001 job executed by the dcmjexe command.
- Creating the parameter file
-
Specify the job number output to the output file by the dcmjexe command in the parameter file as shown below.
If the output file output by the dcmjexe command has been stored, you can specify the stored file as the parameter file.
** dcmjexe output -> dcmstat input JOB_ATTRIBUTE{ job_generator= Collect-slip-file-0001 jobno= JB03121113315383 job_folder= \batch-definition }
- Executing the command
-
When the output file output by the dcmjexe command is stored as the file C:\Dmbat\out.txt, specify the command as follows:
dcmstat.exe /i C:\Dmbat\out.txt
You can use the dcmstat command to check the number of hosts that are in a specific status. For example, when you want to check the number of hosts that failed to start a job, or received a job suspension instruction, specify the command as follows:
dcmstat.exe CLT_NOTREADY SUSPENDED /i C:\Dmbat\out.txt