Data Object - DVPortgroupConfigInfo(vim.dvs.DistributedVirtualPortgroup.ConfigInfo)

Property of
See also
DistributedVirtualSwitch, DistributedVirtualSwitchKeyedOpaqueBlob, DVPortgroupPolicy, DVPortSetting, ManagedEntity
vSphere API 4.0

Data Object Description

The DVPortgroupConfigInfo data object defines the configuration of 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.

When this property is set to true, the portgroup becomes a potential candidate for auto-shrink. Once the portgroup has auto-expanded then its disconnected ports are likely to be deleted automatically, as a part of auto-shrink step, if there are more than certain number of free ports. If the portgroup never auto-expanded, then it will never lose any free ports.

Since vSphere API 5.0

Backing type of portgroup. See DistributedVirtualPortgroup.DistributedVirtualPortgroupBackingType for possible values. The default value is "standard"

Since vSphere API 7.0

Configuration version number.

Common network setting for all the ports in the portgroup.

Description of the portgroup.
to a DistributedVirtualSwitch

Distributed virtual switch 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 of the portgroup.

The logical switch UUID, which is used by NSX portgroup

Since vSphere API 7.0

Name of the portgroup.

Number of ports in the portgroup.

Portgroup policy.

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".

to a ManagedEntity[]

Deprecated. as of vSphere API 5.5

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.

The segment ID of logical switch

Since vSphere API 7.0

The name of transport zone to be associated with a NSX portgroup.

Since vSphere API 7.0

The UUID of transport zone to be associated with a NSX portgroup.

Since vSphere API 7.0

Type of portgroup. See DistributedVirtualPortgroup.DistributedVirtualPortgroupPortgroupType for possible values.

Indicates whether the portgroup is an uplink portroup.

Since vSphere API 6.5

Opaque binary blob that stores vendor specific configuration.

The key of virtual NIC network resource pool to be associated with a portgroup. The default value for this property is unset, indicating that this portgroup is not associated with any virtual NIC network resource pool. To clear the value of this property and revert to unset, set the vmVnicNetworkResourcePoolKey to "-1" in an update operation.

Since vSphere API 6.0
Properties inherited from DynamicData
*Need not be set
Show WSDL type definition