HostVirtualSwitch

HostVirtualSwitch
HostVirtualSwitch

The virtual switch is a software entity to which multiple virtual network adapters can connect to create a virtual network.

It can also be bridged to a physical network.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "key": "string",
    "numPorts": 0,
    "numPortsAvailable": 0,
    "mtu": 0,
    "portgroup": [
        {
            "_typeName": "string",
            "key": "string",
            "port": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "mac": [
                        "string"
                    ],
                    "type": "string"
                }
            ],
            "vswitch": "HostVirtualSwitch Object",
            "computedPolicy": {
                "_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
                }
            },
            "spec": {
                "_typeName": "string",
                "name": "string",
                "vlanId": 0,
                "vswitchName": "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
                    }
                }
            }
        }
    ],
    "pnic": [
        {
            "_typeName": "string",
            "key": "string",
            "device": "string",
            "pci": "string",
            "driver": "string",
            "driverVersion": "string",
            "firmwareVersion": "string",
            "linkSpeed": {
                "_typeName": "string",
                "speedMb": 0,
                "duplex": false
            },
            "validLinkSpecification": [
                {
                    "_typeName": "string",
                    "speedMb": 0,
                    "duplex": false
                }
            ],
            "spec": {
                "_typeName": "string",
                "ip": {
                    "_typeName": "string",
                    "dhcp": false,
                    "ipAddress": "string",
                    "subnetMask": "string",
                    "ipV6Config": {
                        "_typeName": "string",
                        "ipV6Address": [
                            {
                                "_typeName": "string",
                                "ipAddress": "string",
                                "prefixLength": 0,
                                "origin": "string",
                                "dadState": "string",
                                "lifetime": "string",
                                "operation": "string"
                            }
                        ],
                        "autoConfigurationEnabled": false,
                        "dhcpV6Enabled": false
                    }
                },
                "linkSpeed": {
                    "_typeName": "string",
                    "speedMb": 0,
                    "duplex": false
                },
                "enableEnhancedNetworkingStack": false,
                "ensInterruptEnabled": false
            },
            "wakeOnLanSupported": false,
            "mac": "string",
            "fcoeConfiguration": {
                "_typeName": "string",
                "priorityClass": 0,
                "sourceMac": "string",
                "vlanRange": [
                    {
                        "_typeName": "string",
                        "vlanLow": 0,
                        "vlanHigh": 0
                    }
                ],
                "capabilities": {
                    "_typeName": "string",
                    "priorityClass": false,
                    "sourceMacAddress": false,
                    "vlanRange": false
                },
                "fcoeActive": false
            },
            "vmDirectPathGen2Supported": false,
            "vmDirectPathGen2SupportedMode": "string",
            "resourcePoolSchedulerAllowed": false,
            "resourcePoolSchedulerDisallowedReason": [
                "string"
            ],
            "autoNegotiateSupported": false,
            "enhancedNetworkingStackSupported": false,
            "ensInterruptSupported": false,
            "rdmaDevice": {
                "_typeName": "string",
                "key": "string",
                "device": "string",
                "driver": "string",
                "description": "string",
                "backing": {
                    "_typeName": "string"
                },
                "connectionInfo": {
                    "_typeName": "string",
                    "state": "string",
                    "mtu": 0,
                    "speedInMbps": 0
                },
                "capability": {
                    "_typeName": "string",
                    "roceV1Capable": false,
                    "roceV2Capable": false,
                    "iWarpCapable": false
                }
            },
            "dpuId": "string"
        }
    ],
    "spec": {
        "_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
    }
}
string
name
Required

The name of the virtual switch.

Maximum length is 32 characters.

string
key
Required

The virtual switch key.

integer As int32 As int32
numPorts
Required

The number of ports that this virtual switch currently has.

integer As int32 As int32
numPortsAvailable
Required

The number of ports that are available on this virtual switch.

There are a number of networking services that utilize a port on the virtual switch and are not accounted for in the Port array of a PortGroup. For example, each physical NIC attached to a virtual switch consumes one port. This property should be used when attempting to implement admission control for new services attaching to virtual switches.

integer As int32 As int32
mtu
Optional

The maximum transmission unit (MTU) associated with this virtual switch in bytes.

portgroup
Optional

The list of port groups configured for this virtual switch.

pnic
Optional

The set of physical network adapters associated with this bridge.

spec
Required

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