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.

LogicalServerFarm class

Represents a load balanced server farm

LogicalServerFarm class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

create

POST

csm/LogicalServerFarm

Creates a LogicalServerFarm object.

search

POST

csm/LogicalServerFarm/search

Searches for LogicalServerFarm objects.

Operation APIs

Name

HTTP
method

URI

Description

decommission

POST

csm/LogicalServerFarm/guid/decommission

Decommissions one or more LogicalServerFarm objects

Relationship APIs

The LogicalServerFarm class has no relationship APIs.

LogicalServerFarm class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

clientLogicalLoadBalancerInterface

LogicalLoadBalancerInterface

1

cloudParameter

CloudParameter

0..*

destinationLogicalCommunicationPath

LogicalCommunicationPath

0..*

logicalLoadBalancer

LogicalLoadBalancer

1

logicalServerFarmEntry

LogicalServerFarmEntry

0..*

resourceServerFarm

ResourceServerFarm

0..*

resourceSet

ResourceSet

0..1

serverLogicalLoadBalancerInterface

LogicalLoadBalancerInterface

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

backEndProtocol

Integer

1

Virtual IP address assigned to the load balancer pool

clientPortNumber

Integer

1

This is the port number on which the server farm listens for requests. It is the clientPortNumber or listening Port.

frontEndProtocol

Integer

1

Virtual IP address assigned to the load balancer pool

isEnabled

Boolean

1

Indicates whether the load balancer is enabled

natIPAddress

String

0..1

NAT IP address

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

name

String

1

Human-readable name of the object

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.

Comments