jbsrt_distrib
- Organization of this page
Function
The jbsrt_distrib command is executed on a manager host (i.e. host on which JP1/IM - Manager is installed).
This command distributes information defined in the configuration definition file from the host on which the command is executed to lower-level hosts, and then the definitions are enabled.
The two methods for distributing configuration definition information are the batch distribution method and the differential distribution method.
When this command is executed, JP1/Base must be running on all hosts to which the configuration definition is to be distributed (on the hosts whose configuration definition is to be changed and all of their higher hosts when a differential distribution method is used). If JP1/Base has not started yet on a target host, the configuration definition will not be distributed to the host. If this happens, a message is displayed during command execution, notifying you that the configuration information cannot be set. By continuing the process, the configuration definition is distributed to other hosts on which JP1/Base has started. To distribute the configuration information to a host to which the definition could not be distributed, start JP1/Base on the host, and then re-execute the jbsrt_distrib command to distribute the definition. If you are using the batch distribution method, enter N when a message asking you to delete configuration information is displayed. This completes the distribution of the configuration definition in the entire system.
The following configuration definition file is referenced by this command:
- In Windows:
-
installation-folder\conf\route\jbs_route.conf
shared-folder\jp1base\conf\route\jbs_route.conf (when the -h option is specified)
- In UNIX:
-
/etc/opt/jp1base/conf/route/jbs_route.conf
shared-directory/jp1base/conf/route/jbs_route.conf (when the -h option is specified)
For details on the format of the configuration definition file, see Configuration definition file in 16. Definition Files.
Format
- Common definition (JBSRT_DISTRIB_VERSION=0):
jbsrt_distrib [{-D [-f] | -L}] [-h logical-host-name]
- Common definition (JBSRT_DISTRIB_VERSION=1):
jbsrt_distrib [{-D [-f] | -L | -f}] [-h logical-host-name]
Required execution permission
In Windows: Administrators (If User Account Control (UAC) for Windows is enabled, you must execute the command from the administrator console.)
In UNIX: Superuser or JP1/Base administrator permission
Command directory
- In Windows:
-
installation-folder\bin\
- In UNIX:
-
/opt/jp1base/bin/
Arguments
-D
Specify this argument to distribute the configuration definition information by using the differential distribution method. This method deletes configuration definition information from or distributes configuration definition information to only hosts for which changes have been made in the configuration definition. If you omit this option, the value set for JBSRT_DISTRIB_VERSION in the common definition information takes effect.
-L
Specify this argument to distribute the configuration definition information by using the batch distribution method. This method deletes configuration definition information from or distributes configuration definition information to all hosts in the configuration definition information. If you omit this option, the value set for JBSRT_DISTRIB_VERSION in the common definition information takes effect.
-f
Specify this argument if you do not want a message confirming command execution (a message asking you to enter Y or N) to be output. If you specify this option, the message confirming command execution is omitted, the value Y is assumed, and processing continues. If you omit this option, a message confirming command execution will be displayed.
-h logical-host-name
When using JP1/Base in a cluster system, specify the logical host for which you will execute the command. If you omit this option, the host name set in the environment variable JP1_HOSTNAME is assumed. If the environment variable JP1_HOSTNAME is not set, the physical host name is assumed. There is no need to specify this argument unless you are running a cluster system.
Environment variables
JBSRT_CMDRCD_EXTEND
This environment variable expands the set of values that can be returned by the command. To use the expanded set of return values, specify 1. To use the original (unexpanded) set of return values, specify 0. If you omit this environment variable, the command will return a value from the original set of return values.
Note
-
When you execute this command to delete configuration definition information, the configuration definition information after a host with an asterisk (*), if any, in the configuration definition file will not be deleted. If you want to delete the existing configuration definition information, confirm that there is no asterisk (*) in the configuration definition file.
-
If you are using the IM configuration management and execute this command, configuration definition information will be different in the IM configuration management and in JP1/Base. Therefore, if you are using the IM configuration management, we recommend that you do not execute this command, and instead use the IM configuration management to perform integrated configuration management. For details, see the chapter that explains management of hierarchical structure of a system using the IM configuration management in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.
-
If the batch distribution method is used to distribute configuration definition information and configuration information is deleted while the system is running, the following problems might occur between the time when the information was deleted and the time when distribution finishes:
-
An event transfer might fail.
-
Command execution might fail.
-
Automatic action execution might fail.
When a management-target host is added but no hosts are deleted, follow the procedure below to distribute the configuration files without deleting any configuration information. The following procedure allows you to change the system configuration without affecting the existing configuration information.
-
If the message Delete the current configuration definition? is output, enter N.
-
If the message Distribute the configuration definition? is output, enter Y.
-
-
If your JP1/IM - Manager version is 11-01 or earlier, do not set the JBSRT_CMDRCD_EXTEND environment variable as a system environment variable or a user environment variable. If you do, you might not be able to use IM Configuration Management to configure the system hierarchy. Instead, use the command prompt or a batch file to set the JBSRT_CMDRCD_EXTEND environment variable.
-
When distributing configuration definition to many hosts (roughly 1,000 or more hosts) at a time, it may take a long time to complete the command execution if many errors occur during the distribution process. We recommend, therefore, that you use the differential distribution method to distribute it to a group of several hundred to 500 hosts at a time.
-
When operating under a system hierarchical configuration with three or more levels, the processes of hosts under a submanager may take too much time and fail to properly return a response. Hence, the jbsrt_distrib command may result in timeout. For details, see 2.6.3 (5) Reviewing the communication timeout value.
Return values (original set)
0 |
Normal end |
1 |
Abnormal end |
Return values (expanded set)
0 |
Normal end |
1 |
Distribution or deletion of the configuration definition information failed on some hosts. |
2 |
Configuration management server processing is being performed. |
3 |
The command timed out. |
10 |
Invalid argument |
11 |
Permission error |
13 |
A configuration definition information access error occurred, or the configuration definition information is corrupted. |
14 |
Definition file access error |
15 |
Definition file format error |
16 |
An error occurred during communication with the configuration management server. |
20 |
Insufficient memory |
128 |
Other error |
Example
The examples below show the command with the -f option specified and the command with the -f option omitted.
- With the -f option specified:
# jbsrt_distrib -D -f Sending the configuration definition... KAVB3109-I The definition distribution command terminated normally.
- With the -f option omitted:
# jbsrt_distrib -D All hosts to which the configuration definition is to be distributed must be running. Do you want to distribute the configuration definition? [Y/N] y Sending the configuration definition... KAVB3109-I The definition distribution command terminated normally.
The following example shows how to expand the set of values returned by the command:
# set JBSRT_CMDRCD_EXTEND=1 # jbsrt_distrib