Skip to content
API reference
/
v1alpha1
/
hypervisor-managers
/
Unregister a hypervisor manager.

Backup and Recovery API (1.1.0)

Backup and Recovery API

Download OpenAPI description
backup-recovery-api.json
backup-recovery-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1alpha1/backup-recovery-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/

hypervisor-managers

The hypervisor-managers API allows the management of hypervisor-managers

Operations

Register a new hypervisor manager.

Request

Register the hypervisor manager for data management.

Security
bearer
Bodyapplication/jsonrequired
networkAddressstring<= 255 charactersrequired

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

Example: "192.168.0.1"
hypervisorManagerTypestringrequired

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

Value"VMWARE_VCENTER"
dataOrchestratorIdstringrequired

UUID string uniquely identifying the Data Orchestrator.

Example: "8b4c14a6-3cd5-4907-97c4-cf44c5b642e5"
credentialsobjectrequired

Hypervisor server credentials.

credentials.​passwordstring

Password used to access the hypervisor server.

credentials.​usernamestring

Name of the user used to access the hypervisor server.

descriptionstring<= 255 characters

A brief description of the hypervisor manager.

displayNamestring

User defined name for the hypervisor manager.

Example: "myvcenter1"
curl -i -X POST \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1alpha1/backup-recovery-api/backup-recovery/v1alpha1/hypervisor-managers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "credentials": {},
    "dataOrchestratorId": "8b4c14a6-3cd5-4907-97c4-cf44c5b642e5",
    "hypervisorManagerType": "VMWARE_VCENTER",
    "networkAddress": "192.168.0.1"
  }'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request.

Bodyapplication/json
object
Response
application/json
{}

Unregister a hypervisor manager.

Request

Unregister a hypervisor manager.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the hypervisor manager.

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

Force option to forcefully remove hypervisor during unregister operation when underlying resources cannot be removed.

curl -i -X DELETE \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1alpha1/backup-recovery-api/backup-recovery/v1alpha1/hypervisor-managers/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request.

Bodyapplication/json
object
Response
application/json
{}

Update a hypervisor manager.

Request

Update attributes for a hypervisor manager.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the hypervisor manager.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/merge-patch+jsonrequired
credentialsobject

Hypervisor server credentials.

descriptionstring<= 255 characters

A brief description of the hypervisor manager.

displayNamestring

User defined name for the hypervisor manager.

Example: "myvcenter1"
networkAddressstring<= 255 characters

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

Example: "192.168.0.1"
curl -i -X PATCH \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1alpha1/backup-recovery-api/backup-recovery/v1alpha1/hypervisor-managers/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request.

Bodyapplication/json
object
Response
application/json
{}