# Managed Object - DistributedVirtualSwitch

Property of
  ClusterComputeResourceDvsProfile, ClusterComputeResourceDVSSetting, DistributedVirtualSwitchInfo, DistributedVirtualSwitchManagerDvsProductSpec, DistributedVirtualSwitchManagerHostDvsMembershipFilter, DistributedVirtualSwitchManagerImportResult, DVPortgroupConfigInfo, DvsEventArgument
Parameter to
  MergeDvs_Task, QueryCompatibleHostForExistingDvs, QueryCompatibleVmnicsFromHosts, QueryDvsConfigTarget
Returned by
  CreateDVS_Task, QueryDvsByUuid
Extended by
  VmwareDistributedVirtualSwitch
Extends
  ManagedEntity
See also
  DistributedVirtualPort, DistributedVirtualPortgroup, DistributedVirtualSwitchPortCriteria, DistributedVirtualSwitchProductSpec, DVPortConfigSpec, DVPortgroupConfigSpec, DVSCapability, DVSConfigInfo, DVSConfigSpec, DVSHealthCheckConfig, DVSNetworkResourcePool, DVSNetworkResourcePoolConfigSpec, DVSRuntimeInfo, DVSSummary, DvsVmVnicResourcePoolConfigSpec, EntityBackupConfig, HostSystem
Since
  vSphere API 4.0

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
capability | DVSCapability |
config | DVSConfigInfo |
networkResourcePool* | DVSNetworkResourcePool[] | Since vSphere API 4.1
portgroup* | ManagedObjectReference[] to a DistributedVirtualPortgroup[] |
runtime* | DVSRuntimeInfo | Since vSphere API 5.1
summary | DVSSummary |
uuid | xsd:string |
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
AddDVPortgroup_Task, AddNetworkResourcePool, CreateDVPortgroup_Task, DvsReconfigureVmVnicNetworkResourcePool_Task, DVSRollback_Task, EnableNetworkResourceManagement, FetchDVPortKeys, FetchDVPorts, LookupDvPortGroup, MergeDvs_Task, MoveDVPort_Task, PerformDvsProductSpecOperation_Task, QueryUsedVlanIdInDvs, ReconfigureDVPort_Task, ReconfigureDvs_Task, RectifyDvsHost_Task, RefreshDVPortState, RemoveNetworkResourcePool, UpdateDvsCapability, UpdateDVSHealthCheckConfig_Task, UpdateNetworkResourcePool
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

# AddDVPortgroup_Task

Required Privileges
  DVPortgroup.Create

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
spec P | DVPortgroupConfigSpec[] | Since vSphere API 4.0

P Required privilege: spec

Return Value

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

Faults

Type | Description
--- | ---
DuplicateName |
DvsFault |
InvalidName |
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

# AddNetworkResourcePool

Deprecated.

Required Privileges
  DVSwitch.ResourceManagement
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
configSpec P | DVSNetworkResourcePoolConfigSpec[] | Since vSphere API 5.0

P Required privilege: configSpec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
DvsFault |
InvalidName |
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

# CreateDVPortgroup_Task

Required Privileges
  DVPortgroup.Create
Since
  vSphere API 5.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
spec P | DVPortgroupConfigSpec | Since vSphere API 5.1

P Required privilege: spec

Return Value

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

Faults

Type | Description
--- | ---
DuplicateName |
DvsFault |
InvalidName |
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

# DvsReconfigureVmVnicNetworkResourcePool_Task

Required Privileges
  DVSwitch.ResourceManagement
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
configSpec P | DvsVmVnicResourcePoolConfigSpec[] | Since vSphere API 6.0

P Required privilege: configSpec

Return Value

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

Faults

Type | Description
--- | ---
ConcurrentAccess |
ConflictingConfiguration |
DvsFault |
InvalidName |
NotFound |
ResourceInUse |
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

# DVSRollback_Task

Required Privileges
  None
Since
  vSphere API 5.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
entityBackup* P | EntityBackupConfig | Since vSphere API 5.1

*Need not be set P Required privilege: entityBackup

Return Value

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

Faults

Type | Description
--- | ---
DvsFault |
RollbackFailure |
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

