DVSConfigSpec
The DVSConfigSpec data object contains configuration data for a DistributedVirtualSwitch.
Use the ReconfigureDvs_Task method to apply the configuration to the switch.
{
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"configVersion": "string",
"name": "string",
"numStandalonePorts": 0,
"maxPorts": 0,
"uplinkPortPolicy": {
"_typeName": "string"
},
"uplinkPortgroup": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"defaultPortConfig": {
"_typeName": "string",
"blocked": {
"_typeName": "string",
"inherited": false,
"value": false
},
"vmDirectPathGen2Allowed": {
"_typeName": "string",
"inherited": false,
"value": false
},
"inShapingPolicy": {
"_typeName": "string",
"inherited": false,
"enabled": {
"_typeName": "string",
"inherited": false,
"value": false
},
"averageBandwidth": {
"_typeName": "string",
"inherited": false,
"value": 0
},
"peakBandwidth": {
"_typeName": "string",
"inherited": false,
"value": 0
},
"burstSize": {
"_typeName": "string",
"inherited": false,
"value": 0
}
},
"outShapingPolicy": {
"_typeName": "string",
"inherited": false,
"enabled": {
"_typeName": "string",
"inherited": false,
"value": false
},
"averageBandwidth": {
"_typeName": "string",
"inherited": false,
"value": 0
},
"peakBandwidth": {
"_typeName": "string",
"inherited": false,
"value": 0
},
"burstSize": {
"_typeName": "string",
"inherited": false,
"value": 0
}
},
"vendorSpecificConfig": {
"_typeName": "string",
"inherited": false,
"keyValue": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
]
},
"networkResourcePoolKey": {
"_typeName": "string",
"inherited": false,
"value": "string"
},
"filterPolicy": {
"_typeName": "string",
"inherited": false,
"filterConfig": [
{
"_typeName": "string",
"inherited": false,
"key": "string",
"agentName": "string",
"slotNumber": "string",
"parameters": {
"_typeName": "string",
"parameters": [
"string"
]
},
"onFailure": "string"
}
]
}
},
"host": [
{
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"operation": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"backing": {
"_typeName": "string"
},
"maxProxySwitchPorts": 0,
"vendorSpecificConfig": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
]
}
],
"extensionKey": "string",
"description": "string",
"policy": {
"_typeName": "string",
"autoPreInstallAllowed": false,
"autoUpgradeAllowed": false,
"partialUpgradeAllowed": false
},
"vendorSpecificConfig": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
],
"contact": {
"_typeName": "string",
"name": "string",
"contact": "string"
},
"switchIpAddress": "string",
"defaultProxySwitchMaxNumPorts": 0,
"infrastructureTrafficResourceConfig": [
{
"_typeName": "string",
"key": "string",
"description": "string",
"allocationInfo": {
"_typeName": "string",
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"reservation": 0
}
}
],
"netResourcePoolTrafficResourceConfig": [
{
"_typeName": "string",
"key": "string",
"description": "string",
"allocationInfo": {
"_typeName": "string",
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"reservation": 0
}
}
],
"networkResourceControlVersion": "string"
}Set of dynamic properties.
This property is optional because only the properties of an object that are unknown to a client will be part of this set. This property is not readonly just in case we want to send such properties from a client in the future.
The version string of the configuration that this spec is trying to change.
This property is required in reconfiguring a switch and should be set to the same value as configVersion. This property is ignored during switch creation.
The name of the switch.
Must be unique in the parent folder.
The number of standalone ports in the switch.
Standalone ports are ports that do not belong to any portgroup. If set to a number larger than number of existing standalone ports in the switch, new ports get created to meet the number. If set to a number smaller than the number of existing standalone ports, free ports (uplink ports excluded) are deleted to meet the number. If the set number cannot be met by deleting free standalone ports, a fault is raised.
Deprecated as of vSphere API 5.0 The default value of this propoerty is maxint and there is no reason for users to change it to a lower value.
The maximum number of DistributedVirtualPorts allowed in the switch.
If specified in a reconfigure operation, this number cannot be smaller than the number of existing DistributedVirtualPorts.
The DVPortSetting data object describes the network configuration of a DistributedVirtualPort.
The host member specification.
A particular host should have only one entry in this array. Duplicate entries for the same host will raise a fault. The host version should be compatible with the version of DistributedVirtualSwitch. Use QueryDvsCheckCompatibility to check for compatibility.
The key of the extension registered by a remote server that controls the switch.
Set the description string of the switch.
Set the opaque blob that stores vendor specific configuration.
IP address for the switch, specified using IPv4 dot notation.
IPv6 address is not supported for this property. The utility of this address is defined by other switch features. switchIpAddress would be ignored when IPFIX collector uses IPv6.
The default host proxy switch maximum port number
The host infrastructure traffic resource allocation specification.
Only the traffic class resource allocations identified in the list will be updated. The other traffic class resource allocations that are not specified will not change.
The dynamic host infrastructure traffic resource allocation specification.
Indicates the Network Resource Control APIs that are supported on the switch.
Possible value can be of DistributedVirtualSwitchNetworkResourceControlVersionEnum.