Import Vds To Inventory

Import Vds To Inventory

Import Vds to inventory for the given cluster

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

Cluster ID


Request Body

Import Vds Spec

ImportVdsSpec of type(s) application/json
Required
{
    "listOfVdsDetails": [
        {
            "vdsName": "string"
        }
    ]
}
array of VdsDetail
listOfVdsDetails
Required

List of details of vSphere Distributed Switches to be imported to the inventory

Responses
202

Accepted

Returns Array of 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, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
        "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",
        "isRetryable": false
    }
]

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

Internal Server Error

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