jpctool monitor list

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Targets of each argument
Notes
Return values
Displayed information
Assumed environment
Usage example 1
Usage example 2

Format

jpctool monitor list    [-group business-group-name
                        |-host host-name
                        |-id service-ID]
                        [-lhost logical-host-name]

To Page Top

Function

The jpctool monitor list command displays the monitoring suspension statuses and settings for the entire Performance Management system.

To Page Top

Hosts that can execute the command

PFM - Manager

To Page Top

Execution permission

In Windows:: User with Administrators permissions (executed from the administrator console when Windows UAC functionality is enabled)
In UNIX:: User with root user permissions (A user whose uid is 0.)

To Page Top

Installation directory

In Windows:: installation-folder\tools\
In UNIX:: /opt/jp1pc/tools/

To Page Top

Arguments

If you omit the -group option, the -host option, and the -id option, the command assumes that the local host is specified for the -host option.

`-group` `business-group-name`

Specifies the name of the business group for which the monitoring suspension statuses and settings are to be displayed.

For business-group-name, specify a string of 1 to 255 bytes, consisting of double-byte characters, single-byte characters, and the symbols below. Alphabetic characters are case sensitive.

! " # $ % & ' ( ) + - . : ; < = > @ [ \ ] ^ _ ` { | } ~

