Managed Object - DistributedVirtualSwitchManager

Property of
ServiceContent
See also
DistributedVirtualSwitch, DistributedVirtualSwitchHostProductSpec, DistributedVirtualSwitchManagerCompatibilityResult, DistributedVirtualSwitchManagerDvsProductSpec, DistributedVirtualSwitchManagerHostContainer, DistributedVirtualSwitchManagerHostDvsFilterSpec, DistributedVirtualSwitchProductSpec, DVSFeatureCapability, DVSManagerDvsConfigTarget, HostSystem, ManagedEntity
Since
vSphere API 4.0


Managed Object Description

The interface to provide relevant information about DistributedVirtualSwitch.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
QueryAvailableDvsSpec, QueryCompatibleHostForExistingDvs, QueryCompatibleHostForNewDvs, QueryDvsByUuid, QueryDvsCheckCompatibility, QueryDvsCompatibleHostSpec, QueryDvsConfigTarget, QueryDvsFeatureCapability

QueryAvailableDvsSpec

This operation returns a list of switch product specifications that are supported by the vCenter Server.
Required Privileges
System.View

Parameters

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

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.

Show WSDL type definition



QueryCompatibleHostForExistingDvs

This operation returns a list of hosts that are compatible with the given DistributedVirtualSwitch product specification.
Required Privileges
System.View

Parameters

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

Where to look for hosts. Supported types of objects for this parameter are Datacenter, ComputeResource and Folder.
recursivexsd:boolean

Whether to search for hosts in the subfolders, if applicable. In the case when container is a Datacenter, the recursive flag is applied to its HostFolder.
dvsManagedObjectReference
to a DistributedVirtualSwitch

Search the host based on the specification published in the compatibleHostComponentProductInfo of a DistributedVirtualSwitch. If not set, it is assumed to be the specification that a DistributedVirtualSwitch would have if it is created with the default DistributedVirtualSwitchProductSpec.

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]

Faults

Type Description
InvalidArgumentThrown if the switch value is not valid or recognized.
RuntimeFaultThrown 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



QueryCompatibleHostForNewDvs

This operation returns a list of hosts that are compatible with the given DistributedVirtualSwitch product specification.
Required Privileges
System.View

Parameters

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

Where to look for hosts. Supported types of objects for this parameter are Datacenter, ComputeResource and Folder.
recursivexsd:boolean

Whether to search for hosts in the subfolders, if applicable. In the case when container is a Datacenter, the recursive flag is applied to its HostFolder.
switchProductSpec*DistributedVirtualSwitchProductSpec

The productSpec of a DistributedVirtualSwitch. If not set, it is assumed to be the default one used for DistributedVirtualSwitch creation.
*Need not be set

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]

Faults

Type Description
InvalidArgumentThrown if the productSpec value is not valid or recognized.
RuntimeFaultThrown 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



QueryDvsByUuid

This operation returns a DistributedVirtualSwitch given a UUID.
Required Privileges
System.View

Parameters

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



Return Value

Type Description
ManagedObjectReference
to a DistributedVirtualSwitch

Faults

Type Description
NotFoundThrown if a switch with the UUID doesn't exist.
RuntimeFaultThrown 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



QueryDvsCheckCompatibility

This operation returns a list of compatibility results. Each compatibility result is an object that has a host property and optionally a fault which would be populated only if that host is not compatible with a given dvsProductSpec. All filters in hostFilerSpecs are ANDed to derive the intersection of hosts against which compatibility is checked. If caller did not have view privileges on the host entity in an element of the CompatibilityResult array, then that entire element would be removed from the CompatibilityResult array. Typical uses:
Required Privileges
System.View
Since
vSphere API 4.1

Parameters

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

The container of hosts on which we check the compatibility. This container can be a datacenter, folder, or computeResource. We can also include all the hosts in the hierarchy with container as root of the tree.
dvsProductSpec*DistributedVirtualSwitchManagerDvsProductSpec

The productSpec of a DistributedVirtualSwitch. If not set, it is assumed to be the default one used for DistributedVirtualSwitch creation for current version.
hostFilterSpec*DistributedVirtualSwitchManagerHostDvsFilterSpec[]

The hosts against which to check compatibility. This is a filterSpec and users can use this to specify all hosts in a container (datacenter, folder, or computeResource), an array of hosts, or hosts that might or might not be a DVS member.
*Need not be set

Return Value

Type Description
DistributedVirtualSwitchManagerCompatibilityResult[]

Faults

Type Description
InvalidArgumentThrown if the dvsProductSpec value is not valid or recognized.
RuntimeFaultThrown 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



QueryDvsCompatibleHostSpec

This operation returns a list of host product specifications that are compatible with the given DistributedVirtualSwitch product specification.
Required Privileges
System.View

Parameters

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

The productSpec of a DistributedVirtualSwitch. If not set, it is assumed to be the default one used for DistributedVirtualSwitch creation.
*Need not be set

Return Value

Type Description
DistributedVirtualSwitchHostProductSpec[]

Faults

Type Description
InvalidArgumentThrown if the switchProductSpec value is not valid or recognized.
RuntimeFaultThrown 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



QueryDvsConfigTarget

This operation returns the DistributedVirtualSwitch or DistributedVirtualPortgroup config target on a host.
Required Privileges
System.View

Parameters

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

The host on which the query is to be made. If called directly on the host this parameter need not be specified.
dvs*ManagedObjectReference
to a DistributedVirtualSwitch

The distributed virtual switch on which the query is to be made. If unspecified the config target will encompass all the distributed virtual switches available on the host.
*Need not be set

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.

Show WSDL type definition



QueryDvsFeatureCapability

This operation indicates which version-specific DVS features are available for the given DistributedVirtualSwitch product specification.
Required Privileges
System.View
Since
vSphere API 4.1

Parameters

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

The productSpec of a DistributedVirtualSwitch. If not set, it is assumed to be the default one used for DistributedVirtualSwitch creation.
*Need not be set

Return Value

Type Description
DVSFeatureCapability

Faults

Type Description
InvalidArgumentThrown if the switchProductSpec value is not valid or recognized.
RuntimeFaultThrown 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