Cluster Blueprint API 2.0.0

API for managing cluster blueprints and host configurations in the PCD

Authentication

Keystone Authentication token

Fields

Key	In
x-auth-token	Header

Create a new blueprint

Auth

Request Body

object	object
name	string	Cluster name
networkingType	string	Defaults to OVN Enum: `ovn`,`ovs` Default: ovn
enableDistributedRouting	boolean	Enable Cluster Wide Distributed Network Routing Default: true
dnsDomainName	string	DNS Domain Name
virtualNetworking	object
enabled	boolean	Enable Virtual Networking Default: true
underlayType	string	Underlay Technology Enum: `vlan`,`other` Default: vlan
vnidRange	string	VLAN / VNID Range
vmHighAvailability	object
enabled	boolean	Automatically detect host failure and recover VMs on other cluster hosts
autoResourceRebalancing	object
enabled	boolean	Automatically rebalance workloads across hosts in the cluster
rebalancingStrategy	string	Defaults to vm_workload_consolidation, other supported value is node_resource_consolidation Enum: `vm_workload_consolidation`,`node_resource_consolidation` Default: vm_workload_consolidation
rebalancingFrequencyMins	integer	Rebalancing frequency maximum: 60 minimum: 1 Default: 20
imageLibraryStorage	string	Library location on filesystem or Cinder volume type
vmStorage	string	Ephemeral Virtual Machine storage path
storageBackends	object	Persistent Storage Connectivity
*	object	Volume backend name
*	object
driver	string	Storage driver type Enum: `NetApp`,`LVM`
config	object	Configuration distinct based on driver value
*	string	Flexible configuration parameters based on storage driver

Expand

POST /blueprint

xxxxxxxxxx
 
curl --request POST \ --url 'https://platform9.com/blueprint' \ --header 'x-auth-token: {x-auth-token}' \ --data '{  "name": "default",  "networkingType": "{string}",  "enableDistributedRouting": "{boolean}",  "dnsDomainName": "localdomain",  "virtualNetworking": {    "enabled": "{boolean}",    "underlayType": "{string}",    "vnidRange": "1:1000"  },  "vmHighAvailability": {    "enabled": "{boolean}"  },  "autoResourceRebalancing": {    "enabled": "{boolean}",    "rebalancingStrategy": "{string}",    "rebalancingFrequencyMins": "{integer}"  },  "imageLibraryStorage": "/var/lib/images|lvm",  "vmStorage": "/var/lib/instances",  "storageBackends": {}}'
Copy

Responses

204

Operation successful

Headers
Location	string	URL of the created resource

400

Invalid request

409

Operation cannot be performed in current state

Response

xxxxxxxxxx
 
No response
Copy

List all blueprints

Auth

GET /blueprint

xxxxxxxxxx
 
curl --get \ --url 'https://platform9.com/blueprint' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

200

Successfully retrieved blueprints

array	array[object]
name	string	Cluster name
networkingType	string	Defaults to OVN Enum: `ovn`,`ovs` Default: ovn
enableDistributedRouting	boolean	Enable Cluster Wide Distributed Network Routing Default: true
dnsDomainName	string	DNS Domain Name
virtualNetworking	object
enabled	boolean	Enable Virtual Networking Default: true
underlayType	string	Underlay Technology Enum: `vlan`,`other` Default: vlan
vnidRange	string	VLAN / VNID Range
vmHighAvailability	object
enabled	boolean	Automatically detect host failure and recover VMs on other cluster hosts
autoResourceRebalancing	object
enabled	boolean	Automatically rebalance workloads across hosts in the cluster
rebalancingStrategy	string	Defaults to vm_workload_consolidation, other supported value is node_resource_consolidation Enum: `vm_workload_consolidation`,`node_resource_consolidation` Default: vm_workload_consolidation
rebalancingFrequencyMins	integer	Rebalancing frequency maximum: 60 minimum: 1 Default: 20
imageLibraryStorage	string	Library location on filesystem or Cinder volume type
vmStorage	string	Ephemeral Virtual Machine storage path
storageBackends	object	Persistent Storage Connectivity
*	object	Volume backend name
*	object
driver	string	Storage driver type Enum: `NetApp`,`LVM`
config	object	Configuration distinct based on driver value
*	string	Flexible configuration parameters based on storage driver

Expand

Response

xxxxxxxxxx
 
[ {  "name": "default",  "networkingType": "{string}",  "enableDistributedRouting": "{boolean}",  "dnsDomainName": "localdomain",  "virtualNetworking": {   "enabled": "{boolean}",   "underlayType": "{string}",   "vnidRange": "1:1000"  },  "vmHighAvailability": {   "enabled": "{boolean}"  },  "autoResourceRebalancing": {   "enabled": "{boolean}",   "rebalancingStrategy": "{string}",   "rebalancingFrequencyMins": "{integer}"  },  "imageLibraryStorage": "/var/lib/images|lvm",  "vmStorage": "/var/lib/instances",  "storageBackends": {} }]
Copy

