Distributed Virtual Switch Merge Dvs Task

Deprecated as of vSphere API 5.5.

Merge an existing DistributedVirtualSwitch (source) to this switch (destination).

The host members and the connected entity of the source switch will be transferred to the destination switch. This operation disconnects the entities from the source switch, tears down its host proxy switches, creates new proxies for the destination switch, and reconnects the entities to the destination switch.

In summary, this operation does the following:

Adds the config.maxPorts of the source switch to the maxPorts of the destination switch.
The host members of the source switch leave the source switch and join the destination switch with the same Physical NIC and VirtualSwitch (if applicable). A set of new uplink ports, compliant with the uplinkPortPolicy, is created as the hosts join the destination switch.
The portgroups on the source switch are copied over to destination switch, by calculating the effective default port config and creating a portgroup of the same name in the destination switch. If the name already exists, the copied portgroup uses names following a "Copy of switch-portgroup-name" scheme to avoid conflict. The same number of ports are created inside each copied portgroup.
The standalone distributed virtual ports are not copied, unless there is a virtual machine or host virtual NIC connecting to it. In that case, the operation calculates the effective port config and creates a port in the destination switch with the same name. Name conflict is resolved using numbers like "original-port-name(1)". The uplink ports are not copied over.
The virtual machine and host virtual NICs are disconnected from the source switch and reconnected with the destination switch, to the copied standalone port or portgroup.
If you are using a VmwareDistributedVirtualSwitch - Unless the PVLAN map contains exactly the same entries between the source and destination VMware distributed virtual switches, the method raises a fault if pvlanId is set in any port, portgroup, or switch that will be copied.

Required privileges: DVSwitch.Modify

Request

URI

POST

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

Request Body

MergeDvsRequestType of type(s) application/json

Required

Show optional properties

{
    "dvs": {}
}

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

MoRefDistributedVirtualSwitch

dvs

Required

Reference to an instance of the DistributedVirtualSwitch managed object.

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.

ResourceInUse: If failed to delete the source switch

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

Virtual Infrastructure Operations