jpcprocdef list
- Organization of this page
Format
jpcprocdef list -agent service-ID
Function
The jpcprocdef list command lists the names of application definitions that exist on the specified agent. Before you execute the jpcprocdef delete command or jpcprocdef output command, you can check an application definition name that can be specified for the -name option by using the jpcprocdef list command. The agent definitions are listed in the order in which they are set on the agent.
Hosts that can execute the command
PFM - Web Console
Execution permission
- In Windows:
-
User with Administrators permissions
- In UNIX:
-
User with root user permissions
Before you can execute this command, you must create an authentication key file as a user account with the administrator user permission for Performance Management#. For details, see jpcmkkey.
- #
-
Any Performance Management users or JP1 users who want to operate Performance Management must have this permission level.
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pcwebcon/tools/
Arguments
-agent service-ID
Specifies the service ID of the Agent Collector service or a remote agent to identify the agent whose application definitions will be listed. Wildcard characters cannot be used.
The service ID to be specified differs depending on the monitoring agent being used, as shown in the following table.
|
Monitoring agent being used |
Service ID to be specified |
|---|---|
|
PFM - Agent for Platform (Windows) |
Service ID of the Agent Collector service |
|
PFM - Agent for Platform (UNIX) |
|
|
PFM - RM for Platform |
Service ID of the remote agent |
The following service IDs cannot be specified:
-
Service ID of the Agent Store service, Remote Monitor Collector service, Remote Monitor Store service, or a group agent
-
Service ID of a product that is not PFM - Agent for Platform or PFM - RM for Platform
Notes
-
The user who executes this command must be authenticated by PFM - Manager when executing this command. If an authentication key file has not been created, before executing this command, use the jpcmkkey command to create that file. When specifying values for tags, follow the notes on the performance data collection settings in any manual of the relevant PFM - Agent product or any manual of PFM - RM.
-
When you execute this command, make sure that the PFM - Manager service and the target PFM - Agent service are running.
Return values
|
0 |
The command terminated normally. |
|
1 |
The command line format is invalid. |
|
2 |
The user does not have execution permission for the command. |
|
4 |
There are invalid command arguments. |
|
11 |
Authentication by PFM - Manager failed. Alternatively, the user that was specified when the authentication key file was created by using the jpcmkkey command does not have permission to execute the command. |
|
100 |
The Performance Management environment is invalid. |
|
200 |
A memory shortage occurred. |
|
222 |
An error occurred during communication processing. |
|
224 |
Connection to the agent is impossible. |
|
225 |
The agent does not exist. |
|
226 |
The agent is not supported. |
|
227 |
The PFM - Manager host for the connection destination is not supported. |
|
228 |
The target agent is not set up on the PFM - Manager host for the connection destination. |
|
255 |
An unexpected error occurred. |
Usage example
This example lists the names of application definitions that exist on the agent TA1hostpfm.
jpcprocdef list -agent TA1hostpfm
Output example
When this command is executed, detailed information about the command processing is output to the standard output, standard error output, and operation status log file. For the logging specifications, see Chapter 6. Log Information Output by Performance Management.
An example of information that is output to the standard output is shown below.
Example of standard output
"PFM - Manager" "PFM - Web Console"