Data Object Description

Properties

Name	Type	Description
autoExpand*	xsd:boolean	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
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 DistributedVirtualSwitch that 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.
key	xsd:string	The key of the portgroup.
name	xsd:string	The name of the portgroup.
numPorts	xsd:int	Number of ports in the portgroup.
policy	DVPortgroupPolicy	Portgroup policy.
portNameFormat*	xsd:string	If set, a name will be automatically generated based on this format string for a port when it is 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 name generation. To insert a meta tag in the format string, enclose the names defined as meta tag names inside angle brackets. See DistributedVirtualPortgroupMetaTagName for a list of currently available meta tags. For example, "redNetwork-<portIndex>" and "<dvsName>-pnic<portIndex>" result in generated port names like "redNetwork-2" and "switch-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 inside a "<>" pair and is not recognized as one of the defined meta tags, the substring is treated as-is and appear unchanged in the generated name. To prevent a meta tag from being expanded, prefix the meta tag with a '\' (backslash). For example, the format string "abc\<portIndex>def" results in the generated port name "abc<portIndex>def".
scope*	ManagedObjectReference[] to a ManagedEntity[]	The eligible entities that can connect 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 an "AND" relationship. If such a relationship doesn't make sense, the reconfigure operation will raise an exception.
type	xsd:string	The type of portgroup. See DistributedVirtualPortgroupPortgroupType for possible values.
vendorSpecificConfig*	DistributedVirtualSwitchKeyedOpaqueBlob[]	An opaque binary blob that stores vendor specific configuration.
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

autoExpand*

xsd:boolean

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

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 DistributedVirtualSwitch that 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.

key

xsd:string

The key of the portgroup.

name

xsd:string

The name of the portgroup.

numPorts

xsd:int

Number of ports in the portgroup.

policy

DVPortgroupPolicy

Portgroup policy.

portNameFormat*

xsd:string

If set, a name will be automatically generated based on this format string for a port when it is 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 name generation.

To insert a meta tag in the format string, enclose the names defined as meta tag names inside angle brackets. See DistributedVirtualPortgroupMetaTagName for a list of currently available meta tags. For example, "redNetwork-<portIndex>" and "<dvsName>-pnic<portIndex>" result in generated port names like "redNetwork-2" and "switch-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 inside a "<>" pair and is not recognized as one of the defined meta tags, the substring is treated as-is and appear unchanged in the generated name.

To prevent a meta tag from being expanded, prefix the meta tag with a '\' (backslash). For example, the format string "abc\<portIndex>def" results in the generated port name "abc<portIndex>def".

scope*

ManagedObjectReference[]
to a ManagedEntity[]

The eligible entities that can connect 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 an "AND" relationship. If such a relationship doesn't make sense, the reconfigure operation will raise an exception.

type

xsd:string

The type of portgroup. See DistributedVirtualPortgroupPortgroupType for possible values.

vendorSpecificConfig*

DistributedVirtualSwitchKeyedOpaqueBlob[]

An opaque binary blob that stores vendor specific configuration.

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DVPortgroupConfigInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="key" type="xsd:string"/>
                     <element name="name" type="xsd:string"/>
                     <element name="numPorts" type="xsd:int"/>
                     <element name="distributedVirtualSwitch" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="defaultPortConfig" type="vim25:DVPortSetting" minOccurs="0"/>
                     <element name="description" type="xsd:string" minOccurs="0"/>
                     <element name="type" type="xsd:string"/>
                     <element name="policy" type="vim25:DVPortgroupPolicy"/>
                     <element name="portNameFormat" type="xsd:string" minOccurs="0"/>
                     <element name="scope" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="vendorSpecificConfig" type="vim25:DistributedVirtualSwitchKeyedOpaqueBlob" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="configVersion" type="xsd:string" minOccurs="0"/>
                     <element name="autoExpand" type="xsd:boolean" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - DVPortgroupConfigInfo

Data Object Description