| 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 | SelectionSet[] |
The selection criteria for a set of
entities to export the configuration.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | 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 | EntityBackupConfig[] |
Configuration of one or more entities to be imported.
The entity backup configuration is returned
by the DVSManagerExportEntity_Task method.
|
importType | xsd:string |
Specifies whether to create a new configuration
or restore a previous configuration. See EntityImportType for valid values.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask | 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 | xsd:string |
The UUID of the DistributedVirtualSwitch.
|
portgroupKey | xsd:string |
The key that identifies a
DistributedVirtualPortgroup.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a DistributedVirtualPortgroup |
Faults
Type | Description |
---|---|
NotFound | Thrown if the portgroup for the specified inputs was not found. |
NotSupported | Thrown if the operation is not supported. |
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* | xsd:boolean |
If set to true, return only the recommened versions.
If set to false, return only the not recommended versions.
If unset, return all supported versions.
Since vSphere API 6.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 | ManagedObjectReference
to a ManagedEntity |
Where to look for hosts. Supported types of objects for
this parameter are Datacenter,
ComputeResource and Folder.
|
recursive | 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.
|
dvs | 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.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a HostSystem[] |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the switch value is not valid or recognized. |
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 | ManagedObjectReference
to a ManagedEntity |
Where to look for hosts. Supported types of objects for
this parameter are Datacenter,
ComputeResource and Folder.
|
recursive | 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.
|
switchProductSpec* | DistributedVirtualSwitchProductSpec |
The productSpec of a DistributedVirtualSwitch.
If not set, it is assumed to be the default one used for
DistributedVirtualSwitch creation.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a HostSystem[] |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the productSpec value is not valid or recognized. |
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 | xsd:string |
|
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 | 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.
|
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.
|
Return Value
Type | Description |
---|---|
DistributedVirtualSwitchManagerCompatibilityResult[] |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the dvsProductSpec value is not valid or recognized. |
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* | DistributedVirtualSwitchProductSpec |
The productSpec of a DistributedVirtualSwitch.
If not set, it is assumed to be the default one used for
DistributedVirtualSwitch creation.
|
Return Value
Type | Description |
---|---|
DistributedVirtualSwitchHostProductSpec[] |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the switchProductSpec value is not valid or recognized. |
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* | 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.
|
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* | DistributedVirtualSwitchProductSpec |
The productSpec of a DistributedVirtualSwitch.
If not set, it is assumed to be the default one used for
DistributedVirtualSwitch creation.
|
Return Value
Type | Description |
---|---|
DVSFeatureCapability |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the switchProductSpec value is not valid or recognized. |
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 | ManagedObjectReference[]
to a HostSystem[] |
The hosts to be rectified.
|
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. |
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 |