Distributed Virtual Switch Manager DVS Manager Import Entity Task

Import the configuration of entities specified in EntityBackupConfig.

You can restore the existing configuration to the state represented by the backup configuration. You can also use the backup configuration to create a new switch or portgroup. See EntityImportTypeEnum.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualSwitchManager/{moId}/DVSManagerImportEntity_Task

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case DistributedVirtualSwitchManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

DVSManagerImportEntityRequestType of type(s) application/json

Required

{
    "entityBackup": [
        {
            "_typeName": "string",
            "entityType": "string",
            "configBlob": "string",
            "key": "string",
            "name": "string",
            "container": {
                "type": "string",
                "value": "string"
            },
            "configVersion": "string"
        }
    ],
    "importType": "string"
}

array of EntityBackupConfig

entityBackup

Required

Configuration of one or more entities to be imported. The entity backup configuration is returned by the DistributedVirtualSwitchManager.DVSManagerExportEntity_Task method.

string

importType

Required

Specifies whether to create a new configuration or restore a previous configuration. See EntityImportTypeEnum for valid values.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

NotFound: If entity in key doesn't exist.

DvsFault: if operation fails on any host.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Distributed Virtual Switch Manager Operations

POST

Distributed Virtual Switch Manager DVS Manager Export Entity Task