lbpool
This topic describes the verbs, command-line arguments, and API parameters available for the lbpool noun in the BMC Cloud Lifecycle Management SDK.
create
Use lbpool-create from the command line to create a new load balancer pool with the specified load balancers.
clm lbpool-create [-h] --loadbalancer NAME|id:<GUID> --lbpoolname NAME [--environment NAME|id:<GUID>] [--lbpooldescription DESCRIPTION] --transportprotocol {17,6,1} --applicationport PORT --servernetworkname NAME --clientnetworkname NAME [--ipaddress IP_ADDRESS]Use lbpool_create in the API to create a new load balancer pool with the specified load balancers. This command returns a LogicalServerFarm Python object with the same attributes and relationships.
obj = lbpool_create(gcac, loadbalancer, name, transport_protocol, application_port, server_networks, client_network, environment=None, description=None, ipaddress=None)
obj.guid # returns the GUID
obj.name # returns the name
...| Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--loadbalancer | loadbalancer | Name or GUID of a load balancer to add to the new load balancer pool | Yes |
--lbpoolname | name | Name of the new load balancer pool. | Yes |
--transportprotocol | transport_protocol | The protocol identifier:
| Yes |
--applicationport | application_port | Application port number to expose to the external world. | Yes |
--servernetworkname | server_networks | Name of a the server network. | Yes |
--clientnetworkname | client_network | Name of the client network. | Yes |
--environment | environment | Name or GUID of the environment for the load balancer pool. This parameter is required if a name is specified for the --loadbalancer parameter. | Conditional |
--lbpooldescription | description | Description of the load balancer pool. | |
--ipaddress | ipaddress | A virtual IP address. If not specified, a virtual IP address will be created automatically. | |
gcac | GenericCloudAPIClient instance/user authentication. |
delete
Use lbpool-delete from the command line to delete a load balancer pool.
(Prior to 4.1 patch 3)
clm lbpool-delete [-h] [--waitfor TIME_OUT_SECONDS] --lbpoolname NAME
(4.1 patch 3 and later)
clm lbpool-delete [-h] [--waitfor TIME_OUT_SECONDS] --lbpool
NAME|id:<GUID> [--loadbalancer NAME|id:<GUID>]
[--environment NAME|id:<GUID>]Use lbpool_delete in the API to delete a load balancer pool. This command returns a LogicalServerFarm Python object with the same attributes and relationships.
(Prior to 4.1 patch 3)
obj = lbpool_delete(gcac, lbpool_name=None)
obj.guid # returns the GUID
obj.name # returns the name
...
(4.1 patch 3 and later)
obj = lbpool_delete(gcac, lbpool=None, loadbalancer=None, environment=None)
obj.guid # returns the GUID
obj.name # returns the name
...| Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--environment | environment | (4.1 patch 3 and later) Name or GUID of the environment for the load balancer pool. This parameter is required if a name is specified for the --loadbalancer parameter. | Conditional |
--loadbalancer | loadbalancer | (4.1 patch 3 and later) Name or GUID of a load balancer to be deleted from the load balancer pool | Yes |
--lbpool | lbpool | (4.1 patch 3 and later) Name or GUID of the load balancer pool to delete. | Yes |
--lbpoolname | lbpool_name | (Deprecated in 4.1 patch 3) Name of the load balancer pool to delete. | Yes |
--waitfor | Time in seconds to wait for a response from the server, otherwise return running task details. | ||
gcac | GenericCloudAPIClient instance/user authentication. |
list
Use lbpool-list from the command line to list available load balancer pools.
clm lbpool-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]Use lbpool_list in the API to list available load balancer pools. This command returns a list of LogicalServerFarm Python objects with the same attributes and relationships.
obj = lbpool_list(gcac, filters=None)
obj[n].guid returns the GUID
obj[n].name returns the name
...| Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
-l | List all fields. This parameter does not need a value. | ||
-u | List only GUIDs. This parameter does not need a value. | ||
-n | List only names. This parameter does not need a value. | ||
-s | List GUIDs, names, and status (if applicable). This parameter does not need a value. | ||
-k | List the field names specified in the value for this parameter. | ||
--filter | filters | List the output that matches the specified filters. | |
gcac | GenericCloudAPIClient instance/user authentication. |
Comments
Log in or register to comment.