jpctool alarm unbind

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Notes
Return values
Usage example 1
Usage example 2
Usage example 3

Format

jpctool alarm unbind    -key service-key
                       {-table alarm-table-name | -all}
                        -id service-ID
                        [-wait number-of-seconds]

To Page Top

Function

The jpctool alarm unbind command unbinds an alarm table that is bound to an agent.

To Page Top

Hosts that can execute the command

PFM - Manager

To Page Top

Execution permission

In Windows:: User with Administrators permissions
In UNIX:: User with root user permissions

To Page Top

Installation directory

In Windows:

installation-folder\tools\

In UNIX:

/opt/jp1pc/tools/

To Page Top

Arguments

`-key` `service-key`

Specifies the service key of the PFM - Agent or PFM - RM from which an alarm table is to be unbound. A product name can also be specified when the product name display functionality is enabled. You can specify only the service key of PFM - Agent or PFM - RM here. For details about the service key of the PFM - Agent or PFM - RM, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

`-table` `alarm-table-name`

Specifies the name of the alarm table that is to be unbound.

For alarm-table-name, specify a string of 1 to 64 bytes, consisting of double-byte characters, single-byte alphanumeric characters, single-byte spaces, and the following single-byte symbols:

% - ( ) _ . / @ [ ]

If the value contains a space, enclose the entire value in double quotation marks ("). If the value contains a defined symbol, specify an escape character if necessary.

Wildcard characters cannot be used.

`-all`

Unbinds all alarm tables. An error will occur if the functionality for binding multiple alarm tables is not set to be enabled. If no alarms are bound for the specified service ID, the KAVE05288-W message is displayed and the command terminates normally.

`-id` `service-ID`

Specifies the service ID of the Agent Collector service, Remote Monitor Collector service, remote agent, or group agent for the agent for which alarm tables are to be unbound. For service-ID, specify a string of 1 to 258 bytes.

This command will terminate with an error if the specified service ID belongs to an Agent Collector or Remote Monitor Collector service to which the alarm table specified by the -table option is not bound.

You can use wildcard characters to specify multiple service IDs. In this case, even when an error occurs for a given Agent Collector or Remote Monitor Collector service, processing continues for the remaining Agent Collector or Remote Monitor Collector services. Also, when errors occur from multiple Agent Collector or Remote Monitor Collector services, the return value for the last error that occurred is returned.

`-wait` `number-of-seconds`

Specifies the maximum wait period (in seconds) applied when a command that cannot be executed with this command is running. When the setting to suspend execution of alarm commands (Alarm Command Wait Mode) is enabled in the startup information file (jpccomm.ini), if you want to specify a wait period (in seconds) separately from the wait period specified in the jpccomm.ini file, specify a value in the range from 1 to 3,600 for this option.

If you omit the option, this command runs with the wait period (in seconds) specified in the jpccomm.ini file.

For details on the commands that cannot be executed with this command, see Commands that cannot be executed with alarm commands. For details on the jpccomm.ini file and Alarm Command Wait Mode, see Startup information file (jpccomm.ini).

To Page Top

Notes

This command cannot be executed concurrently.
This command cancels a specified bind setting on PFM - Manager. When the bind setting is canceled, the PFM - Manager service cancels the bind setting on the relevant running agent.

Therefore, if the cancellation of an alarm table setting on the agent fails because of a failure in agent communication or for other reasons, even when this command has been executed successfully, a KAVE00448-E message is output to the common message log.
For details about the service ID, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.
This command cannot be executed if any of the Name Server, Master Manager, and View Server services is stopped.
If arguments of a jpctool alarm command include double-byte characters, the LANG environment variable for the shell that is used to execute the command must be set to Japanese (Shift JIS, EUC, or UTF-8) or Simplified Chinese (GB18030 or UTF-8). In addition, the value of that LANG environment variable must be the same as the value of the LANG environment variable that is loaded when PFM - Manager starts. Before you execute this command, make sure that the LANG environment variable settings of the shell and PFM - Manager match.
If PFM - Manager is installed on a logical host, execute the command on the executing node.
When performing multiple monitoring, you cannot execute this command from the secondary PFM - Manager host.
It might take several tens of seconds until this command takes effect on the agent after this command has terminated.

To Page Top

Return values

`0`	The command terminated normally.
`1`	An argument specification is invalid.
`2`	The user does not have execution permission for the command.
`3`	At least one of the Name Server, Master Manager, and View Server services is not running, or there is no PFM - Agent or PFM - RM that corresponds to the specified service ID.
`4`	The startup stop command or another setup command was executed on the same machine.
`5`	The command was executed on a host that is not the PFM - Manager host. Alternatively, the agent from which alarms are to be unbound has not been set up. Or else, an attempt was made to execute the command from the secondary PFM - Manager host when multiple monitoring is performed.
`6`	The specified alarm table was not found.
`11`	The user canceled the processing.
`12`	The functionality for binding multiple alarm tables is not set to be enabled (09-00 or later).
`100`	The Performance Management environment is invalid.
`200`	A memory shortage occurred.
`210`	A disk space shortage occurred.
`211`	A file or directory cannot be accessed.
`222`	A communication error occurred.
`223`	Communication processing resulted in a timeout.
`255`	An unexpected error occurred.

To Page Top

Usage example 1

This example unbinds the PFM UNIX Solution Alarms 8.00 monitoring template for PFM - Agent for Platform (UNIX), from the agent with the host name host01 (service ID: UA1host01).

jpctool alarm unbind -key UNIX -table "PFM UNIX Solution Alarms 8.00" -id UA1host01

To Page Top

Usage example 2

This example assumes that the alarmtable1 alarm table in PFM - Agent for Platform (UNIX) has been bound to all agents whose host names begin with host.

The following command unbinds the alarmtable1 alarm table from all agents:

jpctool alarm unbind -key UNIX -table alarmtable1 -id "UA1host*"

To Page Top

Usage example 3

This example unbinds all alarm tables bound to the UA1hostA service.

jpctool alarm unbind -key UNIX -all -id UA1hostA

To Page Top