18.2.1 lb.properties (load balancer definition property file)

Organization of this subsection

(1) Format
(2) File location
(3) Functionality
(4) Keys that can be specified
(5) Specification example
(6) Notes

(1) Format

Java property format

To Page Top

(2) File location

In Windows

Cosminexus-installation-directory\manager\config
In UNIX

/opt/Cosminexus/manager/config

To Page Top

(3) Functionality

This file configures connection information necessary to access the load balancer. It is used to control the load balancer from Cosminexus.

To Page Top

(4) Keys that can be specified

The following table shows the keys that can be specified for load balancers that employ API-based direct connections, along with their defaults.

Key name	Description	Default
`lb.list`	Specify the management IP address of the load balancer using dot notation (xxx.xxx.xxx.xxx), where `xxx` is an integer from `0` to `255`. If more than one load balancer is used, separate each of the management IP addresses by a comma (`,`).	None
`lb.connect_type.IP-address`^#1#2	Specify the connection condition for the load balancer. Specify `API`. If this is omitted, `jp1_nc` (indicating compatibility with older VRs) is set.	`jp1_nc`
`lb.enable_passwd.IP-address`	Specify the password necessary for the Privileged EXEC level set for the load balancer. This setting is required for each load balancer. Specify this property if ACOS is used.	None
`lb.API.user.IP-address`	Specify the user name used to log into the load balancer via the API.	None
`lb.API.passwd.IP-address`	Specify the user password used to log into the load balancer via the API.	None
`lb.API.port.IP-address`	Specify the port number for the load balancer. The value that can be specified is an integer from `1` to `65534`. If the specified value is out of the range, the default value is set.	`443`
`lb.API.cookie_persistence_template.Web-system-name.IP-address`	Specify the cookie persistence template name created on the load balancer.	None
`lb.API.timeout.IP-address`	Specify the timeout period (in seconds) for API method execution. If an API method is not completed within the period specified in this key, Smart Composer functionality commands (such as `cmx_build_system`) will end abnormally due to a timeout error. The value that can be specified is an integer from `1` and `2147483`. If the specified value is out of the range, the default value is set.	`10`
`lb.API.protocol.IP-address`	Specify the protocol to be used for communication with the load balancer. `http`: Uses the HTTP communication protocol. `https`: Uses the HTTPS communication protocol.	`https`
`javax.net.ssl.trustStore`	If API is specified as the connection condition for the load balancer, specify the trust store where the server certificate for the load balancer is registered. Specify the trust store in accordance with the Java specifications.	cacerts (Default trust store for JDK)
`javax.net.ssl.trustStorePassword`	If API is specified as the connection condition for the load balancer, specify the password for the trust store where the server certificate for the load balancer is registered. Specify the trust store in accordance with the Java specifications.	cacerts (The default key store trusted by Java is used.)

#1: Specify the management IP address of the load balancer specified in lb.list.

#2: If the specified value is invalid and a cmx_test_lb, cmx_build_system, cmx_delete_system, cmx_start_target, or cmx_stop_target command is executed, an error will occur.

To Page Top

(5) Specification example

lb.list=192.168.10.100
lb.enable_passwd.192.168.10.100=adminpw
 
lb.connect_type.192.168.10.100=API
lb.API.user.192.168.10.100=user01
lb.API.passwd.192.168.10.100=user01pw
#lb.API.port.192.168.10.100=443
#lb.API.cookie_persistence_template.MyWebSystem.192.168.10.100=SC_COOKIE_TEMPNAME
#lb.API.timeout.192.168.10.100=10
javax.net.ssl.trustStore=C:\\work\\ACOS.keystore
javax.net.ssl.trustStorePassword=keystore_pass

To Page Top

(6) Notes

This file contains password and other information. Set appropriate access permissions for the file.
If the configuration file is updated while Management Server is running, the updated information is incorporated the next time Management Server is restarted.
If the file is updated, or if the connection configuration between the Management Server machine and load balancer is changed, use the cmx_test_lb command to check the connection to 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 are unable to connect to the load balancer, use the messages output by the cmx_test_lb command to check the configuration of the load balancer and the specified contents of the load balancer definition (<load-balancer> tag definition) in the Easy Setup definition file. For details about how to configure load balancers, see 8.5 Load balancer connection information setup with Management Server (Smart Composer functionality). For details about load balancer definitions (<load-balancer> tag definitions) in the Easy Setup definition file, see 4.7.5 Setting up environment for connecting to the load balancer in the uCosminexus Application Server System Setup and Operation Guide.

To Page Top