jpcconf bgdef import

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Format of business group definition files
Notes
Return values
Usage example 1
Usage example 2

Format

jpcconf bgdef import     {-f business-group-definition-file-name
                         [-noquery | -skip] | -im directory-name}
                         [-lhost logical-host-name]

To Page Top

Function

The jpcconf bgdef import command imports business group definition information from the specified file, and defines business groups with the imported information.

To Page Top

Hosts that can execute the command

PFM - Manager

To Page Top

Execution permission

In Windows:: User with Administrators permissions
In UNIX:: User with root user permissions

To Page Top

Installation directory

In Windows:: installation-folder\tools\
In UNIX:: /opt/jp1pc/tools/

To Page Top

Arguments

`-f` `business-group-definition-file-name`

Specifies the name of the business group definition file to be imported. 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.

`-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 business groups whose names are specified in the file have already been created, the definition information of these business groups will be updated. If business groups whose names are specified in the file have not been created, the definition information of these business groups will be created.

`-skip`

If business groups whose names are specified in the file have already been created, the definition information of these business groups will not be updated. The business groups that have not been created yet will not be created, either.

`-im` `directory-name`

Specify this option to import the business groups defined in JP1/IM. For directory-name, specify the output destination directory name that was specified for the -o option when the jcfexport command (with the -a or -g option specified) was executed to output the business group definition information in JP1/IM 10-00 or later.

You can specify either a relative path or absolute path of the directory. Note that if the string that you want to specify contains single-byte spaces, enclose the entire string in double quotation marks (").

`-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.

To Page Top

Format of business group definition files

The format of business group definition files is described below. Lines in this file can be commented out by prefixing a hash mark (#) to them.

The template file for business group definition files can be generated by executing the jpcconf bgdef export command with the -template option. The template file is useful when you create your business group definition file.

Items that can be specified

Business Group Definition File Version label

Specifies the version of the business group definition file. This label must be specified at the beginning of the file.

Table 3‒16: Business Group Definition File Version label
Item	Description
Description	The version of the business group definition file
Specifiable value	`0001`
Omissible	No

Business Group Definition File Code label

Specifies the encoding of the business group definition file. This label must immediately follow the Business Group Definition File Version label.

Table 3‒17: Business Group Definition File Code label
Item	Description
Description	Encoding of the business group definition file
Specifiable value	One of the following values can be specified according to the characters contained in the file: Shift_JIS Specify this value if the file contains double-byte Shift-JIS characters and single-byte ASCII characters. EUC-JP Specify this value if the file contains double-byte EUC characters and single-byte ASCII characters. UTF-8 Specify this value if the file contains double-byte UTF-8 characters and single-byte ASCII characters. C Specify this value if the file contains single-byte ASCII characters. GB18030 Specify this value if the file contains double-byte GB18030 characters and single-byte ASCII characters. Do not add the byte order mark (BOM) when you use the UTF-8 encoding. If you do so, an error occurs.
Omissible	No

Business Group Data section

Specifies the definition of a business group. To define multiple business groups, create a Business Group Data section and specify a definition for each business group. At least one Business Group Data section must be specified.

Table 3‒18: Business Group Name label
Item	Description
Description	The name of a business group
Specifiable value	You can specify a string of 1 to 255 bytes, consisting of double-byte characters, single-byte characters, and the following symbols: ! " # $ % & ' ( ) + - . : ; < = > @ [ \ ] ^ _ ` { \| } ~ Alphabetic characters are case sensitive. Heading and trailing single-byte spaces are ignored. If the string that you want to specify contains single-byte spaces, enclose the entire string in double quotation marks (`"`). If you specify double-byte characters, make sure that you use the same encoding that is specified for the `Business` `Group` `Definition` `File` `Code` label.
Omissible	No

Table 3‒19: JP1 Resource Group Name label
Item	Description
Description	The name of a JP1 resource group Note: You do not need to specify this label if the user account is authenticated in PFM authentication mode. If you specify this label in PFM authentication mode, the specification is ignored. However, if the label is specified in an incorrect format, an error occurs.
Specifiable value	You can specify a string of 1 to 64 bytes, consisting of single-byte alphanumeric characters and the following single-byte symbols: ! # $ % & ' ( ) * - . @ \ ^ _ ` { } ~ Note that you cannot specify the following strings: The string `JP1_PFM` An asterisk (`*`) Alphabetic characters are case sensitive. Heading and trailing single-byte spaces are ignored.
Omissible	Yes

Table 3‒20: Host Name label
Item	Description
Description	The names of hosts that belong to a business group
Specifiable value	You can specify a string of 1 to 128 bytes, consisting of single-byte alphanumeric characters and the following single-byte symbols: ! $ + - @ [ ] _ ` { } ~ Note that you cannot specify the following strings: The string `localhost` (regardless of the case) Any string in IP address format Any string that begins with a hyphen (`-`) Alphabetic characters are case sensitive. Heading and trailing single-byte spaces are ignored. To specify two or more host names, use commas (`,`) to separate them. Single-byte spaces before and after a comma (`,`) are ignored. Do not add a comma (`,`) at the end of the last entry. If you do so, an error occurs. Note that a host cannot belong to two or more business groups. Specify hosts that do not belong to any business groups in the Performance Management system.
Omissible	Yes

The following shows an example of specifying settings in a business group definition file.

Example of specifying settings in a business group definition file:

Business Group Definition File Version=0001
Business Group Definition File Code=EUC-JP
 
[Business Group Data]
Business Group Name=Group A
JP1 Resource Group Name=resourceA
Host Name=win01,win02,win03
 
[Business Group Data]
Business Group Name=Group B
JP1 Resource Group Name=resourceB
Host Name=sun01,sun02,sun03
 
[Business Group Data]
Business Group Name=Group C
JP1 Resource Group Name=resourceC
Host Name=win04

To Page Top

Notes

You can execute this command only when PFM - Manager is running.
If multiple business groups are defined in the specified business group definition file, the definition information of these business groups is collectively imported. If the file contains at least one error, importing of definition information for all business groups will be canceled.
When performing multiple monitoring, you cannot execute this command from the secondary PFM - Manager host.

To Page Top

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. Or else, an attempt was made to execute the command from the secondary PFM - Manager host when multiple monitoring is performed.
6	The business group definition file contains errors.
100	The Performance Management environment is invalid.
101	A service that is prerequisite for executing this command is not running.
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.
255	An unexpected error occurred.

To Page Top

Usage example 1

This example imports a business group definition file.

jpcconf bgdef import -f C:\tmp\bgdef.cfg

To Page Top

Usage example 2

This example imports the business groups that are defined in JP1/IM.

jpcconf bgdef import -im C:\tmp

To Page Top