| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
capability | DVSCapability |
|
config | DVSConfigInfo |
|
networkResourcePool* | DVSNetworkResourcePool[] |
Since vSphere API 4.1 |
portgroup* | ManagedObjectReference[]
to a DistributedVirtualPortgroup[] |
|
runtime* | DVSRuntimeInfo |
Since vSphere API 5.1 |
summary | DVSSummary |
|
uuid | xsd:string |
|
Properties inherited from ManagedEntity | ||
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
spec P | DVPortgroupConfigSpec[] |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DuplicateName | |
DvsFault | |
InvalidName | |
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 DistributedVirtualSwitch used to make the method call. |
configSpec P | DVSNetworkResourcePoolConfigSpec[] |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | |
InvalidName | |
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 DistributedVirtualSwitch used to make the method call. |
spec P | DVPortgroupConfigSpec |
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DuplicateName | |
DvsFault | |
InvalidName | |
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 DistributedVirtualSwitch used to make the method call. |
configSpec P | DvsVmVnicResourcePoolConfigSpec[] |
Since vSphere API 6.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
ConflictingConfiguration | |
DvsFault | |
InvalidName | |
NotFound | |
ResourceInUse | |
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 DistributedVirtualSwitch used to make the method call. |
entityBackup* P | EntityBackupConfig |
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DvsFault | |
RollbackFailure | |
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 DistributedVirtualSwitch used to make the method call. |
enable P | xsd:boolean |
Since vSphere API 4.1 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | |
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 DistributedVirtualSwitch used to make the method call. |
criteria* P | DistributedVirtualSwitchPortCriteria |
Since vSphere API 4.0 |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
criteria* P | DistributedVirtualSwitchPortCriteria |
Since vSphere API 4.0 |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
portgroupKey P | xsd:string |
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a DistributedVirtualPortgroup |
Faults
Type | Description |
---|---|
NotFound | |
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 DistributedVirtualSwitch used to make the method call. |
dvs P | ManagedObjectReference
to a DistributedVirtualSwitch |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DvsFault | |
InvalidHostState | |
NotFound | |
ResourceInUse | |
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 DistributedVirtualSwitch used to make the method call. |
portKey P | xsd:string[] |
Since vSphere API 4.0 |
destinationPortgroupKey* P | xsd:string |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
operation P | xsd:string |
Since vSphere API 4.0 |
productSpec* P | DistributedVirtualSwitchProductSpec |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DvsFault | |
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress |
Events
Type | |
---|---|
None |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
port P | DVPortConfigSpec[] |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
DvsFault | |
NotFound | |
ResourceInUse | |
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 DistributedVirtualSwitch used to make the method call. |
spec P | DVSConfigSpec |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
AlreadyExists | |
ConcurrentAccess | |
DuplicateName | |
DvsFault | |
DvsNotAuthorized | |
InvalidName | |
InvalidState | |
LimitExceeded | |
NotFound | |
ResourceInUse | |
ResourceNotAvailable | |
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 DistributedVirtualSwitch used to make the method call. |
hosts* P | ManagedObjectReference[]
to a HostSystem[] |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
portKeys* P | xsd:string[] |
Since vSphere API 4.0 |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualSwitch used to make the method call. |
key P | xsd:string[] |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | |
InvalidName | |
NotFound | |
ResourceInUse | |
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 DistributedVirtualSwitch used to make the method call. |
capability P | DVSCapability |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DvsFault | |
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 DistributedVirtualSwitch used to make the method call. |
healthCheckConfig P | DVSHealthCheckConfig[] |
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DvsFault | |
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 DistributedVirtualSwitch used to make the method call. |
configSpec P | DVSNetworkResourcePoolConfigSpec[] |
Since vSphere API 4.1 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
DvsFault | |
InvalidName | |
NotFound | |
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 Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |