Scripting Object - VcDistributedVirtualSwitchManager

Scripting-object corresponding to
DistributedVirtualSwitchManager
Attribute of
VcSdkConnection, VcServiceContent

Scripting Object Description

The {@link vim.dvs.DistributedVirtualSwitchManager} provides methods that support the following operations:

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, dVSManagerExportEntity_Task, dVSManagerImportEntity_Task, dVSManagerLookupDvPortGroup, dVSManagerQueryDvpgUplinkTeam, dVSManagerQueryHostNetworkResource, executeDvsOpaqueCommand_Task, fetchDvsOpaqueData, fetchDvsOpaqueDataEx, queryAvailableDvsSpec, queryCompatibleHostForExistingDvs, queryCompatibleHostForNewDvs, queryDvsByUuid, queryDvsCheckCompatibility, queryDvsCompatibleHostSpec, queryDvsConfigTarget, queryDvsFeatureCapability, queryVwirePort, rectifyDvsOnHost_Task, updateDvsOpaqueData_Task, updateDvsOpaqueDataEx_Task

dVSManagerQueryHostNetworkResource

Returns a list of {@link vim.dvs.DistributedVirtualSwitchManager.HostNetworkResource} containing resource available on host for each specified network ID @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcHostNetworkResource []

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

fetchDvsOpaqueDataEx

Fetch the opaque data associated with given set of entities in selectionSet. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcSelectionSet []

arg1Boolean


Return Value

Type Description
VcDVSOpaqueConfigInfo []

queryDvsConfigTarget

This operation returns the DistributedVirtualSwitch or DistributedVirtualPortgroup configuration target on a host. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostSystem

arg1VcDistributedVirtualSwitch


Return Value

Type Description
VcDVSManagerDvsConfigTarget

dVSManagerImportEntity_Task

Import the configuration of entities specified in {@link vim.dvs.EntityBackup.Config}. You can restore the existing configuration to the state represented by the backup configuration. You can also use the backup configuration to create a new switch or portgroup. See {@link vim.dvs.EntityBackup.ImportType}. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcEntityBackupConfig []

arg1String


Return Value

Type Description
VcTask

fetchDvsOpaqueData

Fetch the opaque data associated with given set of entities in selectionSet. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcSelectionSet []

arg1Boolean


Return Value

Type Description
VcDVSOpaqueDataConfigInfo []

queryDvsCheckCompatibility

This operation returns a list of compatibility results. Each compatibility result is an object that has a host property and optionally a fault which would be populated only if that host is not compatible with a given dvsProductSpec. All filters in hostFilerSpecs are ANDed to derive the intersection of hosts against which compatibility is checked. If caller did not have view privileges on the host entity in an element of the CompatibilityResult array, then that entire element would be removed from the CompatibilityResult array. Typical uses: @since vSphere API 4.1

Parameters

NameTypeDescription
arg0VcDistributedVirtualSwitchManagerHostContainer

arg1VcDistributedVirtualSwitchManagerDvsProductSpec

arg2VcDistributedVirtualSwitchManagerHostDvsFilterSpec []


Return Value

Type Description
VcDistributedVirtualSwitchManagerCompatibilityResult []

queryVwirePort

Get the ports of a virtual wire opaque network. If an entity is provided to this function, then should be of the type VirtualMachine or HostSystem. The function will return all ports of given virtual wire network that are connected to this entity. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcOpaqueNetwork

arg1VcManagedEntity


Return Value

Type Description
VcVwirePort []

queryDvsCompatibleHostSpec

This operation returns a list of host product specifications that are compatible with the given DistributedVirtualSwitch product specification. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDistributedVirtualSwitchProductSpec


Return Value

Type Description
VcDistributedVirtualSwitchHostProductSpec []

dVSManagerLookupDvPortGroup

Returns the portgroup identified by the key within the specified VDS identified by its UUID. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcDistributedVirtualPortgroup

queryDvsFeatureCapability

This operation indicates which version-specific DVS features are available for the given DistributedVirtualSwitch product specification. @since vSphere API 4.1

Parameters

NameTypeDescription
arg0VcDistributedVirtualSwitchProductSpec


Return Value

Type Description
VcDVSFeatureCapability

dVSManagerQueryDvpgUplinkTeam

Returns a list of {@link vim.dvs.DistributedVirtualSwitchManager.DvpgUplinkTeam} containing the uplink team information for each specified portgroup key @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcDVSManagerDvpgUplinkTeam []

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

queryDvsByUuid

This operation returns a DistributedVirtualSwitch given a UUID. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcDistributedVirtualSwitch

queryCompatibleHostForNewDvs

This operation returns a list of hosts that are compatible with the given DistributedVirtualSwitch product specification. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1Boolean

arg2VcDistributedVirtualSwitchProductSpec


Return Value

Type Description
VcHostSystem []

rectifyDvsOnHost_Task

Update the Distributed Switch configuration on the hosts to bring them in sync with the current configuration in vCenter Server. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostSystem []


Return Value

Type Description
VcTask

dVSManagerExportEntity_Task

Export the configuration for entities specified in the selectionSet parameter. You can use this method only for a {@link vim.dvs.VmwareDistributedVirtualSwitch} and its associated {@link vim.dvs.DistributedVirtualPortgroup} objects.

Use the {@link #importEntity} method to restore the entity to the state represented by the exported configuration. You can also use the exported configuration to create a new switch or portgroup. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcSelectionSet []


Return Value

Type Description
VcTask

updateDvsOpaqueData_Task

Update the opaque data on a given set of entities. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcSelectionSet []

arg1VcDVSOpaqueDataConfigSpec []

arg2Boolean


Return Value

Type Description
VcTask

queryCompatibleHostForExistingDvs

This operation returns a list of hosts that are compatible with the given DistributedVirtualSwitch product specification. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1Boolean

arg2VcDistributedVirtualSwitch


Return Value

Type Description
VcHostSystem []

updateDvsOpaqueDataEx_Task

Update the opaque data on a given set of entities. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcSelectionSet []

arg1VcDVSOpaqueConfigSpec []

arg2Boolean


Return Value

Type Description
VcTask

executeDvsOpaqueCommand_Task

Execute the opaque command associated with given set of entities in selectionSet. The command execution should be limited in very short time, since it may block other dvs/dvpg/dvport operations in its execution.

Executing opaque command may require the following privileges depends on what kind of selectionset is specified:

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcSelectionSet []

arg1VcDVSOpaqueCommandReqSpec


Return Value

Type Description
VcTask

queryAvailableDvsSpec

This operation returns a list of switch product specifications that are supported by the vCenter Server. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
VcDistributedVirtualSwitchProductSpec []