Vmware Distributed Virtual Switch APIs

Vmware Distributed Virtual Switch APIs

The VmwareDistributedVirtualSwitch managed object is the VMware implementation of a distributed virtual switch.

The functionality listed here is for a VMware distributed virtual switch only.

When you use a VMware distributed virtual switch, you can perform backup and restore operations on the VMware switch. You can also perform rollback operations on the switch and on portgroups associated with the VMware switch. See the description for the following methods:

Operations
POST
Vmware Distributed Virtual Switch Add DV Portgroup Task
Creates one or more *DistributedVirtualPortgroup*s and adds them to the distributed virtual switch.
POST
Vmware Distributed Virtual Switch Add Network Resource Pool
Add a network resource pool.
POST
Vmware Distributed Virtual Switch Create DV Portgroup Task
Creates a single *DistributedVirtualPortgroup* and adds it to the distributed virtual switch.
POST
Vmware Distributed Virtual Switch Destroy Task
Destroys this object, deleting its contents and removing it from its parent folder (if any).
POST
Vmware Distributed Virtual Switch Dvs Reconfigure Vm Vnic Network Resource Pool Task
reconfigure the Virtual NIC network resource pool configuration.
POST
Vmware Distributed Virtual Switch DVS Rollback Task
This method determines if the distributed virtual switch configuration has changed.
POST
Vmware Distributed Virtual Switch Enable Network Resource Management
Enable/Disable network I/O control on the vSphere Distributed Switch.
POST
Vmware Distributed Virtual Switch Fetch DV Port Keys
Return the keys of ports that meet the criteria.
POST
Vmware Distributed Virtual Switch Fetch DV Ports
Return the ports that meet the criteria.
GET
Vmware Distributed Virtual Switch Get Alarm Actions Enabled
Whether alarm actions are enabled for this entity.
GET
Vmware Distributed Virtual Switch Get Available Field
List of custom field definitions that are valid for the object's type.
GET
Vmware Distributed Virtual Switch Get Capability
Capability of the switch.
GET
Vmware Distributed Virtual Switch Get Config
Switch configuration data.
GET
Vmware Distributed Virtual Switch Get Config Issue
Current configuration issues that have been detected for this entity.
GET
Vmware Distributed Virtual Switch Get Config Status
The configStatus indicates whether or not the system has detected a configuration issue involving this entity.
GET
Vmware Distributed Virtual Switch Get Custom Value
Custom field values.
GET
Vmware Distributed Virtual Switch Get Declared Alarm State
A set of alarm states for alarms that apply to this managed entity.
GET
Vmware Distributed Virtual Switch Get Disabled Method
List of operations that are disabled, given the current runtime state of the entity.
GET
Vmware Distributed Virtual Switch Get Effective Role
Access rights the current session has to this entity.
GET
Vmware Distributed Virtual Switch Get Name
Name of this entity, unique relative to its parent.
GET
Vmware Distributed Virtual Switch Get Network Resource Pool
Network resource pool information for the switch.
GET
Vmware Distributed Virtual Switch Get Overall Status
General health of this managed entity.
GET
Vmware Distributed Virtual Switch Get Parent
Parent of this entity.
GET
Vmware Distributed Virtual Switch Get Permission
List of permissions defined for this entity.
GET
Vmware Distributed Virtual Switch Get Portgroup
Portgroups that are defined on the switch.
GET
Vmware Distributed Virtual Switch Get Recent Task
The set of recent tasks operating on this managed entity.
GET
Vmware Distributed Virtual Switch Get Runtime
Runtime information of the distributed virtual switch.
GET
Vmware Distributed Virtual Switch Get Summary
Summary of the switch.
GET
Vmware Distributed Virtual Switch Get Tag
The set of tags associated with this managed entity.
GET
Vmware Distributed Virtual Switch Get Triggered Alarm State
A set of alarm states for alarms triggered by this entity or by its descendants.
GET
Vmware Distributed Virtual Switch Get Uuid
Generated UUID of the switch.
GET
Vmware Distributed Virtual Switch Get Value
List of custom field values.
POST
Vmware Distributed Virtual Switch Lookup Dv Port Group
Returns the portgroup identified by the key within this VDS.
POST
Vmware Distributed Virtual Switch Merge Dvs Task
Merge an existing DistributedVirtualSwitch (source) to this switch (destination).
POST
Vmware Distributed Virtual Switch Move DV Port Task
Move the ports out of their current portgroup into the specified portgroup.
POST
Vmware Distributed Virtual Switch Perform Dvs Product Spec Operation Task
This method updates the *DistributedVirtualSwitch* product specifications.
POST
Vmware Distributed Virtual Switch Query Used Vlan Id In Dvs
Return the used VLAN ID (PVLAN excluded) in the switch.
POST
Vmware Distributed Virtual Switch Reconfigure DV Port Task
Reconfigure individual ports.
POST
Vmware Distributed Virtual Switch Reconfigure Dvs Task
Reconfigures a distributed virtual switch.
POST
Vmware Distributed Virtual Switch Rectify Dvs Host Task
Update the switch configuration on the host to bring them in sync with the current configuration in vCenter Server.
POST
Vmware Distributed Virtual Switch Refresh DV Port State
Refresh port states.
POST
Vmware Distributed Virtual Switch Reload
Reload the entity state.
POST
Vmware Distributed Virtual Switch Remove Network Resource Pool
Remove a network resource pool.
POST
Vmware Distributed Virtual Switch Rename Task
Renames this managed entity.
POST
Vmware Distributed Virtual Switch Set Custom Value
Assigns a value to a custom field.
POST
Vmware Distributed Virtual Switch Update Dvs Capability
Set the capability of the switch.
POST
Vmware Distributed Virtual Switch Update DVS Health Check Config Task
Update health check configuration.
POST
Vmware Distributed Virtual Switch Update DVS Lacp Group Config Task
Update Link Aggregation Control Protocol groups.
POST
Vmware Distributed Virtual Switch Update Network Resource Pool
Update the network resource pool configuration.