DVSSummary

DVSSummary
DVSSummary

Summary of the distributed switch configuration.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "uuid": "string",
    "numPorts": 0,
    "productInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "hostMember": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "vm": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "host": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "portgroupName": [
        "string"
    ],
    "description": "string",
    "contact": {
        "_typeName": "string",
        "name": "string",
        "contact": "string"
    },
    "numHosts": 0
}
string
name
Required

The name of the switch.

string
uuid
Required

The generated UUID of the switch.

integer As int32 As int32
numPorts
Required

Current number of ports, not including conflict ports.

productInfo
Optional

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.

hostMember
Optional

The names of the hosts that join the switch.

vm
Optional

The Virtual Machines with Virtual NICs that connect to the switch.

In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

host
Optional

The hosts with Virtual NICs that connect to the switch.

array of string
portgroupName
Optional

The names of the portgroups that are defined on the switch.

string
description
Optional

A description string of the switch.

contact
Optional

Contact information of a human operator.

integer As int32 As int32
numHosts
Optional

The number of hosts in the switch.

The value of this property is not affected by the privileges granted to the current user.