14.2.12 OperateSLB (Operate Server Load Balancer)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\OperateSLB - Operate Server Load Balancer

[Linux Manager]
/opt/FJSVcfmg/bin/OperateSLB.sh - Operate Server Load Balancer

Synopsis

[Windows Manager]

OperateSLB -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformId L-Platform_ID -xml path_to_the_XML_file

[Linux Manager]

OperateSLB.sh -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformId L-Platform_ID -xml path_to_the_XML_file

Function description

This command executes server load balancer operations.
If there are operation logs that have not been acquired, operations cannot be performed.
It is necessary to specify all parameters defined in the ruleset.

This command is executed asynchronously. After the command is successfully executed, the status of the L-Platform changes to Reconfiguring (RECONFIG_ING) during the execution of the operation, and changes back to Operating Normally (NORMAL) when the operation is completed.
When the status of an L-Platform is Reconfiguring, the L-Platform cannot be operated. Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.

Options

-version: Specify the version ID of the L-Platform API.

-locale: Specify the language used to communicate with the L-Platform API.

-userId: Specify the user ID for executing the L-Platform API.

-password: Specify the password for the user ID for executing the L-Platform API.

-orgId: Specify the tenant name of the user for executing the L-Platform API.

-lplatformId: Specify the L-Platform ID.

-xml

Specify the path to the XML file that defines server load balancer operations.

<<XML>>

<slb>
 <name>[Server load balancer name]</name>
  <ruleset>
   <name>[ruleset name]</name>
     <parameters>
       <parameter>
         <name>[parameter name]</name>
         <value>[value of the parameter]</value>
       </parameter>
            ...
     </parameters>
   </ruleset>
</slb>

Tag name	Type	Range	Description	Mandatory	Content
slb	-	-	Specify the server load balancer.	N	-
name	ASCII string	1 byte or more	Specify the name of the server load balancer performing the operations.	Y	-
ruleset	-	-	Specify the server load balancer ruleset.	N	-
name	ASCII string	1 byte or more	Specify the name of the ruleset for operations.	Y	-
[parameters]	-	-	Specify the ruleset parameters.	N	-
[parameter]	-	0 or more	Specify the number of parameters.	N	-
name	ASCII string	1 byte or more	Specify the name of the parameters performing the operations.	Y	Specify the name of the parameter in the target ruleset that was obtained by GetRulesetConfiguration.
value	ASCII string	0 byte or more	Specify the value of the parameters performing the operations.	O	-

The symbols in the "Mandatory" column have the following meaning:
Y: If the tag is specified, be sure to specify a value. (Mandatory)
O: The value can be omitted. (Optional)
N: There is no need to set a value. (Unnecessary) Only the tag itself is specified.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> OperateSLB -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -xml C:\sample.xml
<?xml version="1.0" encoding="UTF-8"?>
<OperateSLBResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <operationId>ROR_001</operationId>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</OperateSLBResponse>

[Linux Manager]

# OperateSLB.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -xml /XML/sample.xml
<?xml version="1.0" encoding="UTF-8"?>
<OperateSLBResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <operationId>ROR_001</operationId>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</OperateSLBResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.