Create Clusters

Create Clusters

This API is to be used for creating the specified Clusters.

Request
URI
POST
https://{api_host}/hybridity/api/ztp/v1/clusters
COPY
Request Body

The request payload for Create Cluster API.

InlineZtpV1ClustersRequestBody of type(s) application/json
Required
{
    "domains": [
        {
            "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"
        }
    ]
}
array of object
domains
Required

domains

Authentication
This operation uses the following authentication methods.
Responses
201

The submitted Clusters have been created successfully.

Returns InlineZtpV1Clusters201Response 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 InlineZtpV1Clusters301Response 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 InlineZtpV1Clusters400Response 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

422

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

Returns InlineZtpV1Clusters422Response 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 InlineZtpV1Clusters500Response 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.