Update Cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Cluster ID
{
"name": "string",
"clusterExpansionSpec": {
"hostSpecs": [
{
"id": "string",
"licenseKey": "string",
"ipAddress": "string",
"hostName": "string",
"username": "string",
"password": "string",
"hostNetworkSpec": {
"vmNics": [
{
"id": "string",
"vdsName": "string",
"moveToNvds": false,
"uplink": "string"
}
],
"networkProfileName": "string"
},
"azName": "string",
"sshThumbprint": "string",
"serialNumber": "string"
}
],
"networkSpec": {
"nsxClusterSpec": {
"ipAddressPoolsSpec": [
{
"name": "string",
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"subnets": [
{
"ipAddressPoolRanges": [
{
"start": "string",
"end": "string"
}
],
"cidr": "string",
"gateway": "string"
}
]
}
],
"uplinkProfiles": [
{
"name": "string",
"teamings": [
{
"policy": "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC",
"activeUplinks": [
"string"
],
"standByUplinks": [
"string"
]
}
],
"transportVlan": 0,
"supportedTeamingPolicies": {
"supportedTeamingPolicies": "string"
}
}
]
},
"networkProfiles": [
{
"name": "string",
"description": "string",
"nsxtHostSwitchConfigs": [
{
"vdsName": "string",
"uplinkProfileName": "string",
"ipAddressPoolName": "string",
"vdsUplinkToNsxUplink": [
{
"vdsUplinkName": "string",
"nsxUplinkName": "string"
}
]
}
]
}
]
},
"vsanNetworkSpecs": [
{
"vsanGatewayIP": "string",
"vsanCidr": "string"
}
],
"witnessSpec": {
"vsanIp": "string",
"fqdn": "string",
"vsanCidr": "string"
},
"witnessTrafficSharedWithVsanTraffic": false,
"deployWithoutLicenseKeys": false,
"interRackExpansion": false,
"forceHostAdditionInPresenceofDeadHosts": false,
"skipThumbprintValidation": false
},
"clusterCompactionSpec": {
"hosts": [
{
"id": "string",
"ipAddress": "string",
"fqdn": "string",
"vmNics": [
{
"name": "string",
"linkSpeedMB": 0,
"isInUse": false,
"isAutoNegotiateSupported": false,
"isActive": false
}
],
"azName": "string"
}
],
"force": false,
"forceByPassingSafeMinSize": false
},
"clusterStretchSpec": {
"hostSpecs": [
{
"id": "string",
"licenseKey": "string",
"ipAddress": "string",
"hostName": "string",
"username": "string",
"password": "string",
"hostNetworkSpec": {
"vmNics": [
{
"id": "string",
"vdsName": "string",
"moveToNvds": false,
"uplink": "string"
}
],
"networkProfileName": "string"
},
"azName": "string",
"sshThumbprint": "string",
"serialNumber": "string"
}
],
"witnessSpec": {
"vsanIp": "string",
"fqdn": "string",
"vsanCidr": "string"
},
"witnessTrafficSharedWithVsanTraffic": false,
"vsanNetworkSpecs": [
{
"vsanGatewayIP": "string",
"vsanCidr": "string"
}
],
"secondaryAzOverlayVlanId": 0,
"networkSpec": {
"nsxClusterSpec": {
"ipAddressPoolsSpec": [
{
"name": "string",
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"subnets": [
{
"ipAddressPoolRanges": [
{
"start": "string",
"end": "string"
}
],
"cidr": "string",
"gateway": "string"
}
]
}
],
"uplinkProfiles": [
{
"name": "string",
"teamings": [
{
"policy": "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC",
"activeUplinks": [
"string"
],
"standByUplinks": [
"string"
]
}
],
"transportVlan": 0,
"supportedTeamingPolicies": {
"supportedTeamingPolicies": "string"
}
}
]
},
"networkProfiles": [
{
"name": "string",
"description": "string",
"nsxtHostSwitchConfigs": [
{
"vdsName": "string",
"uplinkProfileName": "string",
"ipAddressPoolName": "string",
"vdsUplinkToNsxUplink": [
{
"vdsUplinkName": "string",
"nsxUplinkName": "string"
}
]
}
]
}
]
},
"isEdgeClusterConfiguredForMultiAZ": false,
"deployWithoutLicenseKeys": false
},
"clusterUnstretchSpec": {},
"markForDeletion": false,
"prepareForStretch": false
}Cluster Name
This specification contains the parameters required to add one or more vSphere hosts to an existing cluster in a workload domain
This specification contains the parameters required to remove one or more vSphere hosts from existing cluster in a workload domain
This spec contains the parameters required to convert a Standard vSAN cluster to a Stretched cluster
This spec contains the parameters required to convert a Stretched cluster to a Standard vSAN cluster
Prepare the cluster for deletion
Prepare the cluster for stretch
Accepted
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}Task ID
Task name
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Task status
Task creation timestamp
Task completion timestamp
Resolution state
Represents task can be cancellable or not.
Indicates whether a task is eligible for retry or not.
Bad Request
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Not Found
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
InternalServerError
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.