Data Object - DVPortgroupConfigInfo

Property of
DistributedVirtualPortgroup
Extends
DynamicData
See also
DistributedVirtualSwitch, DistributedVirtualSwitchKeyedOpaqueBlob, DVPortgroupPolicy, DVPortSetting, ManagedEntity
Since
vSphere API 4.0

Data Object Description

Configuration of a DistributedVirtualPortgroup.

Properties

Name Type Description
configVersion*xsd:string

The version string of the configuration.
defaultPortConfig*DVPortSetting

The common network setting for all the ports in the portgroup.
description*xsd:string

A description string of the portgroup.
distributedVirtualSwitch*ManagedObjectReference
to a DistributedVirtualSwitch

The Distributed Virtual Switch the portgroup is defined on This property should always be set unless the user's setting does not have System.Read privilege on the object referred to by this property.
keyxsd:string

The key of the portgroup.
namexsd:string

The name of the portgroup.
numPortsxsd:int

Number of ports in the portgroup.
policyDVPortgroupPolicy

Portgroup policy.
portNameFormat*xsd:string

If set, a name will be automatically generated based on this format string for a port when it's created in or moved into the portgroup. The format string can contain meta tags that will be resolved to the corresponding values in generating a name, if applicable for the port at the time of generating name.

See MetaTagName for a list of currently available meta tags. To insert a meta tag in the format string, enclose the names defined in MetaTagName with a pair of "<>". For example: "redNetwork-" and "-pnic" will cause the generated port name to be, e.g, "redNetwork-2" and "myhost-pnic3".

If a meta tag is recognized, but there is no applicable value, the tag will be expanded to empty string. If an arbitrary name appears in a pair of "<>" which is not recognized as one of the defined meta tags, the substring will treated as is and unchanged in the generated name.

To prevent a meta tag from being expanded, prefix the meta tag with a '\'. For example a "abc\def" format string will make the generated port name as "abcdef".

scope*ManagedObjectReference[]
to a ManagedEntity[]

The eligible entities that can connects to the portgroup. If unset, there is no restriction on which entity can connect to the portgroup. If set, only the entities in the specified list or their child entities are allowed to connect to the portgroup. If scopes are defined at both port and portgroup level, they are taken as a "AND" relationship. If such a relationship doesn't make sense, the reconfigure operation will raise an exception.
typexsd:string

The type of portgroup. See PortgroupType for possible values.
vendorSpecificConfig*DistributedVirtualSwitchKeyedOpaqueBlob[]

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