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.

Command-line syntax

python com/bmc/cloud/sdk/commandline/clmcmd.py 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.

API syntax

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: 1—ICMP 6—TCP 17—UDP	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	Instance of the gcac authentication instance.

delete

Use lbpool-delete from the command line to delete a load balancer pool.

Command-line syntax

python com/bmc/cloud/sdk/commandline/clmcmd.py lbpool-delete [-h] --lbpoolname NAME

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.

API syntax

obj = lbpool_delete(gcac, lbpool_name=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument	API parameter	Description	Required?
--lbpoolname	lbpool_name	Name of the load balancer pool to delete.	Yes
	gcac	Instance of the gcac authentication instance.

list

Use lbpool-list from the command line to list available load balancer pools.

Command-line syntax

python com/bmc/cloud/sdk/commandline/clmcmd.py 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.

API syntax

obj = lbpool_list(gcac, filters=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument	API parameter	Description
-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	Instance of the gcac authentication instance.

lbpool

create

delete

list

On this page