Data Object - DVPortgroupConfigSpec(vim.dvs.DistributedVirtualPortgroup.ConfigSpec)

Property of
ClusterComputeResourceDvsProfileDVPortgroupSpecToServiceMapping, DVPortgroupReconfiguredEvent
Parameter to
AddDVPortgroup_Task, CreateDVPortgroup_Task, ReconfigureDVPortgroup_Task
Returned by
DVPortgroupRollback_Task
Extends
DynamicData
See also
DistributedVirtualSwitchKeyedOpaqueBlob, DVPortgroupPolicy, DVPortSetting, ManagedEntity
Since
vSphere API 4.0

Data Object Description

The DVPortgroupConfigSpec data object contains configuration data for a DistributedVirtualPortgroup. Use the ReconfigureDVPortgroup_Task method to apply the configuration to the portgroup.

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.

Setting this property to true makes the portgroup 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
backingType*xsd:string

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

Since vSphere API 7.0
configVersion*xsd:string

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.
defaultPortConfig*DVPortSetting

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

Description of the portgroup.
logicalSwitchUuid*xsd:string

The logical switch UUID, which is used by NSX portgroup

Since vSphere API 7.0
name*xsd:string

Name of the portgroup.
numPorts*xsd:int

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.
policy*DVPortgroupPolicy

Portgroup policy.
portNameFormat*xsd:string

Format of the name of the ports when ports are created in the portgroup. For details see portNameFormat.
scope*ManagedObjectReference[]
to a ManagedEntity[]

Deprecated. as of vSphere API 5.5

Eligible entities that can connect to the port. See DVPortgroupConfigInfo.scope.
segmentId*xsd:string

The segment ID of logical switch

Since vSphere API 7.0
transportZoneName*xsd:string

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

Since vSphere API 7.0
transportZoneUuid*xsd:string

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

Since vSphere API 7.0
type*xsd:string

Type of portgroup. See DistributedVirtualPortgroup.DistributedVirtualPortgroupPortgroupType for possible values.
vendorSpecificConfig*DistributedVirtualSwitchKeyedOpaqueBlob[]

Opaque binary blob that stores vendor specific configuration.
vmVnicNetworkResourcePoolKey*xsd:string

The key of virtual NIC network resource pool to be associated with a portgroup. Setting this property to "-1", would mean that this portgroup is not associated with any virtual NIC network resource pool.

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