3.12 rcxadm slb

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm slb - Server load balancer operations and information display

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm slb - Server load balancer operations and information display

Format

rcxadm slb list [{-ruleset [-category {config|operation|all}]|-extend network}]
rcxadm slb log  -name name
rcxadm slb show -name name [-extend network]
rcxadm slb operate -name name -ruleset ruleset_name [-param parameter_name=value[,parameter_name=value]...]

Description

rcxadm slb is the command used to operate or display the information of server load balancers.

Subcommands

list

Displays the list of server load balancers.

The following detailed information is displayed:

Table 3.50 Server Load Balancer Information
Item Name	Description
NAME	The name of the server load balancer
RESOURCE_ID	Resource ID assigned to the server load balancer
TYPE	Type "SLB" is displayed.
RULESET_NAME	Ruleset name used by the Auto-Configuration function
DEVICE_NAME	Network device name in use Up to 32 characters are displayed when -extend network is specified.
NETWORK_NAME	Network resource name in use This is only displayed when -extend network is specified.

Table 3.51 Ruleset Information for Server Load Balancers
Item Name	Description
TYPE	Type "SLB" is displayed.
CATEGORY	For the ruleset for automatic configuration, "config" is displayed. For the ruleset for operations, "operation" is displayed.
RULESET_NAME	Ruleset name used by the Auto-Configuration function
MAX_SEGMENT	The maximum number of segments that can be defined
MAX_SERVER	The maximum number of servers that can be defined
DESCRIPTION	Descriptions of a ruleset

log

Displays up to 10 generations of history of automatic configuration and operations of network devices.

The following detailed information is displayed:

Table 3.52 History Information of Server Load Balancers
Item Name	Description
Name	The name of the server load balancer
Resource ID	Resource ID assigned to the server load balancer
Type	Type "SLB" is displayed.
Tenant Name	Name of the tenant where the server load balancer is deployed
L-Platform Name	Name of the L-Platform where the server load balancer is deployed
Ruleset Name	Ruleset name used by the Auto-Configuration function
ParameterFile Name	Parameter file name used by the ruleset
Device Name	Network device name in use
Vendor Name	Vendor name of the network device (server load balancer)
Product Name	Product name of the network device (server load balancer)
Model Name	Model name of the network device (server load balancer)
Status	Status of the network device (server load balancer)
History	History information of auto-configuration for the server load balancer (up to 10 generations) The following information is displayed for each generation: Generation An integer from "00" is displayed. Run Script Name The name of the script executed by auto-configuration is displayed. Time The date and time on which auto-configuration was performed is displayed. Result The results of auto-configuration are displayed.
OperationHistory	History information of operations on the server load balancer (up to 10 generations) The following information is displayed for each generation: Generation An integer from "00" is displayed. Run Script Name The name of the script executed for operation is displayed. Time The date and time on which the operation was performed. Result The result of the operation is displayed.

show

Displays the detailed information for a network device.

The following detailed information is displayed:

Table 3.53 Detailed Information of Server Load Balancers
Item Name	Description
Name	The name of the server load balancer
Resource ID	Resource ID assigned to the server load balancer
Type	Type "SLB" is displayed.
Tenant Name	Name of the tenant where the server load balancer is deployed
L-Platform Name	Name of the L-Platform where the server load balancer is deployed
Ruleset Name	Ruleset name used by the Auto-Configuration function
ParameterFile Name	Parameter file name used by the ruleset
Device Name	Network device name in use
Vendor Name	Vendor name of the network device (server load balancer)
Product Name	Product name of the network device (server load balancer)
Model Name	Model name of the network device (server load balancer)
Status	Status of the network device (server load balancer)
Network Name	Network resource name in use This is only displayed when -extend network is specified.

operate: Executes the scripts in the ruleset for operations and displays the result.

Options

-name name: In name, specify the name of the server load balancer.

-ruleset

For the list subcommand, specify when displaying the list of rulesets.

For the operate subcommand, specify the name of the ruleset for operations.

-category

Specify the type of the rulesets to display.

config: Specify when displaying the list of the rulesets for automatic configuration.

operation: Specify when displaying the list of rulesets for operations.

all: Specify when displaying all types of rulesets.

When -category is omitted, "config" is specified.

-param

Specify variable information to be passed to the scripts of the ruleset used for operations.

parameter_name=value: Specify in the format of "parameter name = value". To specify multiple parameters, separate them using commas (",").

-extend network: Specify when specifying the name of the network resource in use.

Requirements

Permissions: Refer to "5.1.2 Roles and Available Operations" in the "Design Guide CE".

Location: Admin server

Example

To display a list of server load balancers:

