jcoegsstop
- Organization of this page
Function
This command changes the status of the correlation event generation function from running to standby. When the correlation event generation function is placed in standby status, it stops correlation event generation processing.
Use the jcoegsstop command when you want to stop correlation event generation processing without stopping the correlation event generation function. To restore the correlation event generation function to running status, either execute the jcoegsstart command or restart JP1/IM - Manager.
When the status is changed successfully by the jcoegsstop command, a JP1 event (00003F26) is issued. For details about the 00003F26 JP1 event, see 3.2.2 Details of JP1 events output by JP1/IM - Manager.
Format
jcoegsstop [-h logical-host-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.
Notes
-
If you execute this command during correlation event generation processing, all correlation events undergoing generation processing will result in failure.
-
A JP1 event that is issued while the correlation event generation function is in standby status is not subject to correlation event generation processing.
-
If the correlation event generation function is already in standby status when the jcoegsstop command is executed, the status remains unchanged.
Return values
0 |
Correlation event generation function was terminated successfully |
1 |
Termination of the correlation event generation function failed |
2 |
A timeout occurred during communication with the correlation event generation function |
100 |
No execution permissions (Windows only) Execution permissions are only granted to root (UNIX only) |
101 |
Argument error |
102 |
Communication error |
255 |
Other abnormal termination (system error) |
Example
- Terminate the correlation event generation function on the physical host hostP:
-
- Input value:
jcoegsstop
- Result:
KAJV3301-I The correlation event generation function for hostP has stopped.