HostVirtualSwitchSpec

HostVirtualSwitchSpec
HostVirtualSwitchSpec

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "numPorts": 0,
    "bridge": {
        "_typeName": "string"
    },
    "policy": {
        "_typeName": "string",
        "security": {
            "_typeName": "string",
            "allowPromiscuous": false,
            "macChanges": false,
            "forgedTransmits": false
        },
        "nicTeaming": {
            "_typeName": "string",
            "policy": "string",
            "reversePolicy": false,
            "notifySwitches": false,
            "rollingOrder": false,
            "failureCriteria": {
                "_typeName": "string",
                "checkSpeed": "string",
                "speed": 0,
                "checkDuplex": false,
                "fullDuplex": false,
                "checkErrorPercent": false,
                "percentage": 0,
                "checkBeacon": false
            },
            "nicOrder": {
                "_typeName": "string",
                "activeNic": [
                    "string"
                ],
                "standbyNic": [
                    "string"
                ]
            }
        },
        "offloadPolicy": {
            "_typeName": "string",
            "csumOffload": false,
            "tcpSegmentation": false,
            "zeroCopyXmit": false
        },
        "shapingPolicy": {
            "_typeName": "string",
            "enabled": false,
            "averageBandwidth": 0,
            "peakBandwidth": 0,
            "burstSize": 0
        }
    },
    "mtu": 0
}
integer As int32 As int32
numPorts
Required

The number of ports that this virtual switch is configured to use.

Changing this setting does not take effect until the next reboot. The maximum value is 1024, although other constraints, such as memory limits, may establish a lower effective limit.

bridge
Optional

The bridge specification describes how physical network adapters can be bridged to a virtual switch.

policy
Optional

The virtual switch policy specification.

This has a lower precedence than PortGroup. If the policy property is not set and you are creating a virtual switch, then a default policy property setting is used. If the policy property is not set and you are updating a virtual switch, then the policy will be unchanged.

integer As int32 As int32
mtu
Optional

The maximum transmission unit (MTU) of the virtual switch in bytes.