Distributed Virtual Switch Reconfigure Dvs Task

Distributed Virtual Switch Reconfigure Dvs Task

Reconfigures a distributed virtual switch.

You can use this method to set switch properties or to reset the switch to a previous state.

Reconfiguring a Standard Distributed Virtual Switch

To reconfigure a DistributedVirtualSwitch, use a DVSConfigSpec to set the switch properties.

Reconfiguring a VMware Distributed Virtual Switch

If you use a VmwareDistributedVirtualSwitch, you can perform the following switch reconfiguration:

Reconfiguring the switch may require any of the following privileges, depending on what is being changed:

  • DVSwitch.PolicyOp if policy is set.
  • DVSwitch.PortSetting if defaultPortConfig is set.
  • DVSwitch.HostOp if policy is set. The user will also need the Host.Config.Network privilege on the host.
  • DVSwitch.Vspan if vspanConfigSpec is set.
  • DVSwitch.Modify for anything else.
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualSwitch/{moId}/ReconfigureDvs_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
ReconfigureDvsRequestType of type(s) application/json
Required

Show optional properties

{
    "spec": {}
}
{
    "spec": {
        "_typeName": "string",
        "dynamicProperty": [
            {
                "_typeName": "string",
                "name": "string",
                "val": {
                    "_typeName": "string"
                }
            }
        ],
        "configVersion": "string",
        "name": "string",
        "numStandalonePorts": 0,
        "maxPorts": 0,
        "uplinkPortPolicy": {
            "_typeName": "string"
        },
        "uplinkPortgroup": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "defaultPortConfig": {
            "_typeName": "string",
            "blocked": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "vmDirectPathGen2Allowed": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "inShapingPolicy": {
                "_typeName": "string",
                "inherited": false,
                "enabled": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "averageBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "peakBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "burstSize": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                }
            },
            "outShapingPolicy": {
                "_typeName": "string",
                "inherited": false,
                "enabled": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "averageBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "peakBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "burstSize": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                }
            },
            "vendorSpecificConfig": {
                "_typeName": "string",
                "inherited": false,
                "keyValue": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "opaqueData": "string"
                    }
                ]
            },
            "networkResourcePoolKey": {
                "_typeName": "string",
                "inherited": false,
                "value": "string"
            },
            "filterPolicy": {
                "_typeName": "string",
                "inherited": false,
                "filterConfig": [
                    {
                        "_typeName": "string",
                        "inherited": false,
                        "key": "string",
                        "agentName": "string",
                        "slotNumber": "string",
                        "parameters": {
                            "_typeName": "string",
                            "parameters": [
                                "string"
                            ]
                        },
                        "onFailure": "string"
                    }
                ]
            }
        },
        "host": [
            {
                "_typeName": "string",
                "dynamicProperty": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "val": {
                            "_typeName": "string"
                        }
                    }
                ],
                "operation": "string",
                "host": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "backing": {
                    "_typeName": "string"
                },
                "maxProxySwitchPorts": 0,
                "vendorSpecificConfig": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "opaqueData": "string"
                    }
                ]
            }
        ],
        "extensionKey": "string",
        "description": "string",
        "policy": {
            "_typeName": "string",
            "autoPreInstallAllowed": false,
            "autoUpgradeAllowed": false,
            "partialUpgradeAllowed": false
        },
        "vendorSpecificConfig": [
            {
                "_typeName": "string",
                "key": "string",
                "opaqueData": "string"
            }
        ],
        "contact": {
            "_typeName": "string",
            "name": "string",
            "contact": "string"
        },
        "switchIpAddress": "string",
        "defaultProxySwitchMaxNumPorts": 0,
        "infrastructureTrafficResourceConfig": [
            {
                "_typeName": "string",
                "key": "string",
                "description": "string",
                "allocationInfo": {
                    "_typeName": "string",
                    "limit": 0,
                    "shares": {
                        "_typeName": "string",
                        "shares": 0,
                        "level": "string"
                    },
                    "reservation": 0
                }
            }
        ],
        "netResourcePoolTrafficResourceConfig": [
            {
                "_typeName": "string",
                "key": "string",
                "description": "string",
                "allocationInfo": {
                    "_typeName": "string",
                    "limit": 0,
                    "shares": {
                        "_typeName": "string",
                        "shares": 0,
                        "level": "string"
                    },
                    "reservation": 0
                }
            }
        ],
        "networkResourceControlVersion": "string"
    }
}
spec
Required

The DVSConfigSpec data object contains configuration data for a DistributedVirtualSwitch.

Use the ReconfigureDvs_Task method to apply the configuration to the switch.

Authentication
This operation uses the following authentication methods.
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 or if the spec includes settings for any vNetwork Distributed Switch feature that is not supported on this 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.

ResourceNotAvailable: If there is no port available in the portgroup

VspanPortConflict: if dvPort is used as both the transmitted source and destination ports in Distributed Port Mirroring sessions.

VspanPromiscuousPortNotSupported: if a promiscuous port is used as transmitted source or destination in the Distributed Port Mirroring sessions.

VspanSameSessionPortConflict: if a dvPort is used as both the source and destination in the same Distributed Port Mirroring session.

VspanDestPortConflict: if a dvPort is used as desination ports in multiple Distributed Port Mirroring sessions.

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"
        }
    ]
}

Virtual Infrastructure Operations
POST
Distributed Virtual Switch Add DV Portgroup Task
POST
Distributed Virtual Switch Add Network Resource Pool
POST
Distributed Virtual Switch Create DV Portgroup Task
POST
Distributed Virtual Switch Destroy Task
POST
Distributed Virtual Switch Dvs Reconfigure Vm Vnic Network Resource Pool Task
POST
Distributed Virtual Switch DVS Rollback Task
POST
Distributed Virtual Switch Enable Network Resource Management
POST
Distributed Virtual Switch Fetch DV Port Keys
POST
Distributed Virtual Switch Fetch DV Ports
GET
Distributed Virtual Switch Get Alarm Actions Enabled
GET
Distributed Virtual Switch Get Available Field
GET
Distributed Virtual Switch Get Capability
GET
Distributed Virtual Switch Get Config
GET
Distributed Virtual Switch Get Config Issue
GET
Distributed Virtual Switch Get Config Status
GET
Distributed Virtual Switch Get Custom Value
GET
Distributed Virtual Switch Get Declared Alarm State
GET
Distributed Virtual Switch Get Disabled Method
GET
Distributed Virtual Switch Get Effective Role
GET
Distributed Virtual Switch Get Name
GET
Distributed Virtual Switch Get Network Resource Pool
GET
Distributed Virtual Switch Get Overall Status
GET
Distributed Virtual Switch Get Parent
GET
Distributed Virtual Switch Get Permission
GET
Distributed Virtual Switch Get Portgroup
GET
Distributed Virtual Switch Get Recent Task
GET
Distributed Virtual Switch Get Runtime
GET
Distributed Virtual Switch Get Summary
GET
Distributed Virtual Switch Get Tag
GET
Distributed Virtual Switch Get Triggered Alarm State
GET
Distributed Virtual Switch Get Uuid
GET
Distributed Virtual Switch Get Value
POST
Distributed Virtual Switch Lookup Dv Port Group
POST
Distributed Virtual Switch Merge Dvs Task
POST
Distributed Virtual Switch Move DV Port Task
POST
Distributed Virtual Switch Perform Dvs Product Spec Operation Task
POST
Distributed Virtual Switch Query Used Vlan Id In Dvs
POST
Distributed Virtual Switch Reconfigure DV Port Task
POST
Distributed Virtual Switch Reconfigure Dvs Task
POST
Distributed Virtual Switch Rectify Dvs Host Task
POST
Distributed Virtual Switch Refresh DV Port State
POST
Distributed Virtual Switch Reload
POST
Distributed Virtual Switch Remove Network Resource Pool
POST
Distributed Virtual Switch Rename Task
POST
Distributed Virtual Switch Set Custom Value
POST
Distributed Virtual Switch Update Dvs Capability
POST
Distributed Virtual Switch Update DVS Health Check Config Task
POST
Distributed Virtual Switch Update Network Resource Pool