VirtualDatastore class
The VirtualDatastore class represents a data store attached to a cluster.
VirtualDatastore class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the VirtualDatastore class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
create | POST |
csm/VirtualDatastore/create
| (Reserved, 4.6.05 and later) Creates a VirtualDatastore object. |
delete | DELETE |
csm/VirtualDatastore/guid
| (Reserved, 4.6.05 and later) Deletes a VirtualDatastore object. |
get | GET | Retrieves a VirtualDatastore object. | |
search | POST | Searches for VirtualDatastore objects. |
Operation APIs
The VirtualDatastore class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the inPool relationship. | |
relation | GET | Retrieves the localDisk relationship. | |
relation | GET | Retrieves the virtualCluster relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
VirtualDatastore class relationships and attributes
The following tables list the relationships and attributes of the VirtualDatastore class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
inPool | 1 | Static pool that contains the virtual data store | |
localDisk | 0..* | Associated local disks | |
virtualCluster | 1 | Virtual cluster associated with the virtual data store | |
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 |
|---|---|---|---|
freeCapacity | Integer | 0..1 | Available space |
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 |
totalCapacity | Integer | 1 | Total capacity of the virtual data store |
uniqueId | String | 0..1 | This represents the unique id from the virtualization vendor. This can be used to identify the instance uniquely |
virtualDatastoreType | String | 0..1 | Type of the data store, such as VMFS3 |
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 |