Skip to content
/
Power On CSP Machine Inst...

Virtualization API (1.2.0)

Virtualization API

Download OpenAPI description
index.json
index.yaml
Overview
License
HPE End User License Agreement
Languages
Servers
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/
Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/

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

Create CSP Machine Instance

Request

Create CSP Machine Instance

Security
bearer
Bodyapplication/jsonrequired
accountIdstring(uuid)

ID of the csp-account resource representing the cloud provider account.

Example: "a652f894-1cc6-52c2-9540-490671081fd6"
cspMachineInstanceInfoCreateAWSMachineInstanceRequest (object) or CreateAzureMachineInstanceRequest (object)
One of:
object CreateAWSMachineInstanceRequest Recursive
cspTypestring

The cloud service provider type

Default "AWS"
Enum"AWS""AZURE"
Example: "AWS"
keyPairNamestring

Name of User's KeyPair, required for CSP Machine Instance login

Example: "HPE_DSCC_KeyPair"
namestring

Name of CSP machine instance provided by user

Example: "HPE_CSP_VM"
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/virtualization/v1beta1/csp-machine-instances \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

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

Terminate a CSP Machine Instance

Request

Deletes the cloud service provider (CSP) machine instance.

Security
bearer
Path
idstring(uuid)required

Unique identifier of a CSP machine instance

Example: fad49630-2a7d-4705-956d-67abdbe8a70b
curl -i -X DELETE \
  https://us-west.api.greenlake.hpe.com/virtualization/v1beta1/csp-machine-instances/fad49630-2a7d-4705-956d-67abdbe8a70b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

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

Power Off CSP Machine Instance

Request

Powers off the cloud service provider (CSP) machine instance.

Security
bearer
Path
idstring(uuid)required

Unique identifier of a CSP machine instance

Example: fad49630-2a7d-4705-956d-67abdbe8a70b
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/virtualization/v1beta1/csp-machine-instances/fad49630-2a7d-4705-956d-67abdbe8a70b/power-off \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

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

Power On CSP Machine Instance

Request

Powers on cloud service provider (CSP) machine instance.

Security
bearer
Path
idstring(uuid)required

Unique identifier of a CSP machine instance

Example: fad49630-2a7d-4705-956d-67abdbe8a70b
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/virtualization/v1beta1/csp-machine-instances/fad49630-2a7d-4705-956d-67abdbe8a70b/power-on \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

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

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