Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

LBPoolEntry class (Provider API)


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

The LBPoolEntry class has no basic APIs.

Operation APIs

Name

HTTP
method

URI

Description

decommission

POST

Decommissions load balancer pool entries.

disable

POST

Disables load balancer pool entries.

enable

POST

Enables load balancer pool entries.

lbpe_create

POST

Creates load balancer pool entries.

Relationship APIs

The LBPoolEntry class has no relationship APIs.

LBPoolEntry class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

pool

1

Load balancer pool to which the entry belongs

Attributes

Name

Type

Multi-
plicity

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

 

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