4.2.4 lb.properties (load balancer definition properties file)
- Organization of this subsection
(1) Format
This file is in the Java properties format.
(2) File storage location
-
In Windows
Cosminexus-installation-directory\manager\config
-
In UNIX
/opt/Cosminexus/manager/config
(3) Functionality
This file is used to set connection information needed for accessing the load balancer. You use this file to control the load balancer from Cosminexus.
(4) Specifiable keys
The specifiable keys and default values are described below. Note that which keys can be specified depends on the load balancer control method. For keys that can be set by using the load balancer, which uses direct connection with the use of API, see 18.2.1 lb.properties (load balancer definition property file) in the uCosminexus Application Server Security Management Guide.
Key name |
Contents |
Default |
---|---|---|
lb.list |
Sets the load balancer's management IP address in dot notation (xxx.xxx.xxx.xxx), where xxx is an integer in the range from 0 to 255. If multiple load balancers are used, set multiple management IPs separated by commas. |
None |
lb.connect_type.IP-address#1#2 |
Sets the load balancer connection type.
If nothing is specified, jp1_nc (old VR-compatible) is assumed. |
jp1_nc |
lb.enable_passwd.IP-address |
Sets the password required for the Privileged EXEC level set in the load balancer for each load balancer. Note that this property is set in ACOS. |
None |
lb.ssh.port.IP-address#1 |
Sets the load balancer's ssh server port number, as an integer in the range from 1 to 65535. |
22 |
lb.ssh.user.IP-address#1 |
Sets the user name to be used to connect to the load balancer with ssh. |
None |
lb.ssh.passwd.IP-address#1 |
Sets the user password to be used to connect to the load balancer with ssh. |
None |
lb.ssh.timeout.IP-address#1#2 |
Sets the timeout value (in seconds) for when the ssh command is executed for the load balancer. If the process of connecting to the load balancer is not completed within the time set in this key, the Smart Composer functionality command (cmx_build_system, etc) terminates abnormally with a timeout error. Specify an integer in the range from 1 to 2147483. |
10 |
lb.telnet.command_timeout.IP-address |
Sets the timeout value (in seconds) for sending commands to the load balancer. If the CLI command issued for the load balancer is not completed within the time set in this key, commands of the Smart Composer functionality (cmx_build_system, etc) terminates abnormally with a timeout error. Specify an integer in the range from 1 to 2147483. |
10 |
lb.telnet.login_prompt.IP-address |
Sets the character string to be displayed in the prompt after the login when connecting to the load balancer. To specify spaces at the end, enclose the character string within "" (double quotation mark). |
None |
lb.telnet.login_timeout.IP-address |
Sets the timeout value (in seconds) for the login process when connecting to the load balancer. If the process of connecting to the load balancer is not completed within the time set in this key, the Smart Composer functionality (cmx_build_system, etc) command terminates abnormally with a timeout error. Specify an integer in the range from 1 to 2147483. |
10 |
lb.telnet.passwd.IP-address |
Sets the user password for logging in to the load balancer using Telnet. |
None |
lb.telnet.passwd_prompt.IP-address |
Sets the character string appearing in the password input prompt when connecting to the load balancer. To specify spaces at the end, enclose the character string within "" (double quotation mark). |
None |
lb.telnet.port.IP-address |
Sets the port number of the load balancer. Specify an integer in the range from 1 to 65535. |
23 |
lb.telnet.user.IP-address |
Sets the user name for logging in to the load balancer using Telnet. |
None |
lb.telnet.user_prompt.IP-address |
Sets the character string appearing in the user name input prompt when connecting to the load balancer. To specify spaces at the end, enclose the character string within "" (double quotation mark). |
None |
- #1
-
Specify the management IP address of the load balancer that was specified in lb.list.
- #2
-
If an invalid value is specified, the cmx_test_lb, cmx_build_system, cmx_delete_system, cmx_start_target, and cmx_stop_target commands will result in an error.
(5) Examples of coding
lb.list=192.168.1.100 lb.enable_passwd.192.168.1.100=adminpw lb.connect_type.192.168.1.100=telnet #lb.telnet.port.192.168.1.100=23 lb.telnet.user.192.168.1.100=user01 lb.telnet.passwd.192.168.1.100=user01pw lb.telnet.user_prompt.192.168.1.100="AX login: " lb.telnet.passwd_prompt.192.168.1.100="Password: " lb.telnet.login_prompt.192.168.1.100=> #lb.telnet.login_timeout.192.168.1.100=10 #lb.telnet.command_timeout.192.168.1.100=10
(6) Precautions
-
You must set appropriate access permissions for this file, because the file contains sensitive information such as passwords.
-
If a parameter is missing or invalid, the default value is assumed.
-
If the settings file is updated while the Management Server is running, the updated information is not applied until the next time the Management Server is started.
-
If this file is updated or the settings of the connection between the Management Server machine and load balancer is changed, use the cmx_test_lb command for checking the connection with the load balancer. For details about the cmx_test_lb command, see 8. Commands Used with the Smart Composer Functionality in the uCosminexus Application Server Command Reference Guide. If you cannot connect to the load balancer, check the load balancer settings and the definition (definition of the <load-balancer> tag) of load balancers in the Easy Setup definition file based on the cmx_test_lb command output message. For details about the load balancer settings and the definition (definition of the <load-balancer> tag) of load balancers in the Easy Setup definition file, see 4.7.5 Setting environment for connecting to load balancer in the uCosminexus Application Server Virtual System Setup and Operation Guide.