VirtualCluster class (Provider API)

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 method	URI	Description
get	`GET`	`csm/VirtualCluster/guid`	Retrieves a `VirtualCluster` object.

Operation APIs

Name	HTTP method	URI	Description
offboard	`POST`	`csm/VirtualCluster/offboard`	Offboards a virtual cluster
onboard	`POST`	`csm/VirtualCluster/onboard`	Onboards virtual clusters.

Relationship APIs

The VirtualCluster class has no relationship APIs.

VirtualCluster class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
`cpuSensor`	`BaseCPUSensor`	0..1	CPU sensor that monitors the virtual cluster
`memorySensor`	`BaseMemorySensor`	0..1	Memory sensor that monitors the virtual cluster
`resourcePools`	`VirtualResourcePool`	0..*	Virtual resource pools in this cluster, for those cases where the provisioning target is resource pools
`virtualDatastores`	`VirtualDatastore`	0..*	Virtual data stores associated with the virtual cluster
`virtualHosts`	`VirtualHost`	0..*	Virtual hosts associated with the virtual cluster
`VMs`	`VirtualGuest`	0..*	Virtual machines

Attributes

Name	Type	Multi- plicity	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`	`HardwareArchitectureType`	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`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object