LoadBalancerPool class

The LoadBalancerPool class represents a logical set of devices (for example, web servers) that are considered to be a group for receiving and processing traffic. Each device in the pool is represented by a LoadBalancerPoolEntry class object. Traffic is balanced across devices in the pool based on the configuration of the pool.

LoadBalancerPool class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the LoadBalancerPool class.

Basic APIs

Name	HTTP method	URI	Description
create	`POST`	`csm/LoadBalancerPool`	Creates a `LoadBalancerPool` object.
get	`GET`	`csm/LoadBalancerPool/guid`	Retrieves a `LoadBalancerPool` object.
search	`POST`	`csm/LoadBalancerPool/search`	Searches for `LoadBalancerPool` objects.

Operation APIs

Name	HTTP method	URI	Description
decommission	`POST`	`csm/LoadBalancerPool/decommission`	Decommissions load balancer pools.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/LoadBalancerPool/guid/clientNetworkInterface`	Retrieves the `clientNetworkInterface` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/cloudParameter`	Retrieves the `cloudParameter` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/entries`	Retrieves the `entries` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/lbPoolParameterValue`	Retrieves the `lbPoolParameterValue` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/loadBalancer`	Retrieves the `loadBalancer` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/serverNetworkInterface`	Retrieves the `serverNetworkInterface` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/destinationEndPointNetworkPath`	Retrieves the `destinationEndPointNetworkPath` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/logicalServerFarm`	Retrieves the `logicalServerFarm` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/resourceSet`	Retrieves the `resourceSet` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/LoadBalancerPool/guid/tags`	Retrieves the `tags` relationship.

LoadBalancerPool class relationships and attributes

The following tables list the relationships and attributes of the LoadBalancerPool class.

Relationships

Name	Type	Multi- plicity	Description
`clientNetworkInterface`	`LoadBalancerNetworkInterface`	1	Associated client network interface
`cloudParameter`	`CloudParameter`	0..*
`entries`	`LBPoolEntry`	0..*	Load balancer pool entries
`lbPoolParameterValue`	`LBPoolParameterValue`	0..*	Values for a load balancer pool parameter
`loadBalancer`	`LoadBalancer`	1	Load balancer associated with the load balancer pool
`serverNetworkInterface`	`LoadBalancerNetworkInterface`	0..*	Associated server network interface
`destinationEndPointNetworkPath`	`NetworkPath`	0..*
`logicalServerFarm`	`LogicalServerFarm`	1
`resourceSet`	`ResourceSet`	0..1	Associated network resource set
`tickets`	`Ticket`	0..*
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`clientPortNumber`	`Integer`	0..1	Client-facing port number. This is the port number the client should use when addressing the load balancer pool.
`natIPAddress`	`String`	0..1	NAT IP address
`networkLabel`	`String`	1	Network label
`transportProtocol`	`Integer`	1	Transport protocol identifier for traffic to the load balancer. For example, the identifier for TCP is 6. To find other protocol numbers, see assigned Internet Protocol numbers.
`virtualIPAddress`	`String`	1	Virtual IP address assigned to the load balancer pool
`externalID`	`String`	0..1	Identifier used for the object by an external provider
`owner`	`String`	0..1	Name of the owner of the object
`reconciliationID`	`String`	0..1	Reconciliation identity value for the object from the BMC Atrium CMDB
`tokenID`	`String`	0..1	Token identifier
`description`	`String`	0..1	Text that describes the object
`guid`	`String`	1	Globally unique identifier for the object
`labels`	`String`	0..*
`modifiedDate`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object