Scripting Object - VcDistributedVirtualPortgroup

Scripting-object corresponding to
DistributedVirtualPortgroup
Attribute of
VcDistributedVirtualPortgroupInfo, VcDistributedVirtualSwitch, VcDistributedVirtualSwitchManagerImportResult, VcDVSConfigInfo, VcDVSConfigSpec, VcVmwareDistributedVirtualSwitch, VcVMwareDVSConfigInfo, VcVMwareDVSConfigSpec
Returned by
dVSManagerLookupDvPortGroup, getAllDistributedVirtualPortgroups, getAllDistributedVirtualPortgroups, lookupDvPortGroup, lookupDvPortGroup

Scripting Object Description

The {@link vim.dvs.DistributedVirtualPortgroup} managed object defines how hosts and virtual machines connect to a network. A distributed virtual portgroup specifies {@link vim.dvs.DistributedVirtualPort} configuration options for the ports on a {@link vim.DistributedVirtualSwitch}. A portgroup also represents a {@link vim.Network} entity in the datacenter.

When you use a portgroup for network access, the Server will create a port according to {@link vim.dvs.DistributedVirtualPortgroup#config}.{@link vim.dvs.DistributedVirtualPortgroup.ConfigInfo#type}.

Attributes

Name Type Description
accessibleBoolean

@since Unknown
alarmActionsEnabledBoolean

@since vSphere API 4.0
availableFieldVcCustomFieldDef []

@since VI API 2.5
configVcDVPortgroupConfigInfo

@since vSphere API 4.0
configIssueVcEvent []

@since VI API 2.5
configStatusVcManagedEntityStatus

@since VI API 2.5
customValueVcCustomFieldValue []

@since VI API 2.5
declaredAlarmStateVcAlarmState []

@since VI API 2.5
disabledMethodString []

@since VI API 2.5
effectiveRoleNumber []

@since VI API 2.5
hostVcHostSystem []

@since VI API 2.5
idString

@since Unknown
keyString

@since vSphere API 4.0
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
nameString

@since Unknown
overallStatusVcManagedEntityStatus

@since VI API 2.5
parentVcManagedEntity

@since VI API 2.5
permissionVcPermission []

@since VI API 2.5
portKeysString []

@since vSphere API 4.0
recentTaskVcTask []

@since VI API 2.5
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
summaryVcNetworkSummary

@since VI API 2.5
tagVcTag []

@since vSphere API 4.0
triggeredAlarmStateVcAlarmState []

@since VI API 2.5
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown
vmVcVirtualMachine []

@since VI API 2.5

Methods

Methods defined in this Scripting Object
_getRef, addTag, createTrigger, destroy_Task, destroyNetwork, dVPortgroupRollback_Task, reconfigureDVPortgroup_Task, reload, removeTag, rename_Task, retrieveCustomValues, setCustomValue

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

removeTag

Removes a set of tags from this object. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcTag []


Return Value

Type Description
None

destroy_Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

NOTE: The appropriate privilege must be held on the parent of the destroyed entity as well as the entity itself.

This method can throw one of several exceptions. The exact set of exceptions depends on the kind of entity that is being removed. See comments for each entity for more information on destroy behavior. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

destroyNetwork

Removes a network. A network can be removed only if it is not used by any host or virtual machine. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

reload

Reload the entity state. Clients only need to call this method if they changed some external state that affects the service without using the Web service interface to perform the change. For example, hand-editing a virtual machine configuration file affects the configuration of the associated virtual machine but the service managing the virtual machine might not monitor the file for changes. In this case, after such an edit, a client would call "reload" on the associated virtual machine to ensure the service and its clients have current data for the virtual machine. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

retrieveCustomValues

Retrieve Custom field values based on specified custom field keys. If there is no key specified, all custom values associated to this ManagedEntity will be returned. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0Number []


Return Value

Type Description
VcCustomFieldValue []

dVPortgroupRollback_Task

This method determines if the portgroup configuration has changed. If it has changed, the method returns a {@link vim.dvs.DistributedVirtualPortgroup.ConfigSpec}. Use the {@link vim.dvs.DistributedVirtualPortgroup#reconfigure} method to apply the rollback configuration to the portgroup. You can use the rollback method only on a portgroup that is associated with a {@link vim.dvs.VmwareDistributedVirtualSwitch}.

To use the rollback method, you must have the DVPortgroup.Read privilege.

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcEntityBackupConfig


Return Value

Type Description
VcTask

reconfigureDVPortgroup_Task

Reconfigures one or more distributed virtual portgroups. You can use this method to set portgroup properties or to reset the portgroup to a previous state.

Reconfiguring a Standard Distributed Virtual Portgroup

To reconfigure a {@link vim.dvs.DistributedVirtualPortgroup}, use a {@link vim.dvs.DistributedVirtualPortgroup.ConfigSpec} to set the portgroup properties.

Reconfiguring a Portgroup Associated With a VMware Distributed Virtual Switch

If you use a {@link vim.dvs.VmwareDistributedVirtualSwitch}, you can perform the following portgroup reconfiguration:

The following privileges are required to reconfigure a portgroup.

@since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDVPortgroupConfigSpec


Return Value

Type Description
VcTask

addTag

Add a set of tags to this object that can be queried later. The tag must be of the form "system/" or "global/ Parameters

NameTypeDescription
arg0VcTag []


Return Value

Type Description
None

rename_Task

Renames this managed entity.

Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask