jcochfilter

Function

This command switches the event acquisition filter that is enabled in the correlation event generation function and Event Base Service of JP1/IM - Manager to the event acquisition filter indicated by a specified filter ID. In addition, the specified common exclusion-conditions can be enabled or disabled.

The command can display a list of the event acquisition filter's filter IDs, filter names, common exclusion-conditions group IDs, and common exclusion-conditions group names.

If JP1/IM - Manager is not running on the specified host, and an event acquisition filter (for compatibility) is used, this command cannot be used.

In addition, if the mode of the common exclusion-conditions is extended mode, the following operations can be performed:

• Enabling or disabling of the extended-mode common exclusion-conditions for each condition group

• Reading of the definition file for common exclusion-conditions and batch-application of the definitions for extended-mode common exclusion-conditions

• Reading of the definition file for the common exclusion-conditions and checking of the definitions for extended-mode common exclusion-conditions

• Enabling or disabling of the defined additional common exclusion-conditions group for each conditions group

To Page Top

Format 1

jcochfilter [-i filter-ID]
            [-e [common-exclusion-conditions-group-ID
            [,common-exclusion-conditions-group-ID...]|ALL]]
            [-on common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]]#
            [-off common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]]#
            [-ef name-of-extended-definition-file-for-common-exclusion-conditions]#
            [-h logical-host-name]

#: Can be specified only for extended-mode common exclusion-conditions.

To Page Top

Format 2

jcochfilter -check name-of-extended-definition-file-for-common-exclusion-conditions

To Page Top

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

To Page Top

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

To Page Top

Arguments

-i filter-ID

Specifies the filter ID of the event acquisition filter to be switched.

-e [common-exclusion-conditions-group-ID,common-exclusion-conditions-group-ID...]|ALL

Specifies the IDs of the common exclusion-conditions groups that you want to enable. The common exclusion-conditions whose group IDs are not specified will be disabled. If the common exclusion-conditions mode is extended mode, the ID of an additional common exclusion-conditions group can be specified. Separate multiple IDs with the comma. To enable all common exclusion-conditions, specify ALL.

You can specify the following values for common-exclusion-conditions-group-ID:

• Basic mode: 0 to 29

• Extended mode: 0 to 2,499

Note that if you specify nothing following -e, all common exclusion-conditions will be disabled. For the ID of an additional common exclusion-conditions group, specify a numeric value prefixed with A.

This option can be specified together only with the -i and -h options.

-on common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]

Specifies the ID of the extended-mode common exclusion-conditions you want to enable or the ID of additional common exclusion-conditions. This option can be set only when the common exclusion-conditions mode is extended mode. If you specify multiple extended-mode common exclusion-conditions IDs, separate them with a comma (,). You can specify the following values for common-exclusion-conditions-group-ID:

• Basic mode: 0 to 29

• Extended mode: 0 to 2,499

For the ID of an additional common exclusion-conditions group, specify a numeric value prefixed with A.

This option cannot be specified together with the -e, -ef, or -check option.

-off common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]

Specifies the ID of the extended-mode common exclusion-conditions that you want to disable or the ID of additional common exclusion-conditions. This option can be set only when the common exclusion-conditions mode is extended mode. If you specify multiple extended-mode common exclusion-conditions IDs, separate them with a comma (,). You can specify the following values for common-exclusion-conditions-group-ID:

• Basic mode: 0 to 29

• Extended mode: 0 to 2,499

For the ID of an additional common exclusion-conditions group, specify a numeric value prefixed with A.

This option cannot be specified together with the -e, -ef, or -check option.

-ef name-of-extended-definition-file-for-common-exclusion-conditions

Specifies the name of the definition file for common exclusion-conditions you want to apply to JP1/IM - Manager in relative or absolute path format. This option can be set only when the common exclusion-conditions mode is extended mode. By specifying this option, you can batch-apply to JP1/IM - Manager the definitions of the extended-mode common exclusion-conditions described in the extended definition file for common exclusion-conditions^#.

If an additional common exclusion-conditions group is set, all definitions are deleted. This option can be specified together only with the -h option.

#: The definition cannot be applied if the definition includes any environment-dependent character or other character that might cause character corruption.

-check name-of-extended-definition-file-for-common-exclusion-conditions

This option checks whether the definitions of the extended-mode common exclusion-conditions specified in the extended definition file for common exclusion-conditions are correct. This also checks whether the definitions include any environment-dependent character or other character that might cause character corruption.

Specify the name of the definition file for the common exclusion-conditions you want to apply to JP1/IM - Manager in relative or absolute path format. This option cannot be specified together with other options.

-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. This option cannot be specified together with the -check option.

To Page Top

Notes

• If -h is the only option specified, the following items are listed:

  • Filter IDs and filter names of the event acquisition filters that are currently enabled

  • IDs and names of the common exclusion-conditions groups currently enabled

  • Filter IDs and filter names of the event acquisition filters that have been set

  • IDs and names of the common exclusion-conditions groups that have been set

  • When the common exclusion-conditions operating mode is extended mode, the ID of the extended-mode common exclusion-conditions and the common exclusion-conditions group name

• If JP1/IM - Manager is not running at the specified host and the event acquisition filter is used for compatibility, the jcochfilter command cannot be executed.

• If you execute more than one jcochfilter command at the same time, it might cause an error depending on the timing.

• Executing the jcochfilter command concurrently many times might cause timeouts or a degraded performance of managers.

• The jcochfilter command cannot be executed together with the jco_spmd_status command.

To Page Top

Return values

To Page Top

Example 1

List the event acquisition filters on logical host hostA:

jcochfilter -h hostA

To Page Top

Example 2

Change the filter ID of the event acquisition filter on logical host hostA to 3:

jcochfilter -i 3 -h hostA

To Page Top

Example 3

Enable common exclusion-conditions groups (ID: 0, 2) for the event acquisition filter on the logical host (hostA), and disable all other groups:

jcochfilter -e 0,2 -h hostA

To Page Top