Validate Edge Cluster Update Spec

Validate Edge Cluster Update Spec

Perform validation of the EdgeClusterUpdateSpec specification

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/edge-clusters/{id}/validations
COPY
Path Parameters
string
id
Required

NSX Edge cluster id


Request Body

NSX Edge Cluster Update spec to be validated

EdgeClusterUpdateSpec of type(s) application/json
Required

Show optional properties

{
    "operation": "One among: EXPANSION, SHRINKAGE"
}
{
    "edgeClusterExpansionSpec": {
        "additionalTier1Names": [
            "string"
        ],
        "edgeNodeAdminPassword": "string",
        "edgeNodeAuditPassword": "string",
        "edgeNodeRootPassword": "string",
        "edgeNodeSpecs": [
            {
                "clusterId": "string",
                "edgeNodeName": "string",
                "edgeTep1IP": "string",
                "edgeTep2IP": "string",
                "edgeTepGateway": "string",
                "edgeTepIpAddressPool": {
                    "name": "string",
                    "nsxId": "string"
                },
                "edgeTepVlan": 0,
                "firstNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
                "interRackCluster": false,
                "managementGateway": "string",
                "managementIP": "string",
                "vmManagementPortgroupVlan": 0,
                "vmManagementPortgroupName": "string",
                "secondNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
                "uplinkNetwork": [
                    {
                        "asnPeer": 0,
                        "bgpPeerPassword": "string",
                        "bgpPeers": [
                            {
                                "asn": 0,
                                "ip": "string",
                                "password": "string"
                            }
                        ],
                        "peerIP": "string",
                        "uplinkInterfaceIP": "string",
                        "uplinkVlan": 0
                    }
                ]
            }
        ],
        "newIpAddressPoolSpecs": [
            {
                "description": "string",
                "ignoreUnavailableNsxtCluster": false,
                "name": "string",
                "subnets": [
                    {
                        "cidr": "string",
                        "gateway": "string",
                        "ipAddressPoolRanges": [
                            {
                                "end": "string",
                                "start": "string"
                            }
                        ]
                    }
                ]
            }
        ],
        "skipTepRoutabilityCheck": false,
        "tier1Unhosted": false
    },
    "edgeClusterShrinkageSpec": {
        "edgeNodeIds": [
            "string"
        ]
    },
    "operation": "One among: EXPANSION, SHRINKAGE"
}
edgeClusterExpansionSpec
Optional

This specification contains the parameters required to expand a NSX edge cluster.

edgeClusterShrinkageSpec
Optional

This specification contains the parameters required to shrink a NSX edge cluster.

string
operation
Required

Edge cluster operation Type.

Responses
200

OK

Returns Validation of type(s) application/json
{
    "additionalProperties": {
        "additionalProperties": "string"
    },
    "description": "string",
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "id": "string",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
    "validationChecks": [
        {
            "description": "string",
            "errorResponse": {
                "arguments": [
                    "string"
                ],
                "causes": [
                    {
                        "message": "string",
                        "type": "string"
                    }
                ],
                "context": {
                    "context": "string"
                },
                "errorCode": "string",
                "errorType": "string",
                "message": "string",
                "nestedErrors": [
                    "Error Object"
                ],
                "referenceToken": "string",
                "remediationMessage": "string"
            },
            "nestedValidationChecks": [
                "ValidationCheck Object"
            ],
            "resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
            "severity": "One among: WARNING, ERROR, INFO"
        }
    ]
}
object
additionalProperties
Optional

additionalProperties

string
description
Optional

Description of the validation

string
executionStatus
Optional

Execution status of the validation

string
id
Optional

ID of the validation

string
resultStatus
Optional

Result status of the validation after it has completed its execution

validationChecks
Optional

List of one or more validation checks that are performed as part of the validation


202

Accepted

Returns Validation of type(s) application/json
{
    "additionalProperties": {
        "additionalProperties": "string"
    },
    "description": "string",
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "id": "string",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
    "validationChecks": [
        {
            "description": "string",
            "errorResponse": {
                "arguments": [
                    "string"
                ],
                "causes": [
                    {
                        "message": "string",
                        "type": "string"
                    }
                ],
                "context": {
                    "context": "string"
                },
                "errorCode": "string",
                "errorType": "string",
                "message": "string",
                "nestedErrors": [
                    "Error Object"
                ],
                "referenceToken": "string",
                "remediationMessage": "string"
            },
            "nestedValidationChecks": [
                "ValidationCheck Object"
            ],
            "resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
            "severity": "One among: WARNING, ERROR, INFO"
        }
    ]
}
object
additionalProperties
Optional

additionalProperties

string
description
Optional

Description of the validation

string
executionStatus
Optional

Execution status of the validation

string
id
Optional

ID of the validation

string
resultStatus
Optional

Result status of the validation after it has completed its execution

validationChecks
Optional

List of one or more validation checks that are performed as part of the validation


400

Bad Request

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


500

InternalServerError

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message