Job Management Partner 1/Integrated Management - Manager Command and Definition File Reference
Function
This command displays the status of the correlation event generation function and the start options. By using the options, you can also display the correlation event generation definitions that are currently in use and the date and time at which correlation event generation definitions were applied.
Format
jcoegsstatus [-h logical-host-name]
[-d]
Execution permission
In Windows Server 2003: None
In Windows Server 2008: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)
In UNIX: None
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.
-d
Specifies that the following are to be displayed: the status of the correlation event generation function, start options, correlation event generation definitions that are currently in use, and the date and time at which the correlation event generation definitions were applied by the jcoegschange command.
The jcoegsstatus command with the -d option specified cannot be executed together with the jcoegschange command.
Output format
In Windows:
- When you execute the jcoegsstatus command, the status of the correlation event generation function is displayed in the following format:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function: status Start option : start-option
- When the -d option is specified, the status is displayed in the following format:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function: status Start option : start-option KAJV3281-I The correlation event generation definition for hostP will now be displayed. File name : absolute-path-of-file Reflection time : YYYY/MM/dd hh:mm:ss VERSION=0002 # comment [generation-condition-name] TARGET=filtering-condition-for-the-correlation-target-range CON=event-condition SAME_ATTRIBUTE=duplicate-attribute-value-condition CORRELATION_NUM=maximum-correlation-number TIMEOUT=timeout-period TYPE=event-correlation-type SUCCESS_EVENT=correlation-event-informationIn UNIX:
- When you execute the jcoegsstatus command, the status of the correlation event generation function is displayed in the following format:
KAJV3261-I The status of the correlation event generation service for host-name will now be displayed. Correlation event generation function : status Start option : start-option
- When the -d option is specified, the status is displayed in the following format:
KAJV3261-I The status of the correlation event generation service for host-name will now be displayed. Correlation event generation function : status Start option : start-option KAJV3281-I The correlation event generation definition for host-name will now be displayed. File name : absolute-path-of-file Reflection time : YYYY/MM/dd hh:mm:ss VERSION=0002 # comment [generation-condition-name] TARGET=filtering-condition-for-the-correlation-target-range CON=event-condition SAME_ATTRIBUTE=duplicate-attribute-value-condition CORRELATION_NUM=maximum-correlation-number TIMEOUT=timeout-period TYPE=event-correlation-type SUCCESS_EVENT=correlation-event-informationThe following table lists and describes the character strings that are displayed as status.
Table 1-12 Character strings displayed as status
Operating status Character string displayed as status Description Starting STARTING The correlation event generation function is executing startup processing. Running RUNNING The correlation event generation function is running and is ready to perform correlation event generation processing.
This status occurs in the following cases:
- The correlation event generation function has started.
- The jcoegsstart command is executed while the correlation event generation function is in standby status.
Standby STANDBY The correlation event generation function is running, but correlation event generation processing has stopped.
Correlation event generation processing is not performed on a JP1 event that is issued while the function is in standby status.
Even when the function status changes from standby to running, the correlation event generation processing is not performed on a JP1 event that was issued while the function was in standby status.
- Remarks:
- A correlation event that was being generated before the function was placed in standby status results in a failure after the function is placed in standby status.
Stopping STOPPING The correlation event generation function is engaged in termination processing. Stopped STOP The correlation event generation function has stopped. The following table lists and describes the character strings that are displayed as start-option.
Table 1-13 Character strings displayed as start-option
Start option Character string displayed as start-option Description Cold start cold Do not inherit the information that was under correlation event generation processing when the function went into stop status during the previous session. Warm start warm Inherit the information that was under correlation event generation processing when the function went into stop status during the previous session. For details about the format of a correlation event generation definition file, see Correlation event generation definition file in 2. Definition Files.
Return values
0 Status was displayed successfully 1 Status display failed 2 A timeout occurred during communication with the correlation event generation function 100 No permission to execute the command (Windows Server 2008 only) 101 Argument error 102 Communication error 255 Other abnormal termination (system error)
Example 1
- Display the status of the correlation event generation function on the physical host hostP (status: running; start option: cold):
- Input value:
jcoegsstatus
- Result:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function : RUNNING Start option : cold
Example 2
- Display the status of the correlation event generation function on the physical host hostP and the correlation event generation definitions (status: running; start option: cold):
- Input value:
jcoegsstatus -d
- Result:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function : RUNNING Start option : cold KAJV3281-I The correlation event generation definition for hostP will now be displayed. File name : /tmp/teigi1.conf Reflection time : 2005/11/05 20:35:30 VERSION=2 [CONDITION] TARGET=B.SOURCESERVER==host1;host2;host3 CON=CID:1, B.ID==100, E.SEVERITY==Emergency;Critical;Alert;Error SAME_ATTRIBUTE=B.SOURCESERVER CORRELATION_NUM=20 SUCCESS_EVENT=B.ID:A00, E.SEVERITY:Emergency, B.MESSAGE:$EV1_B.MESSAGE
Example 3
Display the status of the correlation event generation function on the physical host hostP and the correlation event generation definitions (status: standby; start option: warm):
- The following condition applies:
- When JP1/IM - Manager is newly installed
KAJV3283-I is displayed because the correlation event generation definition file has not been set.
- Input value:
jcoegsstatus -d
- Result:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function : STANDBY Start option : warm KAJV3283-I The correlation event generation definition for hostP has not been defined.
Example 4
- Display the status of the correlation event generation function on the physical host hostP and the correlation event generation definitions (status: stopped (process down); start option: cold):
- Input value:
jcoegsstatus -d
- Result:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function : STOP Start option : cold KAJV3281-I The correlation event generation definition for hostP will now be displayed. File name : /tmp/teigi1.conf Reflection time : 2005/11/05 20:35:30 VERSION=2 [CONDITION] TARGET=B.SOURCESERVER==host1;host2;host3 CON=CID:1, B.ID==100, E.SEVERITY==Emergency;Critical;Alert;Error SAME_ATTRIBUTE=B.SOURCESERVER CORRELATION_NUM=20 SUCCESS_EVENT=B.ID:A00, E.SEVERITY:Emergency, B.MESSAGE:$EV1_B.MESSAGE
Example 5
- Load an invalid correlation event generation definition file while the correlation event generation function is running:
- Input value:
jcoegsstatus -d
- Result:
KAJV3261-I The status of the correlation event generation service for hostP will now be displayed. Correlation event generation function : RUNNING Start option : cold KAJV3281-I The correlation event generation definition for hostP will now be displayed. File name : /tmp/teigi1.conf Reflection time : 2005/11/05 20:35:30 KAJV3285-I Operations will continue while ignoring an invalid correlation event generation definition of hostP. [CONDITION] CON=CID:1, B.ID==ZZZ ...#Message ID is invalid SUCCESS_EVENT=B.ID:A00, E.SEVERITY:Emergency, B.MESSAGE:$EV1_B.MESSAGE
All Rights Reserved. Copyright (C) 2009, Hitachi, Ltd.