ClusterUpdateSpec

ClusterUpdateSpec
ClusterUpdateSpec

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

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"
                    }
                ]
            }
        ]
    },
    "clusterComplianceCheckSpec": {
        "clusterImageId": "string"
    },
    "clusterExpansionSpec": {
        "forceHostAdditionInPresenceofDeadHosts": false,
        "deployWithoutLicenseKeys": false,
        "hostSpecs": [
            {
                "azName": "string",
                "hostName": "string",
                "hostNetworkSpec": {
                    "networkProfileName": "string",
                    "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,
        "networkSpec": {
            "networkProfiles": [
                {
                    "description": "string",
                    "name": "string",
                    "nsxtHostSwitchConfigs": [
                        {
                            "ipAddressPoolName": "string",
                            "uplinkProfileName": "string",
                            "vdsName": "string",
                            "vdsUplinkToNsxUplink": [
                                {
                                    "nsxUplinkName": "string",
                                    "vdsUplinkName": "string"
                                }
                            ]
                        }
                    ]
                }
            ],
            "nsxClusterSpec": {
                "ipAddressPoolsSpec": [
                    {
                        "description": "string",
                        "ignoreUnavailableNsxtCluster": false,
                        "name": "string",
                        "subnets": [
                            {
                                "cidr": "string",
                                "gateway": "string",
                                "ipAddressPoolRanges": [
                                    {
                                        "end": "string",
                                        "start": "string"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "uplinkProfiles": [
                    {
                        "name": "string",
                        "supportedTeamingPolicies": {
                            "supportedTeamingPolicies": "string"
                        },
                        "teamings": [
                            {
                                "activeUplinks": [
                                    "string"
                                ],
                                "policy": "string",
                                "standByUplinks": [
                                    "string"
                                ]
                            }
                        ],
                        "transportVlan": 0
                    }
                ]
            }
        },
        "skipThumbprintValidation": false,
        "vsanNetworkSpecs": [
            {
                "vsanCidr": "string",
                "vsanGatewayIP": "string"
            }
        ],
        "witnessSpec": {
            "fqdn": "string",
            "vsanCidr": "string",
            "vsanIp": "string"
        },
        "witnessTrafficSharedWithVsanTraffic": false
    },
    "clusterStretchSpec": {
        "hostSpecs": [
            {
                "azName": "string",
                "hostName": "string",
                "hostNetworkSpec": {
                    "networkProfileName": "string",
                    "vmNics": [
                        {
                            "id": "string",
                            "moveToNvds": false,
                            "uplink": "string",
                            "vdsName": "string"
                        }
                    ]
                },
                "id": "string",
                "ipAddress": "string",
                "licenseKey": "string",
                "password": "string",
                "serialNumber": "string",
                "sshThumbprint": "string",
                "username": "string"
            }
        ],
        "deployWithoutLicenseKeys": false,
        "isEdgeClusterConfiguredForMultiAZ": false,
        "networkProfiles": [
            {
                "description": "string",
                "name": "string",
                "nsxtHostSwitchConfigs": [
                    {
                        "ipAddressPoolName": "string",
                        "uplinkProfileName": "string",
                        "vdsName": "string",
                        "vdsUplinkToNsxUplink": [
                            {
                                "nsxUplinkName": "string",
                                "vdsUplinkName": "string"
                            }
                        ]
                    }
                ]
            }
        ],
        "nsxStretchClusterSpec": {
            "ipAddressPoolsSpec": [
                {
                    "description": "string",
                    "ignoreUnavailableNsxtCluster": false,
                    "name": "string",
                    "subnets": [
                        {
                            "cidr": "string",
                            "gateway": "string",
                            "ipAddressPoolRanges": [
                                {
                                    "end": "string",
                                    "start": "string"
                                }
                            ]
                        }
                    ]
                }
            ],
            "uplinkProfiles": [
                {
                    "name": "string",
                    "supportedTeamingPolicies": {
                        "supportedTeamingPolicies": "string"
                    },
                    "teamings": [
                        {
                            "activeUplinks": [
                                "string"
                            ],
                            "policy": "string",
                            "standByUplinks": [
                                "string"
                            ]
                        }
                    ],
                    "transportVlan": 0
                }
            ]
        },
        "secondaryAzOverlayVlanId": 0,
        "vsanNetworkSpecs": [
            {
                "vsanCidr": "string",
                "vsanGatewayIP": "string"
            }
        ],
        "witnessSpec": {
            "fqdn": "string",
            "vsanCidr": "string",
            "vsanIp": "string"
        },
        "witnessTrafficSharedWithVsanTraffic": false
    },
    "markForDeletion": false,
    "name": "string",
    "prepareForStretch": false
}
clusterCompactionSpec
Optional

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

clusterComplianceCheckSpec
Optional

This specification contains parameters required to check compliance of a Cluster before transition to vSphere Lifecycle Manager Images

clusterComplianceCleanupSpec
Optional

This specification contains parameters required to cleanup compliance results of a Cluster before transition to vSphere Lifecycle Manager Images

clusterExpansionSpec
Optional

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

clusterRemediationSpec
Optional

This specification contains parameters required to remediate a Cluster after transition to vSphere Lifecycle Manager Images

clusterStretchSpec
Optional

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

clusterTransitionSpec
Optional

This specification contains parameters required to transition a Cluster to vSphere Lifecycle Manager Images

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

string
name
Optional

Cluster Name

boolean
prepareForStretch
Optional

Prepare the cluster for stretch