Managed Object - DistributedVirtualSwitchManager

Property of
ServiceContent
See also
DistributedVirtualPortgroup, DistributedVirtualSwitch, DistributedVirtualSwitchHostProductSpec, DistributedVirtualSwitchManagerCompatibilityResult, DistributedVirtualSwitchManagerDvsProductSpec, DistributedVirtualSwitchManagerHostContainer, DistributedVirtualSwitchManagerHostDvsFilterSpec, DistributedVirtualSwitchManagerImportResult, DistributedVirtualSwitchNetworkOffloadSpec, DistributedVirtualSwitchProductSpec, DVSFeatureCapability, DVSManagerDvsConfigTarget, DVSManagerPhysicalNicsList, EntityBackupConfig, HostSystem, ManagedEntity, SelectionSet
Since
vSphere API 4.0


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
DVSManagerExportEntity_Task, DVSManagerImportEntity_Task, DVSManagerLookupDvPortGroup, QueryAvailableDvsSpec, QueryCompatibleHostForExistingDvs, QueryCompatibleHostForNewDvs, QueryCompatibleVmnicsFromHosts, QueryDvsByUuid, QueryDvsCheckCompatibility, QueryDvsCompatibleHostSpec, QueryDvsConfigTarget, QueryDvsFeatureCapability, QuerySupportedNetworkOffloadSpec, RectifyDvsOnHost_Task

DVSManagerExportEntity_Task

Required Privileges
None
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
selectionSet PSelectionSet[]

Since vSphere API 5.1
P Required privilege: selectionSet

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
BackupBlobWriteFailure
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DVSManagerImportEntity_Task

Required Privileges
None
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
entityBackup PEntityBackupConfig[]

Since vSphere API 5.1
importType Pxsd:string

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
DvsFault
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DVSManagerLookupDvPortGroup

Required Privileges
System.View
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
switchUuid Pxsd:string

Since vSphere API 5.1
portgroupKey Pxsd:string

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a DistributedVirtualPortgroup

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryAvailableDvsSpec

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
recommended* Pxsd:boolean

Since vSphere API 4.0
*Need not be set P Required privilege: recommended

Return Value

Type Description
DistributedVirtualSwitchProductSpec[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryCompatibleHostForExistingDvs

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
container PManagedObjectReference
to a ManagedEntity

Since vSphere API 4.0
recursive Pxsd:boolean

Since vSphere API 4.0
dvs PManagedObjectReference
to a DistributedVirtualSwitch

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryCompatibleHostForNewDvs

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
container PManagedObjectReference
to a ManagedEntity

Since vSphere API 4.0
recursive Pxsd:boolean

Since vSphere API 4.0
switchProductSpec* PDistributedVirtualSwitchProductSpec

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryCompatibleVmnicsFromHosts

Required Privileges
System.View
Since
null

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
hosts* PManagedObjectReference[]
to a HostSystem[]

Since null
dvs PManagedObjectReference
to a DistributedVirtualSwitch

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
DVSManagerPhysicalNicsList[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryDvsByUuid

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
uuid Pxsd:string

Since vSphere API 4.0
P Required privilege: uuid

Return Value

Type Description
ManagedObjectReference
to a DistributedVirtualSwitch

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryDvsCheckCompatibility

Required Privileges
System.View
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
hostContainer PDistributedVirtualSwitchManagerHostContainer

Since vSphere API 4.1
dvsProductSpec* PDistributedVirtualSwitchManagerDvsProductSpec

Since vSphere API 4.1
hostFilterSpec* PDistributedVirtualSwitchManagerHostDvsFilterSpec[]

Since vSphere API 4.1
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
DistributedVirtualSwitchManagerCompatibilityResult[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryDvsCompatibleHostSpec

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
switchProductSpec* PDistributedVirtualSwitchProductSpec

Since vSphere API 4.0
*Need not be set P Required privilege: switchProductSpec

Return Value

Type Description
DistributedVirtualSwitchHostProductSpec[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryDvsConfigTarget

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
dvs* PManagedObjectReference
to a DistributedVirtualSwitch

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
DVSManagerDvsConfigTarget

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryDvsFeatureCapability

Required Privileges
System.View
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
switchProductSpec* PDistributedVirtualSwitchProductSpec

Since vSphere API 4.1
*Need not be set P Required privilege: switchProductSpec

Return Value

Type Description
DVSFeatureCapability

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QuerySupportedNetworkOffloadSpec

Required Privileges
System.View
Since
null

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
switchProductSpec PDistributedVirtualSwitchProductSpec

Since null
P Required privilege: switchProductSpec

Return Value

Type Description
DistributedVirtualSwitchNetworkOffloadSpec[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RectifyDvsOnHost_Task

Required Privileges
System.Read
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DistributedVirtualSwitchManager used to make the method call.
hosts PManagedObjectReference[]
to a HostSystem[]

Since vSphere API 5.0
P Required privilege: hosts

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
DvsFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None