VirtualDatastore class (Provider API)

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

The VirtualDatastore class has no basic APIs.

Operation APIs

Name

HTTP
method

URI

Description

offboard

POST

csm/VirtualDatastore/offboard

Offboards the specified virtual data store.

Relationship APIs

The VirtualDatastore class has no relationship APIs.

VirtualDatastore class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

virtualCluster

VirtualCluster

1

Virtual cluster associated with the virtual data store

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

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments