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.

LogicalServerFarmEntry class


Represents a single load balanced server within a LogicalServerFarm. Traffic to a LogicalServerFarm's virtual IP will be load balanced amongst all the servers represented by an enabled LogicalServerFarmEntry within this LogicalServerFarm.

LogicalServerFarmEntry class APIs

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

Basic APIs

 

Name

HTTP
method

URI

Description

create

POST

Creates a LogicalServerFarmEntry object.

search

POST

Searches for LogicalServerFarmEntry objects.

 

Operation APIs

 

Name

HTTP
method

URI

Description

bulkCreate

POST

Creates one or more LogicalServerFarmEntry objects.

bulkDisable

POST

Disables one or more LogicalServerFarmEntry objects. Once disabled, the server represented by the LoigcalServerFarmEntry will no longer be routed any traffic via the LogicalServerFarm with which this LogicalServerFarmEntry is associated.

bulkEnable

POST

Enables one or more LogicalServerFarmEntry objects.

decommission

POST

Decommissions one or more LogicalServerFarmEntry objects. Once decommissioned, the servers are no longer load balanced via the associated LogicalServerFarm.

disable

POST

 

enable

POST

 

 

Relationship APIs

The LogicalServerFarmEntry class has no relationship APIs.

LogicalServerFarmEntry class relationships and attributes

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

Relationships

 

Name

Type

Multi-
plicity

Description

computeContainerNetworkInterface

0..1

 

logicalServerFarm

1

 

resourceServerFarmEntry

0..*

 

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

1

This is port number which the server farm will route requests too. It is a port on the end server.

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*