jcachange
- Organization of this page
Function
This command reloads the automated action definition file, places the automated action function on standby, or, enables or disables the automated action definition.
If both options are omitted, the command reloads the automated action definition file. After you have changed the contents of the automated action definition file, you use this command to activate the modified action definitions by reloading the file.
This command skips invalid action definitions in the automated action definition file, and continues processing.
If the automated action definition file contains an invalid action definition, the command displays the KAVB5104-W message. If you want to reload the automated action definition file you edited, before executing the jcachange command, execute the jcamakea command to make sure that there are no errors in the automated action definition file.
If the KAVB5104-W message is displayed, review the contents of the automated action definition file.
If the loaded automated action definition file contains no valid action definitions, the command displays the KAVB4053-I message and places the automated action function on standby.
When this command is executed with no option specified, the suppression time and the status of satisfied AND-joined conditions are initialized for all action execution conditions. When this command is executed with the -e, -on, -off, or -st option specified, the suppression time and the status of satisfied AND-joined conditions are not initialized unless the definition of the action execution condition is changed.
A reloaded automated action definition parameter that exceeds the maximum size is ignored by the command. For details about the size of an automated action definition parameter, see Automated action definition file (actdef.conf) in Chapter 2. Definition Files.
Format
jcachange [-n] [-h logical-host-name] [-e [action-ID[,action-ID...] | ALL]] [-on action-ID[,action-ID...]] [-off action-ID[,action-ID...]] [-st]
Execution permission
In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)
In UNIX: Superuser permissions
Storage directory
- In Windows:
-
Console-path\bin\
- In UNIX:
-
/opt/jp1cons/bin/
Arguments
- -n
-
Specifies that the automated action function is to be placed on standby. No actions are executed even if an event that matches an action definition is received.
To restart the automated action function, either execute the jcachange command with no options specified or restart JP1/IM - Manager.
- -h logical-host-name
-
When you are operating in a cluster system, this option specifies the logical host name. The command reloads or places on standby the action definitions for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.
- -e [action-ID[,action-ID...] | ALL]
-
Specifies the action ID of an action definition to enable. Other action definitions whose IDs are not specified in this option are disabled. To specify multiple IDs, separate them with a comma (,). To enable all actions, specify ALL.
Executing the command with this option changes every valid parameter in the action definition file. When the action ID is specified, the corresponding valid parameter is changed to true. When the action ID is not specified, it is changed to false. When ALL is specified, all valid parameters are changed to true.
This option is available only when DESC_VERSION of the action definition file is 4.
When the action definition of a specified action ID is not found in the action definition file, the KAVB4028-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 10. When no action execution condition is defined in the action definition file and ALL is specified for this option, the KAVB4029-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 10. When no action execution condition is defined in the action definition file and no action ID is specified for this option, the KAVB4029-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 11.
- -on action-ID[,action-ID...]
-
Specifies the action ID of an action definition to enable. To specify multiple IDs, separate them with a comma (,). The status of other action definitions whose IDs are not specified remains the same. This option cannot be combined with the -e option.
Executing the command with this option changes the valid parameters of the specified action IDs in the action definition file to true.
This option is available only when DESC_VERSION of the action definition file is 4.
When the action definition of a specified action ID is not found in the action definition file, the KAVB4028-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 10.
- -off action-ID[,action-ID...]
-
Specifies the action ID of an action definition to disable. To specify multiple IDs, separate them with a comma (,). The status of other action definitions whose IDs are not specified remains the same. This option cannot be combined with the -e option.
Executing the command with this option changes the valid parameters of the specified action IDs in the action definition file to false.
This option is available only when DESC_VERSION of the action definition file is 4.
When the action definition of a specified action ID is not found in the action definition file, the KAVB4028-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 11.
- -st
-
Specifies that executing the command will not initialize the suppression status and the status of satisfied conditions of the AND-joined conditions when the following is true for the action execution condition:
-
There is no difference between the definition of the action execution condition that works in the Event Base Service and the definition that is specified in the action definition file.
This option is available only when DESC_VERSION of the action definition file is 4. Only the -h option can be combined with this option.
-
Return values
0 |
Normal termination |
4 |
There was no response from the automated action function |
5 |
Command failed to reload the automated action definition file or place the automated action function on standby |
10 |
There is no action definition that is to be enabled |
11 |
There is no action definition that is to be disabled |
12 |
Failed to update due to failure to acquire exclusive rights for the automated action definition file |
13 |
Failed to read due to failure to acquire exclusive rights for the automated action definition file |
111 |
Failed to connect to the Event Base Service or the Event Console Service (in UNIX) |
154 |
File input/output error (in UNIX) |
243 |
A specified argument value was invalid (in UNIX) |
-13 |
A specified argument value was invalid (in Windows) |
-102 |
File input/output error (in Windows) |
-401 |
Failed to connect to the Event Base Service or the Event Console Service (in Windows) |
Other value |
System error |