Update Cluster

Update Cluster

Update the specified Cluster.

Request
URI
PUT
https://{api_host}/hybridity/api/ztp/v1/clusters/{cluster_id}
COPY
Path Parameters
string
cluster_id
Required

The ID of the Cluster.


Request Body

The request payload for Update Cluster API.

InlineZtpV1ClustersCluster_idRequestBody of type(s) application/json
Required
{
    "id": "string",
    "version": 0,
    "name": "cdc1-cc1",
    "type": "string",
    "enabled": false,
    "parentDomainId": "string",
    "location": {
        "city": "string",
        "country": "string",
        "address": "string",
        "longitude": "number",
        "latitude": "number"
    },
    "licenses": {
        "esxi": [
            "string"
        ],
        "vsan": [
            "string"
        ]
    },
    "switches": [
        {
            "name": "string",
            "uplinks": [
                {
                    "pnic": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "services": [
        {
            "name": "string",
            "type": "string",
            "enabled": false,
            "vsanConfig": {
                "vsanDedup": false
            }
        }
    ],
    "storage": {
        "twoNodeVsanCluster": {
            "witness": {
                "preDeployed": {
                    "witnessHostAddress": "string"
                },
                "ztpDeployed": {
                    "ovaPath": "string",
                    "witnessVMDeployment": {
                        "formFactor": "string",
                        "deploymentTarget": {
                            "clusterName": "string",
                            "resourceGroup": "string",
                            "hostName": "string"
                        },
                        "dataStoreName": "string",
                        "primaryNetwork": {
                            "networkName": "string",
                            "fqdn": "string",
                            "gateway": "string",
                            "prefix": 0
                        },
                        "secondaryNetwork": {
                            "networkName": "string",
                            "fqdn": "string",
                            "gateway": "string",
                            "prefix": 0
                        },
                        "rootPassword": "string"
                    }
                }
            }
        }
    },
    "networks": [
        {
            "type": "string",
            "name": "string",
            "switch": "string",
            "segmentType": "string",
            "vlan": 0,
            "mtu": 0,
            "gateway": "string",
            "prefixLength": 0,
            "mac_learning_enabled": false,
            "uplinkTeamingPolicy": {
                "uplinkPortOrder": {
                    "active": [
                        "string"
                    ],
                    "standby": [
                        "string"
                    ],
                    "unused": [
                        "string"
                    ]
                }
            }
        }
    ],
    "settings": {
        "dns": {
            "suffix": "string",
            "servers": [
                "string"
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        },
        "csiTagging": {
            "enableCsiZoning": false,
            "clusterCsiZoneTagNamingScheme": "string",
            "hostCsiZoneTagNamingScheme": "string"
        },
        "disableDatastoreCustomization": false
    },
    "csiTags": {
        "csiZoneTag": "string"
    },
    "csiCategories": {
        "useExisting": false,
        "zone": "string"
    },
    "hcpId": "string"
}
string As uuid As uuid
id
Optional

The unique ID of the domain. This is optional when creating domains and required when updating domain(s) in the absence of domain ID as API Path Param. This field is required and cannot be updated during Domain Update.

integer
version
Optional

The version of this domain entity. This field must be specified during Domain Update.

string As ^[^\s]+$
name
Required

The name of the domain. This field cannot be updated during Domain Update.

string
type
Required

The type of the domain. This field cannot be updated during Domain Update.

boolean
enabled
Optional

Flag indicating whether this domain is enabled or disabled.

string As uuid As uuid
parentDomainId
Optional

The unique ID of the parent domain for this domain. Central Site and Regional Site type domains of sub type MANAGEMENT can't have parent as they themselves are the parents for other domains. This field cannot be updated during Domain Update.

object
location
Optional

The location of the domain.

object
licenses
Optional

The license keys required for the domain.

array of object
switches
Optional

The list of switches under this domain.

array of object
services
Optional

services

object
storage
Optional

Configuration for two node vsan.

array of object
networks
Optional

The list of networks for the switches under this domain.

object
settings
Optional

settings

object
csiTags
Optional

csiTags

object
csiCategories
Optional

csiCategories

string As uuid As uuid
hcpId
Optional

The unique ID of the Host Config Profile to be applied to this domain. This is an optional field when creating domains. During Domain update, if the previous value is present and current update doesn't have this value, it will be treated as intent to remove currently applied Host Config Profile from this domain.

Authentication
This operation uses the following authentication methods.
Responses
200

The specified Cluster has been updated successfully.

Returns InlineZtpV1ClustersCluster_id200Response of type(s) application/json
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1ClustersCluster_id301Response of type(s) application/json
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


400

Response may include details of why the request is bad.

Returns InlineZtpV1ClustersCluster_id400Response of type(s) application/json
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

404

The specified Cluster was not found.

Operation doesn't return any data structure

422

The request payload couldn't be processed by the server.

Returns InlineZtpV1ClustersCluster_id422Response of type(s) application/json
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1ClustersCluster_id500Response of type(s) application/json
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.