Host Network System Add Virtual Switch
Adds a new virtual switch to the system with the given name.
The name must be unique with respect to other virtual switches on the host and is limited to 32 characters.
See also UpdateVirtualSwitch.
Required privileges: Host.Config.Network
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}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"vswitchName": "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
}
}
vswitchName
This data object type describes the VirtualSwitch specification representing the properties on a VirtualSwitch that can be configured once the object exists.
No Content
AlreadyExists: if the virtual switch already exists.
InvalidArgument: if network vswitchName exceeds the maximum allowed length, or the number of ports specified falls out of valid range, or the network policy is invalid, or beacon configuration is invalid.
ResourceInUse: if the physical network adapter being bridged is already in use.
HostConfigFault: for all other configuration failures.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}