J.2 CLI commands of the load balancer executed by Smart Composer functionality
This section describes the CLI commands of the load balancer for each product that are executed by the Smart Composer functionality. For details on CLI commands of load balancer, see the documents of the product in use.
- Organization of this subsection
(1) For AX2000 or BS320
For AX2000 or BS320, you can use direct connections using the telnet protocol as a connection method of the load balancer.
The following table describes the CLI commands of the load balancer that are executed by the Smart Composer functionality, when using ACOS (AX2000 or BS320) as a load balancer. For details on the CLI commands of ACOS, see the documents of the product in use.
|
Smart Composer functionality commands |
CLI commands of load balancer |
|
|---|---|---|
|
Common |
enable config show version exit |
|
|
cmx_build_system (when configuring a Web system) |
Without cookie switching#1 |
slb server real-server-name real-server-IP-address port real-port tcp |
|
slb service-group virtual-server-name tcp member real-server-name:real-port disable |
||
|
slb virtual-server virtual-server-name virtual-server-IP-address port virtual-port http service-group virtual-server-name |
||
|
write memory |
||
|
With cookie switching#1 |
slb server real-server-name real-server-IP-address port real-port tcp |
|
|
slb service-group virtual-server-name tcp |
||
|
member real-server-name:real-port disable |
||
|
slb template persist cookie virtual-server-name name cookie-name expire 0 |
||
|
slb virtual-server virtual-server-name virtual-server-IP-address port virtual-port http service-group virtual-server-name template persist cookie virtual-server-name |
||
|
write memory |
||
|
cmx_build_system (when performing scale out) |
slb server real-server-name real-server-IP-address port real-port tcp |
|
|
slb service-group virtual-server-name tcp member real-server-name:real-port disable |
||
|
write memory |
||
|
cmx_build_system (when changing the real port) |
slb server real-server-name real-server-IP-address port real-port-after-change tcp exit no port real-port tcp |
|
|
slb service-group virtual-server-name tcp member real-server-name:real-port-after-change disable |
||
|
write memory |
||
|
cmx_delete_system (when deleting the service unit)#2 |
slb server real-server-name real-server-IP-address no port real-port tcp |
|
|
write memory |
||
|
cmx_delete_system (when performing scale in of the host unit model)#3 |
no slb server real-server-name |
|
|
write memory |
||
|
cmx_delete_system (when deleting a Web system) |
Without cookie switching |
no slb virtual-server virtual-server-name |
|
no slb service-group virtual-server-name |
||
|
no slb server real-server-name |
||
|
write memory |
||
|
With cookie switching |
no slb virtual-server virtual-server-name |
|
|
no slb service-group virtual-server-name |
||
|
no slb server real-server-name |
||
|
no slb template persist cookie virtual-server-name |
||
|
write memory |
||
|
cmx_start_target |
slb service-group virtual-server-name tcp member real-server-name:real-port enable |
|
|
write memory |
||
|
cmx_stop_target |
slb service-group virtual-server-name tcp member real-server-name:real-port disable |
|
|
write memory |
||
- #1
-
Execute the same CLI commands even if the virtual server is not initialized (when you specify -lb keepvs).
- #2
-
If there is another service unit shared by the real server, do not execute the deletion for each server.
- #3
-
If there is no other service unit shared by the real server, perform deletion for each server.
- Reference note
-
For ACOS, use the virtual server name as the service group name and the template name.
(2) For BIG-IP v9, BIG-IP v10.1, or BIG-IP v10.2
For BIG-IP v9, BIG-IP v10.1, or BIG-IP v10.2, you can use direct connections that use the ssh protocol as a connection method for the load balancer. Note that for version 09-00 or later version, you can use direct connections that use APIs as connection methods of the load balancer.
If you directly connect by using the ssh protocol, you must set the client environment of the ssh on the host for deploying Management Server. The following points describe how to setup the ssh client environment for each OS:
-
For Windows
You must have the ssh client program on the host for deploying Management Server. The available ssh client program is the CLI commands of PuTTY. Obtain PuTTY beforehand and then install. Also, add the folder under the PuTTY installation folder that stores the plink command, to the system environment variable PATH. You can download PuTTY from the applicable page (http://www.chiark.greenend.org.uk/~sgtatham/putty/).
-
For UNIX
When you use the ssh command for the first time, execute the query request of the connection confirmation.
Connect to the load balancer by executing the ssh command, with the user having root permission and respond yes for the query request (Are you sure you want to continue connecting (yes/no)? of the connection confirmation. When replying with yes, the ssh command can no longer execute the query request of the connection confirmation.
- Important note
-
In AIX, if you select the direct usage of ssh as the connection configuration with the load balancer, the ssh command is required. Obtain the software required for using the ssh command in advance.
The following points describe the CLI commands of BIG-IP executed by the Smart Composer functionality for each product. For details on CLI commands of BIG-IP, reference the documents of the product in use.
(a) For BIG-IP v9 or BIG-IP v10.1
The following table describes the CLI commands of the load balancer that are executed by the Smart Composer functionality, when using BIG-IP v9 or BIG-IP v10.1 as a load balancer:
|
Smart Composer functionality commands |
CLI commands of load balancer to be executed |
|
|---|---|---|
|
Common |
b save b version |
|
|
cmx_build_system (when configuring a Web system) |
Without cookie switching |
b pool virtual-server-name {member real-server-IP-address: real-port} |
|
b pool virtual-server-name member real-server-IP-address : real-port add |
||
|
b pool virtual-server-name member real-server-IP-address : real-port session disable |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address: virtual-port pool virtual-server-name profile http enable} |
||
|
With cookie switching |
b pool virtual-server-name {member real-server-IP-address : real-port} |
|
|
b pool virtual-server-name member real-server-IP-address : real-port add |
||
|
b pool virtual-server-name member real-server-IP-address: real-port session disable |
||
|
b profile persist virtual-server-name {mode cookie cookie mode insert cookie name cookie-name} |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address:virtual-port pool virtual-server-name profile http persist virtual-server-name enable} |
||
|
cmx_build_system (when performing scale out) |
b pool virtual-server-name member real-server-IP-address : real-port add |
|
|
b pool virtual-server-name member real-server-IP-address : real-port session disable |
||
|
cmx_build_system (when changing the real port) |
b pool virtual-server-name member real-server-IP-address: real-port-after-change add |
|
|
b pool virtual-server-name member real-server-IP-address: real-port-after-modification session disable |
||
|
b pool virtual-server-name member real-server-IP-address : real-port delete |
||
|
cmx_build_system (when configuring a Web system without installing a virtual server of the load balancer) |
Without cookie switching |
b pool virtual-server-name member real-server-IP-address : real-port add |
|
b pool virtual-server-name member real-server-IP-address : real-port session disable |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address: virtual-port pool virtual-server-name profile http enable} |
||
|
With cookie switching |
b pool virtual-server-name member real-server-IP-address : real-port add |
|
|
b pool virtual-server-name member real-server-IP-address : real-port session disable |
||
|
b profile persist virtual-server-name {mode cookie cookie mode insert cookie name cookie-name} |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address : virtual-port pool virtual-server-name profile http persist virtual-server-name enable} |
||
|
cmx_delete_system (when deleting service units, and performing scale in of the host unit management model) |
b pool virtual-server-name member real-server-IP-address :real-port delete |
|
|
b node real-server-IP-address delete |
||
|
cmx_delete_system (when deleting a Web system) |
Without cookie switching |
b virtual virtual-server-name delete |
|
b pool virtual-server-name delete |
||
|
b node real-server-IP-address delete |
||
|
With cookie switching |
b virtual virtual-server-name delete |
|
|
b pool virtual-server-name delete |
||
|
b node real-server-IP-address delete |
||
|
b profile persist virtual-server-name delete |
||
|
cmx_start_target |
b pool virtual-server-name member real-server-IP-address : real-port session enable |
|
|
cmx_stop_target |
b pool virtual-server-name member real-server-IP-address : real-port session disable |
|
- Reference note
-
For BIG-IP v9 and BIG-IP v10.1, use the virtual server name as the pool name.
(b) For BIG-IP v10.2
The following table describes the CLI commands of the load balancer that are executed by the Smart Composer functionality when using BIG-IP v10.2 as a load balancer.
|
Smart Composer functionality commands |
CLI commands of load balancer to be executed |
|
|---|---|---|
|
Common |
b save b version |
|
|
cmx_build_system (when configuring a Web system) |
Without cookie switching |
b pool virtual-server-name {member real-server-IP-address : real-port } |
|
b pool virtual-server-name member real-server-IP-address : real-port add |
||
|
b pool virtual-server-name member real-server-IP-address : real-port session user disabled |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address :virtual-port pool virtual-server-name profile http enable} |
||
|
With cookie switching |
b pool virtual-server-name {member real-server-IP-address :real-port } |
|
|
b pool virtual-server-name member real-server-IP-address : real-port add |
||
|
b pool virtual-server-name member real-server-IP-address : real-port session user disabled |
||
|
b profile persist virtual-server-name {mode cookie cookie mode insert cookie name cookie-name} |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address :virtual-port pool virtual-server-name profile http persist virtual-server-name enable} |
||
|
cmx_build_system (when performing scale out) |
b pool virtual-server-name member real-server-IP-address: real-port add |
|
|
b pool virtual-server-name member real-server-IP-address : real-port session user disabled |
||
|
cmx_build_system (when changing the real port) |
b pool virtual-server-name member real-server-IP-address : real-port-after-change add |
|
|
b pool virtual-server-name member real-server-IP-address : real-port-after-change session user disabled |
||
|
b pool virtual-server-name member real-server-IP-address : real-port delete |
||
|
cmx_build_system (when configuring a Web system without installing a virtual server of the load balancer) |
Without cookie switching |
b pool virtual-server-name member real-server-IP-address : real-port add |
|
b pool virtual-server-name member real-server-IP-address :real-port session user disabled |
||
|
b virtual virtual-server-name {destination < virtual-server-IP-address :virtual-port pool virtual-server-name profile http enable} |
||
|
With cookie switching |
b pool virtual-server-name member real-server-IP-address : real-port add |
|
|
b pool virtual-server-name member real-server-IP-address :<real-port session user disabled |
||
|
b profile persist virtual-server-name {mode cookie cookie mode insert cookie name cookie-name} |
||
|
b virtual virtual-server-name {destination virtual-server-IP-address:virtual-port pool virtual-server-name profile http persist virtual-server-name enable} |
||
|
cmx_delete_system (when deleting a service unit, and performing scale in of the host unit management model) |
b pool virtual-server-name member real-server-IP-address:real-port delete |
|
|
b node real-server-IP-address delete |
||
|
cmx_delete_system (when deleting a Web system) |
Without cookie switching |
b virtual virtual-server-name delete |
|
b pool virtual-server-name delete |
||
|
b node real-server-IP-address delete |
||
|
With cookie switching |
b virtual virtual-server-name delete |
|
|
b pool virtual-server-name delete |
||
|
b node real-server-IP-address delete |
||
|
b profile persist virtual-server-name delete |
||
|
cmx_start_target |
b pool virtual-server-name member real-server-IP-address :real-port session user enabled |
|
|
cmx_stop_target |
b pool virtual-server-name member real-server-IP-address : real-port session user disabled |
|
- Reference note
-
For BIG-IP v10.2, use the virtual server name as the pool name.