jcochcefmode
- Organization of this page
Function
This command changes the operating mode for the common exclusion-conditions of JP1/IM - Manager. Executing the command changes the common exclusion-conditions mode from normal to extended, and vice versa. If the mode is changed from extended to normal, common exclusion-conditions and additional common exclusion-conditions are not passed to the normal-mode common exclusion-conditions. To change the common exclusion-conditions mode to extended, the regular expressions of JP1/Base must be extended. For details about how to extend regular expressions of JP1/Base, see the JP1/Base User's Guide.
If you execute this command with the -m option specified, JP1/IM - Manager must not be running. If this command is executed without stopping JP1/IM - Manager, the command terminates with an error and a message is displayed.
In addition, multiple instances of this command cannot be executed concurrently.
Note that the operating mode of the common exclusion-conditions can be changed to extended when common exclusion-conditions have already been set.
The backup file of the extended definition file for the common exclusion-conditions is output as common_exclude_filter_backup.conf when either of the following applies:
-
The operating mode is changed from normal to extended, and there is a problem with the regular expressions.
-
The operating mode is changed from extended to normal.
The following shows the output destination of the backup file.
- In Windows:
-
- For a physical host:
-
Console-path\conf\console\filter\
- For a logical host:
-
shared-folder\jp1cons\conf\console\filter\
- In UNIX:
-
- For a physical host:
-
/etc/opt/jp1cons/conf/console/filter/
- For a logical host:
-
shared-directory/jp1cons/conf/console/filter/
If there are regular expressions that cannot be used in extended mode, an error is displayed, and extended-mode common exclusion-conditions are not set. Edit the output file, and then use the -ef option of the jcochfilter command to apply the changes to JP1/IM - Manager.
For details about the extended definition file for common exclusion-conditions, see Common-exclusion-conditions extended definition file in Chapter 2. Definition Files.
For details about the jcochfilter command, see jcochfilter in Chapter 1. Commands.
Format
jcochcefmode [-m {normal | extended}] [-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
- -m {normal | extended}
-
Specifies the operating mode of the common exclusion-conditions.
-
normal: Specify this value to set the operating mode of the common exclusion-conditions to normal mode. The default value is normal.
If the operating mode is changed back to normal from extended, the definition of normal-condition common exclusion-conditions becomes empty. The definition of the common exclusion-conditions used in extended mode is saved as a backup. In addition, all definitions of additional common exclusion-conditions are deleted. For details about backup files, see Function.
-
extended: Specify this value to set the operating mode of the common exclusion-conditions to extended mode. The definition for the common exclusion-conditions used in normal mode is passed to the definition of the extended-mode common exclusion-conditions. Note that if the operating mode of the common exclusion conditions is changed to extended mode, the regular expressions in JP1/Base must be extended, which will affect your ability to use those regular expressions in JP1/Base. For details about extended regular expressions in JP1/Base, see the JP1/Base User's Guide.
normal and extended are not case sensitive.
-
- -h logical-host-name
-
For operation in a cluster system, this option specifies the logical host name. The operating mode for the specified host is set in the common exclusion-conditions for JP1/IM - Manager. If this option is omitted, the logical host name specified for 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.
If JP1_DEFAULT or a non-existent logical host is set for the JP1_HOSTNAME environment variable, an error is displayed.
Notes
-
If the -m option is not specified, the operating mode in the common exclusion-conditions is displayed.
-
If either of the following conditions, or both, applies, extended mode cannot be used:
-
An event acquisition filter (for compatibility) is used
-
Extended regular expressions are not used in JP1/Base on the manager host
-
-
To change the operation mode of the common exclusion conditions on a logical host by using the -h option, a shared disk must be mounted.
-
If you are using a cluster system, you must copy the common definition information from the active server to the standby server.
For details about how to copy the information, see 7.7.2 Using commands to change settings (for Windows) or 8.7.2 Using commands to change settings (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.
-
The jcochcefmode command cannot be executed together with the jco_spmd_status command.
Return values
0 |
Normal termination |
1 |
Abnormal termination |
2 |
Argument error |
3 |
JP1/IM - Manager is running |
4 |
Prerequisite conditions for extended mode are not satisfied, or an event acquisition filter (for compatibility) is running |
5 |
Prerequisite conditions for extended mode are not satisfied or regular expressions in JP1/Base are not extended |
6 |
The same operating mode as the current mode is specified |
7 |
No execution permission for the jcochcefmode command assigned (Windows only) |
8 |
Backup of the extended definition file for common exclusion-conditions failed |
9 |
Invalid logical host specification |
10 |
Concurrent execution error |
255 |
Other error |
Example 1
- Change the operating mode to normal mode:
-
- Input value:
jcochcefmode -m normal
- Result:
KAVB1005-I The command (jcochcefmode) has started. KAVB0895-I The operation mode of the common exclusion conditions was changed to basic mode. KAVB1002-I The command (jcochcefmode) terminates normally.
Example 2
- Change the operating mode to extended mode:
-
- Input value:
jcochcefmode -m extended
- Result:
KAVB1005-I The command (jcochcefmode) has started. KAVB0896-I The operation mode of the common exclusion conditions was changed to extended mode. KAVB1002-I The command (jcochcefmode) terminates normally.
Example 3
- Check the operating mode for the common exclusion-conditions (in this example, the name of the physical or logical host is hostA, and the operating mode is extended):
-
- Input value:
jcochcefmode
- Result:
KAVB1005-I The command (jcochcefmode) has started. KAVB0894-I The operation mode of the common exclusion conditions will be displayed. (host name = host A) operation mode = extended mode KAVB1002-I The command (jcochcefmode) terminates normally.