Get a datastore identified by {datastore-id}

csp-machine-images

Operations on cloud service provider (CSP) machine images.

Operations

csp-machine-instance-types

Operations on cloud service provider (CSP) machine instance types.

Operations

csp-machine-instances

Operations on cloud service provider (CSP) machine instances.

Operations

datastores

The datastores API allows the registration and management of datastores.

Operations

Get all datastores across registered hypervisor managers.

Request

List all the datastores across registered hypervisor managers.

Security

bearer

Query

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger(int32)[ 1 .. 1000 ]

The numbers of items to return

Default 20

filterstring

The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter.

A comparison compares a property name to a literal. The following comparisons are supported:

“eq” : Is a property equal to value. Valid for number, boolean and string properties.
“ne” : Is a property not equal to value. Valid for number, boolean and string properties.
“gt” : Is a property greater than a value. Valid for number or string timestamp properties.
“lt” : Is a property less than a value. Valid for number or string timestamp properties
“in” : Is a value in a property (that is an array of strings)

Examples:

GET /virtualization/v1beta1/datastores?filter="datastoreType eq VMFS"
GET /virtualization/v1beta1/datastores?filter="datastoreType eq VMFS and status eq ERROR"

Filters are supported on the following attributes:

status
state
appType
hypervisorManagerInfo/name
hypervisorManagerInfo/displayName
hypervisorManagerInfo/id
hostsInfo/id
hostsInfo/name
hostsInfo/displayName
clusterInfo/id
clusterInfo/name
clusterInfo/displayName
protectionJobInfo/protectionPolicyInfo/id
protectionJobInfo/protectionPolicyInfo/name
vmProtectionGroupsInfo/id
vmProtectionGroupsInfo/name
volumesInfo/id
volumesInfo/storageSystemInfo/id
volumesInfo/storageSystemInfo/serialNumber
volumesInfo/storageSystemInfo/name
volumesInfo/storageSystemInfo/vendorName
volumesInfo/storageFolderInfo/id
volumesInfo/storageFolderInfo/name
volumesInfo/storagePoolInfo/id
volumesInfo/storagePoolInfo/name
datastoreType
createdAt
name
services
allowedOperations
capacityInBytes
capacityFree
displayName
replicationInfo/name
replicationInfo/id
hciClusterUuid

sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified, the default order is ascending.

selectstring

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/datastores \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

countintegerrequired

Total number of records returned.

itemsArray of objects(Datastore)required

items[].idstringrequired

UUID string uniquely identifying the datastore

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"

items[].typestringread-onlyrequired

The type of resource.

items[].generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].createdAtstring(date-time)required

Time in UTC at which the object was created.

items[].updatedAtstring(date-time)required

Time in UTC at which the object was last updated.

items[].allowedOperationsArray of strings

List of allowed operation on the datastore.

Items Enum"DATASTORE_CREATE""DATASTORE_DELETE""DATASTORE_BACKUP_CREATE"

Example: ["DATASTORE_CREATE","DATASTORE_DELETE"]

items[].appTypestring

Application type of this asset

Value"VMWARE"

Example: "VMWARE"

items[].capacityFreeinteger(int64)

Unused storage of the datastore in bytes.

Example: 76534

items[].capacityInBytesinteger(int64)

Size of the datastore in bytes.

Example: 2407653459860

items[].capacityUncommittedinteger(int64)

Uncommitted storage of the datastore in bytes.

Example: 653422

items[].clusterInfoobject

items[].customerIdstring

The customer application identifier.

items[].datacentersInfoArray of objects(DatacenterInfo)

List of datacenters to which the datastore is presented to.

items[].datastoreClassificationstring

Classification of datastore types for which protection will be disabled

Value"PROTECTION_STORE_GATEWAY"

items[].datastoreTypestring

Type of the datastore.

Enum"VMFS""VVOL""NFS"

Example: "VMFS"

