Distributed Virtual Portgroup DV Portgroup Rollback Task

This method determines if the portgroup configuration has changed.

If it has changed, the method returns a DVPortgroupConfigSpec. Use the ReconfigureDVPortgroup_Task method to apply the rollback configuration to the portgroup. You can use the rollback method only on a portgroup that is associated with a VmwareDistributedVirtualSwitch.

If you specify the entityBackup parameter, the returned configuration specification represents the exported portgroup configuration. If the entityBackup matches the current portgroup configuration, the method does not return a configuration specification.
If entityBackup is not specified, the returned configuration specification represents a previous state of the portgroup, if available. When you use a VMware distributed virtual switch, each time you reconfigure the switch, the Server saves the switch configuration before applying the updates. If the vCenter Server is restarted, the saved configuration is not preserved and the method does not return a configuration specification.

To use the rollback method, you must have the DVPortgroup.Read privilege.

Request

URI

POST

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

string

release

Required

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

Request Body

DVPortgroupRollbackRequestType of type(s) application/json

Required

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

EntityBackupConfig

entityBackup

Optional

The EntityBackupConfig data object contains VmwareDistributedVirtualSwitch or DistributedVirtualPortgroup backup configuration data produced by the DVSManagerExportEntity_Task method.

It also contains properties that support DVSManagerImportEntity_Task operations.

A DVSManagerExportEntity_Task operation sets properties that identify the entity instance (entityType, key, and name) and inventory location (container). When you import a backup configuration, you can set the key, name, and container properties in accordance with the importType specified in the call to DVSManagerImportEntity_Task. See EntityImportTypeEnum.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns a Task object with which to monitor the operation. If the distributed virtual portgroup configuration has changed, the Task.info.result property contains the DVPortgroupConfigSpec object.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

RollbackFailure: if there is no configuration specified in entityBackup and the previous configuration does not exist either

DvsFault: if operation fails.

Returns DvsFault of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_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 Portgroup Operations

POST

Distributed Virtual Portgroup Destroy Task