Retrieve a specific blueprint

Auth

GET /blueprint/{clusterName}

xxxxxxxxxx
 
curl --get \ --url 'https://platform9.com/blueprint/{clusterName}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

200

Successfully retrieved blueprint

string

Default: null

404

Resource not found

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Update an existing blueprint

Auth

Request Body

object	object
name	string	Cluster name
networkingType	string	Defaults to OVN Enum: `ovn`,`ovs` Default: ovn
enableDistributedRouting	boolean	Enable Cluster Wide Distributed Network Routing Default: true
dnsDomainName	string	DNS Domain Name
virtualNetworking	object
enabled	boolean	Enable Virtual Networking Default: true
underlayType	string	Underlay Technology Enum: `vlan`,`other` Default: vlan
vnidRange	string	VLAN / VNID Range
vmHighAvailability	object
enabled	boolean	Automatically detect host failure and recover VMs on other cluster hosts
autoResourceRebalancing	object
enabled	boolean	Automatically rebalance workloads across hosts in the cluster
rebalancingStrategy	string	Defaults to vm_workload_consolidation, other supported value is node_resource_consolidation Enum: `vm_workload_consolidation`,`node_resource_consolidation` Default: vm_workload_consolidation
rebalancingFrequencyMins	integer	Rebalancing frequency maximum: 60 minimum: 1 Default: 20
imageLibraryStorage	string	Library location on filesystem or Cinder volume type
vmStorage	string	Ephemeral Virtual Machine storage path
storageBackends	object	Persistent Storage Connectivity
*	object	Volume backend name
*	object
driver	string	Storage driver type Enum: `NetApp`,`LVM`
config	object	Configuration distinct based on driver value
*	string	Flexible configuration parameters based on storage driver

Expand

PUT /blueprint/{clusterName}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://platform9.com/blueprint/{clusterName}' \ --header 'x-auth-token: {x-auth-token}' \ --data '{  "name": "default",  "networkingType": "{string}",  "enableDistributedRouting": "{boolean}",  "dnsDomainName": "localdomain",  "virtualNetworking": {    "enabled": "{boolean}",    "underlayType": "{string}",    "vnidRange": "1:1000"  },  "vmHighAvailability": {    "enabled": "{boolean}"  },  "autoResourceRebalancing": {    "enabled": "{boolean}",    "rebalancingStrategy": "{string}",    "rebalancingFrequencyMins": "{integer}"  },  "imageLibraryStorage": "/var/lib/images|lvm",  "vmStorage": "/var/lib/instances",  "storageBackends": {}}'
Copy

Responses

204

Operation successful

No response body

404

Resource not found

Response

xxxxxxxxxx
 
No response
Copy

Delete a specific blueprint

Auth

DELETE /blueprint/{clusterName}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://platform9.com/blueprint/{clusterName}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

204

Operation successful

No response body

404

Resource not found

Response

xxxxxxxxxx
 
No response
Copy

Assign role to the host or update role settings

Auth

Request Body

Role specific settings; required only for persistent-storage role

object	object
backends	array[string]	List of storage backends to associate with the role

PUT /hosts/{hostId}/roles/{roleName}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://platform9.com/hosts/{hostId}/roles/{roleName}' \ --header 'x-auth-token: {x-auth-token}' \ --data '{  "backends": [    "{array[string]...}"  ]}'
Copy

Responses

200

Role assigned successfully

No response body

400

Invalid request

404

Resource not found

409

Operation cannot be performed in current state

Response

xxxxxxxxxx
 
No response
Copy

Remove role from the host

Auth

DELETE /hosts/{hostId}/roles/{roleName}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://platform9.com/hosts/{hostId}/roles/{roleName}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

204

Role unassigned successfully

No response body

400

Invalid request

404

Resource not found

Response

xxxxxxxxxx
 
No response
Copy

List host configurations

Auth

GET /hostconfigs

xxxxxxxxxx
 
curl --get \ --url 'https://platform9.com/hostconfigs' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

200

List of host configurations

array	array
name	string
mgmtInterface	string
vmConsoleInterface	string
hostLivenessInterface	string
tunnelingInterface	string
imagelibInterface	string
networkLabels	object
clusterName	string
id	uuid

Response

xxxxxxxxxx
 
[ {  "name": "Hypervisor-002",  "mgmtInterface": "ens3",  "vmConsoleInterface": "ens3",  "hostLivenessInterface": "ens3",  "tunnelingInterface": "ens3",  "imagelibInterface": "eth0",  "networkLabels": {   "physnet": "ens3"  },  "clusterName": "default",  "id": "17e20369-0c70-4e33-b018-b361cad83cf5" }]
Copy

