Hitachi

JP1 Version 12 JP1/Performance Management Reference


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

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