Vmware Distributed Virtual Switch Get Config
Switch configuration data.
The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VmwareDistributedVirtualSwitch/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
OK
{
"_typeName": "string",
"uuid": "string",
"name": "string",
"numStandalonePorts": 0,
"numPorts": 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"
}
}
],
"runtimeState": {
"_typeName": "string",
"currentMaxProxySwitchPorts": 0
},
"config": {
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"maxProxySwitchPorts": 0,
"vendorSpecificConfig": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
],
"backing": {
"_typeName": "string"
},
"nsxSwitch": false,
"ensEnabled": false,
"ensInterruptEnabled": false,
"transportZones": [
{
"_typeName": "string",
"uuid": "string",
"type": "string"
}
],
"nsxtUsedUplinkNames": [
"string"
],
"networkOffloadingEnabled": false
},
"productInfo": {
"_typeName": "string",
"name": "string",
"vendor": "string",
"version": "string",
"build": "string",
"forwardingClass": "string",
"bundleId": "string",
"bundleUrl": "string"
},
"uplinkPortKey": [
"string"
],
"status": "string",
"statusDetail": "string"
}
],
"productInfo": {
"_typeName": "string",
"name": "string",
"vendor": "string",
"version": "string",
"build": "string",
"forwardingClass": "string",
"bundleId": "string",
"bundleUrl": "string"
},
"targetInfo": {
"_typeName": "string",
"name": "string",
"vendor": "string",
"version": "string",
"build": "string",
"forwardingClass": "string",
"bundleId": "string",
"bundleUrl": "string"
},
"extensionKey": "string",
"vendorSpecificConfig": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
],
"policy": {
"_typeName": "string",
"autoPreInstallAllowed": false,
"autoUpgradeAllowed": false,
"partialUpgradeAllowed": false
},
"description": "string",
"configVersion": "string",
"contact": {
"_typeName": "string",
"name": "string",
"contact": "string"
},
"switchIpAddress": "string",
"createTime": "string",
"networkResourceManagementEnabled": false,
"defaultProxySwitchMaxNumPorts": 0,
"healthCheckConfig": [
{
"_typeName": "string",
"enable": false,
"interval": 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",
"vmVnicNetworkResourcePool": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"description": "string",
"configVersion": "string",
"allocationInfo": {
"_typeName": "string",
"reservationQuota": 0
}
}
],
"pnicCapacityRatioForReservation": 0
}
Generated UUID of the switch.
Unique across vCenter Server inventory and instances.
Name of the switch.
Number of standalone ports in the switch.
Standalone ports are ports that do not belong to any portgroup.
Current number of ports, not including conflict ports.
Maximum number of ports allowed in the switch, not including conflict ports.
List of uplink portgroups.
When adding host members, the server uses the DVSConfigInfo.uplinkPortPolicy to create a number of uplink ports for the host. If portgroups are shown here, those uplink ports will be added to the portgroups, with uplink ports evenly spread among the portgroups.
The DVPortSetting data object describes the network configuration of a DistributedVirtualPort.
This data object type is a subset of AboutInfo.
An object of this type can be used to describe the specification for a proxy switch module of a DistributedVirtualSwitch.
This data object type is a subset of AboutInfo.
An object of this type can be used to describe the specification for a proxy switch module of a DistributedVirtualSwitch.
Key of the extension registered by the remote server that controls the switch.
Opaque binary blob that stores vendor specific configuration.
Description string for the switch.
Version string of the configuration.
IP address for the switch, specified using IPv4 dot notation.
The utility of this address is defined by other switch features.
Create time of the switch.
Boolean to indicate if network I/O control is enabled on the switch.
Default host proxy switch maximum port number
Host infrastructure traffic class resource configuration.
Dynamic Host infrastructure traffic class resource configuration.
Network resource control version of the switch.
Possible value can be of DistributedVirtualSwitchNetworkResourceControlVersionEnum.
The Virtual NIC network resource pool information for the switch.
The percentage of physical nic link speed PhysicalNicLinkInfo.speedMb available for infrastructure traffic reservation.
If this value is 75, then for a 1Gbps physical nic, only 750Mbps is allowed for all infrastructure traffic reservations.