Skip to Content
Information
Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

lbpoolentry

This topic describes the verbs, command-line arguments, and API parameters available for the lbpoolentry noun in the BMC Cloud Lifecycle Management SDK.

add

Use lbpoolentry-add from the command line to add an entry to a load balancer pool.

Command-line syntax
clm lbpoolentry-add [-h] [--waitfor TIME_OUT_SECONDS] --lbpool NAME|id:<GUID>
--ipaddress IP_ADDRESS --port PORT [--environment NAME|id:<GUID>] [--loadbalancer NAME|id:<GUID>]

Use lbpoolentry_add in the API to add an entry to a load balancer pool. This command returns a LogicalServerFarmEntry Python object with the same attributes and relationships.

API syntax
obj = lbpoolentry_add(gcac, environment=None, lbPool=None, loadBalancer=None,
ipAddress=None, port=None)

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

Command-line argument

API parameter

Description

Required?

--lbpool
lbPool

Name of the load balancer pool to which the entry is added.

Yes

--ipaddress
ipAddress

IP address of the load balancing entry to add

Yes

--port
port

Port number for the load balancing entry to add

Yes

--loadbalancer
loadBalancer

Name or GUID of the load balancer entry. This parameter is required if a name is specified for the --lbpool parameter.

Conditional

--environment
environment

Name or GUID of the load balancer pool environment. This parameter is required if a name is specified for the --loadbalancer parameter.

Conditional

--waitfor

 

Time in seconds to wait for response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

delete

Use lbpoolentry-delete from the command line to delete an entry from a load balancer pool.

Command-line syntax
clm lbpoolentry-delete [-h] [--waitfor TIME_OUT_SECONDS] [--environment NAME|id:<GUID>]
[--loadbalancer NAME|id:<GUID>] [--lbpool NAME|id:<GUID>] --ipaddress IP_ADDRESS|id:<GUID>

Use lbpoolentry_delete in the API to delete an entry from a load balancer pool. This command returns a LogicalServerFarmEntry Python object with the same attributes and relationships.

API syntax
obj = lbpoolentry_delete(gcac, environment=None, ipAddress=None, loadBalancer=None, lbPool=None)

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

Command-line argument

API parameter

Description

Required?

--ipaddress
ipAddress

IP address or GUID of the load balancing server entry to delete.

Yes

--lbpool
lbPool

Name or GUID of the load balancer pool from which the entry is deleted.

Yes

--loadbalancer
loadBalancer

Name or GUID of the load balancer entry. This parameter is required if a name is specified for the --lbpool parameter.

Conditional

--environment
environment

Name or GUID of the load balancer pool environment. This parameter is required if a name is specified for the --loadbalancer parameter.

Conditional

--waitfor

 

Time in seconds to wait for response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

disable

Use lbpoolentry-disable from the command line to disable an entry in a load balancer pool.

Command-line syntax
clm lbpoolentry-disable [-h] [--waitfor TIME_OUT_SECONDS] [--environment NAME|id:<GUID>]
[--loadbalancer NAME|id:<GUID>] [--lbpool NAME|id:<GUID>] --ipaddress IP_ADDRESS|id:<GUID>

Use lbpoolentry_disable in the API to disable an entry in a load balancer pool. This command returns a LogicalServerFarmEntry Python object with the same attributes and relationships.

API syntax
obj = lbpoolentry_disable(gcac, environment=None, ipAddress=None, loadBalancer=None, lbPool=None)

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

Command-line argument

API parameter

Description

Required?

--ipaddress
ipAddress

IP address or GUID of the load balancing server entry to disable.

Yes

--lbpool
lbPool

Name or GUID of the load balancer pool for which the entry is disabled. This parameter is required if an IP address is specified for the --ipaddress parameter.

Conditional

--loadbalancer
loadBalancer

Name or GUID of the load balancer entry. This parameter is required if a name is specified for the --lbpool parameter.

Conditional

--environment
environment

Name or GUID of the load balancer pool environment. This parameter is required if a name is specified for the --loadbalancer parameter.

Conditional

--waitfor

 

Time in seconds to wait for response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

enable

Use lbpoolentry-enable from the command line to enable an entry in a load balancer pool.

Command-line syntax
clm lbpoolentry-enable [-h] [--waitfor TIME_OUT_SECONDS] [--environment NAME|id:<GUID>]
[--loadbalancer NAME|id:<GUID>] [--lbpool NAME|id:<GUID>] --ipaddress IP_ADDRESS|id:<GUID>

Use lbpoolentry_enable in the API to enable an entry in a load balancer pool. This command returns a LogicalServerFarmEntry Python object with the same attributes and relationships.

API syntax
obj = lbpoolentry_enable(gcac, environment=None, ipAddress=None, loadBalancer=None, lbPool=None)

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

Command-line argument

API parameter

Description

Required?

--ipaddress
ipAddress

IP address or GUID of the load balancing server entry to enable.

Yes

--lbpool
lbPool

Name or GUID of the load balancer pool from which the entry is enabled. This parameter is required if an IP address is specified for the --ipaddress parameter.

Conditional

--loadbalancer
loadBalancer

Name or GUID of the load balancer entry. This parameter is required if a name is specified for the --lbpool parameter.

Conditional

--environment
environment

Name or GUID of the load balancer pool environment. This parameter is required if a name is specified for the --loadbalancer parameter.

Conditional

--waitfor

 

Time in seconds to wait for response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

list

Use lbpoolentry-list from the command line to list available load balancer pool entries.

Command-line syntax
clm lbpoolentry-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]]
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]

Use lbpoolentry_list in the API to list available load balancer pool entries. This command returns a list of LogicalServerFarmEntry Python objects with the same attributes and relationships.

API syntax
obj = lbpoolentry_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.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Cloud Lifecycle Management 4.5