| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
A proxy switch performs network I/O to support the following network traffic and operations:
A DistributedVirtualSwitch is the base distributed switch implementation. It supports a VMware distributed virtual switch implementation and it supports third party distributed switch implementations. The base implementation provides the following capabilities (DVSFeatureCapability):
A VmwareDistributedVirtualSwitch supports the following additional capabilities (DVSFeatureCapability and VMwareDVSFeatureCapability):
To use a distributed virtual switch, you create a switch and portgroups on a vCenter Server, and add hosts as members of the switch.
Port creation on a distributed switch is determined by the portgroup type (DVPortgroupConfigSpec.type):
true
.
You can also specify standalone ports that are not associated with a port group and uplink ports that are created on ESXi hosts (DVSConfigSpec.numStandalonePorts).
The DVPortgroupConfigInfo.numPorts property is the total number of ports for a distributed virtual switch. This total includes the ports generated by the static and dynamic portgroups and the standalone ports.
When you add a host to a distributed virtual switch (DistributedVirtualSwitch.config.host), the host automatically creates a proxy switch. The proxy switch is removed automatically when the host is removed from the distributed virtual switch.
Host connection | Specify port or portgroup connections in the host virtual NIC spec (HostVirtualNicSpec.distributedVirtualPort or HostVirtualNicSpec.portgroup). |
Virtual machine connection | Specify port or portgroup connections in the distributed virtual port backing (VirtualEthernetCardDistributedVirtualPortBackingInfo) for the virtual Ethernet cards on the virtual machine (VirtualEthernetCard.backing). |
If you are using a VmwareDistributedVirtualSwitch, you can perform backup and rollback operations on the switch and its associated distributed virtual portgroups.
When you reconfigure a VMware distributed virtual switch (ReconfigureDvs_Task), the Server saves the current switch configuration before applying the configuration updates. The saved switch configuration includes portgroup configuration data. The Server uses the saved switch configuration as a checkpoint for rollback operations. You can rollback the switch or portgroup configuration to the saved configuration, or you can rollback to a backup configuration (EntityBackupConfig).SelectionSet
parameter.
To backup the complete configuration you must select the
distributed virtual switch and all of its portgroups.
To perform query operations on a distributed virtual switch, use the DistributedVirtualSwitchManager methods.
Properties
Name | Type | Description |
---|---|---|
capability | DVSCapability |
Capability of the switch. Capabilities are indicated at the port,
portgroup and switch levels, and for version-specific features.
When you retrieve this property from an ESXi host,
capability.dvsOperationSupported
should always be set to false.
|
config | DVSConfigInfo |
Switch configuration data.
|
networkResourcePool* | DVSNetworkResourcePool[] |
Network resource pool information for the switch.
Since vSphere API 4.1 |
portgroup* | ManagedObjectReference[]
to a DistributedVirtualPortgroup[] |
Portgroups that are defined on the switch.
|
summary | DVSSummary |
Summary of the switch.
|
uuid | xsd:string |
Generated UUID of the switch. Unique across vCenter Server
inventory and instances.
|
Properties inherited from ManagedEntity | ||
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
AddDVPortgroup_Task, EnableNetworkResourceManagement, FetchDVPortKeys, FetchDVPorts, MergeDvs_Task, MoveDVPort_Task, PerformDvsProductSpecOperation_Task, QueryUsedVlanIdInDvs, ReconfigureDVPort_Task, ReconfigureDvs_Task, RectifyDvsHost_Task, RefreshDVPortState, UpdateDvsCapability, UpdateNetworkResourcePool |
Methods inherited from ManagedEntity |
Destroy_Task, Reload, Rename_Task |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
spec | DVPortgroupConfigSpec[] |
The specification for the portgroup.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | Returns a Task object with which to monitor the operation. The method does not return a value in the Task.info.result property. Use the portgroup property to obtain managed object references to the new portgroups. |
Faults
Type | Description |
---|---|
DuplicateName | |
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidName | |
NotSupported | Thrown if called directly on a host. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
enable | xsd:boolean |
If true, enables I/O control. If false,
disables network I/O control.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | Thrown if the enabling/disabling fails. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
NotSupported | Thrown if network I/O control is not supported on the vSphere Distributed Switch. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
criteria* | DistributedVirtualSwitchPortCriteria |
The port selection criteria. If unset, the operation
returns the keys of all the ports in the switch.
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
criteria* | DistributedVirtualSwitchPortCriteria |
The port selection criteria. If unset, the operation
returns the keys of all the ports in the portgroup.
|
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 |
In summary, this operation does the following:
config
.maxPorts
of the source switch to the maxPorts
of the
destination switch.Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
dvs P | ManagedObjectReference
to a DistributedVirtualSwitch |
The switch (source) to be merged
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | Returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidHostState | |
NotFound | |
NotSupported | Thrown if called directly on a host. |
ResourceInUse | Thrown if failed to delete the source switch |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
portKey | xsd:string[] |
The keys of the ports to be moved into the portgroup.
|
destinationPortgroupKey* | xsd:string |
The key of the portgroup to be moved into.
If unset, the port will be moved under the switch.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | Returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
NotFound | |
NotSupported | Thrown if called directly on a host. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
operation | xsd:string |
The operation. See DistributedVirtualSwitchProductSpecOperationType for
valid values. For
VmwareDistributedVirtualSwitch,
only upgrade
is valid.
|
productSpec* | DistributedVirtualSwitchProductSpec |
The product info of the implementation.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | Returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidState | |
NotSupported | Thrown if called directly on a host. |
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 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
port | DVPortConfigSpec[] |
The specification of the ports.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | Returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidArgument | Thrown if the array have different elements for the same port. |
NotFound | |
NotSupported | Thrown if called directly on a host or if the switch implementation doesn't support this API or if the spec includes settings for any vSphere Distributed Switch feature that is not supported on this switch. |
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 |
To reconfigure a DistributedVirtualSwitch, use a DVSConfigSpec to set the switch properties.
If you use a VmwareDistributedVirtualSwitch, you can perform the following switch reconfiguration:
Reconfiguring the switch may require any of the following privileges, depending on what is being changed:
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
spec | DVSConfigSpec |
The configuration of the switch
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | Returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
vim.fault.VspanPortConflict | Thrown if dvPort is used as both the transmitted source and destination ports in Distributed Port Mirroring sessions. |
vim.fault.VspanPromiscuousPortNotSupported | Thrown if a promiscuous port is used as transmitted source or destination in the Distributed Port Mirroring sessions. |
vim.fault.VspanSameSessionPortConflict | Thrown if a dvPort is used as both the source and destination in the same Distributed Port Mirroring session. |
vim.fault.VspanDestPortConflict | Thrown if a dvPort is used as desination ports in multiple Distributed Port Mirroring sessions. |
AlreadyExists | |
ConcurrentAccess | |
DuplicateName | |
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidArgument | Thrown if any of the hosts being added lack support for any of the overlay classes of the switch's overlay instances. |
InvalidName | |
InvalidState | |
LimitExceeded | |
NotFound | |
NotSupported | Thrown if called directly on a host or if the spec includes settings for any vNetwork Distributed Switch feature that is not supported on this switch. |
ResourceInUse | |
ResourceNotAvailable | Thrown if there is no port available in the portgroup |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
hosts* | ManagedObjectReference[]
to a HostSystem[] |
The hosts to be rectified.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
portKeys* | xsd:string[] |
The keys of the ports to be refreshed. If not specified, all port
states are refreshed.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
capability | DVSCapability |
The capability of the switch.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
NotSupported | Thrown if called directly on a host or if the switch implementation doesn't support this API. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
configSpec | DVSNetworkResourcePoolConfigSpec[] |
The network resource pool configuration specification.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConcurrentAccess | Thrown if a network resource pool is modified by two or more clients at the same time. |
DvsFault | Thrown if operation fails on any host or if there are other update failures. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidName | Thrown if the name of the resource pool is invalid. |
NotFound | Thrown if the resource pool does not exist on the dvs. |
NotSupported | Thrown if network I/O control is not supported on the vSphere Distributed Switch. |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |