This command connects to the managing server running on a local host, and suspends and resumes file transfer between a specified relay system and a system below it. This command also suspends and resumes file transfer between the connection-destination managing server and a system below it.

dcmsusp.exe [processing-key] [/s] /i parameter-file1
            [parameter-file2] [/o result-output-filename] [/LC {ON|OFF}]

• processing-key
  This key specifies the type of processing to be executed. Specify one of the following four processing keys after the command name. The default is NETM_SUSPEND.
  
  • NETM_SUSPEND
    This key, which executes a Suspend file transfer job, suspends the file transfer between a specified relay system and a system below it. Use a parameter file (or a command argument) to specify a job destination (the client function of the relay system).
    
  • NETM_RESUME
    This processing key, which executes a Resume file transfer job, resumes the file transfer between a specified relay system and a system below it. Use a parameter file (or a command argument) to specify a job destination (the client function of the relay system).
    
  • NETM_MANSUSP
    This processing key suspends the file transfer between the connection destination managing server and the system below it. If this processing key is specified, all arguments other than the processing key are ignored.
    
  • NETM_MANRESU
    This processing key resumes the file transfer between the connection destination managing server and the system below it. If this processing key is specified, all arguments other than the processing key are ignored.
    
• /s
  This argument saves a created job without executing it. If the processing key is either NETM_MANSUSP or NETM_MANRESU, this argument, if specified, is ignored.
  If a job registration date/time, execution date/time, or expiration date is specified, this argument also saves such schedule information.
  
• /i
  Specify one or two full paths for the parameter file to be used. Delimit two full paths with spaces. The command fails if three or more full paths are specified.
  
• /o
  Specify the full path for the result output file. This argument is required if the processing key is either NETM_SUSPEND or NETM_RESUME. If the processing key is NETM_MANSUSP or NETM_MANRESU, this argument, if specified, is ignored.
  If either NETM_SUSPEND or NETM_RESUME is specified, the following items are output to a specified result output file upon normal termination of the command; if a result output file already exists, it is overwritten:
  
  • Job name
  • Job number
  • Job storage folder path
  The output file created by a /s specification can be used as a parameter file for the dcmjexe command. The output file without a /s specification can be used as a parameter file for the dcmjbrm, dcmrtry, and dcmstat commands.
  
• /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 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 4.6 Registry settings (JP1/Software Distribution Manager) 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.
  

You can also use command arguments to specify the template used for exporting and output file format instead of specifying these parameters in a parameter file. The table below shows the correspondence between the contents of a parameter file and the command arguments.

Table 4-21 Correspondence between parameter file contents and arguments (dcmsusp command)

Parameter file specification contents		Description	Specification	Command argument
Tag	Parameter
JOB_ATTRIBUTE	job_generator	Job name	O#1	/j value
	jobno	Job number	X	--
	job_folder	Job folder path	O	/l value
	unsuspended	Whether a distribution being suspended exists	X	--
JOB_DESTINATION	group	Group	R#2	/g value
	host_name	Host name	R#2	/h value
	lower_clients	Whether there is any specified destination	X	--
JOB_DESTINATION_ID	destination_id	Destination ID	R#2	/X value
JOB_SCHEDULE	job_entry_date	Job registration date/time	O	/jst value
	job_execution_date	Job execution date/time	O	/jsx value
	job_expiration_date	Job expiration date	O	/jsp value

Legend:

R: required.

O: optional.

X: not required (ignored if specified).

--: Cannot be specified in a command argument.

#1

If you omit job_generator or /j, processing-key+job-execution-date-and-time is automatically set as the job name. If you execute multiple commands with the same processing key, job names may be duplicated and jobs may not be executed correctly. If you execute multiple commands with the same processing key, Hitachi recommends that you specify different job names using job_generator or /j.

#2

Either JOB_DESTINATION (/g and /h) or JOB_DESTINATION_ID (/X) must be specified, but the two cannot be specified together. For JOB_DESTINATION, you can specify either group or host_name (/g and /h), or you can specify both arguments together.

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

Code	Meaning	Action
0	The managing server started a job, or the suspended state of the managing server itself was changed.	None.
1	Unable to open parameter file, or invalid file format.	Check the parameter file specification or coding format.
2	Invalid value in command argument or parameter file.	Check the settings for the command argument or parameter file.
3	Error during connection to the managing server.	Check the version of the managing server.
4	Unable to open result output file.	Check the result output file specification.
5	Communication failure between client and managing server.	Check the communication environment settings for the setup for the managing server.
12	Other errors occurred.	Check the event log. Possible causes of error include a system error, invalid command argument syntax, or denied processing due to specification of a value not defined in connection-destination managing server.

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

Note the following items when specifying either host_name for the JOB_DESTINATION tag or the command argument /h:

• If either a host name or an IP address is specified in either host_name or /h in an environment where a host ID is used, the job is executed by assigning the specified host name or IP address to the host ID.
• If the node for the host name or IP address specified in host_name or /h does not exist in the system configuration, the job is executed using the specified destination name. In this case, because a destination node does not exist in the system configuration, when the job terminates normally, the remote installation manager cannot verify the suspension status of the destination node.
• If multiple host names or IP addresses specified in host_name or /h (nodes with the same name but different host IDs) exist in the system configuration, the job is executed for all applicable relay systems. When executing a job for some identically named nodes, register the destinations for which the job is to be executed as a host group, and execute the job with respect to the host group.

Note the following when you specify job_folder or the /l argument for the JOB_ATTRIBUTE tag:

• If you execute the command with specification of a job storage folder path for a folder that has not been defined in the Job Definition window, the specified folder is created. This job storage folder that is created is not deleted and remains after the command has executed. If you do not plan to use this folder, you should delete it after the job is completed.