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
method

URI

Description

create

POST

csm/LBPoolEntry

Creates a LBPoolEntry object.

get

GET

csm/LBPoolEntry/guid

Retrieves a LBPoolEntry object.

search

POST

csm/LBPoolEntry/search

Searches for LBPoolEntry objects.

Operation APIs

Name

HTTP
method

URI

Description

decommission

POST

csm/LBPoolEntry/decommission

Decommissions load balancer pool entries.

disable

POST

csm/LBPoolEntry/disable

Disables load balancer pool entries.

enable

POST

csm/LBPoolEntry/enable

Enables load balancer pool entries.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/LBPoolEntry/guid/pool

Retrieves the pool relationship.

relation

GET

csm/LBPoolEntry/guid/serverNetworkInterface

Retrieves the serverNetworkInterface relationship.

relation

GET

csm/LBPoolEntry/guid/logicalServerFarmEntry

Retrieves the logicalServerFarmEntry relationship.

relation

GET

csm/LBPoolEntry/guid/resourceSet

Retrieves the resourceSet relationship.

relation

GET

csm/LBPoolEntry/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/LBPoolEntry/guid/provider

Retrieves the provider relationship.

relation

GET

csm/LBPoolEntry/guid/tags

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-
plicity

Description

pool

LoadBalancerPool

1

Load balancer pool to which the entry belongs

serverNetworkInterface

ServerNetworkInterface

1

Associated server network interface

logicalServerFarmEntry

LogicalServerFarmEntry

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

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

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