The managing server system obtains the execution status of the jobs specified in a parameter file. The status of a job can be determined from the return code.

Job status	Return code
All jobs terminated normally.	0
Some jobs terminated with an error.	30
Jobs are being executed.	31
Jobs are being executed, and some jobs have terminated with an error.	32
Jobs are being deleted, and some jobs are waiting for completion of the deletion process.	33

This command checks the number of hosts that are in the execution status by specifying the execution status of jobs on a managing server for JP1/Software Distribution Manager. The number of hosts in the specified execution status is equal to 10,000 minus the return code value.

dcmstat.exe [job-status] /i parameter-file-name [/LC {ON|OFF}]

• job-status
  Specify the execution status of a job to determine the number of hosts that are in a specific execution status. Use one or more items from the following arguments after the command name. The total number of hosts +10,000 that are in the specified job status is returned as a return code. This argument can be specified only on the management server at the local host. If this argument is specified for JP1/Software Distribution Client (relay system), operation fails with return code 3.
  

  Job status	Description
  TRANS_WAIT	The job is waiting for transmission in the managing server.
  TRANSMITTED	The job is either being transmitted to a client or being executed.
  REGISTERED	The ID group job is being transferred to the relay managing the ID group.
  CLT_NOTREADY	The job failed to be started.
  CLT_SERVICE_OFF#	The job failed to be started because JP1/Software Distribution is stopped.
  CLT_POWER_OFF#	The job failed to be started because the power for the PC is off.
  CLT_NETWORK_ERR#	Due to a network error and other reasons, the job failed to be started.
  SUSPENDED	A suspend specification was received at a relay system.
  INST_WAIT	The job is waiting for installation or collection.
  HOLD_EXEC	The job has been put on hold.
  REJECTED	The installation was rejected.
  ID_NOPKG	The ID group job deleted a relay-storage package.
  CANCEL	The job was cancelled by the client.
  CONNECT_ERROR	A communication error occurred.
  ERROR	A job execution error occurred.
  DELETING	The job is being deleted by the relay manager/system or client.

  #

  This can be specified when the Break down the reason for a starting failure check box was selected on the Server Customization page during JP1/Software Distribution Manager setup. This argument, however, is ignored if it is specified together with CLT_NOTREADY.

  If specified when the checkbox is off, these arguments are not counted as part of the total number of hosts.

  
  If a job execution status is not specified, the command checks the execution status of the jobs specified in the parameter file, and returns a return code (0-33) associated with the execution status.
  
• /i
  Specify the full path for the parameter file to be used.
  You can also use the output file from the dcmcoll command (without the /s specification), the dcminst command (without the /s specification), the dcmjexe command, or the dcmsusp command (without the /s specification) as a parameter file.
  
• /LC
  Specify ON or OFF to indicate whether the command's processing is to continue after logging off from Windows when Task Scheduler or JP1/AJS is used to execute commands in the background.
  
  • ON
    Continues command processing even after logging off from Windows.
    
  • OFF
    Forcibly terminates command processing once Windows is logged off.
    
  This argument is effective when the command is executed from a service under any of the following OSs:
  
  • Windows NT 4.0
  • Windows 2000
  • Windows XP
  • Windows Server 2003 (excluding Windows Server 2003 (IPF))
  Do not specify /LC ON when you execute the command from the command prompt, because in this case the command is executed as a foreground program.
  You can use a registry setting to specify whether command processing is to continue after Windows is logged off. For details about the registry setting, see the following sections:
  
  • Executing the command in JP1/Software Distribution Manager
    4.6 Registry settings (JP1/Software Distribution Manager) in the manual Setup Guide
    
  • Executing the command in JP1/Software Distribution Client (relay system)
    5.4 Registry settings (JP1/Software Distribution Client (relay system)) in the manual Setup Guide
    
  Note that operation may differ depending on the combination of the /LC specification and the registry setting. For details, see 4.28 Command operation at logoff that depends on a registry setting and logoff option.
  

The table below shows the contents of the parameter file for the dcmstat command. The contents of the parameter file used in this command cannot be specified by using a command argument.

Table 4-19 Contents of the parameter file (dcmstat command)

Parameter file specification contents		Description	Specification	Command argument
Tag	Parameter
JOB_ATTRIBUTE	job_generator	Job name	X	--
	jobno	Job number	R	--
	job_folder	Job folder path	O#	--
	unsuspended	Whether a distribution being suspended exists	X	--

Legend:

R: required.

O: optional.

X: not required (ignored if specified).

--: Cannot be specified in a command argument.

#

By default, the dcmstat command displays the job status by searching all the folders or files that lie below the root folder.

The following explains the return codes that the dcmstat command may return:

Code	Meaning	Action
0	All jobs completed normally.	None.
1	Unable to open parameter file, or invalid file format.	Check the specification or coding format for the parameter file.
2	Invalid value specified in parameter file.	Check the parameter file value.
3	Error during connection to managing server, or an execution status was specified in either a basic database environment or JP1/Software Distribution Client (relay system).	Check the version of the managing server. When specifying an execution status, check to see if the managing server is JP1/Software Distribution Manager.
5	Communication failure between client and managing server system.	Check the communications settings in the setup for the managing server.
12	Other errors occurred.	Check the event log.
30	Errors in at least some jobs.	None.
31	Jobs being executed; no errors detected.	None.
32	Jobs being executed; errors detected in some jobs.	None.
33	Jobs being deleted; some jobs waiting to complete deletion.	None.

If the job status is specified, the total number of hosts +10,000 that are in the specified job status is returned as a return code.

If JP1/Base is linked to manage JP1/Software Distribution users, see 1.3.3 Setting for executing commands.

• In the parameter file, specify the job number that was output to an output file by the dcmcoll (no /s specification), dcminst (no /s specification), dcmjexe, or dcmsusp (no /s specification) command.
• The dcmstat command cannot be issued if there is an unknown job number for the job for which the job status is to be determined. In this case, you should verify the job status of the job in the Job Status window of the managing server.

The following is an example of determining the job status of the invoice-file-0001-collection job that was executed using the dcmjexe command.

(a) Creating a parameter file

Specify the job number that was output to the output file by the dcmjexe command in the parameter file, as follows:

If the output file from the dcmjexe command has been saved, that file can be specified as a parameter file.

** dcmjexe output -> dcmstat input
 
JOB_ATTRIBUTE{
job_generator= invoice-file-0001-collection
jobno= JB03121113315383
job_folder= \batch-definition
}

(b) Command execution

If the output file from the execution of the dcmjexe command is saved in C:\Dmbat\out.txt, specify the command as follows:

dcmstat.exe /i C:\Dmbat\out.txt

The dcmstat command enables you to check the number of hosts that are in a specific status. For example, to determine the number of hosts that have failed to start and the number of hosts that have received a suspension instruction, you can specify the following:

dcmstat.exe CLT_NOTREADY SUSPENDED /i C:\Dmbat\out.txt