jpctool monitor suspend
- Organization of this page
Format
jpctool monitor suspend {-group business-group-name
| -host host-name [-force]
| -id service-ID}
[-log]
[-lhost logical-host-name]
[-noquery]
[-wait number-of-seconds]
[-verbose]
Function
The jpctool monitor suspend command suspends the monitoring.
Hosts that can execute the command
PFM - Manager
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.)
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pc/tools/
Arguments
-group business-group-name
Specifies the name of the business group of which the monitoring is to be suspended.
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 also use wildcard characters to specify multiple business group names.
-host host-name
Specifies the name of the host of which the monitoring is to be suspended.
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.
-force
Specify this option to start the services for a host that is to be newly added or a host whose name was changed when the monitoring of the host is suspended.
If you specify a wildcard character or an existing host name for the -host option, this option is ignored.
-id service-ID
Specifies the service ID of which the monitoring is to be suspended.
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.
-log
Specify this option to continue the storage of the operating information and suspend the monitoring.
-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 and no wildcard characters. If you omit this option, the command assumes that the physical host is specified.
-noquery
If this option is specified, the command does not output any query messages that interrupt command execution, making it unnecessary for the user to respond.
-wait number-of-seconds
Specifies the maximum wait time (in seconds) applied when a command that cannot be executed with this command. Specify a number in the range from 0 to 3,600 for this option.
If you omit this option, the command assumes that 300 seconds are specified. If you specify 0, the command execution is not suspended.
-verbose
If you specify this option, lists the hosts and agents for which the monitoring status is to be changed to the monitoring suspended status.
Targets of each argument
|
Argument |
Target |
|---|---|
|
-group |
Suspends the monitoring of 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 of the remote agents is also resumed. |
|
-host |
Suspends the monitoring of the specified host and the agents that are installed in the host. If the agents are PFM - RM, the monitoring of the remote agents is also suspended. |
|
-id |
Suspends the monitoring of the agent. If the agent is PFM - RM, the monitoring of the remote agents is also suspended. |
Notes
-
If the monitoring suspension function option is disabled, this command cannot be used.
-
If 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.
-
This command cannot be executed with the startup stop command or another setup command on the same machine. By specifying the -wait option, if a command that cannot be executed with this command is running, execution of this command can wait to complete the command processing for the specified period (in seconds).
-
Do not add or delete monitoring targets while this command is running. The latest information might not be displayed.
-
The monitoring of the hosts that have never been connected to PFM - Manager cannot be suspended by using the -group option. Specify the -host option and the -force option to suspend the monitoring.
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 was not the PFM - Manager host. |
|
11 |
The user canceled the processing. |
|
12 |
The monitoring suspension function is disabled. |
|
16 |
This command waited to run because a startup or termination command or other setup command was being executed on the same machine, but a timeout occurred. |
|
17 |
This command was executed from the secondary PFM - Manager in a multiple-monitoring environment. |
|
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. |
|
22 |
Failed to update PFM - Manager. |
|
23 |
Failed to update PFM - Agent and PFM - RM. |
|
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. |
Displayed information
The following table describes the information displayed by executing this command.
|
No |
Displayed information |
Description |
|---|---|---|
|
1 |
List of targets |
The following information is displayed based on Table 3-90 Information displayed by the jpctool monitor command:
|
|
2 |
Query message |
A KAVE06182-Q message asking whether to continue the processing is output. If you enter Y, the processing continues. |
|
3 |
Progress display |
The progress for the following processing is displayed:
|
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]](GRAPHICS/ZU113000.GIF)
Usage example 1
This example suspends the monitoring by specification of a business group.
jpctool monitor suspend -group Group1
The following shows an example of the command execution results.
[List of setting changes] Status Setting # Mon Log Mon Log Name - --- --- --- --- ------------------------------------------------------ G --- - --- - Group1 H Act Y Act Y HostA H Act Y Act Y HostB H Act Y Act Y HostC KAVE06182-Q Monitoring on the displayed host or agent will be suspended. Do you want to continue? (Y/N) Y KAVE06193-I Monitoring will be suspended. KAVE06183-I The settings information for the monitoring suspension function on the monitoring manager was successfully updated. [100%] KAVE06186-I The settings information for the monitoring suspension function on the monitoring agent was successfully updated. KAVE06194-I The suspension of monitoring was successful.
Usage example 2
This example suspends the monitoring by specification of a host.
jpctool monitor suspend -host HostA
The following shows an example of the command execution results.
[List of setting changes] Status Setting # Mon Log Mon Log Name - --- --- --- --- ------------------------------------------------------ H Act Y Act Y HostA KAVE06182-Q Monitoring on the displayed host or agent will be suspended. Do you want to continue? (Y/N) Y KAVE06193-I Monitoring will be suspended. KAVE06183-I The settings information for the monitoring suspension function on the monitoring manager was successfully updated. [100%] KAVE06186-I The settings information for the monitoring suspension function on the monitoring agent was successfully updated. KAVE06194-I The suspension of monitoring was successful.
Usage example 3
This example suspends the monitoring by specification of an agent.
jpctool monitor suspend -id TA1HostB
The following shows an example of the command execution results.
[List of setting changes] Status Setting # Mon Log Mon Log Name - --- --- --- --- ------------------------------------------------------ A Act Y Act Y TA1HostB KAVE06182-Q Monitoring on the displayed host or agent will be suspended. Do you want to continue? (Y/N) Y KAVE06193-I Monitoring will be suspended. KAVE06183-I The settings information for the monitoring suspension function on the monitoring manager was successfully updated. [100%] KAVE06186-I The settings information for the monitoring suspension function on the monitoring agent was successfully updated. KAVE06194-I The suspension of monitoring was successful.
Usage example 4
This example continues the storage of the operating information and suspends the monitoring by specification of a host.
jpctool monitor suspend -host HostA -log
The following shows an example of the command execution results.
[List of setting changes] Status Setting # Mon Log Mon Log Name - --- --- --- --- ------------------------------------------------------ H Act Y Act Y HostA KAVE06182-Q Monitoring on the displayed host or agent will be suspended. Do you want to continue? (Y/N) Y KAVE06193-I Monitoring will be suspended. KAVE06183-I The settings information for the monitoring suspension function on the monitoring manager was successfully updated. [100%] KAVE06186-I The settings information for the monitoring suspension function on the monitoring agent was successfully updated. KAVE06194-I The suspension of monitoring was successful.