If you specify a string that contains single-byte spaces, enclose the entire string in double quotation marks ("). If you specify a single-byte symbol, specify an escape character as necessary. You can use wildcard characters to specify multiple business group names.

`-host` `host-name`

Specifies the name of the host for which the monitoring suspension statuses and settings are to be displayed.

For host-name, specify a string of 1 to 32 bytes, consisting of single-byte alphanumeric characters with no space characters. You can use wildcard characters to specify multiple host names.

`-id` `service-ID`

Specifies the service ID for which the monitoring suspension statuses and settings are to be displayed.

Specify the service ID (the second character is A) for the Agent Collector service or the Remote Monitor Collector service. You can also specify the health check agent. For service-ID, specify a string of 1 to 258 bytes. You can use wildcard characters to specify multiple service IDs.

`-lhost` `logical-host-name`

Specifies a logical host name if this command is to be executed by a host in the logical host environment, not in the physical host environment.

For logical-host-name, specify a string of 1 to 32 bytes, consisting of single-byte alphanumeric characters with no space characters. If you omit this option, the command assumes that the physical host is specified. Wildcard characters cannot be specified.

To Page Top

Targets of each argument

Table 3‒89: Targets of each argument (jpctool monitor list command)
Argument	Target
`-group`	Displays the monitoring suspension statuses and settings for the hosts that belong to the specified business group and the agents that are installed in the hosts. If the agents are PFM - RM, the monitoring suspension statuses and settings for the remote agents are also displayed.
`-host`	Displays the monitoring suspension statuses and settings for the specified host and the agents that are installed in the host. If the agents are PFM - RM, the monitoring suspension statuses and settings for the remote agents are also displayed.
`-id`	Displays the monitoring suspension statuses and settings for the agent. If the agent is PFM - RM, the monitoring statuses and settings for the remote agents are also displayed.

To Page Top

Notes

When the monitoring suspension function option is disabled, this command cannot be used.
When the PFM - Manager service (Master Manager and View Server services) is not running, this command cannot be used.
If command execution is interrupted by pressing the Ctrl + C keys or by a signal, a predefined return value is not returned. Therefore, you should ignore the return value when the command was interrupted by the Ctrl + C keys or by a signal.
In a multiple-monitoring environment, if you execute this command on the secondary host, - is displayed for the Status column. In addition, an incorrect value might be displayed for the Status column due to the following reasons:
- A terminated agent starts when the jpctool monitor suspend command or the jpctool monitor resume command runs.
- The switchover is performed between the primary and secondary hosts even though there are agents whose setting application statuses are unknown.
To display a correct value for the Status column, execute the jpctool monitor resume command on the PFM - Manager for the both primary and secondary hosts to resume the entire monitoring. Then, suspend the monitoring again. However, the jpctool monitor resume command cannot be executed on the PFM - Manager for the secondary host. Therefore, switch over the secondary host to the primary host and then execute the jpctool monitor resume command.
If you suspend or resume the monitoring when there are agents whose versions are 10-00 or earlier, an asterisk (*) is displayed for the setting application statuses of the agents. To remove the asterisk (*), you need to upgrade the versions of the agents to 10-00 or later or delete the services of the agents.
Usually, even if you execute this command, the monitoring suspension statuses and settings for the hosts and agents below are not displayed and are displayed only when the monitoring is suspended by specifying the -force option.
- The hosts and agents that have never been connected to PFM - Manager.
- The host and agents that have never been started since the host name was changed.

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.
`5`	The command was executed on a host that is not the PFM - Manager host.
`12`	The monitoring suspension function is disabled.
`18`	The specified business group has not been registered.
`19`	The specified host has not been registered.
`20`	The specified service has not been registered.
`100`	The Performance Management environment is invalid.
`101`	The service required for this operation does not start.
`102`	The specified logical host name has not been set up.
`200`	A memory shortage occurred.
`211`	A file or directory cannot be accessed.
`222`	A communication processing error occurred.
`223`	A communication processing timeout error occurred.
`253`	Access control by business group is disabled.
`255`	An unexpected error occurred.

To Page Top

Displayed information

The following table describes the information that is displayed by executing the jpctool monitor command.

Table 3‒90: Information displayed by the jpctool monitor command
No	Displayed item		Meaning	Format
1	`#`		Type	Displays one of the following identifiers for each type: `G`: Business group^#1 `H`: Host `A`: Agent `R`: Remote agent
2	`Status`	-	Monitoring status	Displays the monitoring status for the target.
3		`*`	Result of changing the monitoring statuses for the agents^#2	For the line where the type item is `H`: Indicates whether the monitoring statuses for the agents have been changed when the monitoring of the host and its agents is suspended or resumed. `-`: The monitoring statuses for all agents have been changed. ``: Unknown whether the monitoring statuses for some agents have been changed. `#`: The target host does not have any agents (when the monitoring of the host is suspended by using the `jpctool monitor suspend` command with the `-force` option specified, when all agents on the host of which the monitoring was suspended by using the `jpctool monitor suspend` command are uninstalled, etc.) For the line where the type item is `A` or `R`: Indicates the result of changing the monitoring statuses for the agent. `-`: The monitoring statuses have been changed. ``: Unknown whether the monitoring statuses have been changed.
4		`Mon`	Monitoring status (monitoring suspension)	`Act`: The monitoring is activated. `Sus`: The monitoring is suspended.
5		`Log`	Monitoring status (DB storage continuation)	`Y`: The storage of the operating information continues. `N`: The storage of the operating information is suspended.
6	`Setting`	-	Settings	The monitoring suspension unit, host-based or agent-based.
7		`*`	Setting application status for the target^#2	For the line where the type item is `H`: When the monitoring was suspended or resumed by specifying a business group or a host name, indicates the result of changing the monitoring statuses for the agents under the business group or host. `-`: The monitoring statuses for all agents have been changed. ``: Unknown whether the monitoring statuses for some agents have been changed. For the line where the type item `A` or `R`: When the monitoring was suspended by specifying a service ID, indicates the result of changing the monitoring status. `-`: The monitoring status has been changed. ``: Unknown whether the monitoring status has been changed.
8		`Mon`	Setting (monitoring suspension)	For the line where the type item is `H`: Indicates whether the monitoring was suspended by specifying a business group or a host name. `Act`: Not suspended. `Sus`: Suspended. For the line where the type item is `A` or `R`: Indicates whether the monitoring was suspended by specifying a service ID. `Act`: Not suspended. `Sus`: Suspended.
9		`Log`	Setting (DB storage continuation)	`Y`: The storage of the operating information has been set to continue. `N`: The storage of the operating information has been set to be suspended.
10	`Name`		Business group name^#1, host name, or service ID	Displays the grouped business group names^#1, host names, or service IDs, in ascending order. Even if the product name display functionality is enabled, service IDs are displayed.

#1: The jpctool monitor status command does not display the information.
#2: Only the jpctool monitor list command displays the information.

To Page Top

Assumed environment

The usage examples below assume that this command is executed in the environment below.

In the figure, PFM - Agent indicates PFM - Agent for Platform and PFM - RM indicates PFM - RM for Oracle.

[Figure]

To Page Top

Usage example 1

This example displays the monitoring suspension statuses and settings for all hosts whose name begins with Host and their agents.

jpctool monitor list -host Host*

The following shows an example of the command execution results.

  Status    Setting
# * Mon Log * Mon Log Name
- - --- --- - --- --- --------------------------------------------------
H - Act Y   - Act Y   HostA
A - Act Y   - Act Y   1A1hostA[HostA]
A - Act Y   - Act Y   1A1hostA[All@HostA]
R - Act Y   - Act Y   1A1hostA[hostB@HostA]
R - Act Y   - Act Y   1A1hostA[hostC@HostA]
A - Act Y   - Act Y   TA1HostA
H - Act Y   - Act Y   HostB
A - Act Y   - Act Y   1A1hostA[hostB@HostA]
A - Act Y   - Act Y   TA1HostB
H - Act Y   - Act Y   HostC
A - Act Y   - Act Y   1A1hostA[hostC@HostA]
KAVE06180-I The monitoring suspension function was successfully set and the monitoring status was successfully displayed.

To Page Top

Usage example 2

This example displays the monitoring suspension statuses and settings for all hosts whose name begins with Host and their agents.

This example assumes that the monitoring of HostB is suspended by specification of the host.

jpctool monitor list -host Host*

The following shows an example of the command execution results.

  Status    Setting
# * Mon Log * Mon Log Name
- - --- --- - --- --- --------------------------------------------------
H - Act Y   - Act Y   HostA
A - Act Y   - Act Y   1A1hostA[HostA]
A - Act Y   - Act Y   1A1hostA[All@HostA]
R - Sus N   - Act Y   1A1hostA[hostB@HostA]
R - Act Y   - Act Y   1A1hostA[hostC@HostA]
A - Act Y   - Act Y   TA1HostA
H - Sus N   - Sus N   HostB
A - Sus N   - Act Y   1A1hostA[hostB@HostA]
A - Sus N   - Act Y   TA1HostB
H - Act Y   - Act Y   HostC
R - Act Y   - Act Y   1A1hostA[hostC@HostA]
KAVE06180-I The monitoring suspension function was successfully set and the monitoring status was successfully displayed.

To Page Top