clusterRequest
clusterRequest
JSON Example
{
"clusterPassword": "string",
"clusterTemplateId": "string",
"clusterType": "string",
"description": "string",
"location": {
"city": "string",
"country": "string",
"cityAscii": "string",
"latitude": "string",
"longitude": "string"
},
"clusterConfig": {
"csi": [
{
"name": "string",
"properties": {
"serverIP": "string",
"mountPath": "string",
"datastoreUrl": "string",
"region": "string",
"zone": "string"
}
}
],
"tools": [
{
"name": "string",
"properties": {
"extensionId": "string",
"password": "string",
"type": "string",
"url": "string",
"username": "string"
}
}
],
"systemSettings": [
{
"name": "string",
"properties": {
"host": "string",
"port": 0,
"protocol": "string"
}
}
]
},
"airgapConfig": {
"type": "string",
"extensionId": "string",
"fqdn": "string",
"ip": "string",
"caCert": "string"
},
"proxyConfig": {
"http_proxy": "http_proxy",
"no_proxy": "no_proxy",
"https_proxy": "https_proxy",
"caCert": "caCert",
"type": "extension",
"extensionId": "extensionId"
},
"hcxCloudUrl": "string",
"endpointIP": "string",
"managementClusterId": "string",
"masterNodes": [
{
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"nameservers": [
"string"
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
]
}
],
"name": "string",
"placementParams": [
{
"name": "string",
"type": "string"
}
],
"vmTemplate": "string",
"workerNodes": [
{
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"nameservers": [
"string"
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
]
}
]
}
string
clusterPassword
Optional
This password is used to login to the master nodes and worker nodes. The username is "capv".
string
clusterTemplateId
Required
clusterTemplateId
string
clusterType
Required
clusterType
Possible values are :
MANAGEMENT,
WORKLOAD,
string
description
Optional
description
string
hcxCloudUrl
Required
hcxCloudUrl
string
endpointIP
Required
API server load balancer IP. This address is used by Kube-vip pod that runs in the control plane nodes and provides load balancing services for the cluster API server. Make sure that this Ip Address is not in the DHCP range, but its in the same subnet as the DHCP range of master node's management network.
string
managementClusterId
Optional
managementClusterId
array of
clusterRequest_masterNodes
masterNodes
Required
Pool of nodes on which Kubernetes control plane can run.
string
As ^[a-z][-a-z0-9]{0,44}[a-z0-9]$
name
Required
name
string
vmTemplate
Required
vmTemplate