Create a Hypervisor

Create Hypervisor for that particular type

application/json

Request Body

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [VMW]

vcenterHostName string required

Vcenter hostname

userName string required

Vcenter username

password string required

Vcenter password

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [XEN_SERVER]

serverName string required

Xen hostname

userName string required

Xen userName

password string required

Xen password

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [Hyper-V]

serverName string required

Hyper-V hostname

userName string required

Hyper-V userName

password string required

Hyper-V password

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [Amazon]

accessKey string required

Access Key of Amazon login

RoleARN string

Role ARN for STS assume role with IAM policy

secretKey string required

secret Key of Amazon login

Region string

AWS region if Iam role is used

useIamRole boolean required

if Iam Role is used

useServiceAccount string

Clientname to be used as Admin Account

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [Azure_V2]

tenantId string required

Tenant id of Azure login Application

subscriptionId string required

subscription id of Azure

ApplicationId string

Application id of Azure login Application

ApplicationPassword string

Application Password of Azure login Application

workloadRegion object

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [Azure_V2]

resourceManagerURL string

resource Manager URL for Azure Stack

tenantId string required

Tenant id of Azure login Application

subscriptionId string required

subscription id of Azure

ApplicationId string

Application id of Azure login Application

ApplicationPassword string

Application Password of Azure login Application

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [GOOGLE_CLOUD]

serviceAccountId string required

service account id of google cloud

userName string required

username of GCP login Application

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [REDHAT]

RhevMManager string required

Rhev Manager

userName string required

Rhev userName

password string required

Rhev password

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [OPENSTACK]

keynoteAddress string required

OpenStack KeyNote address

userName string required

OpenStack userName

password string required

OpenStack password

openstackDomain string

OpenStack Domain Name

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [DOCKER]

serverName string required

Docker hostname

userName string required

Docker userName

password string required

Docker password

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [ORACLE_CLOUD_INFRASTRUCTURE]

tenancyOCId string required

OCID for the tenant.

userOCId string required

OCID for the admin user for the hypervisor

fingerPrint string required

Finger print for the private key

privateKeyFileName string required

File Name for the private key

privateKeyPassword string

password for the private key.This is the passphrase that was used to encrypt the private key.

regionName string required

home region for the tenant

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [ALIBABA_CLOUD]

accessKey string required

Access key of alibaba cloud

secretKey string required

secret key of alibaba cloud

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [ORACLE_VM]

oracleVMManager string required

oracle VM Manager

userName string required

Username of the oracle VM info

password string required

password of the oracle VM info

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [REDHAT_OPENSHIFT]

serverName string

redHatOpenShift hostname

userName string required

redHatOpenShift userName

password string required

redHatOpenShift password

glusterHostCredentials object required

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [VCLOUD]

vOrganizationName string

Organization name of VMware Cloud Director

vOrganizationGuid string

Organization Guid of VMware Cloud Director

vCloudDirector string

VMware Cloud Director Name

hostName string

VMware Cloud Director hostname or organization guid if org client

userName string

VMware Cloud Director username

password string

VMware Cloud Director password

createOrgAccount boolean

Default value: false

True if organization account to be used

autoCompany string

Possible values: [AUTO_CREATE_NEW, USE_EXISTING, DO_NOT_AUTO_CREATE]

indicates the mode for company association

companyId int32

company id is required if use existing mode is selected for org client

companyName string

company name is required for org client

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [NUTANIX]

hostName string required

Nutanix hostname

userName string required

Nutanix userName

password string required

Nutanix password

name string required

The name of the hypervisor group being created

skipCredentialValidation boolean

Default value: true

if credential validation has to be skipped.

accessNodes object[] required

credentials object

etcdProtection object

planEntity object

hypervisorType string required

Possible values: [PROXMOX]

hostName string required

Proxmox hostname

userName string required

proxmox userName

password string required

proxmox password

Responses

Success

application/json

Schema
Example (from schema)

Schema

response object
hypervisorId int32
warningCode int32
errorCode int32
errorMessage string
Response message
warningMessage string
Response message

{
  "response": {
    "hypervisorId": 0,
    "warningCode": 0,
    "errorCode": 0,
    "errorMessage": "string",
    "warningMessage": "string"
  }
}

Internal Server Error

application/json

Schema
Example (from schema)

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Internal Server Error

application/json

Schema
Example (from schema)

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

POST /v4/hypervisor

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/Hypervisor' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "VMW",
  "vcenterHostName": "string",
  "userName": "string",
  "password": "string"
}'