Skip to content
Internal API Catalog
/
Virtualization API
/
API reference
/
virtual-machines
/
Shutdown guest OS of a virtual machine

Virtualization API (1.2.0)

Virtualization API

Download OpenAPI description
virtualization-api.json
virtualization-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/

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

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

Get all virtual machines across registered hypervisor managers.

Request

List all the virtual machines 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/virtual-machines?filter="appType eq VMWARE"
  • GET /virtualization/v1beta1/virtual-machines?filter="appType eq VMWARE and status eq ERROR"

Filters are supported on the following attributes:

  • status
  • state
  • appType
  • hypervisorManagerInfo/name
  • hypervisorManagerInfo/displayName
  • hypervisorManagerInfo/id
  • hostInfo/id
  • hostInfo/name
  • hostInfo/displayName
  • clusterInfo/id
  • clusterInfo/name
  • clusterInfo/displayName
  • protectionJobInfo/protectionPolicyInfo/id
  • protectionJobInfo/protectionPolicyInfo/name
  • vmProtectionGroupsInfo/id
  • vmProtectionGroupsInfo/name
  • appInfo/vmware/type
  • appInfo/vmware/moref
  • appInfo/vmware/datastoresInfo/id
  • appInfo/vmware/datastoresInfo/name
  • appInfo/vmware/datastoresInfo/displayName
  • 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
  • powerState
  • createdAt
  • name
  • services
  • allowedOperations
  • hciClusterUuid
  • id
  • type
  • capacityInBytes
  • computeInfo/numCpuCores
  • computeInfo/memorySizeInMib
  • vmPerfMetricInfo/cpuAllocatedInMhz
  • vmPerfMetricInfo/cpuUsedInMhz
  • vmPerfMetricInfo/storageAllocatedInKb
  • vmPerfMetricInfo/storageUsedInBytes
  • vmPerfMetricInfo/memoryAllocatedInMb
  • vmPerfMetricInfo/memoryUsedInMb
  • vmPerfMetricInfo/totalReadIops
  • vmPerfMetricInfo/totalWriteIops
  • vmPerfMetricInfo/averageReadLatency
  • vmPerfMetricInfo/averageWriteLatency
  • displayName
  • protectionStatus
  • recoveryPointsExist
  • vclsVm
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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Total number of records returned.

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

UUID string uniquely identifying the virtual machine

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 virtual machine.

Items Enum"VIRTUAL_MACHINE_POWER_ON""VIRTUAL_MACHINE_POWER_OFF""VIRTUAL_MACHINE_RESET"
Example: ["VIRTUAL_MACHINE_POWER_ON","VIRTUAL_MACHINE_POWER_OFF"]
items[].​appInfoobject

Application specific information for this virtual machine.

items[].​appTypestring

Type of the application to which the VM belongs.

Value"VMWARE"
items[].​capacityInBytesinteger(int64)

Size of the virtual machine in bytes.

Example: 2407653459860
items[].​clusterInfoobject
items[].​computeInfoobject

Compute information of the virtual machine.

items[].​customerIdstring

The customer application identifier.

items[].​displayNamestring

A user-friendly name that identifies the virtual machine.

Example: "My-Test-VM"
items[].​folderInfoobject

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

items[].​guestInfoobject

Information of this guest OS running on the virtual machine.

items[].​hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

Example: "754f63f7-1016-40ec-9b8f-610f978b9aec"
items[].​hostInfoobject
items[].​hypervisorManagerInfoobject
items[].​namestring<= 80 charactersread-only

Name of the virtual machine as configured in the hypervisor manager.

Example: "vm-1-windows"
items[].​networkAdaptersArray of objects
items[].​networkAddressstring

IP address of the virtual machine.

items[].​powerStatestring

This provides the information power state of the virtual machine.

Enum"POWERED_ON""POWERED_OFF""SUSPENDED"
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[].​recoveryPointsExistboolean(recoveryPointsExist)

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

items[].​resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/virtual-machines/{vm-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 virtual machine

Enum"OK""UNAVAILABLE""ERROR"
Example: "OK"
items[].​stateReasonstring<= 255 characters

Brief reason for the current state of the virtual machine

items[].​statusstring

The current status of the virtual machine.

Enum"OK""ERROR""WARNING"
items[].​uidstring(uuid)

Unique identifier of the virtual machine as reported by the hypervisor.

items[].​vclsVmboolean

Indicates it is a vCLS virtual machine or not.

Example: false
items[].​virtualDisksArray of objects

A list of objects encapsulating information about the storage disks provisioned to a virtual machine

items[].​vmClassificationstring

Classification of different system/control VM types

Enum"DATA_ORCHESTRATOR""PROTECTION_STORE_GATEWAY""VCLS_VM"
items[].​vmConfigPathstring

VM configuration path of the virtual machine.

Example: "NEW_VCSA6.7/NEW_VCSA6.7.vmx"
items[].​vmPerfMetricInfoobject

Virtual machine performance metrics.

items[].​vmProtectionGroupsInfoArray of objects(VmProtectionGroupInfo)

Protection groups related to the virtual machine.

items[].​volumesInfoArray of objects(VolumeInfo)

Volumes associated with this virtual machine.

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
}

