jpcprocdef output
- Organization of this page
Format
jpcprocdef output -agent service-ID
{-name application-definition-name
[-name application-definition-name]... | -all}
-f export-file-name
[-noquery]
Function
The jpcprocdef output command exports application definitions that exist on the specified agent to a file in XML format. The exported file can be used to check the current contents of application definitions. The exported file can also be used as an input file for the jpcprocdef create command.
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 exported. 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
-name application-definition-name
Specifies the name of an application definition to be exported from the agent specified by the -agent option. Wildcard characters cannot be used.
To export multiple application definitions at one time, specify multiple -name options. In this case, the application definitions will be exported to a file in the order in which they are specified by -name options, rather than in the order in which they are set on the agent. The command ignores -name options that specify application definitions that do not exist on the agent.
-all
Specify this option to export all application definitions that exist on the agent specified by the -agent option. The agent definitions are exported in the order in which they are set on the agent.
-f export-file-name
Specifies the name of the export-destination application definition file. If multiple application definitions are specified, they will be exported collectively to one file. The file name can be specified with either a relative path or an absolute path.
-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. Specify this option if you want the command to run in non-interactive mode.
If the application definition file specified for the -f option already exists, the file will be overwritten by the new file.
Format of the application definition file
See Format of the application definition file in the description of the jpcprocdef create command.
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. |
|
3 |
An export file could not be created. |
|
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. |
|
21 |
The export file cannot be accessed. |
|
80 |
When the command was executed without the -noquery option and the user was asked whether to continue processing, the processing was interrupted because the user made a reply that was not Y or y. |
|
100 |
The Performance Management environment is invalid. |
|
142 |
Some of the specified application definitions do not exist. |
|
145 |
All specified application definitions do not exist. |
|
146 |
No application definitions are set on the agent. |
|
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 exports the contents of the application definition named PFM - Manager that is set on the agent TA1hostpfm.
jpcprocdef output -agent TA1hostpfm -name "PFM - Manager" -f appdef.xml
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. In this example, OK has been output as the command execution result for the agent specified by a service ID (if the processing fails, ERR is output).
Example of standard output
jpcprocdef output connected to localhost at yyyy MM dd HH:MM:SS.mmm output result OK : TA1hostpfm jpcprocdef output disconnected at yyyy MM dd HH:MM:SS.mmm
Output file
An example of a file output by this command is shown below.
Example of output file
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "processmonitoring_params.dtd"> <pr-cli-parameters ver="0100"> <application-definition> <name>PFM - Manager</name> <virtual-env-id></virtual-env-id> <process01 label="jpcah" max="65535" min="1" type="none">jpcah.exe</process01> <process02 label="jpcagt0" max="65535" min="1" type="program">jpcagt0.exe</process02> <process03 label="jpcep" max="65535" min="1" type="program">jpcep.exe</process03> <process04 label="jpcmm" max="65535" min="1" type="program">jpcmm.exe</process04> <process05 label="jpcnsvr" max="65535" min="1" type="program">jpcnsvr.exe</process05> <process06 label="jpcstatsvr" max="65535" min="1" type="program">jpcstatsvr.exe</process06> <process07 label="jpcsto" max="65535" min="2" type="program">jpcsto.exe</process07> <process08 label="jpctrap" max="65535" min="1" type="program">jpctrap.exe</process08> <process09 label="jpcvsvr" max="65535" min="1" type="program">jpcvsvr.exe</process09> <process10 label="Monitoring10" max="0" min="0" type="none"></process10> <process11 label="Monitoring11" max="0" min="0" type="none"></process11> <process12 label="Monitoring12" max="0" min="0" type="none"></process12> <process13 label="Monitoring13" max="0" min="0" type="none"></process13> <process14 label="Monitoring14" max="0" min="0" type="none"></process14> <process15 label="Monitoring15" max="0" min="0" type="none"></process15> </application-definition> </pr-cli-parameters>