jpcconf bgdef export
- Organization of this page
Format
jpcconf bgdef export -f business-group-definition-file-name {-group business-group-name [-lhost logical-host-name] | -template} [-noquery | -skip]
Function
The jpcconf bgdef export command exports the definition information of a business group or business groups to the specified file as a business group definition file. This command can also generate the template file for business group definition files, rather than the business group definition file that contains the current definition information.
An exported business group definition file can be specified in the jpcconf bgdef import command as an input file.
Hosts that can execute the command
PFM - Manager
Execution permission
- In Windows:
-
User with Administrators permissions
- In UNIX:
-
User with root user permissions
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pc/tools/
Arguments
-f business-group-definition-file-name
Specifies the name of the business group definition file to be exported. You can specify either a relative path or absolute path for the file.
The string you specify can have double-byte characters, single-byte alphanumeric characters, single-byte spaces, and the following single-byte symbols:
% - ( ) _ / @ [ ]
If the string that you want to specify contains single-byte spaces, enclose the entire string in double quotation marks ("). Note that you might need to add escape characters when specifying single-byte symbols.
-group business-group-name
Specifies the name of the business group for which definition information is to be exported.
For business-group-name, specify a string of 1 to 255 bytes, consisting of double-byte characters, single-byte characters, and the symbols below. Alphabetic characters are case sensitive.
! " # $ % & ' ( ) + - . : ; < = > @ [ \ ] ^ _ ` { | } ~
If the string that you want to specify contains single-byte spaces, enclose the entire string in double quotation marks ("). Note that you might need to add escape characters when specifying single-byte symbols.
You can use wildcard characters to specify multiple business group names.
-lhost logical-host-name
Specifies the logical host name of the host on which this command is executed. For logical-host-name, specify a string of 1 to 32 bytes, consisting of single-byte alphanumeric characters. If this option is omitted, the command will be executed on the physical host.
Note, however, that you do not need to specify this option even when the host on which this command is executed belongs to a logical host if the -template option is specified.
-template
Specify this option to generate the template file for business group definition files. In the template file, all lines are commented out with hash marks (#). Edit this file according to your needs.
-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 business group definition file specified for the -f option already exists, that file will be overwritten by the new file.
-skip
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 business group definition file specified for the -f option already exists, the command skips the updating of the file.
Format of business group definition files
See Format of business group definition files in the description of the jpcconf bgdef import command.
Note that although the generated template file includes all label names, any exported business group definition file includes only the names of labels whose values exist in the business group definition information.
Notes
-
PFM - Manager must be running when you execute this command except when you specify the -template option.
-
Access control by business group must be enabled when you execute this command except when you specify the -template option.
-
The value of the LANG environment variable for the shell that is used to execute the command determines the encoding of the business group definition file and the Business Group Definition File Code label's value in that file. If the business group definitions that you want to export include non-ASCII characters, make sure that the value of the relevant LANG environment variable is appropriate before you execute this command.
The tables below describe, for each OS, the encoding of the file and the value of the Business Group Definition File Code label for each value of the LANG environment variable
If the value of the LANG environment variable is not shown in the tables below, the command assumes that the LANG environment variable is set to C.
Table 2‒15: Correspondence between the value of the LANG environment variable, the character encoding, and the value of the Business Group Definition File Code label (Windows) Language
Value of the LANG environment variable
Character encoding
Value of the Business Group Definition File Code label
Japanese
--
Shift_JIS (SJIS)
Shift_JIS
English
--
ASCII
C
Chinese (Simplified)
--
GB18030
GB18030
Table 2‒16: Correspondence between the value of the LANG environment variable, the character encoding, and the value of the Business Group Definition File Code label (AIX) Language
Value of the LANG environment variable
Character encoding
Value of the Business Group Definition File Code label
Japanese
-
ja_JP
-
ja_JP.IBM-eucJP
EUC
EUC-JP
-
Ja_JP
-
Ja_JP.IBM-932
Shift_JIS (SJIS)
Shift_JIS
-
JA_JP.UTF-8
UTF-8
UTF-8
English
-
C
ASCII
C
Chinese (Simplified)
-
Zh_CN
-
Zh_CN.GB18030
GB18030
GB18030
-
ZH_CN
-
ZH_CN.UTF-8
UTF-8
UTF-8
Table 2‒17: Correspondence between the value of the LANG environment variable, the character encoding, and the value of the Business Group Definition File Code label (Linux) Language
Value of the LANG environment variable
Character encoding
Value of the Business Group Definition File Code label
Japanese
-
ja_JP.SJIS#
-
ja_JP.sjis#
Shift_JIS (SJIS)
Shift_JIS
-
ja_JP.UTF-8
-
ja_JP.utf8
UTF-8
UTF-8
English
-
C
ASCII
C
Chinese (Simplified)
-
zh_CN.gb18030
GB18030
GB18030
-
zh_CN.UTF-8
-
zh.CN.utf8
UTF-8
UTF-8
-
Return values
0 |
The command terminated normally. |
1 |
An argument specification is invalid. |
2 |
The user does not have execution permission for the command. |
4 |
A startup or termination command, or other setup command, has been executed on the same machine. |
5 |
The command was executed on a host that was not the PFM - Manager host. |
6 |
One or more specified business groups do not exist. |
11 |
Processing was interrupted by a user or the system. |
100 |
The Performance Management environment is invalid. |
101 |
A service that is prerequisite for executing this command is not running (when the -template option is not specified). |
102 |
The specified logical host has not been set up. |
200 |
A memory shortage occurred. |
211 |
A file or directory cannot be accessed. |
254 |
Access control by business group is disabled (when the -template option is not specified). |
255 |
An unexpected error occurred. |
Usage example 1
This example exports the definition information for business group groupA.
#jpcconf bgdef export -f C:\tmp\bgdef.cfg -group groupA
Usage example 2
This example generates the template file for business group definition files.
#jpcconf bgdef export -f C:\tmp\bgdef.cfg -template