Deploy virtual machine

Request

Deploys one or more virtual machines in HCI environment with specified template and storage provisioning policy.

Security
bearer
Bodyapplication/jsonrequired
vmConfigobjectrequired

Defines the virtual machine configurations

vmConfig.​namestringrequired

Name of the virtual machine to be deployed

vmConfig.​acceptEulabooleanrequired

Accept EULA by default or not

vmConfig.​annotationstring

The description of the image

vmConfig.​localestring

Locale to use for parsing OVF descriptor

vmConfig.​numberOfVmsinteger

Number of virtual machines to be created.

Default 1
vmConfig.​powerOnboolean

Power on/off the virtual machine

vmConfig.​propertyConfigArray of objects

Properties which can be set to a virtual machine during deployment

storageConfigobjectrequired

Specifies the storage configurations for a virtual machine

storageConfig.​defaultDatastoreIdstringrequired

The UUID of the hypervisor datastore where the virtual machine is to be deployed

storageConfig.​provisioningTypestring

Specifies whether datastore is THIN or THICK to provision the virtual machine

Enum"THIN""THICK"
destinationobject

Specifies where to deploy the virtual machine

imageSourceobject

Specifies the hypervisor image information using which the virtual machine is deployed

networkConfigobject

Specifies name and the target network to use for deployment

vmPolicyArray of objects

Specifies the policies which can be attached to the virtual machine

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "storageConfig": {
      "defaultDatastoreId": "string"
    },
    "vmConfig": {
      "acceptEula": true,
      "name": "string"
    }
  }'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Delete a virtual machine

Request

Delete a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X DELETE \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Get a virtual machine identified by {vm-id}

Request

Details of a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the virtual machine

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 virtual machine.

Items Enum"VIRTUAL_MACHINE_POWER_ON""VIRTUAL_MACHINE_POWER_OFF""VIRTUAL_MACHINE_RESET"
Example: ["VIRTUAL_MACHINE_POWER_ON","VIRTUAL_MACHINE_POWER_OFF"]
appInfoobject

Application specific information for this virtual machine.

appTypestring

Type of the application to which the VM belongs.

Value"VMWARE"
capacityInBytesinteger(int64)

Size of the virtual machine in bytes.

Example: 2407653459860
clusterInfoobject
computeInfoobject

Compute information of the virtual machine.

customerIdstring

The customer application identifier.

displayNamestring

A user-friendly name that identifies the virtual machine.

Example: "My-Test-VM"
folderInfoobject

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

guestInfoobject

Information of this guest OS running on the virtual machine.

hciClusterUuidstring

UUID string uniquely identifying the HCI cluster.

Example: "754f63f7-1016-40ec-9b8f-610f978b9aec"
hostInfoobject
hypervisorManagerInfoobject
namestring<= 80 charactersread-only

Name of the virtual machine as configured in the hypervisor manager.

Example: "vm-1-windows"
networkAdaptersArray of objects
networkAddressstring

IP address of the virtual machine.

powerStatestring

This provides the information power state of the virtual machine.

Enum"POWERED_ON""POWERED_OFF""SUSPENDED"
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"
recoveryPointsExistboolean(recoveryPointsExist)

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

resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/virtual-machines/{vm-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 virtual machine

Enum"OK""UNAVAILABLE""ERROR"
Example: "OK"
stateReasonstring<= 255 characters

Brief reason for the current state of the virtual machine

statusstring

The current status of the virtual machine.

Enum"OK""ERROR""WARNING"
uidstring(uuid)

Unique identifier of the virtual machine as reported by the hypervisor.

vclsVmboolean

Indicates it is a vCLS virtual machine or not.

Example: false
virtualDisksArray of objects

A list of objects encapsulating information about the storage disks provisioned to a virtual machine

vmClassificationstring

Classification of different system/control VM types

Enum"DATA_ORCHESTRATOR""PROTECTION_STORE_GATEWAY""VCLS_VM"
vmConfigPathstring

VM configuration path of the virtual machine.

Example: "NEW_VCSA6.7/NEW_VCSA6.7.vmx"
vmPerfMetricInfoobject

Virtual machine performance metrics.

vmProtectionGroupsInfoArray of objects(VmProtectionGroupInfo)

Protection groups related to the virtual machine.

volumesInfoArray of objects(VolumeInfo)

Volumes associated with this virtual machine.

Response
application/json
{
  "allowedOperations": [
    "VIRTUAL_MACHINE_POWER_ON",
    "VIRTUAL_MACHINE_POWER_OFF"
  ],
  "appInfo": {
    "vmware": { … }
  },
  "appType": "VMWARE",
  "capacityInBytes": 2407653459860,
  "clusterInfo": {
    "displayName": "myesxcluster1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "myesxcluster1",
    "resourceUri": "string",
    "type": "string"
  },
  "computeInfo": {
    "memorySizeInMib": "4096",
    "numCpuCores": 8,
    "numCpuThreads": 16
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "displayName": "My-Test-VM",
  "folderInfo": {
    "displayName": "myVmFolder",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "myVmFolder",
    "resourceUri": "string",
    "type": "string"
  },
  "generation": 0,
  "guestInfo": {
    "buildVersion": "6.7.0 build-9030300, NT 6.3, 3.8.13-44.1.1.el6uek.x86_64",
    "name": "Microsoft Windows Server 2008 R2 (64-bit)",
    "releaseVersion": "6.7.0 build-9030300, R2, 7.2",
    "type": "WINDOWS"
  },
  "hciClusterUuid": "754f63f7-1016-40ec-9b8f-610f978b9aec",
  "hostInfo": {
    "displayName": "myESXi",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "myESXi",
    "resourceUri": "string",
    "type": "string"
  },
  "hypervisorManagerInfo": {
    "displayName": "myvcenter1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "string",
    "type": "string"
  },
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "vm-1-windows",
  "networkAdapters": [
    { … }
  ],
  "networkAddress": "string",
  "powerState": "POWERED_ON",
  "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",
  "recoveryPointsExist": true,
  "resourceUri": "/virtualization/v1beta1/virtual-machines/{vm-id}",
  "services": [
    "hci-manager",
    "backup-and-recovery"
  ],
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  "updatedAt": "2019-08-24T14:15:22Z",
  "vclsVm": false,
  "virtualDisks": [
    { … }
  ],
  "vmClassification": "DATA_ORCHESTRATOR",
  "vmConfigPath": "NEW_VCSA6.7/NEW_VCSA6.7.vmx",
  "vmPerfMetricInfo": {
    "averageReadLatency": 0,
    "averageWriteLatency": 0,
    "cpuAllocatedInMhz": 0,
    "cpuUsedInMhz": 0,
    "memoryAllocatedInMb": 0,
    "memoryUsedInMb": 0,
    "storageAllocatedInKb": 0,
    "storageUsedInBytes": 0,
    "totalReadIops": 0,
    "totalWriteIops": 0
  },
  "vmProtectionGroupsInfo": [
    { … }
  ],
  "volumesInfo": [
    { … }
  ]
}

Power off a virtual machine

Request

Power off a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/power-off \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Power on a virtual machine

Request

Power on a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/power-on \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Refresh the specified virtual machine instance

Request

Updates the properties of the specified virtual machine instance

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request accepted

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

Reset a virtual machine

Request

Reset a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/reset \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Restart guest OS of a virtual machine

Request

Restart guest OS of a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restart-guest-os \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Shutdown guest OS of a virtual machine

Request

Shutdown guest OS of a virtual machine

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/shutdown-guest-os \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Reconfigure virtual machine hardware configurations

Request

Updates CPU, memory, network adapters, and disks of a virtual machine. This operation can be performed when the virtual machine is powered off.

Security
bearer
Path
vm-idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
cpuMemConfigobject

Reconfigure CPU and memory values for a virtual machine

networkAdaptersArray of objects

Reconfigure network adapter(s) for a virtual machine. ADD/EDIT/DELETE list of network adapters.

virtualDisksArray of objects

Reconfigure disk(s) for a virtual machine. ADD/EDIT/DELETE list of disks.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/update-hardware \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

Async-operations URI that can be used to monitor the progress of the operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Migrate virtual machines

Request

Migrate virtual machines to another cluster or datastore

Security
bearer
Query
parameter-typestring^(vms|sourceDataStoreIDs)$

Type of the query parameter (vms or sourceDataStoreIDs)

vmsArray of strings

A list of VM IDs to migrate or a list of SourceDatastoreIDs. If you specify the list of SourceDatastoreIDs, all VMs within the specified datastores are migrated. If you specify a list of VM IDs, only those VMs are migrated.

Bodyapplication/jsonrequired
targetDatastoreIdstringrequired

Target Datastore ID to which VMs will be migrated.

hypervisorManagerIdstringrequired

An identifier for the Hypervisor Manager.

targetHypervisorClusterIdstringrequired

An identifier for the target Hypervisor cluster.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/virtual-machines/migrate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hypervisorManagerId": "string",
    "targetDatastoreId": "string",
    "targetHypervisorClusterId": "string"
  }'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}