ClusterUpdateSpec

ClusterUpdateSpec
ClusterUpdateSpec

Cluster Update Data

JSON Example
{
    "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
}
string
name
Optional

Cluster Name

clusterExpansionSpec
Optional

This specification contains the parameters required to add one or more vSphere hosts to an existing cluster in a workload domain

clusterCompactionSpec
Optional

This specification contains the parameters required to remove one or more vSphere hosts from existing cluster in a workload domain

clusterStretchSpec
Optional

This spec contains the parameters required to convert a Standard vSAN cluster to a Stretched cluster

clusterUnstretchSpec
Optional

This spec contains the parameters required to convert a Stretched cluster to a Standard vSAN cluster

boolean
markForDeletion
Optional

Prepare the cluster for deletion

boolean
prepareForStretch
Optional

Prepare the cluster for stretch