Job Management Partner 1/Software Distribution Administrator's Guide Volume 2

[Contents][Glossary][Index][Back][Next]

4.10 dcminst.exe (creating and executing a job)

This section explains the dcminst command, which creates and executes jobs. You can execute this command on the managing server of JP1/Software Distribution Manager and JP1/Software Distribution Client (relay system).

Jobs executed with this command can be verified in the Job Status window of the managing server system.

Organization of this section
(1) Function
(2) Format
(3) Arguments
(4) Parameters in a parameter file and corresponding command arguments
(5) Format of the command without using a parameter file
(6) Return codes
(7) Notes
(8) Example

(1) Function

This command creates and executes the following types of jobs that are related to remote installation:

JP1/Software Distribution Client (relay system) can create and execute only Install package and Send package, allow client to choose jobs.

JP1/Software Distribution Client (relay system) can only execute jobs that are one level below itself.

(2) Format

dcminst.exe [processing-key] [/f] [/s]
             /i parameter-file1 [parameter-file2]
             /o result-output-file-name
            [/LC {ON|OFF}]

(3) Arguments

(4) Parameters in a parameter file and corresponding command arguments

You can also use command arguments to specify the contents of the parameter file used in this command. The table below shows the correspondence between the contents of a parameter file and the command arguments.

Table 4-11 Correspondence between parameter file contents and arguments (dcminst command)

Parameter file specification contents Description Specification Command argument
Tag Parameter
JOB_DESTINATION group Host group name R#1 /g value
directory_com Directory information (computer hierarchy) R#1, #2 /dc value
directory_group Directory information (group hierarchy) O#1, #2 /dg value
directory_ou Directory information (organizational unit (OU) hierarchy) O#1, #2 /do value
host_name Host name R#1 /h value
lower_clients Whether to specify all lower clients O#1, #3 --
JOB_DESTINATION_ID destination_id ID name R#1 /X value
PACKAGING_INFORMATION#4 package_name Package name R /p value
package_id Package ID R /I value
version_revision Version/revision R /v value
generation Generation R /G value
cabinet_name Cabinet name R /c value
cabinet_id Cabinet ID R /C value
package_code Code type O /KW or /KP
JOB_ATTRIBUTE job_generator Job name O#5 /j value
jobno Job number X --
job_folder Job folder path O /l value
unsuspended Distribution during suspension yes/no O#6 /uns value
JOB_SCHEDULE job_entry_date Job registration date and time O /jst value
job_execution_date Job execution date and time O /jsx value
job_expiration_date Job execution time limit O /jsp value
JOB_SPLIT_DELIVERY#6 split_size Split size O /sds value
wait_time Transfer interval O /sdt value
JOB_CLIENT_CONTROL client_wake_up Whether to activate the client O /WWU
client_shutdown Whether to shut down the client O /WUS

Legend:
R: required.
O: optional.
X: not required (ignored if specified).
--: Cannot be specified in a command argument.

#1
JOB_DESTINATION and JOB_DESTINATION_ID are mutually exclusive. The parameters /g, /h, /dc, /dg, and /do cannot be specified together with /X. Always specify one or the other.
If the processing key is either NETM_STORE or NETM_DELETE, an ID cannot be specified.

#2
You cannot specify group or host_name (/g or /h) together with directory_com or directory_ou (/dc or /do). However, you can specify group and host_name (/g and /h) together. You can also specify any combination of directory_com, directory_group, and directory_ou (/dc, /dg, and /do).
Even if you specify lower_clients together with directory_com, directory_group, or directory_ou (/dc, /dg, or /do), all destination specifications are ignored.

#3
Cannot be specified in JP1/Software Distribution Client (relay system).

#4
In this command, a reserved word cannot be specified as a parameter for the tag PACKAGING_INFORMATION.

#5
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.

#6
unsuspended of JOB_ATTRIBUTE and JOB_SPLIT_DELIVERY are mutually exclusive.

(5) Format of the command without using a parameter file

The following shows the format of the command when you specify the command by using arguments only instead of using a parameter file:

dcminst.exe [processing-key] [/f] [/s]
               {[/g host-group] [/h host-name] |
               [/dc computer-hierarchy] [/dg group-hierarchy]
               [/do OU-hierarchy] | /X ID}
               /p package-name /I package-ID
               /v version/revision /G generation
               /c cabinet-name /C cabinet-ID
              [{/KW| /KP}]
              [/j job-name] [ /l job-folder-path]
              [/uns unsuspended]
              [/jst job-registration-date-and-time]
              [/jsx job-execution-date-and-time]
              [/jsp job-execution-time-limit]
              [/sds split-size] [/sdt transfer-interval]
              [/WWU client-wakeup]
              [/WUS client-shutdown]
               /o result-output-file-name
              [/LC {ON|OFF}]

(6) Return codes

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

Code Meaning Action
0 Managing server has started job. None.
1 Unable to open parameter file. 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 managing server. Check the version of the managing server.
4 Unable to open output file. Check the specification for the output file.
5 Communication failure between client and managing server. Check the communications settings in the setup for the managing server.
12 Other errors occurred. Check the event log.

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

(7) Notes

(8) Example

The following is an example of distributing software packaged under the name Finance Data 2003 5 to hosts dmp491 and dmp492, on which JP1/Software Distribution Client (client) is running.

(a) Creating a parameter file

Code the attributes of the host and the package in a parameter file as follows, and save the parameter file under any name:

** dcminst Parameter File Sample
 
JOB_DESTINATION{
host_name=dmp491;dmp492
}
PACKAGING_INFORMATION
{
package_name=Finance Data 2003 5
package_id=FD200305
version_revision=000001
generation=0000
cabinet_name=FCAB01
cabinet_id=F1
package_code=P
}
(b) Command execution

When saving the parameter file that has been created in a file named C:\Dmbat\dcminst.txt and acquiring an output file in C:\Dmbat\out.txt, code the following specification:

dcminst.exe /i C:\Dmbat\dcminst.txt /o C:\Dmbat\out.txt /j overwrite-installation /f
(c) Checking the output file

Upon normal completion of the command, the job name, job number, and job storage folder path are output to the C:\Dmbat\out.txt file as follows:

JOB_ATTRIBUTE{
job_generator= NETM_INSTALL_2003_12_11_13_34_36
jobno= JB03121113315383
job_folder= \
}

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
Copyright, patent, trademark, and other intellectual property rights related to the "TMEng.dll" file are owned exclusively by Trend Micro Incorporated.