Data Object - DVSSummary

Property of
DistributedVirtualSwitch
Extends
DynamicData
See also
DistributedVirtualSwitchProductSpec, DVSContactInfo, HostSystem, VirtualMachine
Since
vSphere API 4.0

Data Object Description

Summary of the distributed switch configuration.

Properties

Name Type Description
contact*DVSContactInfo

The human operator contact information.
description*xsd:string

A description string of the switch.
host*ManagedObjectReference[]
to a HostSystem[]

The hosts with Virtual NICs that connect to the switch.
hostMember*ManagedObjectReference[]
to a HostSystem[]

The names of the hosts that join the switch.
namexsd:string

The name of the switch.
numPortsxsd:int

Current number of ports, not including conflict ports.
portgroupName*xsd:string[]

The names of the portgroups that are defined on the switch.
productInfo*DistributedVirtualSwitchProductSpec

The product information for the implementation of the switch.
uuidxsd:string

The generated UUID of the switch.
vm*ManagedObjectReference[]
to a VirtualMachine[]

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.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition