# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
selectionSet P | SelectionSet[] | Since vSphere API 5.1

P Required privilege: selectionSet

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
BackupBlobWriteFailure |
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
entityBackup P | EntityBackupConfig[] | Since vSphere API 5.1
importType P | xsd:string | Since vSphere API 5.1

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
DvsFault |
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
switchUuid P | xsd:string | Since vSphere API 5.1
portgroupKey P | xsd:string | Since vSphere API 5.1

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DistributedVirtualPortgroup |

Faults

Type | Description
--- | ---
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
recommended* P | xsd:boolean | Since vSphere API 4.0

*Need not be set P Required privilege: recommended

Return Value

Type | Description
--- | ---
DistributedVirtualSwitchProductSpec[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
container P | ManagedObjectReference to a ManagedEntity | Since vSphere API 4.0
recursive P | xsd:boolean | Since vSphere API 4.0
dvs P | ManagedObjectReference to a DistributedVirtualSwitch | Since vSphere API 4.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a HostSystem[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
container P | ManagedObjectReference to a ManagedEntity | Since vSphere API 4.0
recursive P | xsd:boolean | Since vSphere API 4.0
switchProductSpec* P | DistributedVirtualSwitchProductSpec | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a HostSystem[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
hosts* P | ManagedObjectReference[] to a HostSystem[] | Since null
dvs P | ManagedObjectReference to a DistributedVirtualSwitch | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
DVSManagerPhysicalNicsList[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
uuid P | xsd:string | Since vSphere API 4.0

P Required privilege: uuid

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DistributedVirtualSwitch |

Faults

Type | Description
--- | ---
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
hostContainer P | DistributedVirtualSwitchManagerHostContainer | Since vSphere API 4.1
dvsProductSpec* P | DistributedVirtualSwitchManagerDvsProductSpec | Since vSphere API 4.1
hostFilterSpec* P | DistributedVirtualSwitchManagerHostDvsFilterSpec[] | Since vSphere API 4.1

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
DistributedVirtualSwitchManagerCompatibilityResult[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
switchProductSpec* P | DistributedVirtualSwitchProductSpec | Since vSphere API 4.0

*Need not be set P Required privilege: switchProductSpec

Return Value

Type | Description
--- | ---
DistributedVirtualSwitchHostProductSpec[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since vSphere API 4.0
dvs* P | ManagedObjectReference to a DistributedVirtualSwitch | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
DVSManagerDvsConfigTarget |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
switchProductSpec* P | DistributedVirtualSwitchProductSpec | Since vSphere API 4.1

*Need not be set P Required privilege: switchProductSpec

Return Value

Type | Description
--- | ---
DVSFeatureCapability |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
switchProductSpec P | DistributedVirtualSwitchProductSpec | Since null

P Required privilege: switchProductSpec

Return Value

Type | Description
--- | ---
DistributedVirtualSwitchNetworkOffloadSpec[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call.
hosts P | ManagedObjectReference[] to a HostSystem[] | Since vSphere API 5.0

P Required privilege: hosts

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

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

Events

Type
None