jpcaspsv output
- Organization of this page
Format
jpcaspsv output [-mx maximum-heap-size]
[-ms initial-heap-size]
-o output-file-name
service-ID
Function
The jpcaspsv output command connects to an agent to acquire definitions related to the storage conditions of the Store database and outputs the definitions in XML format. You can specify the obtained output file as an input file for the jpcaspsv update 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
To execute this command, a key file for authentication needs to be created in advance for a user account with administrator user permissions# for Performance Management. For details, see the jpcmkkey command.
- #
-
Execution permissions for Performance Management that are required for a Performance Management user or JP1 user.
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pcwebcon/tools/
Arguments
-mx maximum-heap-size
Specifies the maximum heap size for java.exe (in megabytes). The default is 128 MB. The maximum size that can actually be acquired depends on the system. If the specified value does not satisfy the following conditions, an invalid command line format results:
-
Integer in the range 1 to 2,048
-
Value specified in -mx >= value specified in -ms
-ms initial-heap-size
Specifies the initial heap size for java.exe (in megabytes). The default is 32 MB. If the specified value does not satisfy the following conditions, an invalid command line format results:
-
Integer in the range 1 to 2,048
-
Value specified in -mx >= value specified in -ms
-o output-file-name
Specifies the name of an XML-format file to which the execution results are to be output. This can be an absolute file path name, relative file path name, or file name. If the specified file name is not the absolute file path name, the command assumes the current directory as the reference directory (if the specified directory does not exist, an error results).
service-ID
Specifies the service ID of the target agent. Wildcard characters cannot be used. Conditions for the specified value are as follows:
-
4 to 258 characters
-
The first character specifies the product ID of the agent (for details about product IDs, see the PFM - Agent or PFM - RM manuals).
-
The second character specifies S (Agent Store or Remote Monitor Store).
Notes
-
The command requires authentication for PFM - Manager during execution. If a key file for authentication has not been created prior to command execution, use the jpcmkkey command to create the key file for authentication. For details about the service ID, see the PFM - Agent or PFM - RM manuals.
-
If the specified service ID is not for an agent product, an error results.
-
Definition information that cannot be updated is output as comments in the output file.
-
Normally, you do not need to set the -mx or -ms option. If the KAVJK0401-E message, which reports insufficient memory, is output during command execution, re-execute the command with the -mx option to increase the maximum heap size. At this time, make sure that you specify 64 or a greater value for the -mx option.
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 |
Creation of the output file failed. |
|
5 |
The parameters cannot be analyzed because they do not match the DTD file. |
|
10 |
Updating of at least one Store database definition failed. |
|
11 |
Authentication processing for login to PFM - Manager failed. Alternatively, the user specified at authentication does not have execution permission. |
|
100 |
The environment is invalid. |
|
200 |
A memory error occurred. |
|
202 |
A file access error occurred. |
|
222 |
A communication processing error occurred. |
|
255 |
An unexpected error occurred. |
Usage example
This example outputs to a parameter file (aspsv_output.xml) definition information for the Store database recording method for the PFM - Agent whose service ID is TS1host1:
jpcaspsv output -o aspsv_output.xml TS1host1
Output example
This example outputs the details of the command's processing to the standard output, standard error output, and trace log file. For details about the log specifications, see Chapter 6. Log Information Output by Performance Management.
An example of the standard output is shown below. It displays the execution results (OK or ERR) for the service ID specified in the argument.
Example of standard output
jpcaspsv output connected to hostname at yyyy MM dd HH:MM:SS.mmm output result OK : TS1host1 jpcaspsv 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
-
Output file example (when the Store version is 1.0)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-preserve-definition> <service id="TS1host1"> <product-interval> <minute-drawer>month</minute-drawer> <hour-drawer>month</hour-drawer> <day-drawer>month</day-drawer> <week-drawer>month</week-drawer> <month-drawer>month</month-drawer> <!-- year-drawer : Year --> </product-interval> <product-detail> <detail-record id="PD" max-rec="20000"/> <detail-record id="PD_THRD" max-rec="20000"/> <detail-record id="PD_ADRS" max-rec="20000"/> <detail-record id="PD_PDI" max-rec="20000"/> <detail-record id="PD_PEND" max-rec="20000"/> <detail-record id="PD_THD" max-rec="20000"/> <detail-record id="PD_IMAG" max-rec="20000"/> <detail-record id="PD_PAGF" max-rec="20000"/> <detail-record id="PD_GEND" max-rec="20000"/> <detail-record id="PD_SVC" max-rec="20000"/> <detail-record id="PD_DEV" max-rec="20000"/> <detail-record id="PD_ELOG" max-rec="20000"/> </product-detail> <product-log> <log-record id="PL" max-rec="20000"/> <log-record id="RM" max-rec="20000"/> </product-log> </service> </agent-store-db-preserve-definition> </pr-cli-parameters> -
Output file example (when the Store version is 2.0)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-preserve-definition> <service id="TS1host1"> <ex-product-interval> <ex-interval-record id="PI"> <minute-drawer-days period="10"/> <hour-drawer-days period="10"/> <day-drawer-weeks period="10"/> <week-drawer-weeks period="10"/> <month-drawer-months period="10"/> <!-- year-drawer-years period="10" --> </ex-interval-record> <ex-interval-record id="PI_LOGD"> <minute-drawer-days period="10"/> <hour-drawer-days period="10"/> <day-drawer-weeks period="10"/> <week-drawer-weeks period="10"/> <month-drawer-months period="10"/> <!-- year-drawer-years period="10" --> </ex-interval-record> </ex-product-interval> <ex-product-detail> <ex-detail-record id="PD" period="10"/> <ex-detail-record id="PD_THRD" period="10"/> <ex-detail-record id="PD_ADRS" period="10"/> <ex-detail-record id="PD_PDI" period="10"/> <ex-detail-record id="PD_PEND" period="10"/> </ex-product-detail> <ex-product-log> <ex-log-record id="PL" period="10"/> <ex-log-record id="RM" period="10"/> </ex-product-log> </service> </agent-store-db-preserve-definition> </pr-cli-parameters>