| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
selectionSet
parameter. You can use this method only
for a VmwareDistributedVirtualSwitch and its
associated DistributedVirtualPortgroup objects.
Use the DVSManagerImportEntity_Task method to restore the entity to the state represented by the exported configuration. You can also use the exported configuration to create a new switch or portgroup.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitchManager used to make the method call. |
selectionSet P | SelectionSet[] |
The selection criteria for a set of
entities to export the configuration.
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. After successful completion, the Task.Info.result property contains the EntityBackupConfig object. |
Faults
Type | Description |
---|---|
BackupBlobWriteFailure | Thrown if failed to create backup config blob. |
NotFound | Thrown if entity in selectionSet doesn't exist. |
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 DistributedVirtualSwitchManager used to make the method call. |
entityBackup P | EntityBackupConfig[] |
Configuration of one or more entities to be imported.
The entity backup configuration is returned
by the DVSManagerExportEntity_Task method.
Since vSphere API 5.1 |
importType P | xsd:string |
Specifies whether to create a new configuration
or restore a previous configuration. See EntityImportType for valid values.
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails on any host. |
NotFound | Thrown if entity in key doesn't exist. |
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 DistributedVirtualSwitchManager used to make the method call. |
switchUuid P | xsd:string |
The UUID of the DistributedVirtualSwitch.
Since vSphere API 5.1 |
portgroupKey P | xsd:string |
The key that identifies a
DistributedVirtualPortgroup.
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a DistributedVirtualPortgroup |
Faults
Type | Description |
---|---|
NotFound | Thrown if the portgroup for the specified inputs was not found. |
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 DistributedVirtualSwitchManager used to make the method call. |
recommended* P | xsd:boolean |
If set to true, return only the recommended versions.
If set to false, return only the not recommended versions.
If unset, return all supported versions.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
DistributedVirtualSwitchProductSpec[] |
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 DistributedVirtualSwitchManager used to make the method call. |
container P | ManagedObjectReference
to a ManagedEntity |
Where to look for hosts. Supported types of objects for
this parameter are Datacenter,
ComputeResource and Folder.
Since vSphere API 4.0 |
recursive P | xsd: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.
Since vSphere API 4.0 |
dvs P | ManagedObjectReference
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.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a HostSystem[] |
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 DistributedVirtualSwitchManager used to make the method call. |
container P | ManagedObjectReference
to a ManagedEntity |
Where to look for hosts. Supported types of objects for
this parameter are Datacenter,
ComputeResource and Folder.
Since vSphere API 4.0 |
recursive P | xsd: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.
Since vSphere API 4.0 |
switchProductSpec* P | DistributedVirtualSwitchProductSpec |
The productSpec of a DistributedVirtualSwitch.
If not set, it is assumed to be the default one used for
DistributedVirtualSwitch creation.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a HostSystem[] |
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 DistributedVirtualSwitchManager used to make the method call. |
uuid P | xsd:string |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a DistributedVirtualSwitch |
Faults
Type | Description |
---|---|
NotFound | Thrown if a switch with the UUID doesn't exist. |
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 DistributedVirtualSwitchManager used to make the method call. |
hostContainer P | DistributedVirtualSwitchManagerHostContainer |
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.
Since vSphere API 4.1 |
dvsProductSpec* P | DistributedVirtualSwitchManagerDvsProductSpec |
The productSpec of a DistributedVirtualSwitch. If not
set, it is assumed to be the default one used for
DistributedVirtualSwitch creation for current version.
Since vSphere API 4.1 |
hostFilterSpec* P | 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.
Since vSphere API 4.1 |
Return Value
Type | Description |
---|---|
DistributedVirtualSwitchManagerCompatibilityResult[] |
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 DistributedVirtualSwitchManager used to make the method call. |
switchProductSpec* P | DistributedVirtualSwitchProductSpec |
The productSpec of a DistributedVirtualSwitch.
If not set, it is assumed to be the default one used for
DistributedVirtualSwitch creation.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
DistributedVirtualSwitchHostProductSpec[] |
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 DistributedVirtualSwitchManager used to make the method call. |
host* P | 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.
Since vSphere API 4.0 |
dvs* P | 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.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
DVSManagerDvsConfigTarget |
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 DistributedVirtualSwitchManager used to make the method call. |
switchProductSpec* P | DistributedVirtualSwitchProductSpec |
The productSpec of a DistributedVirtualSwitch.
If not set, it is assumed to be the default one used for
DistributedVirtualSwitch creation.
Since vSphere API 4.1 |
Return Value
Type | Description |
---|---|
DVSFeatureCapability |
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 DistributedVirtualSwitchManager used to make the method call. |
hosts P | ManagedObjectReference[]
to a HostSystem[] |
The hosts to be rectified.
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | 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. |
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 Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |