jpctool config mgrexport
- Organization of this page
Format
jpctool config mgrexport -d export-destination-directory
Function
The jpctool config mgrexport command exports a definition information file from the PFM - Manager in a multiple-monitoring environment to a specified directory.
The definition information that can be exported is as follows:
-
Alarm information (alarm and action definitions)
-
Bind information
-
Report definition
-
Business group definition
-
Performance Management user account information (including the information about agent hierarchy [User Agents])
-
Auto alarm bind setting
To execute this command on UNIX, the environment must allow the use of the Korn shell (ksh). For details about the applicable package, see the Release Notes for PFM - Manager.
Hosts that can execute the command
PFM - Manager
Execution permission
- In Windows:
-
User with Administrators permissions (When the UAC of Windows is enabled, execute this command from the administrator console.)
- In UNIX:
-
User with root user permissions (user with uid = 0)
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pc/tools/
Argument
-d export-destination-directory
Specifies the directory to which to export the definition information.
For export-destination-directory, specify a string of 1 to 35 bytes, consisting of single-byte alphanumeric characters, single-byte space characters, and the symbols shown below.
-_#():/\
You cannot specify a relative path. Always specify an absolute path.
If the directory name that you want to specify includes spaces, enclose the entire name in double quotation marks ("). If you specify any of the following symbols, enclose it in double quotation marks (") to prevent it from being analyzed by a shell or command prompt:
( )
Be sure to specify a directory that is not the installation directory for Performance Management. Be sure also to specify an empty directory that contains no files or directories.
Notes
-
Before executing the command in UNIX, the current directory must be changed to the command's installation directory.
-
This command requires the version of PFM - Manager on the execution host to be 10-10 or later.
-
This command cannot be executed together with the start or stop command or any other setup command on the same host.
-
This command must be executed in a multiple-monitoring environment.
-
The jpctool config mgrexport command must not be executed concurrently.
-
Make sure that there is enough disk space available. Estimate the available disk space on the basis of the size of the disk space used for installing each product.
-
Before executing this command, make sure there are no services with an alarm application status of Waiting, Failed, or Incompatible.
-
If an error occurs during command execution, an exported file might be left in the export-destination directory.
-
You cannot specify a network drive as export-destination-directory in the -d option.
-
You cannot specify a write-protected medium, such as a CD or DVD, as export-destination-directory in the -d option.
-
If many reports have been defined, it might take a long time to complete the execution of this command (when 1,000 reports are defined, it takes about 30 minutes to 1 hour.).
-
Do not cancel processing during command execution by pressing Ctrl+C.
-
Do not change the definition information or system configuration while this command is exporting the definition information.
-
While the command is executing, do not perform any modify operations that require administrator permissions.
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. |
|
5 |
The command was executed in a host other than the Performance Management host. |
|
10 |
The command is now running. |
|
12 |
The command was not executed in a multiple-monitoring environment. |
|
100 |
The Performance Management environment is invalid. |
|
105 |
The current directory is not the directory in which the jpctool config mgrexport command is installed. |
|
200 |
A memory shortage occurred. |
|
210 |
A disk space shortage occurred. |
|
211 |
The specified file or directory cannot be accessed. |
|
235 |
Copying of one or more files failed. |
|
255 |
An unexpected error occurred. |
Usage example
This example exports definition information to the /tmp/pfmexport directory.
jpctool config mgrexport -d /tmp/pfmexport