Managed Object - DistributedVirtualPortgroup

Property of: DistributedVirtualPortgroupInfo, DistributedVirtualSwitch, DVSConfigInfo, DVSConfigSpec
Extends: Network
See also: DVPortgroupConfigInfo, DVPortgroupConfigSpec
Since: vSphere API 4.0

Managed Object Description

The interface to the distributed virtual portgroup objects. This type represents both a group of ports that share the common network setting and a Network entity in the datacenter.

Properties

Name	Type	Description
config	DVPortgroupConfigInfo	The configuration of the portgroup.
key	xsd:string	The generated UUID of the portgroup.
portKeys*	xsd:string[]	The port keys of those ports in the portgroup.
Properties inherited from Network
host, name, summary, vm
Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be present

Methods

Methods defined in this Managed Object
ReconfigureDVPortgroup_Task
Methods inherited from Network
DestroyNetwork
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

ReconfigureDVPortgroup_Task

The DistributedVirtualPortgroups to be reconfigured

DVPortgroup.PolicyOp if changing the policy of the portgroup.
DVPortgroup.ScopeOp if changing the scope of the portgroup.
DVPortgroup.Modify for anything else.

Required Privileges: Dynamic - See discussion above

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DistributedVirtualPortgroup used to make the method call.
spec	DVPortgroupConfigSpec

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

Type	Description
ConcurrentAccess
DuplicateName
DvsFault	Thrown if spec is not valid.
DvsNotAuthorized	Thrown if login-session's extension key does not match the switch's configured extensionKey.
InvalidName
NotSupported	Thrown if the spec includes settings for any VDS feature that is not supported on this switch.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.