Update Cluster
Update the specified Cluster.
The ID of the Cluster.
The request payload for Update Cluster API.
{
"id": "string",
"version": 0,
"name": "cdc1-cc1",
"type": "string",
"enabled": false,
"parentDomainId": "string",
"location": {
"city": "string",
"country": "string",
"address": "string",
"longitude": "number",
"latitude": "number"
},
"licenses": {
"esxi": [
"string"
],
"vsan": [
"string"
]
},
"switches": [
{
"name": "string",
"uplinks": [
{
"pnic": "string",
"name": "string"
}
]
}
],
"services": [
{
"name": "string",
"type": "string",
"enabled": false,
"vsanConfig": {
"vsanDedup": false
}
}
],
"storage": {
"twoNodeVsanCluster": {
"witness": {
"preDeployed": {
"witnessHostAddress": "string"
},
"ztpDeployed": {
"ovaPath": "string",
"witnessVMDeployment": {
"formFactor": "string",
"deploymentTarget": {
"clusterName": "string",
"resourceGroup": "string",
"hostName": "string"
},
"dataStoreName": "string",
"primaryNetwork": {
"networkName": "string",
"fqdn": "string",
"gateway": "string",
"prefix": 0
},
"secondaryNetwork": {
"networkName": "string",
"fqdn": "string",
"gateway": "string",
"prefix": 0
},
"rootPassword": "string"
}
}
}
}
},
"networks": [
{
"type": "string",
"name": "string",
"switch": "string",
"segmentType": "string",
"vlan": 0,
"mtu": 0,
"gateway": "string",
"prefixLength": 0,
"mac_learning_enabled": false,
"uplinkTeamingPolicy": {
"uplinkPortOrder": {
"active": [
"string"
],
"standby": [
"string"
],
"unused": [
"string"
]
}
}
}
],
"settings": {
"dns": {
"suffix": "string",
"servers": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
},
"csiTagging": {
"enableCsiZoning": false,
"clusterCsiZoneTagNamingScheme": "string",
"hostCsiZoneTagNamingScheme": "string"
},
"disableDatastoreCustomization": false
},
"csiTags": {
"csiZoneTag": "string"
},
"csiCategories": {
"useExisting": false,
"zone": "string"
},
"hcpId": "string"
}
The unique ID of the domain. This is optional when creating domains and required when updating domain(s) in the absence of domain ID as API Path Param. This field is required and cannot be updated during Domain Update.
The version of this domain entity. This field must be specified during Domain Update.
The name of the domain. This field cannot be updated during Domain Update.
The type of the domain. This field cannot be updated during Domain Update.
Flag indicating whether this domain is enabled or disabled.
The unique ID of the parent domain for this domain. Central Site and Regional Site type domains of sub type MANAGEMENT can't have parent as they themselves are the parents for other domains. This field cannot be updated during Domain Update.
The location of the domain.
The license keys required for the domain.
The list of switches under this domain.
services
Configuration for two node vsan.
The list of networks for the switches under this domain.
settings
csiTags
csiCategories
The unique ID of the Host Config Profile to be applied to this domain. This is an optional field when creating domains. During Domain update, if the previous value is present and current update doesn't have this value, it will be treated as intent to remove currently applied Host Config Profile from this domain.
The specified Cluster has been updated successfully.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}
The list of warnings.
The list of errors.
API endpoint has permanently moved.
{
"redirectURL": "string"
}
redirectURL
Response Headers
URI where the client will find the new endpoint.
Response may include details of why the request is bad.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}
The list of warnings.
The list of errors.
User is not authenticated to invoke this endpoint.
User is not authorized to invoke this endpoint.
The specified Cluster was not found.
The request payload couldn't be processed by the server.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}
The list of warnings.
The list of errors.
An internal server error has occurred.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}
The list of warnings.
The list of errors.