[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

ClusterUpdateSpec

This specification contains the parameters required to perform update operation on cluster


Properties

clusterCompactionSpec Optional

Parameters required to perform cluster compaction, optional otherwise


clusterExpansionSpec Optional

Parameters required to perform cluster expansion, optional otherwise


clusterStretchSpec Optional

Parameters required to perform Stretch operation on cluster, optional otherwise


clusterUnstretchSpec Optional

Parameters required to perform Unstretch operation on cluster, optional otherwise


boolean
markForDeletion Optional

Prepare the cluster for deletion


boolean
prepareForStretch Optional

Prepare the cluster for stretch

JSON Example

{
	"clusterCompactionSpec": {
		"force": false,
		"forceByPassingSafeMinSize": false,
		"hosts": [
			{
				"azName": "string",
				"fqdn": "string",
				"id": "string",
				"ipAddress": "string",
				"vmNics": [
					{
						"isActive": false,
						"isAutoNegotiateSupported": false,
						"isInUse": false,
						"linkSpeedMB": 0,
						"name": "string"
					}
				]
			}
		]
	},
	"clusterExpansionSpec": {
		"forceHostAdditionInPresenceofDeadHosts": false,
		"hostSpecs": [
			{
				"azName": "string",
				"hostName": "string",
				"hostNetworkSpec": {
					"vmNics": [
						{
							"id": "string",
							"moveToNvds": false,
							"uplink": "string",
							"vdsName": "string"
						}
					]
				},
				"id": "string",
				"ipAddress": "string",
				"licenseKey": "string",
				"password": "string",
				"serialNumber": "string",
				"sshThumbprint": "string",
				"username": "string"
			}
		],
		"interRackExpansion": false,
		"skipThumbprintValidation": false,
		"vsanNetworkSpecs": [
			{
				"vsanCidr": "string",
				"vsanGatewayIP": "string"
			}
		],
		"witnessSpec": {
			"fqdn": "string",
			"vsanCidr": "string",
			"vsanIp": "string"
		},
		"witnessTrafficSharedWithVsanTraffic": false
	},
	"clusterStretchSpec": {
		"hostSpecs": [
			{
				"azName": "string",
				"hostName": "string",
				"hostNetworkSpec": {
					"vmNics": [
						{
							"id": "string",
							"moveToNvds": false,
							"uplink": "string",
							"vdsName": "string"
						}
					]
				},
				"id": "string",
				"ipAddress": "string",
				"licenseKey": "string",
				"password": "string",
				"serialNumber": "string",
				"sshThumbprint": "string",
				"username": "string"
			}
		],
		"isEdgeClusterConfiguredForMultiAZ": false,
		"secondaryAzOverlayVlanId": 0,
		"vsanNetworkSpecs": [
			{
				"vsanCidr": "string",
				"vsanGatewayIP": "string"
			}
		],
		"witnessSpec": {
			"fqdn": "string",
			"vsanCidr": "string",
			"vsanIp": "string"
		},
		"witnessTrafficSharedWithVsanTraffic": false
	},
	"clusterUnstretchSpec": {},
	"markForDeletion": false,
	"prepareForStretch": false
}
[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Parameter To

Update Cluster
Validate Cluster Operations

Feedback

Was this page helpful?