Data Object - DVPortgroupConfigSpec

Property of
Parameter to
AddDVPortgroup_Task, ReconfigureDVPortgroup_Task
See also
DistributedVirtualSwitchKeyedOpaqueBlob, DVPortgroupPolicy, DVPortSetting, ManagedEntity
vSphere API 4.0

Data Object Description

Specification to reconfigure a DistributedVirtualPortgroup.


Name Type Description

If set to true, this property ignores the limit on the number of ports in the portgroup. When a Virtual Machine/Host tries to connect to the portgroup and there are no free ports available in the portgroup, new ports will be automatically added to the portgroup. The flag is currently supported only for static portgroups.

Since vSphere API 5.0

The version string of the configuration that this spec is trying to change. This property is required in reconfiguring a portgroup and should be set to the same value as the configVersion. This property is ignored in creating a portgroup if set.

The default network setting for all the ports in the portgroup.

A description string of the portgroup.

The name of the portgroup.

Number of ports in the portgroup. Setting this number larger than the number of existing ports in the portgroup causes new ports to be added to the portgroup to meet the number. Setting this property smaller than the number of existing ports deletes the free ports from the portgroup. If the number cannot be met by deleting free ports, a fault is raised. If new ports are added to the portgroup, they are also added to the switch. For portgroups of type ephemeral this property is ignored.

Portgroup policy.

The format of the name of the ports when ports are created in the portgroup. For details see portNameFormat.
to a ManagedEntity[]

The eligible entities that can connects to the port, for detail see scope.

The type of portgroup. See DistributedVirtualPortgroupPortgroupType for possible values.

An opaque binary blob that stores vendor specific configuration.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition