hypervisor-clusters

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

hypervisor-clusters

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

Operations

Get all clusters across registered hypervisor managers.

Request

List all the hypervisors clusters 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/hypervisor-clusters?filter="clusterType eq ESX_CLUSTER"
GET /virtualization/v1beta1/hypervisor-clusters?filter="clusterType eq ESX_CLUSTER and status eq ERROR"

Filters are supported on the following attributes:

clusterType
id
state
hypervisorManagerInfo/name
hypervisorManagerInfo/displayName
hypervisorManagerInfo/id
status
createdAt
hciClusterUuid
name
services
displayName
appInfo/vmware/moref

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://us-west.api.greenlake.hpe.com/virtualization/v1beta1/hypervisor-clusters \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

countintegerrequired

Total number of records returned.

itemsArray of objects(HypervisorCluster)required

items[].idstringrequired

UUID string uniquely identifying the hypervisor cluster.

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

items[].typestringread-onlyrequired

items[].generationinteger(int64)read-onlyrequired

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[].appInfoobject

Application specific information for this cluster.

items[].clusterPerfMetricInfoobject

Hypervisor cluster performance metrics.

items[].clusterTypestring

The type of the hypervisor cluster.

Value"ESX_CLUSTER"

items[].customerIdstring

The customer application identifier.

items[].displayNamestring

A user-friendly name that identifies the hypervisor cluster. This will always be same as name since adding or updating hypervisor clusters is not supported when managed from a manager, such as the vCenter.

Example: "myesxcluster1"

items[].hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

items[].hypervisorHostsArray of objects

Captures the list of all hosts of this cluster. In a VMWare cluster, this entity maps to ESXi hosts.

items[].hypervisorManagerInfoobject

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

Name of the cluster as reported by the hypervisor manager.

Example: "myesxcluster1"

items[].networksInfoArray of strings

All the network names associated with this cluster.

Example: ["network-2053","network-1005"]

items[].resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/hypervisor-clusters/{cluster-id}"

items[].servicesArray of strings(Services)

items[].statestring

The current state of the hypervisor cluster object.

Enum"OK""ERROR""REFRESHING"

items[].stateReasonstring<= 255 characters

Brief reason for the current state of the hypervisor cluster.

items[].statusstring

The current status of the hypervisor cluster. Status is derived and abstracted to a 'standard status' based on the status reported by the hypervisor manager.

Enum"OK""ERROR""WARNING"

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
}

Get a hypervisor cluster resource identified by {cluster-id}

Request

Details of a hypervisors cluster.

Security

bearer

Path

cluster-idstringrequired

UUID string uniquely identifying the hypervisor cluster.

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

curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/virtualization/v1beta1/hypervisor-clusters/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstringrequired

UUID string uniquely identifying the hypervisor cluster.

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

typestringread-onlyrequired

generationinteger(int64)read-onlyrequired

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.

appInfoobject

Application specific information for this cluster.

clusterPerfMetricInfoobject

Hypervisor cluster performance metrics.

clusterTypestring

The type of the hypervisor cluster.

Value"ESX_CLUSTER"

customerIdstring

The customer application identifier.

displayNamestring

A user-friendly name that identifies the hypervisor cluster. This will always be same as name since adding or updating hypervisor clusters is not supported when managed from a manager, such as the vCenter.

Example: "myesxcluster1"

hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

hypervisorHostsArray of objects

Captures the list of all hosts of this cluster. In a VMWare cluster, this entity maps to ESXi hosts.

hypervisorManagerInfoobject

namestring(hostname)<= 255 charactersread-only

Name of the cluster as reported by the hypervisor manager.

Example: "myesxcluster1"

networksInfoArray of strings

All the network names associated with this cluster.

Example: ["network-2053","network-1005"]

resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/hypervisor-clusters/{cluster-id}"

servicesArray of strings(Services)

statestring

The current state of the hypervisor cluster object.

Enum"OK""ERROR""REFRESHING"

stateReasonstring<= 255 characters

Brief reason for the current state of the hypervisor cluster.

statusstring

The current status of the hypervisor cluster. Status is derived and abstracted to a 'standard status' based on the status reported by the hypervisor manager.

Enum"OK""ERROR""WARNING"

Response

application/json

{
  "appInfo": {
    "vmware": { … }
  },
  "clusterPerfMetricInfo": {
    "cpuCapacityInMhz": 0,
    "cpuUsageInMhz": 0,
    "memorySizeInBytes": 0,
    "memoryUsageInMb": 0,
    "totalStorageInBytes": 0,
    "usedStorageInBytes": 0
  },
  "clusterType": "ESX_CLUSTER",
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "displayName": "myesxcluster1",
  "generation": 0,
  "hciClusterUuid": "string",
  "hypervisorHosts": [
    { … }
  ],
  "hypervisorManagerInfo": {
    "displayName": "myvcenter1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "string",
    "type": "string"
  },
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "myesxcluster1",
  "networksInfo": [
    "network-2053",
    "network-1005"
  ],
  "resourceUri": "/virtualization/v1beta1/hypervisor-clusters/{cluster-id}",
  "services": [
    "hci-manager",
    "backup-and-recovery"
  ],
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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

hypervisor-clusters

Get all clusters across registered hypervisor managers.

Request

Responses

Was this helpful?

Get a hypervisor cluster resource identified by {cluster-id}

Request

Responses

Was this helpful?

hypervisor-folders

hypervisor-hosts

hypervisor-managers

hypervisor-networks

hypervisor-tags

resource-pools

virtual-machines