Create host configuration(s)

Auth

Request Body

object	object
name	string
mgmtInterface	string
vmConsoleInterface	string
hostLivenessInterface	string
tunnelingInterface	string
imagelibInterface	string
networkLabels	object
clusterName	string

POST /hostconfigs

xxxxxxxxxx
 
curl --request POST \ --url 'https://platform9.com/hostconfigs' \ --header 'x-auth-token: {x-auth-token}' \ --data '{  "name": "Hypervisor-002",  "mgmtInterface": "ens3",  "vmConsoleInterface": "ens3",  "hostLivenessInterface": "ens3",  "tunnelingInterface": "ens3",  "imagelibInterface": "eth0",  "networkLabels": {    "physnet": "ens3"  },  "clusterName": "default"}'
Copy

Responses

200

Host configuration(s) created

Headers
Location	string	URL of the created Resource
Body
array	array
name	string
mgmtInterface	string
vmConsoleInterface	string
hostLivenessInterface	string
tunnelingInterface	string
imagelibInterface	string
networkLabels	object
clusterName	string
id	uuid

409

Operation cannot be performed in current state

Response

xxxxxxxxxx
 
[ {  "name": "Hypervisor-002",  "mgmtInterface": "ens3",  "vmConsoleInterface": "ens3",  "hostLivenessInterface": "ens3",  "tunnelingInterface": "ens3",  "imagelibInterface": "eth0",  "networkLabels": {   "physnet": "ens3"  },  "clusterName": "default",  "id": "17e20369-0c70-4e33-b018-b361cad83cf5" }]
Copy

Get host configuration

Auth

GET /hostconfigs/{hostConfigId}

xxxxxxxxxx
 
curl --get \ --url 'https://platform9.com/hostconfigs/{hostConfigId}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

200

Host configuration details

object	object
name	string
mgmtInterface	string
vmConsoleInterface	string
hostLivenessInterface	string
tunnelingInterface	string
imagelibInterface	string
networkLabels	object
clusterName	string
id	uuid

Response

xxxxxxxxxx
 
{ "name": "Hypervisor-002", "mgmtInterface": "ens3", "vmConsoleInterface": "ens3", "hostLivenessInterface": "ens3", "tunnelingInterface": "ens3", "imagelibInterface": "eth0", "networkLabels": {  "physnet": "ens3" }, "clusterName": "default", "id": "17e20369-0c70-4e33-b018-b361cad83cf5"}
Copy

Update host configuration

Auth

Request Body

object	object
name	string
mgmtInterface	string
vmConsoleInterface	string
hostLivenessInterface	string
tunnelingInterface	string
imagelibInterface	string
networkLabels	object
clusterName	string

PUT /hostconfigs/{hostConfigId}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://platform9.com/hostconfigs/{hostConfigId}' \ --header 'x-auth-token: {x-auth-token}' \ --data '{  "name": "Hypervisor-002",  "mgmtInterface": "ens3",  "vmConsoleInterface": "ens3",  "hostLivenessInterface": "ens3",  "tunnelingInterface": "ens3",  "imagelibInterface": "eth0",  "networkLabels": {    "physnet": "ens3"  },  "clusterName": "default"}'
Copy

Responses

200

Host configuration updated

object	object
name	string
mgmtInterface	string
vmConsoleInterface	string
hostLivenessInterface	string
tunnelingInterface	string
imagelibInterface	string
networkLabels	object
clusterName	string
id	uuid

Response

xxxxxxxxxx
 
{ "name": "Hypervisor-002", "mgmtInterface": "ens3", "vmConsoleInterface": "ens3", "hostLivenessInterface": "ens3", "tunnelingInterface": "ens3", "imagelibInterface": "eth0", "networkLabels": {  "physnet": "ens3" }, "clusterName": "default", "id": "17e20369-0c70-4e33-b018-b361cad83cf5"}
Copy

Delete host configuration

Auth

DELETE /hostconfigs/{hostConfigId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://platform9.com/hostconfigs/{hostConfigId}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

204

Host configuration deleted

No response body

Response

xxxxxxxxxx
 
No response
Copy

Assign host configuration to host

Auth

PUT /hosts/{hostId}/hostconfig/{hostConfigId}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://platform9.com/hosts/{hostId}/hostconfig/{hostConfigId}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

200

Host configuration assigned

No response body

Response

xxxxxxxxxx
 
No response
Copy

Unassign host configuration from host

Auth

DELETE /hosts/{hostId}/hostconfig/{hostConfigId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://platform9.com/hosts/{hostId}/hostconfig/{hostConfigId}' \ --header 'x-auth-token: {x-auth-token}'
Copy

Responses

204

Host configuration unassigned

No response body

Response

xxxxxxxxxx
 
No response
Copy