14.17 dcmsusp.exe (suspending and resuming file transfer)
This section describes the dcmsusp command, which suspends or resumes file transfer.
Function
This command connects to the managing server on the local host, and suspends or resumes file transfers between a specified relay system or management relay server and the systems directly under them. This command suspends or resumes also the file transfer between the connected managing server and the lower systems directly connected to the relay system.
Format
dcmsusp.exe [processing-key] [/s] /i parameter-file-1 [parameter-file-2]
[/o output-file-name]Arguments
-
processing-key
This argument specifies the type of processing to be executed. Specify one of the processing keys listed below immediately after the command name. When this argument is omitted, specification of NETM_SUSPEND is assumed.
-
NETM_SUSPEND
When the processing key is NETM_SUSPEND, this command executes a Suspend file transfer job to suspend file transfers between a specified relay system or management relay server and the systems directly under them. In a parameter file (or command argument), specify the job destination (an agent that is under a relay system or management relay server and has the same name as the relay system or management relay server).
-
NETM_RESUME
When the processing key is NETM_RESUME, this command executes a Resume file transfer job to resume file transfers between a specified relay system or management relay server and the systems directly under them. In a parameter file (or command argument), specify the job destination (an agent that is under a relay system or management relay server and has the same name as the relay system or management relay server).
-
NETM_MANSUSP
When the processing key is NETM_MANSUSP, this command suspends the file transfer between the connected managing server and the lower systems directly connected to the managing server. When this processing key is specified, all the arguments other than the processing key are ignored.
-
NETM_MANRESU
When the processing key is NETM_MANRESU, this command resumes the file transfer between the connected managing server and the lower systems directly connected to the managing server. When this processing key is specified, all the arguments other than the processing key are ignored.
-
-
/s
When the argument /s is specified, this command creates a job, and then stores it without execution. When the processing key is NETM_MANSUSP, or NETM_MANRESU, this argument is ignored even if specified.
When the parameters for job registration date and time, job execution date and time, and job expiration date are specified, this command stores also the specified schedule information.
-
/i
In the argument /i, specify one or two full path names of the parameter files to be used. When specifying two full path names, separate them by a space. Specifying three or more full path names causes this command to fail.
-
/o
In the argument /o, specify the full path name of the output file. Always specify this argument when the processing key is NETM_SUSPEND or NETM_RESUME. When the processing key is NETM_MANSUSP or NETM_MANRESU, this argument is ignored even if specified.
When this command ends normally with NETM_SUSPEND or NETM_RESUME specified as the processing key, the items listed below are output to the specified output file. If the output file already contains data, the data is overwritten.
-
Job name
-
Job number
-
Path name of job storage folder
When the argument /s is specified, the output file can be used as a parameter file for the dcmjexe command. When the argument /s is not specified, the output file can be used as a parameter file for the dcmjbrm, dcmrtry, and dcmstat commands.
-
Correspondence between the specification contents of parameter file and command arguments
The contents of the parameter file available for this command can also be specified in command arguments. The following table shows the specification contents of the parameter file, and their corresponding command arguments.
|
Specification content of parameter file |
Content |
Whether to specify |
Command argument |
|
|---|---|---|---|---|
|
Tag |
Parameter |
|||
|
job_generator |
Job name |
Y/N#1 |
/j value |
|
|
jobno |
Job number |
N |
-- |
|
|
job_folder |
Path name of job storage folder |
Y/N |
/l value |
|
|
unsuspended |
Whether to distribute during suspension |
N |
-- |
|
|
group |
Host group name |
Y#2 |
/g value |
|
|
host_name |
Host name |
Y#2 |
/h value |
|
|
destination_id |
ID name |
Y#2 |
/X value |
|
|
job_entry_date |
Job registration date and time |
Y/N |
/jst value |
|
|
job_execution_date |
Job execution date and time |
Y/N |
/jsx value |
|
|
job_expiration_date |
Job expiration date |
Y/N |
/jsp value |
|
- Legend:
-
Y: The parameter must be specified.
Y/N: The parameter can be omitted.
N: The parameter is not necessary (is ignored even when specified).
--: The content cannot be specified by using a command argument.
- #1
-
When the job_generator parameter (or the argument /j) is omitted, "processing key and job execution date and time" is automatically set as the job name. Therefore, if multiple commands with the same processing key are executed concurrently, their job names might be duplicated, and their jobs might not be executed correctly. We recommend that, when executing multiple commands with the same processing key concurrently, you specify different job names for the commands by using job_generator (or /j).
- #2
-
You cannot specify the JOB_DESTINATION tag together with the JOB_DESTINATION_ID tag. Also, you cannot specify /g and /h together with /X. You must specify only either JOB_DESTINATION or JOB_DESTINATION_ID, or either /g and /h or /X. You can specify either the group parameter (/g) or host_name parameter (/h), or both.
Return codes
The following table lists the return codes that are output when the dcmsusp command is executed:
|
Code |
Meaning |
Action to be taken |
|---|---|---|
|
0 |
The managing server started the job, or changed its own suspended status. |
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 is set in a command argument or the parameter file. |
Check the values specified in command arguments and the parameter file. |
|
3 |
Connection to the database failed. |
Check database settings in the setup of the managing server. |
|
4 |
The output file cannot be opened. |
Check the specification of the output file. |
|
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. Possible causes are a system error, a syntax error in a command argument, or rejection of processing because of specification (in the parameter file) of a value not defined in the connection-destination managing server. |
Notes
When you specify the host_name parameter under the JOB_DESTINATION tag or the argument /h, note the following:
-
When a host name or IP address is specified in the host_name parameter or argument /h, the job is executed while assigning the specified host name or IP address to a host ID.
-
Assume that the node having the host name or IP address specified in the host_name parameter or argument /h does not exist in the system configuration. Then, the job is executed by using the specified destination name. In such a case, even when the job ends normally, you cannot check the suspended status of the destination node by Remote Install Manager or other tool because the destination node does not exist in the system configuration.
-
Assume that multiple nodes having the same host name or IP address specified in the host_name parameter or argument /h exist in the system configuration (multiple nodes of the same name with different host IDs exist). Then, the job is executed on all the relay systems or management relay servers corresponding to these nodes. When you want to execute the job only for some of the nodes of the same name, register the destinations for which to execute the job as a host group, and execute the job for the host group.
Note the following point when you specify the job_folder parameter under the JOB_ATTRIBUTE tag or the argument /1.
-
When you execute the dcmcoll command specifying the path name of a folder not defined in the Job Definition window as the path name of job storage folder, the specified folder is created. The created job storage folder remains without being deleted even after command execution. If you do not use the created folder, delete it after the job is complete.
When you execute a command, do not specify the same destination more than once. It will execute the same jobs at a destination for multiple times.
-
Notes on execution of the command
If you pause the command by pressing of the (Ctrl + C, or else) keys during the execution, the job definitions that the command has created might not be deleted.
If you pause the command, check the job definition window on the remote install manager and delete job definitions if necessary.