LoadBalancerPool class (Provider API)

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

The LoadBalancerPool class has no basic APIs.

Operation APIs

Name

HTTP
method

URI

Description

decommission

POST

csm/LoadBalancerPool/decommission

Decommissions load balancer pools.

lbp_create

POST

csm/LoadBalancerPool/lbp_create

Creates load balancer pools

Relationship APIs

The LoadBalancerPool class has no relationship APIs.

LoadBalancerPool class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

entries

LBPoolEntry

0..*

Load balancer pool entries

loadBalancer

LoadBalancer

1

Load balancer associated with the load balancer pool

destinationEndPointNetworkPath

NetworkPath

0..*

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

Was this page helpful? Yes No Submitting... Thank you

Comments