Managed Object - DistributedVirtualSwitchManager

Property of
ServiceContent
See also
DistributedVirtualSwitch, DistributedVirtualSwitchHostProductSpec, DistributedVirtualSwitchProductSpec, DVSManagerDvsConfigTarget, HostSystem, ManagedEntity
Since
vSphere API 4.0


Managed Object Description

The interface to provide relevant information of DistributedVirtualSwitch.

Properties

Name Type Description
None

Methods

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

QueryAvailableDvsSpec

This operation returns a list of switch product specification that are supported by the Virtual Center 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
NotSupportedThrown if called directly on a host.
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 object for this parameter are Datacenter, ComputeResource and Folder.
recursivexsd:boolean

Whether to search for hosts in the subfolders, if applicable.
dvsManagedObjectReference
to a DistributedVirtualSwitch

Search the host based on the specification published in the compatibleHostComponentProductInfo of a DistributedVirtualSwitch. If not set, it's 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.
NotSupportedThrown if called directly on a host.
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 object for this parameter are Datacenter, ComputeResource and Folder.
recursivexsd:boolean

Whether to search for hosts in the subfolders, if applicable.
switchProductSpec*DistributedVirtualSwitchProductSpec

The productSpec of a DistributedVirtualSwitch. If not set, it's 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.
NotSupportedThrown if called directly on a host.
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



QueryDvsCompatibleHostSpec

This operation returns a list of host product specification 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's 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.
NotSupportedThrown if called directly on a host.
NotSupportedThrown if called directly on a host.
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