jcoegschange
- Organization of this page
Function
This command changes correlation event generation definitions. You can execute this command while the status of the correlation event generation function is stopped, running, or standby, but not while the status is starting or stopping.
The following notes apply to execution of the jcoegschange command:
-
When you execute the jcoegschange command to change correlation event generation definitions, the new definitions take effect immediately. If there are JP1 events under correlation event generation processing when the new definitions take effect, all these events will fail.
-
If no conditions are defined in the correlation event generation definition file when the jcoegschange command is issued, the command executes processing with no correlation event generation conditions. This means that no correlation events are issued.
-
If the correlation event generation function is in running status and the correlation event generation definitions to be changed by the jcoegschange command contain an error, the definitions are not changed and processing continues.
-
If the correlation event generation function is not running, the only processing that occurs is that the correlation event generation definitions are set. Once you start the correlation event generation function, the correlation event generation definitions take effect.
-
The jcoegschange command cannot be executed together with the jcoegsstatus command in which the -d option is specified.
Format
jcoegschange [-h logical-host-name]
-f correlation-event-generation-definition-file-name
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
- -h logical-host-name
-
When you are operating in a cluster system, this option specifies the logical host name. 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.
- -f correlation-event-generation-definition-file-name
-
Specifies the relative or absolute path of the correlation event generation definition file.
Return values
|
0 |
Correlation event generation definitions were changed successfully |
|
1 |
Attempt to change correlation event generation definitions failed |
|
2 |
A timeout occurred during communication with the Event Generation Service (when the integrated monitoring database is not used) or with Event Base Service (when the integrated monitoring database is used) |
|
100 |
Execution permission error (Windows only) |
|
101 |
Argument error |
|
102 |
Communication error |
|
255 |
Other abnormal termination (system error) |
Example
- Change the correlation event generation definitions for the physical host hostP to the definitions specified in the correlation event generation definition file /tmp/teigi1.conf:
-
- Input value:
jcoegschange -f /tmp/teigi1.conf
- Result:
KAJV3201-I The correlation event generation definition file (/tmp/teigi1.conf) has been read, and the definitions for the correlation event generation function on (hostP) have been updated.
The same result is output even if no correlation event generation definitions are set for the correlation event generation function.