jpcparamdump
- Organization of this page
Format
jpcparamdump -d output-destination-directory
Function
The jpcparamdump command outputs the setting information of the Performance Management program on the command execution host into a text file. The jpcparamdump command can collect the setting information of the following products:
-
PFM - Manager (10-10-10 and later)
-
PFM - Base (10-10-10 and later)
-
PFM - Agent for Platform (Windows and UNIX) (10-00 and later)
-
PFM - RM for Platform (10-00 and later)
-
PFM - RM for VM (10-00 and later)
Hosts that can execute the command
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
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
-d output-destination-directory
Specifies the directory to which the setting information file is to be output, with the absolute path that is 35 bytes or less. The directory specified for this option must satisfy the following conditions:
-
It does not exist before the command runs.
-
It is not under the Performance Management installation directory.
-
The name consists of single-byte alphanumeric characters or single-byte symbols.
However, the following single-byte symbols cannot be specified:
" & ' * , ; < > ? ^ ` |
If you specify a string that contains single-byte spaces or parentheses (( )), enclose the entire string in double quotation marks (").
In addition, you cannot specify a directory name that ends with a backslash (\).
Notes
-
Before executing the command, verify that the character encoding for the command execution environment matches the character encoding used when Performance Management service starts up. If not, a file that uses multiple character encodings might be output.
-
If the command fails, half-created files and directories remain under the specified path. Before you re-execute the command, delete these files and directories.
-
If the jpcparamdump command is executed in an environment in which the WMI command-line (WMIC) has not been installed, the following character string is output to the Host.prm file:
WMIC is being installed. Please wait a while.
There is no a problem with the Performance Management settings if this character string differs from one in the Host.prm file of another host. Please ignore the difference.
Note that this character string is no longer output with subsequent executions.
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. |
100 |
The Performance Management environment is invalid. |
200 |
A memory shortage occurred. |
210 |
A disk space shortage occurred. |
211 |
A file or directory cannot be accessed. |
255 |
An unexpected error occurred. |
Output information
When you execute the jpcparamdump command, files are created under the directory that is specified for the -d option and then the setting information of the target products is output to the files. If a logical environment has been configured on the command execution host, this command outputs the setting information for the logical host, in addition to the setting information for the physical host.
For details on the configuration of the directory created by the jpcparamdump command and the files, see Appendix G. Information Output by the jpcparamdump Command.