Distributed Virtual Switch Move DV Port Task

Deprecated as of vSphere API 6.0.

Move the ports out of their current portgroup into the specified portgroup.

If the moving of any of the ports results in a violation of the portgroup policy, or type of the source or destination portgroup, the operation raises a fault. A conflict port cannot be moved.

Required privileges: DVSwitch.Modify

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualSwitch/{moId}/MoveDVPort_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 DistributedVirtualSwitch/{moId}.

string

release

Required

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

Request Body

MoveDVPortRequestType of type(s) application/json

Required

{
    "portKey": [
        "string"
    ],
    "destinationPortgroupKey": "string"
}

array of string

portKey

Required

The keys of the ports to be moved into the portgroup.

string

destinationPortgroupKey

Optional

The key of the portgroup to be moved into. If unset, the port will be moved under the switch.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

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

NotSupported: If called directly on a host.

DvsFault: if operation fails on any host or if there are other update failures.

DvsNotAuthorized: if login-session's extension key does not match the switch's configured extensionKey.

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 Operations