[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

ClusterUpdateSpec

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

Properties

ClusterCompactionSpec

clusterCompactionSpec Optional

Parameters required to perform cluster compaction, optional otherwise

ClusterExpansionSpec

clusterExpansionSpec Optional

Parameters required to perform cluster expansion, optional otherwise

ClusterStretchSpec

clusterStretchSpec Optional

Parameters required to perform Stretch operation on cluster, optional otherwise

ClusterUnstretchSpec

clusterUnstretchSpec Optional

Parameters required to perform Unstretch operation on cluster, optional otherwise

boolean

markForDeletion Optional

Prepare the cluster for deletion

string

name Optional

Cluster Name

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,
	"name": "string",
	"prepareForStretch": false
}

vcf

Parameter To

Update Cluster
Validate Cluster Operations

ClusterUpdateSpec

Properties

JSON Example

Parameter To

Was this page helpful?