Search

Class VcDVPortgroupConfigInfo

Extends VcDynamicData
The VcDVPortgroupConfigInfo data object defines the configuration of a VcDistributedVirtualPortgroup. .

Attributes

Name Type Description
autoExpand 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. <p> 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.
configVersion String Configuration version number.
defaultPortConfig VcDVPortSetting Common network setting for all the ports in the portgroup.
description String Description of the portgroup.
distributedVirtualSwitch VcDistributedVirtualSwitch 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 String Key of the portgroup.
name String Name of the portgroup.
numPorts Number Number of ports in the portgroup.
policy VcDVPortgroupPolicy Portgroup policy.
portNameFormat 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. <p> To insert a meta tag in the format string, enclose the names defined as meta tag names inside angle brackets. See <a href="VcDistributedVirtualPortgroupMetaTagName.html">VcDistributedVirtualPortgroupMetaTagName</a> for a list of currently available meta tags. For example, "redNetwork-&lt;portIndex&gt;" and "&lt;dvsName&gt;-pnic&lt;portIndex&gt;" result in generated port names like "redNetwork-2" and "switch-pnic3". <p> 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 "&lt;&gt;" 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. <p> To prevent a meta tag from being expanded, prefix the meta tag with a '\' (backslash). For example, the format string "abc\&lt;portIndex&gt;def" results in the generated port name "abc&lt;portIndex&gt;def".
scope VcManagedEntity[] 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. <br/><i>as of vSphere API 5.5</i>
type String Type of portgroup. See <a href="VcDistributedVirtualPortgroup.html">VcDistributedVirtualPortgroup</a>.<a href="VcDistributedVirtualPortgroupPortgroupType.html">VcDistributedVirtualPortgroupPortgroupType</a> for possible values.
vendorSpecificConfig VcDistributedVirtualSwitchKeyedOpaqueBlob[] Opaque binary blob that stores vendor specific configuration.

Methods

Name Returns
VcDVPortgroupConfigInfo() constructor
equals(Object ) boolean
getAdditionalBeanInfo() java.beans.BeanInfo[]
getBeanDescriptor() java.beans.BeanDescriptor
getDefaultEventIndex() Number
getDefaultPropertyIndex() Number
getDeserializer(String , java.lang.Class , javax.xml.namespace.QName ) org.apache.axis.encoding.Deserializer
getDistributedVirtualSwitch_ManagedObject() Object
getEventSetDescriptors() java.beans.EventSetDescriptor[]
getIcon(Number ) java.awt.Image
getMethodDescriptors() java.beans.MethodDescriptor[]
getPropertyDescriptors() java.beans.PropertyDescriptor[]
getScope_ManagedObject() Object
getSerializer(String , java.lang.Class , javax.xml.namespace.QName ) org.apache.axis.encoding.Serializer
getTypeDesc() org.apache.axis.description.TypeDesc
hashCode() Number
setDistributedVirtualSwitch_ManagedObject(Object ) void
setScope_ManagedObject(Object ) void

Returned by

None

Referenced in

None