Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

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
method

URI

Description

get

GET

csm/VirtualDatastore/guid

Retrieves a VirtualDatastore object.

search

POST

csm/VirtualDatastore/search

Searches for VirtualDatastore objects.

Operation APIs

The VirtualDatastore class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/VirtualDatastore/guid/inPool

Retrieves the inPool relationship.

relation

GET

csm/VirtualDatastore/guid/localDisk

Retrieves the localDisk relationship.

relation

GET

csm/VirtualDatastore/guid/virtualCluster

Retrieves the virtualCluster relationship.

relation

GET

csm/VirtualDatastore/guid/provider

Retrieves the provider relationship.

relation

GET

csm/VirtualDatastore/guid/tags

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-
plicity

Description

inPool

StaticPool

1

Static pool that contains the virtual data store

localDisk

LocalDisk

0..*

Associated local disks

virtualCluster

VirtualCluster

1

Virtual cluster associated with the virtual data store

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

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

name

String

1

Human-readable name of the object

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments