Host Network System Update Virtual Switch

Updates the properties of the virtual switch.

If the bridge is NULL, the configuration will be unset.

If a network adapter is listed in the active or standby list, then changing the set of network adapters to which the physical network adapter is associated may have a side effect of changing the network adapter order policy. If a network adapter is removed from the bridge configuration, then the network adapter is removed from the network adapter teaming order.

The BondBridge configuration is the only valid bridge configuration for an ESX Server system.

See also HostNicOrderPolicy.

Required privileges: Host.Config.Network

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/UpdateVirtualSwitch

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 HostNetworkSystem/{moId}.

string

release

Required

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

Request Body

UpdateVirtualSwitchRequestType of type(s) application/json

Required

{
    "vswitchName": "string",
    "spec": {
        "numPorts": 0,
        "bridge": {
            "_typeName": "string"
        },
        "policy": {
            "security": {
                "allowPromiscuous": false,
                "macChanges": false,
                "forgedTransmits": false
            },
            "nicTeaming": {
                "policy": "string",
                "reversePolicy": false,
                "notifySwitches": false,
                "rollingOrder": false,
                "failureCriteria": {
                    "checkSpeed": "string",
                    "speed": 0,
                    "checkDuplex": false,
                    "fullDuplex": false,
                    "checkErrorPercent": false,
                    "percentage": 0,
                    "checkBeacon": false
                },
                "nicOrder": {
                    "activeNic": [
                        "string"
                    ],
                    "standbyNic": [
                        "string"
                    ]
                }
            },
            "offloadPolicy": {
                "csumOffload": false,
                "tcpSegmentation": false,
                "zeroCopyXmit": false
            },
            "shapingPolicy": {
                "enabled": false,
                "averageBandwidth": 0,
                "peakBandwidth": 0,
                "burstSize": 0
            }
        },
        "mtu": 0
    }
}

string

vswitchName

Required

vswitchName

HostVirtualSwitchSpec

spec

Required

This data object type describes the VirtualSwitch specification representing the properties on a VirtualSwitch that can be configured once the object exists.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

ResourceInUse: if the physical network adapter being bridged is already in use.

NotFound: if the virtual switch does not exist.

InvalidArgument: if the bridge parameter is bad or the network policy is invalid or does not exist or the number of ports specified falls out of valid range, or the beacon configuration is invalid.

NotSupported: if network adapter teaming policy is set but is not supported.

HostConfigFault: for all other configuration failures.

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

204 Response Body

Errors

Host Network System Operations