LoadBalancer class
The LoadBalancer class represents a load balancer.
LoadBalancer class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the LoadBalancer class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a LoadBalancer object. | |
search | POST | Searches for LoadBalancer objects. |
Operation APIs
The LoadBalancer class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the clientNetworkInterface relationship. | |
relation | GET | Retrieves the networkContainer relationship. | |
relation | GET | Retrieves the pools relationship. | |
relation | GET | Retrieves the serverNetworkInterface relationship. | |
relation | GET | Retrieves the zone relationship. | |
relation | GET | Retrieves the logicalLoadBalancer relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
LoadBalancer class relationships and attributes
The following tables list the relationships and attributes of the LoadBalancer class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
clientNetworkInterface | 0..* | Associated client networks | |
networkContainer | 1 | Zone associated with the load balancer | |
pools | 0..* | Load balancer pools associated with the load balancer | |
serverNetworkInterface | 0..* | Associated server networks | |
zone | 1 | Associated zone | |
logicalLoadBalancer | 1 |
| |
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 |
|---|---|---|---|
deviceType | String | 0..1 | Type of device |
isEnabled | Boolean | 1 | Indicates whether the load balancer is enabled |
isLocked | Boolean | 1 | Indicates whether the load balancer is locked |
isTemplate | Boolean | 1 | Indicates whether the load balancer is a template |
vendor | String | 0..1 | Name of device vendor |
isOnboarded | Boolean | 1 | Indicates whether the object is onboarded |
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 |