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

hypervisor-managers

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

Operations

Get all registered hypervisor managers.

Request

List all the 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 comparisons supported are the following:

  • “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-managers?filter="hypervisorManagerType eq VMWARE_VCENTER"
  • GET /virtualization/v1beta1/hypervisor-managers?filter="hypervisorManagerType eq VMWARE_VCENTER and status eq ERROR"

Filters are supported on the following attributes:

  • hypervisorManagerType
  • state
  • status
  • releaseVersion
  • createdAt
  • name
  • services
  • dataOrchestratorInfo/id
  • username
  • networkAddress
  • displayName
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-managers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

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

UUID string uniquely identifying the hypervisor manager.

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

Hypervisor specific information.

items[].​buildVersionstring

The hypervisor manager build details

Example: "6.7.0 build-9030300, NT 6.3, 3.8.13-44.1.1.el6uek.x86_64"
items[].​customerIdstring

The customer application identifier.

items[].​dataOrchestratorInfoobject

Data Orchestrator specific information.

items[].​dataServicesConnectorsInfoArray of objects

Data Services Connectors specific information.

items[].​descriptionstring<= 255 characters

A brief description of the hypervisor manager.

items[].​displayNamestring

User defined name for the hypervisor manager.

Example: "myvcenter1"
items[].​hypervisorManagerTypestring

The type of the hypervisor manager. Currently only vCenter is supported.

Value"VMWARE_VCENTER"
items[].​lastRefreshedstring(date-time)

Time in UTC at which the object was last refreshed.

items[].​namestring(hostname)<= 255 characters

Name as reported by the hypervisor manager.

Example: "vcenter123.hpe.com"
items[].​networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the hypervisor manager

Example: "192.168.0.1"
items[].​releaseVersionstring

The hypervisor manager release version.

Example: "6.7.0 build-9030300, R2, 7.2"
items[].​resourceUristring

The 'self' reference for this resource.

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

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

Brief reason for the current state of the hypervisor manager

items[].​statusstring

The current status of the hypervisor manager resource.

Enum"OK""ERROR""WARNING"
items[].​uidstring

A hypervisor manager provided durable UID. In case of VMware it will be instanceUUID of the vCenter

items[].​usernamestring

Name of the user used to access the hypervisor server. Mutually exclusive with credentialInfo.

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 manager resource identified by {hypervisor-id}.

Request

Get detailed information for a registered hypervisor manager qualified by hypervisor-id.

Security
bearer
Path
hypervisor-idstringrequired

UUID string uniquely identifying the hypervisor manager.

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

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the hypervisor manager.

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

Hypervisor specific information.

buildVersionstring

The hypervisor manager build details

Example: "6.7.0 build-9030300, NT 6.3, 3.8.13-44.1.1.el6uek.x86_64"
customerIdstring

The customer application identifier.

dataOrchestratorInfoobject

Data Orchestrator specific information.

dataServicesConnectorsInfoArray of objects

Data Services Connectors specific information.

descriptionstring<= 255 characters

A brief description of the hypervisor manager.

displayNamestring

User defined name for the hypervisor manager.

Example: "myvcenter1"
hypervisorManagerTypestring

The type of the hypervisor manager. Currently only vCenter is supported.

Value"VMWARE_VCENTER"
lastRefreshedstring(date-time)

Time in UTC at which the object was last refreshed.

namestring(hostname)<= 255 characters

Name as reported by the hypervisor manager.

Example: "vcenter123.hpe.com"
networkAddressstring<= 255 characters

An IP address or hostname or FQDN to address the hypervisor manager

Example: "192.168.0.1"
releaseVersionstring

The hypervisor manager release version.

Example: "6.7.0 build-9030300, R2, 7.2"
resourceUristring

The 'self' reference for this resource.

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

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

Brief reason for the current state of the hypervisor manager

statusstring

The current status of the hypervisor manager resource.

Enum"OK""ERROR""WARNING"
uidstring

A hypervisor manager provided durable UID. In case of VMware it will be instanceUUID of the vCenter

usernamestring

Name of the user used to access the hypervisor server. Mutually exclusive with credentialInfo.

Response
application/json
{
  "appInfo": {
    "vmware": { … }
  },
  "buildVersion": "6.7.0 build-9030300, NT 6.3, 3.8.13-44.1.1.el6uek.x86_64",
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "dataOrchestratorInfo": {
    "id": "8b4c14a6-3cd5-4907-97c4-cf44c5b642e5",
    "resourceUri": "string",
    "type": "string"
  },
  "dataServicesConnectorsInfo": [
    { … }
  ],
  "description": "string",
  "displayName": "myvcenter1",
  "generation": 0,
  "hypervisorManagerType": "VMWARE_VCENTER",
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "lastRefreshed": "2019-08-24T14:15:22Z",
  "name": "vcenter123.hpe.com",
  "networkAddress": "192.168.0.1",
  "releaseVersion": "6.7.0 build-9030300, R2, 7.2",
  "resourceUri": "/virtualization/v1beta1/hypervisor-managers/{hypervisor-id}",
  "services": [
    "hci-manager",
    "backup-and-recovery"
  ],
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "uid": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "username": "string"
}

Get all virtual machine images from the hypervisor library.

Request