items[].displayNamestring

A user-friendly name that identifies the datastore.

Example: "Nimble-DS1"

items[].folderInfoobject

The immediate parent folder on which this resource is hosted in the inventory of hypervisor-manager.

items[].hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

Example: "754f63f7-1016-40ec-9b8f-610f978b9aec"

items[].hostsInfoArray of objects

List of hypervisor hosts to which the datastore is presented to.

items[].hypervisorManagerInfoobject

items[].morefstring

VMware provided moref of the data store

Example: "datastore-1234"

items[].namestring(hostname)<= 255 charactersread-only

Name of the datastore as reported by the hypervisor manager.

Example: "Nimble-DS2"

items[].protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

items[].protectionPolicyAppliedAtInfoobject(ProtectionPolicyAppliedAtInfo)

Describes applied protection policy information.

items[].protectionStatusstring(protectionStatus)

Provides the current protection status of this resource. - UNPROTECTED - No policy assigned, No recovery points exists - LAPSED - No policy assigned, at least one recovery points exists - PENDING - Policy assigned, No recovery points exists - PARTIAL - Policy assigned, At least one recovery point exists - PROTECTED - Policy assigned, most recent run of every configured schedule is successful - PAUSED - Policy assigned, one or more of the schedules are paused - UNSUPPORTED - No policy can be assigned

Enum"UNPROTECTED""LAPSED""PENDING"

items[].provisioningPolicyInfoobject(ProvisioningPolicyInfo)

Describes provisioning policy information.

items[].recoveryPointsExistboolean(recoveryPointsExist)

Indicates at least one valid recovery point exists for this resource.

items[].replicationInfoobject(ReplicationInfo)

Replication groups information containing details of all replication partners. Applicable only for Protection Group type 'STORAGE_REPLICATION_GROUP'

items[].resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/datastores/{datastore-id}"

items[].servicesArray of strings(Services)

List of services this object belongs to. This list can be used to filter specific services in the UI.

items[].statestring

The current state of the datastore

Enum"OK""ERROR""CREATING"

Example: "OK"

items[].stateReasonstring<= 255 characters

Brief reason for the current state of the datastore

items[].statusstring

The current status of the datastore.

Enum"OK""ERROR""WARNING"

items[].uidstring(uuid)= 36 characters

VMware provided uuid of the datastore.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"

items[].vmCountinteger(int64)

Number of virtual machines associated with the datastore.

Example: 120

items[].vmProtectionGroupsInfoArray of objects(VmProtectionGroupInfo)

List of virtual machine protection groups.

items[].volumesInfoArray of objects(VolumeInfo)

Volumes associated with datastore.

offsetintegerrequired

The number of items to skip before starting to collect the result set

totalinteger

Total number of documents matching filter criteria.

Response

application/json

{
  "count": 0,
  "items": [
    { … }
  ],
  "offset": 0,
  "total": 0
}

Create datastore

Request

Create datastore

Security

bearer

Bodyapplication/jsonrequired

namestringrequired

Name of datastore to be created

datastoreTypestringrequired

Supported datastore types are VMFS or vVOL

Enum"VMFS""VVOL"

sizeInBytesinteger(int64)required

Size of the datastore in bytes

targetHypervisorClusterIdstring(uuid)required

Target Hypervisor Cluster ID

storageSystemIdstring(uuid)required

Storage System ID

provisioningPolicyIdstring(uuid)

Unique identifier of a provisioning policy.

curl -i -X POST \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/datastores \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "datastoreType": "VMFS",
    "name": "string",
    "sizeInBytes": 0,
    "storageSystemId": "82fa5c8f-b188-4241-b1a7-66c08561dbc1",
    "targetHypervisorClusterId": "4019c72a-faa8-43fa-89cb-2dcaf55f0d8a"
  }'

Responses

Accepted

Headers

Locationstring

Bodyapplication/json

object(EmptyResponse)