# EnableNetworkResourceManagement

Required Privileges
  DVSwitch.ResourceManagement
Since
  vSphere API 4.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
enable P | xsd:boolean | Since vSphere API 4.1

P Required privilege: enable

Return Value

Type | Description
--- | ---
None

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

# FetchDVPortKeys

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
criteria* P | DistributedVirtualSwitchPortCriteria | Since vSphere API 4.0

*Need not be set P Required privilege: criteria

Return Value

Type | Description
--- | ---
xsd:string[] |

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

# FetchDVPorts

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
criteria* P | DistributedVirtualSwitchPortCriteria | Since vSphere API 4.0

*Need not be set P Required privilege: criteria

Return Value

Type | Description
--- | ---
DistributedVirtualPort[] |

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

# LookupDvPortGroup

Required Privileges
  System.Read
Since
  vSphere API 5.1

Parameters

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

P Required privilege: portgroupKey

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

# MergeDvs_Task

Deprecated.

Required Privileges
  DVSwitch.Modify

Parameters

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

P Required privilege: dvs

Return Value

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

Faults

Type | Description
--- | ---
DvsFault |
InvalidHostState |
NotFound |
ResourceInUse |
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

# MoveDVPort_Task

Deprecated.

Required Privileges
  DVSwitch.Modify

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
portKey P | xsd:string[] | Since vSphere API 4.0
destinationPortgroupKey* P | xsd:string | Since vSphere API 4.0

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

Return Value

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

Faults

Type | Description
--- | ---
ConcurrentAccess |
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

# PerformDvsProductSpecOperation_Task

Required Privileges
  DVSwitch.Modify

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
operation P | xsd:string | Since vSphere API 4.0
productSpec* 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 ConverterTask |

Faults

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

Events

Type
None

# QueryUsedVlanIdInDvs

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.

Return Value

Type | Description
--- | ---
xsd:int[] |

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

# ReconfigureDVPort_Task

Required Privileges
  DVSwitch.PortConfig

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
port P | DVPortConfigSpec[] | Since vSphere API 4.0

P Required privilege: port

Return Value

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

Faults

Type | Description
--- | ---
ConcurrentAccess |
DvsFault |
NotFound |
ResourceInUse |
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

# ReconfigureDvs_Task

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
spec P | DVSConfigSpec | Since vSphere API 4.0

P Required privilege: spec

Return Value

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

Faults

Type | Description
--- | ---
AlreadyExists |
ConcurrentAccess |
DuplicateName |
DvsFault |
DvsNotAuthorized |
InvalidName |
InvalidState |
LimitExceeded |
NotFound |
ResourceInUse |
ResourceNotAvailable |
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

# RectifyDvsHost_Task

Deprecated.

Required Privileges
  System.Read

Parameters

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

*Need not be set P Required privilege: hosts

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

# RefreshDVPortState

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
portKeys* P | xsd:string[] | Since vSphere API 4.0

*Need not be set P Required privilege: portKeys

Return Value

Type | Description
--- | ---
None

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

# RemoveNetworkResourcePool

Deprecated.

Required Privileges
  DVSwitch.ResourceManagement
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
key P | xsd:string[] | Since vSphere API 5.0

P Required privilege: key

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
DvsFault |
InvalidName |
NotFound |
ResourceInUse |
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

# UpdateDvsCapability

Required Privileges
  DVSwitch.Modify

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
capability P | DVSCapability | Since vSphere API 4.0

P Required privilege: capability

Return Value

Type | Description
--- | ---
None

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

# UpdateDVSHealthCheckConfig_Task

Required Privileges
  DVSwitch.Modify
Since
  vSphere API 5.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
healthCheckConfig P | DVSHealthCheckConfig[] | Since vSphere API 5.1

P Required privilege: healthCheckConfig

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

# UpdateNetworkResourcePool

Deprecated.

Required Privileges
  DVSwitch.ResourceManagement
Since
  vSphere API 4.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call.
configSpec P | DVSNetworkResourcePoolConfigSpec[] | Since vSphere API 4.1

P Required privilege: configSpec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
ConcurrentAccess |
DvsFault |
InvalidName |
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