Create Avns

Create Avns

Create AVNs

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/avns
COPY
Request Body

Avn creation data

AvnsCreationSpec of type(s) application/json
Required

Show optional properties

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

The list of AVNs to be created

string
edgeClusterId
Required

The UUID of the Edge Cluster to associate AVNs

Responses
200

OK

Returns Task of type(s) application/json 
{
    "completionTimestamp": "string",
    "creationTimestamp": "string",
    "errors": [
        {
            "arguments": [
                "string"
            ],
            "causes": [
                {
                    "message": "string",
                    "type": "string"
                }
            ],
            "context": {
                "context": "string"
            },
            "errorCode": "string",
            "errorType": "string",
            "message": "string",
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "remediationMessage": "string"
        }
    ],
    "id": "string",
    "isCancellable": false,
    "localizableDescriptionPack": {
        "arguments": [
            "string"
        ],
        "component": "string",
        "message": "string",
        "messageKey": "string"
    },
    "name": "string",
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "resources": [
        {
            "fqdn": "sfo-vc01.rainpole.io",
            "name": "string",
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "sans": [
                "string"
            ],
            "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
        }
    ],
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "subTasks": [
        {
            "completionTimestamp": "string",
            "creationTimestamp": "string",
            "description": "string",
            "errors": [
                {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                }
            ],
            "name": "string",
            "resources": [
                {
                    "fqdn": "sfo-vc01.rainpole.io",
                    "name": "string",
                    "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                    "sans": [
                        "string"
                    ],
                    "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
                }
            ],
            "stages": [
                {
                    "completionTimestamp": "string",
                    "creationTimestamp": "string",
                    "description": "string",
                    "errors": [
                        {
                            "arguments": [
                                "string"
                            ],
                            "causes": [
                                {
                                    "message": "string",
                                    "type": "string"
                                }
                            ],
                            "context": {
                                "context": "string"
                            },
                            "errorCode": "string",
                            "errorType": "string",
                            "message": "string",
                            "nestedErrors": [
                                "Error Object"
                            ],
                            "referenceToken": "string",
                            "remediationMessage": "string"
                        }
                    ],
                    "name": "string",
                    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
                    "type": "string"
                }
            ],
            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
            "subTasks": [
                "SubTask Object"
            ],
            "type": "string"
        }
    ],
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
string
completionTimestamp
Optional

Task completion timestamp

string
creationTimestamp
Optional

Task creation timestamp

array of Error
errors
Optional

List of errors in case of a failure

string
id
Optional

Task ID

boolean
isCancellable
Optional

Represents task can be cancellable or not.

MessagePack
localizableDescriptionPack
Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string
name
Optional

Task name

string
resolutionStatus
Optional

Resolution state

array of Resource
resources
Optional

List of resources associated with task

string
status
Optional

Task status

array of SubTask
subTasks
Optional

List of sub-tasks of the task

string
type
Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _


202

Accepted

Returns Task of type(s) application/json 
{
    "completionTimestamp": "string",
    "creationTimestamp": "string",
    "errors": [
        {
            "arguments": [
                "string"
            ],
            "causes": [
                {
                    "message": "string",
                    "type": "string"
                }
            ],
            "context": {
                "context": "string"
            },
            "errorCode": "string",
            "errorType": "string",
            "message": "string",
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "remediationMessage": "string"
        }
    ],
    "id": "string",
    "isCancellable": false,
    "localizableDescriptionPack": {
        "arguments": [
            "string"
        ],
        "component": "string",
        "message": "string",
        "messageKey": "string"
    },
    "name": "string",
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "resources": [
        {
            "fqdn": "sfo-vc01.rainpole.io",
            "name": "string",
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "sans": [
                "string"
            ],
            "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
        }
    ],
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "subTasks": [
        {
            "completionTimestamp": "string",
            "creationTimestamp": "string",
            "description": "string",
            "errors": [
                {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                }
            ],
            "name": "string",
            "resources": [
                {
                    "fqdn": "sfo-vc01.rainpole.io",
                    "name": "string",
                    "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                    "sans": [
                        "string"
                    ],
                    "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
                }
            ],
            "stages": [
                {
                    "completionTimestamp": "string",
                    "creationTimestamp": "string",
                    "description": "string",
                    "errors": [
                        {
                            "arguments": [
                                "string"
                            ],
                            "causes": [
                                {
                                    "message": "string",
                                    "type": "string"
                                }
                            ],
                            "context": {
                                "context": "string"
                            },
                            "errorCode": "string",
                            "errorType": "string",
                            "message": "string",
                            "nestedErrors": [
                                "Error Object"
                            ],
                            "referenceToken": "string",
                            "remediationMessage": "string"
                        }
                    ],
                    "name": "string",
                    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
                    "type": "string"
                }
            ],
            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
            "subTasks": [
                "SubTask Object"
            ],
            "type": "string"
        }
    ],
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
string
completionTimestamp
Optional

Task completion timestamp

string
creationTimestamp
Optional

Task creation timestamp

array of Error
errors
Optional

List of errors in case of a failure

string
id
Optional

Task ID

boolean
isCancellable
Optional

Represents task can be cancellable or not.

MessagePack
localizableDescriptionPack
Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string
name
Optional

Task name

string
resolutionStatus
Optional

Resolution state

array of Resource
resources
Optional

List of resources associated with task

string
status
Optional

Task status

array of SubTask
subTasks
Optional

List of sub-tasks of the task

string
type
Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _


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


On This Page
Avns Operations
POST
Create Avns
GET
Get All Avns
POST
Validate Avns