VirtualResourcePool class
The VirtualResourcePool class represents a collection of resources such as CPU or RAM pooled together to be allocated to virtual guests.
VirtualResourcePool class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the VirtualResourcePool class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a VirtualResourcePool object. | |
search | POST | Searches for VirtualResourcePool objects. |
Operation APIs
The VirtualResourcePool class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the child relationship. | |
relation | GET | Retrieves the inPool relationship. | |
relation | GET | Retrieves the parent relationship. | |
relation | GET | Retrieves the virtualCluster 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. |
VirtualResourcePool class relationships and attributes
The following tables list the relationships and attributes of the VirtualResourcePool class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
child | 0..* | Child objects that compose the virtual resource pool | |
inPool | 1 | Pool that contains the virtual resource pool | |
parent | 0..1 | Parent object of the virtual resource pool | |
virtualCluster | 1 | Virtual cluster that has the virtual resource pool | |
VMs | 0..* | Virtual machines hosted by the virtual resource pool | |
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 |
|---|---|---|---|
vcpus | Integer | 0..1 | Total number of virtual CPUs allocated to the virtual resource pool |
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 |