HostVirtualSwitchSpec | Virtual Infrastructure JSON API

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:

DataObject

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.

HostVirtualSwitchBridge

bridge

Optional

A bridge connects a virtual switch to a physical network adapter.

There are multiple types of bridges.

HostNetworkPolicy

policy

Optional

This data object type describes network policies that can be configured for both virtual switches and port groups.

The policy settings on the port group can inherit policy settings from their containing virtual switch. These policy settings are inherited if the settings on the port group are not set. Since every policy setting on a port group is optional, every individual policy setting can be inherited.

By contrast, if a host is capable of implementing a policy setting, every virtual switch has some value assigned to the policy setting. In this case, although all of the policy settings are optional, they always have some value either by inheritance or by direct setting.

Policy settings are organized into policy groups such as SecurityPolicy. Policy groups are optional since it is possible that a host may not implement such policies. If a host does not support a policy group, the policy group is not set on both the virtual switches and the port groups.