>rcxadm slb list<RETURN>
NAME                   RESOURCE_ID      TYPE       RULESET_NAME               DEVICE_NAME    
----                   -----------      ----       ------------               -----------      
L-NetDev2              LBEFGH-456       SLB        SLB_RULE11                 SLB-1
L-NetDev4              LBMNOP-123       SLB        SLB_RULE21                 SLB-2
L-NetDev11             LBUVWX-789       SLB        SLB_RULE31                 SLB-3

To display a list of server load balancers (when specifying -extend network):

>rcxadm slb list -extend network<RETURN>
NAME                   RESOURCE_ID      TYPE       RULESET_NAME               DEVICE_NAME    NETWORK_NAME
----                   -----------      ----       ------------               -----------    ------------
L-NetDev2              LBEFGH-456       SLB        SLB_RULE11                 SLB-1          LNetwork1
L-NetDev4              LBMNOP-123       SLB        SLB_RULE21                 SLB-2          LNetwork2
L-NetDev11             LBUVWX-789       SLB        SLB_RULE31                 SLB-3          LNetwork3

To display a list of rulesets for automatic configuration of server load balancers:

>rcxadm slb list -ruleset<RETURN>
TYPE       CATEGORY        RULESET_NAME    MAX_SEGMENT  MAX_SERVER  DESCRIPTION
----       -----------     ------------    -----------  ----------  -----------
SLB        config          SLB_RULE1       -            50          HTTP(80) roundrobin connection_limit=none
SLB        config          SLB_RULE2       -            50          HTTP(80) mini-conne connection_limit=500
SLB        config          SLB_RULE3       -            100         HTTP(80) roundrobin cookie_persistence

To display a list of rulesets for operations on server load balancers:

>rcxadm slb list -ruleset -category operation<RETURN>
TYPE       CATEGORY        RULESET_NAME    MAX_SEGMENT  MAX_SERVER  DESCRIPTION
----       -----------     ------------    -----------  ----------  -----------
SLB        operation       SLB_OPE1        -            -           Separation of distribution server
SLB        operation       SLB_OPE2        -            -           Incorporation of distribution server

To display detailed information of server load balancers:

>rcxadm slb show -name slb1<RETURN>
Name: slb1
Resource ID: SLB-001
Serial Number Per Device: 1
Type: SLB
Tenant Name: Tenant001
L-Platform Name: L-Platform1
Ruleset Name: slb_rule_01
ParameterFile Name: default_param.prm
Device Name: SLB-1
Vendor Name: Fujitsu
Product Name: IPCOM EX IN
Model Name: IPCOM EX2500IN
Status: Normal

To display detailed information of server load balancers (when specifying -extend network):

>rcxadm slb show -name slb1 -extend network<RETURN>
Name: slb1
Resource ID: SLB-001
Serial Number Per Device: 1
Type: SLB
Tenant Name: Tenant001
L-Platform Name: L-Platform1
Ruleset Name: slb_rule_01
ParameterFile Name: default_param.prm
Device Name: SLB-1
Vendor Name: Fujitsu
Product Name: IPCOM EX IN
Model Name: IPCOM EX2500IN
Status: Normal
Network Name: LNetwork1

To display the history information of server load balancers:

>rcxadm slb log -name slb1<RETURN>
Name: slb1
Resource ID: SLB-001
Serial Number Per Device: 1
Type: SLB
Tenant Name: Tenant001
L-Platform Name: L-Platform1
Ruleset Name: slb_rule_01
ParameterFile Name: default_param.prm
Device Name: SLB-1
Vendor Name: Fujitsu
Product Name: IPCOM EX IN
Model Name: IPCOM EX2500IN
Status: Normal

History: 
00 Run Script Name: create  Time: 2011/03/30 Wed 00:16:00  Result: normal
01 Run Script Name: modify  Time: 2011/03/30 Wed 10:31:00  Result: normal
02 Run Script Name: modify  Time: 2011/04/06 Wed 12:10:26  Result: normal
:
09 Run Script Name: modify  Time: 2011/04/27 Wed 08:45:10  Result: normal

OperationHistory:
00 Run Ruleset Name: ope1    Time: 2011/03/30 Wed 10:33:00  Result: normal
01 Run Ruleset Name: ope2    Time: 2011/04/06 Wed 12:12:30  Result: normal
:
09 Run Ruleset Name: ope10   Time: 2011/04/27 Wed 08:47:10  Result: normal

Information

When auto-configuration is set for redundancy configuration network devices, the information after Device Name is displayed for each network device in the detailed information or the history information.
If the detailed information or the history information is displayed while a server load balancer is being created, a hyphen "-" may be displayed for the information after Device Name.

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.