Response

application/json

{}

Get a datastore identified by {datastore-id}

Request

Details of a datastore

Security

bearer

Path

datastore-idstringrequired

UUID string uniquely identifying the datastore

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/datastores/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstringrequired

UUID string uniquely identifying the datastore

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required

Time in UTC at which the object was created.

updatedAtstring(date-time)required

Time in UTC at which the object was last updated.

allowedOperationsArray of strings

List of allowed operation on the datastore.

Items Enum"DATASTORE_CREATE""DATASTORE_DELETE""DATASTORE_BACKUP_CREATE"

Example: ["DATASTORE_CREATE","DATASTORE_DELETE"]

appTypestring

Application type of this asset

Value"VMWARE"

Example: "VMWARE"

capacityFreeinteger(int64)

Unused storage of the datastore in bytes.

Example: 76534

capacityInBytesinteger(int64)

Size of the datastore in bytes.

Example: 2407653459860

capacityUncommittedinteger(int64)

Uncommitted storage of the datastore in bytes.

Example: 653422

clusterInfoobject

customerIdstring

The customer application identifier.

datacentersInfoArray of objects(DatacenterInfo)

List of datacenters to which the datastore is presented to.

datastoreClassificationstring

Classification of datastore types for which protection will be disabled

Value"PROTECTION_STORE_GATEWAY"

datastoreTypestring

Type of the datastore.

Enum"VMFS""VVOL""NFS"

Example: "VMFS"

displayNamestring

A user-friendly name that identifies the datastore.

Example: "Nimble-DS1"

folderInfoobject

The immediate parent folder on which this resource is hosted in the inventory of hypervisor-manager.

hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

Example: "754f63f7-1016-40ec-9b8f-610f978b9aec"

hostsInfoArray of objects

List of hypervisor hosts to which the datastore is presented to.

hypervisorManagerInfoobject

morefstring

VMware provided moref of the data store

Example: "datastore-1234"

namestring(hostname)<= 255 charactersread-only

Name of the datastore as reported by the hypervisor manager.

Example: "Nimble-DS2"

protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

protectionPolicyAppliedAtInfoobject(ProtectionPolicyAppliedAtInfo)

Describes applied protection policy information.

protectionStatusstring(protectionStatus)

Provides the current protection status of this resource. - UNPROTECTED - No policy assigned, No recovery points exists - LAPSED - No policy assigned, at least one recovery points exists - PENDING - Policy assigned, No recovery points exists - PARTIAL - Policy assigned, At least one recovery point exists - PROTECTED - Policy assigned, most recent run of every configured schedule is successful - PAUSED - Policy assigned, one or more of the schedules are paused - UNSUPPORTED - No policy can be assigned

Enum"UNPROTECTED""LAPSED""PENDING"

provisioningPolicyInfoobject(ProvisioningPolicyInfo)

Describes provisioning policy information.

recoveryPointsExistboolean(recoveryPointsExist)

Indicates at least one valid recovery point exists for this resource.

replicationInfoobject(ReplicationInfo)

Replication groups information containing details of all replication partners. Applicable only for Protection Group type 'STORAGE_REPLICATION_GROUP'

resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/datastores/{datastore-id}"

servicesArray of strings(Services)

List of services this object belongs to. This list can be used to filter specific services in the UI.

statestring

The current state of the datastore

Enum"OK""ERROR""CREATING"

Example: "OK"

stateReasonstring<= 255 characters

Brief reason for the current state of the datastore

statusstring

The current status of the datastore.

Enum"OK""ERROR""WARNING"

uidstring(uuid)= 36 characters

VMware provided uuid of the datastore.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"

vmCountinteger(int64)

Number of virtual machines associated with the datastore.

Example: 120

vmProtectionGroupsInfoArray of objects(VmProtectionGroupInfo)

List of virtual machine protection groups.

volumesInfoArray of objects(VolumeInfo)

