VirtualCluster class
The VirtualCluster class represents an aggregation of virtual hosts, such as a VMWare virtual cluster or a Xen resource pool.
VirtualCluster class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the VirtualCluster class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a VirtualCluster object. | |
refresh | POST | Refreshes a VirtualCluster object. | |
search | POST | Searches for VirtualCluster objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
offboard | POST | Offboards the specified virtual cluster. | |
onboard | POST | Onboards virtual clusters. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the cpuSensor relationship. | |
relation | GET | Retrieves the inPool relationship. | |
relation | GET | Retrieves the memorySensor relationship. | |
relation | GET | Retrieves the resourcePools relationship. | |
relation | GET | Retrieves the switch relationship. | |
relation | GET | Retrieves the virtualDatastores relationship. | |
relation | GET | Retrieves the virtualHosts relationship. | |
relation | GET | Retrieves the VMs relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
VirtualCluster class relationships and attributes
The following tables list the relationships and attributes of the VirtualCluster class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
cpuSensor | 0..1 | CPU sensor that monitors the virtual cluster | |
inPool | 1 | Resource pool in which this cluster resides | |
memorySensor | 0..1 | Memory sensor that monitors the virtual cluster | |
resourcePools | 0..* | Virtual resource pools in this cluster, for those cases where the provisioning target is resource pools | |
switch | 0..* | Associated switches | |
virtualDatastores | 0..* | Virtual data stores associated with the virtual cluster | |
virtualHosts | 0..* | Virtual hosts associated with the virtual cluster | |
VMs | 0..* | Virtual machines | |
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 |
|---|---|---|---|
hostsInCluster | Integer | 0..1 | Number of hosts in the cluster. It is derived from the relationship to VirtualHosts. |
vcpus | Integer | 0..1 | Total number of vCPUs available to the cluster |
vmsInCluster | Integer | 0..1 | Number of VMs hosted in the cluster. It is derived from the relationship with VirtualServer. |
hwArchitecture | 0..1 | Hardware architecture of the server | |
isAvailable | Boolean | 0..1 | This attribute lets one know about whether this instance is available. The value is derived from its provider when a sync/refresh operation happens |
moRef | String | 0..1 | This represents the unique id from the virtualization vendor. This can be used to identify the instance uniquely |
providerCategorizationTier3 | String | 0..* | Values from the InstallableResource class categorizationTier3 attribute that are valid installable resource types for this infrastructure resource |
totalMemory | Integer | 0..1 | Total amount of memory available to be allocated to guests. Measured in GB. |
vendor | String | 0..1 | Name of the virtualization vendor, such as VMWare |
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 |