jpcwbackup
- Organization of this page
Format
jpcwbackup -d backup-data-storage-directory
Function
The jpcwbackup command creates a backup file for the definition information of PFM - Web Console in a specified directory.
Hosts that can execute the command
PFM - Web Console
Execution permission
- In Windows:
-
-
User with Administrators permissions
-
User with Backup Operators permissions
-
- In UNIX:
-
User with root user permissions
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pcwebcon/tools/
Arguments
-d backup-data-storage-directory
Specifies the directory in which backed up definition information is to be stored. The directory can be specified with either a relative path or absolute path, but must satisfy the following conditions:
-
The directory exists on the local disk.
-
The directory is empty.
-
The administrator can access the directory.
-
The path name is not longer than 35 characters (in Windows) or 35 bytes (in UNIX). If a relative path of the directory is specified, this limitation also applies if it is converted to the absolute path of the directory.
-
The name of the directory does not use any characters other than single-byte alphanumeric characters, single-byte spaces, and the following symbols:
! # $ % + . - / : = @ [ \ ] _ { } ( )
If the name includes spaces and the following symbols, they are enclosed in double quotation marks ("): ( ) ! =
If an exclamation mark (!) is include in a directory name, a caret (^) is added as an escape character immediately before the exclamation mark (!).
Do not specify a network directory.
Notes
-
Do not execute multiple instances of this command concurrently.
-
While this command is being executed, do not perform any subsequent operations that change a definition or configuration:
-
Any CLI operations that require the administrator role
-
Any GUI operations that can be performed by administrators only
If a definition or configuration is changed during execution of this command, the command might fail with a return value of 235.
If this occurs, re-execute the command, making sure that you do not change a definition or configuration during command execution.
-
-
If you save the backup data storage directory to a directory whose path name is long, the path length of files might exceed the maximum (Windows: 255 characters, UNIX: 1,023 bytes). If the path length of files exceeds the maximum, the paths of these files are automatically shortened, making it impossible to restore these files.
-
The config.xml file is reloaded when the PFM - Web Console service is restarted. Therefore, after the file has been changed, if the file is backed up before that service is restarted, the system might be unable to operate correctly when the file is restored from the backed up file.
-
If an error occurs during execution of this command and backup processing stops, data might remain in the backup directory. Before you re-execute the command, delete any remaining data from the backup directory.
-
In a cluster configuration, execute this command on both the executing host and the standby host.
-
When this command is executed on the standby host, a KAVJT6551-W message is always output because the command cannot access the environment directory. However, the user does not need to take any action.
-
Assume, in a UNIX environment, that you have changed the path of the directory containing bookmarks and process monitoring templates to a path that includes characters other than 7-bit ASCII codes by changing the specification in the initialization file (config.xml). If you execute the jpcwbackup command in such a case, make the value of the LANG environment variable equal to that set at the startup of the PFM - Web Console service. If character encoding differs between the startup of the PFM - Web Console service and the execution of the jpcwbackup command, the backup operation might be incorrect.
Return values
|
0 |
The command terminated normally. |
|
1 |
Invalid arguments are specified on the command line. |
|
2 |
The user does not have execution permission for the command. |
|
3 |
Creation of a directory failed. |
|
4 |
The specified directory was not empty. |
|
15 |
An attempt to access the directory that contains template information for monitoring bookmarks or processes failed. |
|
100 |
The Performance Management environment is invalid. |
|
101 |
There are problems with the config.xml file. |
|
200 |
A memory shortage occurred. |
|
202 |
A file access error occurred. |
|
210 |
A disk space shortage occurred. |
|
235 |
An attempt to back up one or more files failed. |
|
255 |
An unexpected error occurred. |
Usage example
This example executes the command by specifying the /tmp/backup_wc_2012 folder with the -d option.
jpcwbackup -d /tmp/backup_wc_2012
Output result (Console)
>jpcwbackup -d /tmp/backup_wc_2012 KAVJT6501-I The PFM - Web Console backup of definition information will now start. The backup of definition information for PFM - Web Console service ended. The backup of bookmarks information ended. The backup of processMonitoringTemplates information ended. KAVJT6502-I The PFM - Web Console backup of definition information ended normally.