Skip to content

Virtualization API (1.2.0)

Virtualization API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

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

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

Get all hosts across registered hypervisor managers.

Request

List all the hosts 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-hosts?filter="hostType eq ESXI"
  • GET /virtualization/v1beta1/hypervisor-hosts?filter="hostType eq ESXI and status eq ERROR"

Filters are supported on the following attributes:

  • hostType
  • state
  • status
  • hypervisorManagerInfo/name
  • hypervisorManagerInfo/displayName
  • hypervisorManagerInfo/id
  • version
  • createdAt
  • hciClusterUuid
  • hciServerUuid
  • name
  • services
  • displayName
  • cpuInfo/processorSpeedHz
  • cpuInfo/processorSockets
  • cpuInfo/processorCores
  • cpuInfo/logicalProcessors
  • cpuInfo/hyperthreadingActive
  • cpuSockets/vendor
  • cpuSockets/cpuBusSpeedHz
  • cpuSockets/cpuCoreSpeedHz
  • 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://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/hypervisor-hosts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

itemsArray of objects(HypervisorHost)required
items[].​idstringrequired

UUID string uniquely identifying the hypervisor host.

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

Application specific information for this host.

items[].​cpuInfoobject(CpuInfo)

CPU information.

items[].​cpuSocketsArray of objects(CpuSocket)

CPU sockets information.

items[].​customerIdstring

The customer application identifier.

items[].​displayNamestring

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

Example: "myESXi"
items[].​hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

items[].​hciServerUuidstring

UUID string uniquely identifying the HCI server.

items[].​hostNetworkSystemobject(HostNetworkSystem)

Host network system information.

items[].​hostPerfMetricInfoobject

Hypervisor host performance metrics.

items[].​hostTypestring

The type of the hypervisor host.

Value"ESXI"
items[].​hypervisorManagerInfoobject
items[].​namestring(hostname)<= 255 charactersread-only

Name of the host as reported by the hypervisor manager.

Example: "myESXi"
items[].​networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the hypervisor host.

Example: "192.168.0.1"
items[].​networksInfoArray of strings

All the network names associated with this host.

Example: ["network-2053","network-1005"]
items[].​parentInfoobject

Parent of this host. It could be a cluster or folder in case of a VMware ESXi Host. For a Hyper-V host it will be cluster or host group.

items[].​resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/hypervisor-hosts/{host-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 hypervisor host object

Enum"OK""ERROR""REFRESHING"
items[].​stateReasonstring<= 255 characters

Brief reason for the current state of the hypervisor host

items[].​statusstring

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

Enum"OK""ERROR""WARNING"
items[].​storageAdaptersInfoArray of objects

List of storage adapters associated with this host.

items[].​uidstring

A hypervisor host provided durable UID.

items[].​versionstring

The hypervisor host version.

Example: "6.7.0 build-9030300, R2, 7.2"
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 host resource identified by {host-id}

Request

Details of a hypervisors host.

Security
bearer
Path
host-idstringrequired

UUID string uniquely identifying the hypervisor host.

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/hypervisor-hosts/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the hypervisor host.

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

appInfoobject

Application specific information for this host.

cpuInfoobject(CpuInfo)

CPU information.

cpuSocketsArray of objects(CpuSocket)

CPU sockets information.

customerIdstring

The customer application identifier.

displayNamestring

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

Example: "myESXi"
hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

hciServerUuidstring

UUID string uniquely identifying the HCI server.

hostNetworkSystemobject(HostNetworkSystem)

Host network system information.

hostPerfMetricInfoobject

Hypervisor host performance metrics.

hostTypestring

The type of the hypervisor host.

Value"ESXI"
hypervisorManagerInfoobject
namestring(hostname)<= 255 charactersread-only

Name of the host as reported by the hypervisor manager.

Example: "myESXi"
networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the hypervisor host.

Example: "192.168.0.1"
networksInfoArray of strings

All the network names associated with this host.

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

Parent of this host. It could be a cluster or folder in case of a VMware ESXi Host. For a Hyper-V host it will be cluster or host group.

resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/hypervisor-hosts/{host-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 hypervisor host object

Enum"OK""ERROR""REFRESHING"
stateReasonstring<= 255 characters

Brief reason for the current state of the hypervisor host

statusstring

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

Enum"OK""ERROR""WARNING"
storageAdaptersInfoArray of objects

List of storage adapters associated with this host.

uidstring

A hypervisor host provided durable UID.

versionstring

The hypervisor host version.

Example: "6.7.0 build-9030300, R2, 7.2"
Response
application/json
{
  "appInfo": {
    "vmware": { … }
  },
  "cpuInfo": {
    "hyperthreadingActive": true,
    "logicalProcessors": 2,
    "processorCores": 2,
    "processorSockets": 2,
    "processorSpeedHz": 2299999000
  },
  "cpuSockets": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "displayName": "myESXi",
  "generation": 0,
  "hciClusterUuid": "string",
  "hciServerUuid": "string",
  "hostNetworkSystem": {
    "portGroups": [ … ]
  },
  "hostPerfMetricInfo": {
    "cpuCapacityInHz": 0,
    "cpuUsageInMhz": 0,
    "memorySizeInBytes": 0,
    "memoryUsageInMb": 0,
    "totalStorageInBytes": 0,
    "usedStorageInBytes": 0
  },
  "hostType": "ESXI",
  "hypervisorManagerInfo": {
    "displayName": "myvcenter1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "string",
    "type": "string"
  },
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "myESXi",
  "networkAddress": "192.168.0.1",
  "networksInfo": [
    "network-2053",
    "network-1005"
  ],
  "parentInfo": {
    "displayName": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "xyz_cluster",
    "resourceUri": "string",
    "type": "CLUSTER"
  },
  "resourceUri": "/virtualization/v1beta1/hypervisor-hosts/{host-id}",
  "services": [
    "hci-manager",
    "backup-and-recovery"
  ],
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "storageAdaptersInfo": [
    { … }
  ],
  "type": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": "6.7.0 build-9030300, R2, 7.2"
}

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