Managed Object - DistributedVirtualSwitch

Property of: DistributedVirtualSwitchInfo, DVPortgroupConfigInfo, DvsEventArgument
Parameter to: MergeDvs_Task, QueryCompatibleHostForExistingDvs, QueryDvsConfigTarget
Returned by: CreateDVS_Task, QueryDvsByUuid
Extended by: VmwareDistributedVirtualSwitch
Extends: ManagedEntity
See also: DistributedVirtualPort, DistributedVirtualPortgroup, DistributedVirtualSwitchPortCriteria, DistributedVirtualSwitchProductSpec, DVPortConfigSpec, DVPortgroupConfigSpec, DVSCapability, DVSConfigInfo, DVSConfigSpec, DVSSummary, HostSystem
Since: vSphere API 4.0

Managed Object Description

The interface to the distributed virtual switch objects.

Properties

Name	Type	Description
capability	DVSCapability	The capbility of the switch. Queried against hosts, the property should always return configModificationSupported as false.
config	DVSConfigInfo	The config of the switch.
portgroup*	ManagedObjectReference[] to a DistributedVirtualPortgroup[]	The portgroups that are defined on the switch.
summary	DVSSummary	The summary of the switch.
uuid	xsd:string	The generated UUID of the switch. Unique across VC 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

*May not be present

Methods

Methods defined in this Managed Object
AddDVPortgroup_Task, FetchDVPortKeys, FetchDVPorts, MergeDvs_Task, MoveDVPort_Task, PerformDvsProductSpecOperation_Task, QueryUsedVlanIdInDvs, ReconfigureDVPort_Task, ReconfigureDvs_Task, RectifyDvsHost_Task, RefreshDVPortState, UpdateDvsCapability
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

AddDVPortgroup_Task

Add a DistributedVirtualportgroups to the switch.

Required Privileges: DVPortgroup.Create

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 Task

Faults

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

FetchDVPortKeys

Return the keys of ports that meet the criteria. Queried against host, the property reports only the connected ports currently on the host.

Required Privileges: System.Read

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 will return the keys of all the ports in the switch.

*Need not be set

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FetchDVPortKeys" type="vim25:FetchDVPortKeysRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FetchDVPortKeysResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

FetchDVPorts

Return the ports that meet the criteria.

Required Privileges: System.Read

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 will return the keys of all the ports in the portgroup.

*Need not be set

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FetchDVPorts" type="vim25:FetchDVPortsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FetchDVPortsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:DistributedVirtualPort" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

MergeDvs_Task

Merge an existing DistributedVirtualSwitch (source) to this switch (destination). The host members and the connected entity of the source switch will be transferred to the destination switch. This operation disconnects the entities from the source switch, tears down its host proxy VirtualSwitches, create the new ones for the destination switch and reconnect the entities to the destination switch.

In summary, this operation does the following:

The maxPorts of source switch is added to the maxPorts of the destination switch.
The host members of the source switch leave the source switch and join the destination switch with the same pnic and VirtualSwitch (if applicable). A set of new uplink ports, compilant with the UplinkPortPolicy, is created as the hosts join the destination switch.
The portgroups on the source switch are copied over to destination switch, by calculating the effective default port config and create a portgroup of the same name in the destination switch. If the name already exists, the copied portgroup will use names like "Copy of switch-portgroup-name" scheme to avoid conflict. The same number of port is created inside each copied portgroup.
The standalone DVPorts are not copied, unless there is a Virtual Machine or host vnic connecting to it. In which case, the operation calculates the effective port config and create a port in the designation DVS with the same name. Name conflict is resolved like "original-port-name(1)". The uplink ports are not copied over.
The Virtual Machine, host vnics are disconnected from the source switch and reconnect with the destination switch, either to the copied standalone port or portgroup.
(Applicable to VmwareDistributedVirtualSwitch object only) Unless the PVLAN map contains exactly the same entries between the source and destination switches, otherwise the operation will raise a fault if pvlanId is set in any of the port/portgroup/switch that will be copied.

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	The switch (source) to be merged

P Required privilege: DVSwitch.Delete

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

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

MoveDVPort_Task

Move the ports out of its current portgroup into the specified portgroup. If the moving of any of the port results in a violation of the portgroup policy/type of the source or destination portgroup, the operation will raise a fault. A conflict port cannot be moved.

Required Privileges: DVSwitch.Modify

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.

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

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

PerformDvsProductSpecOperation_Task

Push the proxy VirtualSwitch module of the specified product info to the host members of the switch at a fixed location known by the host.

Required Privileges: DVSwitch.Modify

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DistributedVirtualSwitch used to make the method call.
operation	xsd:string	The operation. See ProductSpecOperationType for valid values.
productSpec*	DistributedVirtualSwitchProductSpec	The product info of the imeplementation.

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

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

QueryUsedVlanIdInDvs

Return the used VLAN id (PVLAN excluded) in the switch.

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryUsedVlanIdInDvs" type="vim25:QueryUsedVlanIdInDvsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryUsedVlanIdInDvsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:int" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ReconfigureDVPort_Task

Reconfigure individual ports.

Required Privileges: DVSwitch.PortConfig

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 Task

Faults

Type	Description
ConcurrentAccess
DvsFault
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.
ResourceInUse
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

ReconfigureDvs_Task

Reconfigure the switch.

Reconfiguring the switch may require any of the following privileges, depending on what is being changed:

DVSwitch.PolicyOp if ConfigSpec#policy is set.
DVSwitch.PortSetting if ConfigSpec#defaultPortConfig is set.
DVSwitch.HostOp if ConfigSpec#policy is set. The user will also need the Host.Config.Network privilege on the host.
DVSwitch.Modify for anything else.

Required Privileges: Dynamic - See discussion above

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 Task

Faults

Type	Description
AlreadyExists
ConcurrentAccess
DuplicateName
DvsFault
DvsNotAuthorized	Thrown if login-session's extension key does not match (@link vim.DistributedVirtualSwitch.ConfigInfo#extensionKey).
InvalidName
InvalidState
LimitExceeded
NotFound
NotSupported	Thrown if called directly on a host.
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.

RectifyDvsHost_Task

Update the switch configuration on the host to bring them in sync with the current configuration in VirtualCenter server.

Required Privileges: System.Read

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 refreshed. If not set, all hosts are rectified.

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a Task

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.

RefreshDVPortState

Refresh port states.

Required Privileges: System.Read

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 set, all port states are refreshed.

*Need not be set

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshDVPortState" type="vim25:RefreshDVPortStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshDVPortStateResponse">
            <complexType/>
         </element>

UpdateDvsCapability

Set the capability of the switch.

Required Privileges: DVSwitch.Modify

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
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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateDvsCapability" type="vim25:UpdateDvsCapabilityRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateDvsCapabilityResponse">
            <complexType/>
         </element>