List all virtual machine images from the hypervisor library.

Security
bearer
Path
hypervisor-idstringrequired

UUID string uniquely identifying the hypervisor manager.

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

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

limitinteger[ 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.
  • “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 /api/v1/hypervisor-managers/{hypervisor-id}/hypervisor-library-images?filter="filetype eq OVF"

Filters are supported on the following attributes:

  • fileType
  • name
  • services
  • sizeInBytes
  • subscribed
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-managers/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/hypervisor-library-images \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

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

UUID string uniquely identifying the virtual machine image from the hypervisor image library

Example: "9476c228-d128-519c-a2ac-a4932ff2109b"
items[].​typestringrequired

Hypervisor object type

Example: "HypervisorLibraryImages"
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[].​createdAtstringrequired

Time at which the virtual machine image was created

Example: "2022-02-04T07:43:27Z"
items[].​updatedAtstringrequired

Time at which the virtual machine image was updated

Example: "2022-02-04T08:43:27Z"
items[].​customerIdstring

The customer application identifier.

Example: "90299b6c06aa283091cd4a89298b5471"
items[].​descriptionstring

Description given for the virtual machine image from the hypervisor image library

Example: "This is a sample virtual machine image description"
items[].​displayNamestring

Name of the virtual machine image

Example: "CentOS.ova"
items[].​fileTypestring

The type of the virtual machine image from the hypervisor manager image library

Value"OVF"
Example: "OVF"
items[].​hypervisorManagerInfoobject
items[].​libraryNamestring

Name of the hypervisor library

Example: "LibraryImages"
items[].​namestring

Virtual machine image name

Example: "Centos.ova"
items[].​resourceUristring

The 'self' reference for this resource.

Example: "The URI reference for this resource."
items[].​sizeinteger

Size of the virtual machine image from the hypervisor manager image library in bytes

Example: 15344
items[].​subscribedboolean

True if the image will be pulled from a remote hypervisor image library (ex. vCenter subscribed content library).

Example: false
items[].​uidstring

Hypervisor provided identifier of the virtual machine image from the hypervisor image library

Example: "9476c228-d128-519c-a2ac-a4932ff2109b"
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 library image identified by {hypervisor-library-image-id}

Request

Details of a virtual machine image

Security
bearer
Path
hypervisor-idstringrequired

UUID string uniquely identifying the hypervisor manager.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
hypervisor-library-image-idstringrequired

UUID string uniquely identifying the virtual machine image from the hypervisor image library

Example: 9476c228-d128-519c-a2ac-a4932ff2109b
curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/hypervisor-managers/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/hypervisor-library-images/9476c228-d128-519c-a2ac-a4932ff2109b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the virtual machine image from the hypervisor image library

Example: "9476c228-d128-519c-a2ac-a4932ff2109b"
typestringrequired

Hypervisor object type

Example: "HypervisorLibraryImages"
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.

createdAtstringrequired

Time at which the virtual machine image was created

Example: "2022-02-04T07:43:27Z"
updatedAtstringrequired

Time at which the virtual machine image was updated

Example: "2022-02-04T08:43:27Z"
customerIdstring

The customer application identifier.

Example: "90299b6c06aa283091cd4a89298b5471"
descriptionstring

Description given for the virtual machine image from the hypervisor image library

Example: "This is a sample virtual machine image description"
displayNamestring

Name of the virtual machine image

Example: "CentOS.ova"
fileTypestring

The type of the virtual machine image from the hypervisor manager image library

Value"OVF"
Example: "OVF"
hypervisorManagerInfoobject
libraryNamestring

Name of the hypervisor library

Example: "LibraryImages"
namestring

Virtual machine image name

Example: "Centos.ova"
resourceUristring

The 'self' reference for this resource.

Example: "The URI reference for this resource."
sizeinteger

Size of the virtual machine image from the hypervisor manager image library in bytes

Example: 15344
subscribedboolean

True if the image will be pulled from a remote hypervisor image library (ex. vCenter subscribed content library).

Example: false
uidstring

Hypervisor provided identifier of the virtual machine image from the hypervisor image library

Example: "9476c228-d128-519c-a2ac-a4932ff2109b"
Response
application/json
{
  "createdAt": "2022-02-04T07:43:27Z",
  "customerId": "90299b6c06aa283091cd4a89298b5471",
  "description": "This is a sample virtual machine image description",
  "displayName": "CentOS.ova",
  "fileType": "OVF",
  "generation": 0,
  "hypervisorManagerInfo": {
    "displayName": "myvcenter1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "string",
    "type": "string"
  },
  "id": "9476c228-d128-519c-a2ac-a4932ff2109b",
  "libraryName": "LibraryImages",
  "name": "Centos.ova",
  "resourceUri": "The URI reference for this resource.",
  "size": 15344,
  "subscribed": false,
  "type": "HypervisorLibraryImages",
  "uid": "9476c228-d128-519c-a2ac-a4932ff2109b",
  "updatedAt": "2022-02-04T08:43:27Z"
}

Refresh the specified hypervisor manager

Request

Updates the properties of the specified hypervisor manager

Security
bearer
Path
hypervisor-idstringrequired

UUID string uniquely identifying the hypervisor manager.

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

Responses

Request accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

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