Job Management Partner 1/Base User's Guide
Function
The jcocmddef command configures and references the command execution environment. Two types of arguments are provided: one type to be specified on the manager host (host on which JP1/IM - Manager is installed), and the other type to be specified only on the host that executes the command. For details on these arguments, see the following description.
Format
jcocmddef [ [-show] | [-default] [-rsptime response-monitoring-time] [-record number-of-records] [-group host-group-definition-file-name] [-loaduserprofile {ON|OFF}] [-queuenum number-of-commands-in-queue] [-execnum number-of-commans-to-be-executed-concurrently] [-open {ON|OFF}] [-flush {ON|OFF}] [-cmdevent {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}] [-actevent {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}] [-actresult {ON|OFF}] [-host logical-host-name] [-runevinterval interval-of-issuing-the-elapsed-time-notification-event] [-actlimit {ON [transferred-data-amount-(number-of-lines)] | OFF}] [-cmdlimit {ON [transferred-data-amount-(number-of-lines)] | OFF}] [-queuethreshold threshold-for-number-of-commands-in-queue] ]
Required execution permission
In Windows: Administrators (If User Account Control (UAC) for Windows is enabled, you must execute the command from the administrator console.)
In UNIX: Superuser
Command directory
- In Windows:
installation-folder\bin\
- In UNIX:
/opt/jp1base/bin/
Arguments
-show
This option enables you to display the current definitions. You can only specify this option when the other options are not specified. If you omit all of the options including this option, the current definitions are displayed, which is the same result as when only the -show option is specified.
-default
This option resets the values of the following options to their defaults: -rsptime, -record, -loaduserprofile, -queuenum, -execnum, -open, -flush, -cmdevent, -actevent, -actresult, -runevinterval, -actlimit, -cmdlimit, and -queuethreshold. The -default option takes precedence if you specify this option with any other options.
-rsptime response-monitoring-time
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
Specify the monitoring time for response from the executed command. The specifiable range is 0 to 600 (in seconds). When 0 is specified, no monitoring occurs. The default is 60 seconds.
If there is no response from the executed command within the specified response monitoring time, the KAVB2002-I message is output.
The value specified in this option is valid when JP1/Base is restarted.
-record number-of-records
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
Specify the number of records as an upper limit of command execution logs for commands that are executed in the Execute Command window of JP1/IM - View or by an automated action.
The specifiable range is 1 to 196,600. The default is 20,000 records.
The number of records to be used in one command execution is (number-of-command-output-rows + 3) records. One record is 6,520 bytes. You cannot change the record size.
If there are not enough records, the result of automated actions might not be displayed properly.
The changed number of records is valid when the command execution logs (ISAM) are deleted. When deleting the command execution logs (ISAM), note that you cannot restore the logs for the previously executed automated actions or the command executions. For details on the procedure for, and notes on, deleting the command execution logs (ISAM), see the section describing how to change the maximum number of records in the chapter Troubleshooting in the manual Job Management Partner 1/Integrated Management - Manager Administration Guide.
-group host-group-definition-file-name
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
Specify a host group definition file in which the command execution hosts have been defined. For details on the format of the definition file, see the manual Job Management Partner 1/Integrated Management - Manager Command and Definition file Reference.
If a host group has not been defined in the host group definition file, the host group will be deleted.
-loaduserprofile {ON|OFF}
This option is set on the host that executes the command.
Specify whether OS users' profiles are read by executing this command. If you specify ON, profiles are read. If you specify OFF, profiles are not read. The values ON and OFF are not case sensitive. The default is OFF.
The value specified in this option is valid when JP1/Base is restarted.
This option is for Windows.
-queuenum number-of-commands-in-queue
This option is set on the host that executes the command.
Specify the maximum number of commands that can reside in the queue on the host that executes the command, if the command is executed by using the automated action functionality. The specifiable range is 0 to 65,535. The default is 1,024. If you specify 0, you cannot execute multiple instances of a command at the same time on the target host.
If the number of automated actions in queue exceeds the value of number-of-commands-in-queue, the KAVB2058-E message appears.
The value specified in this option is valid when JP1/Base is restarted.
-execnum number-of-commans-to-be-executed-concurrently
This option is set on the host that executes the command.
Specify the maximum number of commands to be executed concurrently on the host that executes the command, if the command is executed by using the automated action functionality. The specifiable range is 1 to 48. The default is 1. You can specify a different value for each host on which the command is executed.
The value specified in this option is valid when JP1/Base is restarted.
This option is useful if the command execution takes a long time and you want a command further down the queue to be executed ahead of the command that takes a while to execute, or if a large number of automated actions occur and you want to speed up processing.
If you specify 2 or a larger number, multiple commands are executed at the same time, so the executed commands might not end in the same order as they started in. Therefore, if you need to operate the system considering the end order of automated actions, do not specify this option.
-open {ON|OFF}
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
Set whether an execution log is output leaving the command execution log files (ISAM) still being opened. If you specify ON, an execution log is output leaving the command execution log files still being opened. If you specify OFF, an execution log is output not leaving the command execution log files still being opened. The default is OFF. This option is valid only for the command execution log for automated actions, and it is invalid for command execution log for the Execute Command window of JP1/IM - View.
To enable the -open setting, you must restart JP1/Base.
-flush {ON|OFF}
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
Set whether command execution logs are written to the disks for each row. If this option is enabled, you can restart JP1/Base and reference the execution logs when an unexpected shutdown occurs. If you specify ON, the execution logs are written to the disks for each row. If you specify OFF, the system buffers the execution logs, instead of writing to the disks for each row. The default is OFF.
If -flush is enabled, automated action and command execution performance might deteriorate. This is because a disk write operation occurs for each row.
To enable the -flush setting, you must restart JP1/Base.
-cmdevent {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
If you want to issue an event (command execution-related event) before, during, or after a command is executed, you must specify the level of the event to be issued. You can specify any one of the event levels listed in the following table. The default is 0.
Table 13-1 Event levels (command execution-related)
Event Level Event ID Description 0 None Does not issue a command executed-related event. 1 00003FA0 Issues an event when command execution begins. 2 00003FA1 Issues an event when command execution ends. 3 00003FA0, 00003FA1 Issues an event when command execution begins and ends. 4 00003FA2 Issues an event when command execution ends abnormally. 5 00003FA0, 00003FA2 Issues an event when command execution begins and ends abnormally. 6 00003FA1, 00003FA2 Issues an event when command execution ends normally or ends abnormally. 7 00003FA0, 00003FA1, 00003FA2 Issues an event when command execution begins and ends normally, or when command execution ends abnormally. The value specified in this option is valid when JP1/Base is restarted.
-actevent {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
If you want to issue an event (action status notification-related event) when the status of an action changes, you must specify the level of the event to be issued. You can specify any one of the event levels listed in the following table. The default is 0.
Table 13-2 Event levels (automated action status notification-related)
Event level Event ID Description 0 None Do not issue an action status notification-related event. 1 000020E0, 000020E3 Issues an event when the status of an action changes to Sending, Queued, or Running. 2 000020E1, 000020E4 Issues an event when the status of an action changes to Finished, Canceled, or Forcibly terminated. 3 000020E0, 000020E1, 000020E3, 000020E4 Issues an event when the status of an action changes to Sending, Queued, Running, or Finished. 4 000020E2, 000020E5 Issues an event when the status of an action changes to Unexecutable or Failed. 5 000020E0, 000020E2, 000020E3, 000020E5 Issues an event when the status of an action changes to Sending, Queued, Running, Unexecutable, or Failed. 6 000020E1, 000020E2, 000020E4, 000020E5 Issues an event when the status of an action changes to Finished, Canceled, Forcibly terminated, Unexecutable, or Failed. 7 000020E0, 000020E1, 000020E2, 000020E3, 000020E4, 000020E5 Issues an event when the status of an action changes to Sending, Queued, Running, Finished, Canceled, Forcibly terminated, Unexecutable, or Failed. The value specified in this option is applied when JP1/IM - Manager restarts, or when the jco_spmd_reload command is used to reload the manager.
To issue an action status notification-related event, JP1/IM - Manager refers to the action information file. If the action information file becomes full and is overwritten, the manager cannot refer to the action information that was overwritten. This makes it impossible to issue an action status notification-related event. In such a case, a warning event (000020E6 or 000020E7) or an error event (000020E8) is issued.
-actresult {ON|OFF}
This option is set on a manager host (i.e. host on which JP1/IM - Manager is installed).
This option specifies whether results of commands executed by the automated action function are to be recorded in the command execution log. If you record execution results, specify ON. If you do not record them, specify OFF.
The values ON and OFF are not case sensitive. The default is ON. If you want detailed command execution results, you must specify ON.
If OFF is specified, performance of the JP1/Base controller improves. This is because output to the command execution log file (ISAM) is suppressed. However, because the return values from commands executed as automated actions are the only items of information that are not discarded, no detailed command execution result is output. (As a result, only the KAVB2401-I message is output to Message in the Action Log Details window of JP1/IM - View.)
The value specified in this option is valid when JP1/IM - Manager is restarted.
-host logical-host-name
Specify the logical host if you are using JP1/Base in a cluster system. If you omit this option, the host name set in the environment variable JP1_HOSTNAME is assumed. If the environment variable JP1_HOSTNAME is not set, the physical host name is assumed.
If this option is specified and a setting for an active or standby server is changed, make sure that the settings in each server match.
-runevinterval interval-of-issuing-the-elapsed-time-notification-event
This option is set on the host that executes the command.
This option specifies how often to issue an event that indicates a specified amount of time has elapsed since a command was started in the Execute Command window of JP1/IM - View, or since a command was started as an automated action. The specifiable range is 0 to 86,400. The default is 600 seconds (10 minutes).
An event with the event ID 00003FA3 (execution elapsed time notification event) is issued and the KAVB2402-W message appears after the specified amount of time has elapsed. If 0 is specified, no event is issued.
The value specified in this option is valid when JP1/Base is restarted.
-actlimit {ON [transferred-data-amount-(number-of-lines)] | OFF}
This option is set on the host that executes the command.
If the results of commands executed by the automated action function are transferred to the manager, you can use this option to specify whether to suppress the amount of result data transferred. You can also specify the maximum amount of result data that can be transferred when data transfer is suppressed. The specifiable range is 0 to 196,600. The default setting is ON (suppressed), and the default maximum amount is 1,000. If the JP1/Base version running on the command-executing host is 07-51 or earlier, or if the version has upgraded to 08-00 or later, the default setting for this option is OFF (unsuppressed).
To suppress the amount of command execution result data to be transferred, specify this option to ON, and specify the total number of lines as the maximum amount of data (assuming 256 bytes per line). 1,000 lines is the default.
If you do not want to suppress the amount of data to be transferred, specify the setting to be OFF.
If you do not want to output a large amount of result data for commands executed by the automated action function, or if you want to prevent an executed command from entering an infinite loop due to an invalid operation, we recommend using this setting. If you enable this setting, only a small amount of data is output.
If command execution results exceed the maximum value, the KAVB2070-W message is output.
To enable the -actlimit setting, you must restart JP1/Base.
-cmdlimit {ON [transferred-data-amount-(number-of-lines)] | OFF}
This option is set on the host that executes the command.
If the results of commands executed in the Execute Command window of JP1/IM - View are transferred to the manager, you can use this option to specify whether to suppress the amount of result data transferred. You can also specify the maximum amount of result data that can be transferred when data transfer is suppressed. The specifiable range is 0 to 196,600. The default setting is ON (suppressed), and the default maximum amount is 1,000. If the JP1/Base version running on the command-executing host is 07-51 or earlier, or if the version has been upgraded to 08-00 or later, the default setting for this option is OFF (unsuppressed).
To suppress the amount of command execution result data to be transferred, specify this option to ON, and specify the total number of lines as the maximum amount of data (assuming 256 bytes per line). 1,000 lines is the default.
If you do not want to suppress the amount of data to be transferred, specify the setting to be OFF.
If you do not want to output a large amount of result data for commands executed in the Execute Command window of JP1/IM - View, or if you want to prevent an executed command from entering an infinite loop due to an invalid operation, we recommend using this setting. If you enable this setting, only a small amount of data is output.
If command execution results exceed the maximum value, the KAVB2070-W message is output.
To enable the -cmdlimit setting, you must restart JP1/Base.
-queuethreshold threshold-for-number-of-commands-in-queue
This option is set on the host that executes the command.
If you want to monitor the number of queued commands on the command-executing host that are waiting to be executed by the automated action function, you can use this option to specify a threshold for the number of commands that can be prequeued. The specifiable range is 0 to 65,535. The default is 10.
When 0 is specified, a threshold is not monitored.
If a non-zero value is specified and that value is reached, a warning JP1 event is issued and the KAVB2071-W message is output. If the number of prequeued commands returns to 0, a recovery JP1 event is issued and the KAVB2072-I message is output.
Threshold monitoring allows you to detect the accumulation of actions in the JP1/Base queue. This helps you to prevent execution delays before they occur.
To enable the -queuethreshold setting, you must restart JP1/Base.
Output format
When a jcocmddef command is executed, all the parameters (including parameters that have been changed) are displayed. The output format is shown below.
Figure 13-1 jcocmddef command output format
Return values
0 Normal end -1 Abnormal end
All Rights Reserved. Copyright (C) 2009, Hitachi, Ltd.