Volumes associated with datastore.

Response

application/json

{
  "allowedOperations": [
    "DATASTORE_CREATE",
    "DATASTORE_DELETE"
  ],
  "appType": "VMWARE",
  "capacityFree": 76534,
  "capacityInBytes": 2407653459860,
  "capacityUncommitted": 653422,
  "clusterInfo": {
    "displayName": "myesxcluster1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "myesxcluster1",
    "resourceUri": "string",
    "type": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "datacentersInfo": [
    { … }
  ],
  "datastoreClassification": "PROTECTION_STORE_GATEWAY",
  "datastoreType": "VMFS",
  "displayName": "Nimble-DS1",
  "folderInfo": {
    "displayName": "myVmFolder",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "myVmFolder",
    "resourceUri": "string",
    "type": "string"
  },
  "generation": 0,
  "hciClusterUuid": "754f63f7-1016-40ec-9b8f-610f978b9aec",
  "hostsInfo": [
    { … }
  ],
  "hypervisorManagerInfo": {
    "displayName": "myvcenter1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "string",
    "type": "string"
  },
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "moref": "datastore-1234",
  "name": "Nimble-DS2",
  "protectionJobInfo": {
    "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
    "name": "string",
    "protectionPolicyInfo": { … },
    "resourceUri": "string",
    "type": "string"
  },
  "protectionPolicyAppliedAtInfo": {
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "name": "ProtectionPolicy1",
    "resourceUri": "string",
    "type": "DATASTORE"
  },
  "protectionStatus": "PROTECTED",
  "provisioningPolicyInfo": {
    "id": "6a38acc7-e470-4ed7-b141-ca9509672dac",
    "name": "ProvisioningPolicy1",
    "resourceUri": "string",
    "type": "string"
  },
  "recoveryPointsExist": true,
  "replicationInfo": {
    "id": "string",
    "name": "string",
    "partnerDetails": [ … ],
    "resourceUri": "/storage-fleet/v1/storage-systems/{uuid}/volume-sets",
    "type": "storage-fleet/volume-set"
  },
  "resourceUri": "/virtualization/v1beta1/datastores/{datastore-id}",
  "services": [
    "hci-manager",
    "backup-and-recovery"
  ],
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "uid": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "updatedAt": "2019-08-24T14:15:22Z",
  "vmCount": 120,
  "vmProtectionGroupsInfo": [
    { … }
  ],
  "volumesInfo": [
    { … }
  ]
}

hypervisor-clusters

The hypervisor clusters API enables you to get the details of the hypervisor clusters in a hypervisor manager.

Operations

hypervisor-folders

The hypervisor folders API enables you to get the details of the hypervisor folders in a hypervisor manager.

Operations

hypervisor-hosts

The hypervisor hosts API enables you to get the details of the hypervisor hosts in a hypervisor manager.

Operations

hypervisor-managers

The hypervisor managers API allows the registration and management of hypervisor managers.

Operations

hypervisor-networks

The hypervisor networks API enables you to get the details of the hypervisor networks in a hypervisor manager.

Operations

hypervisor-tags

The hypervisor tags API enables you to get the details of the hypervisor tags in a hypervisor manager.

Operations

resource-pools

The resource pool API enables you to get the details of the hypervisor resource pools in a hypervisor manager.

Operations

virtual-machines

The virtual machines API allows the registration and management of virtual machines.

Operations

Virtualization API (1.2.0)

csp-machine-images

csp-machine-instance-types

csp-machine-instances

datastores

Get all datastores across registered hypervisor managers.

Request

Responses

Was this helpful?

Create datastore

Request

Responses

Was this helpful?

Get a datastore identified by {datastore-id}

Request

Responses

Was this helpful?

hypervisor-clusters

hypervisor-folders

hypervisor-hosts

hypervisor-managers

hypervisor-networks

hypervisor-tags

resource-pools

virtual-machines