LBPoolEntry class
The LBPoolEntry class represents a load balancer pool entry. A load balancer pool entry is used to add an IP address to a load balancer pool.
LBPoolEntry class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the LBPoolEntry class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
create | POST | Creates a LBPoolEntry object. | |
get | GET | Retrieves a LBPoolEntry object. | |
search | POST | Searches for LBPoolEntry objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
decommission | POST | Decommissions load balancer pool entries. | |
disable | POST | Disables load balancer pool entries. | |
enable | POST | Enables load balancer pool entries. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the pool relationship. | |
relation | GET | Retrieves the serverNetworkInterface relationship. | |
relation | GET | Retrieves the logicalServerFarmEntry relationship. | |
relation | GET | Retrieves the resourceSet relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
LBPoolEntry class relationships and attributes
The following tables list the relationships and attributes of the LBPoolEntry class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
pool | 1 | Load balancer pool to which the entry belongs | |
serverNetworkInterface | 1 | Associated server network interface | |
logicalServerFarmEntry | 1 |
| |
resourceSet | 0..1 | Associated network resource set | |
tickets | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
ipAddress | String | 1 | IP address for the entry. The IP address corresponds to an IP address of a compute container NIC. |
isEnabled | Boolean | 1 | Indicates whether the entry is enabled. The default value is false. |
serverPortNumber | Integer | 0..1 | Server-facing port value for the entry. If unspecified, the pool's client port number will be used. |
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 | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |