Validate Avn Spec

Validate Avn Spec

Returns Validation report

Request
URI
POST
https://{api_host}/v1/avns/validations
COPY
Request Body
AvnsCreationSpec of type(s) application/json
Required

Show optional properties

{
    "avns": [
        {
            "name": "vRealize-AVN",
            "regionType": "REGION_A",
            "subnet": "192.168.31.0",
            "subnetMask": "255.255.255.0",
            "gateway": "192.168.31.1",
            "mtu": 1600
        }
    ]
}
{
    "edgeClusterId": "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
    "avns": [
        {
            "id": "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
            "name": "vRealize-AVN",
            "regionType": "REGION_A",
            "subnet": "192.168.31.0",
            "subnetMask": "255.255.255.0",
            "gateway": "192.168.31.1",
            "mtu": 1600,
            "vlanId": 30,
            "portGroupName": "sfo-m01-seg01-pg",
            "domainName": "rainpole.io",
            "routerName": "sfo-m01-ec01-t1-gw01"
        }
    ]
}
string
edgeClusterId
Optional

The UUID of the Edge Cluster to associate VLAN AVNs

array of Avn
avns
Required

The list of AVNs to be created

Responses
200

Validation of AVN Creation spec completed

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

ID of the validation

string
description
Required

Description of the validation

string
executionStatus
Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string
resultStatus
Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of ValidationCheck
validationChecks
Optional

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

object
additionalProperties
Optional

additionalProperties


500

Unexpected error

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

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

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

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

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.


On This Page
Avns Operations
POST
Create Avns
GET
Get Avns
POST
Validate Avn Spec