jpcconf bgdef check
- Organization of this page
Format
jpcconf bgdef check {-f business-group-definition-file-name [-lhost logical-host-name | -syntax] | -im directory-name}
Function
The jpcconf bgdef check command checks the contents of the business group definition file. This command checks the following items:
-
Whether there are syntax errors
-
Whether there are already business groups with the same names as specified business groups
-
Whether specified hosts already belong to other business groups in the Performance Management system
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 checked. 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.
-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 -syntax or -im option is specified.
-syntax
Specify this option to check only for syntax errors.
-im directory-name
Specify this option to check 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 was executed to output the business group definition information in JP1/IM 10-00 or later. If the -im option is specified, the command checks only for syntax errors.
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 (").
Format of business group definition files
See Format of business group definition files in the description of the jpcconf bgdef import command.
Notes
-
PFM - Manager must be running when you execute this command except when you specify the -syntax or -im option.
-
Access control by business group must be enabled when you execute this command except when you specify the -syntax or -im option.
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 |
The business group definition file contains errors. |
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 -syntax or -im 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 -syntax or -im option is not specified). |
255 |
An unexpected error occurred. |
Usage example
This example checks a business group definition file.
#jpcconf bgdef check -f C:\tmp\bgdef.cfg