Virtual Infrastructure Distributed Virtual Portgroup APIs
The DistributedVirtualPortgroup managed object defines how hosts and virtual machines connect to a network.
A distributed virtual portgroup specifies DistributedVirtualPort configuration options for the ports on a DistributedVirtualSwitch. A portgroup also represents a Network entity in the datacenter.
- To configure host access by portgroup, set the portgroup in the host virtual NIC specification (HostVirtualNicSpec.portgroup).
- To configure virtual machine access by portgroup, set the portgroup in the virtual Ethernet card backing (VirtualEthernetCard.backing.port.portgroupKey).
When you use a portgroup for network access, the Server will create a port according to config.type.
Operations
POST
Distributed Virtual Portgroup Destroy Task
Destroys this object, deleting its contents and removing it from its parent folder (if any).
POST
Distributed Virtual Portgroup Destroy Network
Removes a network.
POST
Distributed Virtual Portgroup DV Portgroup Rollback Task
This method determines if the portgroup configuration has changed.
GET
Distributed Virtual Portgroup Get Alarm Actions Enabled
Whether alarm actions are enabled for this entity.
GET
Distributed Virtual Portgroup Get Available Field
List of custom field definitions that are valid for the object's type.
GET
Distributed Virtual Portgroup Get Config
Configuration of the portgroup.
GET
Distributed Virtual Portgroup Get Config Issue
Current configuration issues that have been detected for this entity.
GET
Distributed Virtual Portgroup Get Config Status
The configStatus indicates whether or not the system has detected a configuration issue involving this entity.
GET
Distributed Virtual Portgroup Get Custom Value
Custom field values.
GET
Distributed Virtual Portgroup Get Declared Alarm State
A set of alarm states for alarms that apply to this managed entity.
GET
Distributed Virtual Portgroup Get Disabled Method
List of operations that are disabled, given the current runtime state of the entity.
GET
Distributed Virtual Portgroup Get Effective Role
Access rights the current session has to this entity.
GET
Distributed Virtual Portgroup Get Host
Hosts attached to this network.
GET
Distributed Virtual Portgroup Get Key
Generated UUID of the portgroup.
GET
Distributed Virtual Portgroup Get Name
Name of this entity, unique relative to its parent.
GET
Distributed Virtual Portgroup Get Overall Status
General health of this managed entity.
GET
Distributed Virtual Portgroup Get Parent
Parent of this entity.
GET
Distributed Virtual Portgroup Get Permission
List of permissions defined for this entity.
GET
Distributed Virtual Portgroup Get Port Keys
Port keys for the set of ports in the portgroup.
GET
Distributed Virtual Portgroup Get Recent Task
The set of recent tasks operating on this managed entity.
GET
Distributed Virtual Portgroup Get Summary
Properties of a network.
GET
Distributed Virtual Portgroup Get Tag
The set of tags associated with this managed entity.
GET
Distributed Virtual Portgroup Get Triggered Alarm State
A set of alarm states for alarms triggered by this entity or by its descendants.
GET
Distributed Virtual Portgroup Get Value
List of custom field values.
GET
Distributed Virtual Portgroup Get Vm
Virtual machines using this network.
POST
Distributed Virtual Portgroup Reconfigure DV Portgroup Task
Reconfigures one or more distributed virtual portgroups.
POST
Distributed Virtual Portgroup Reload
Reload the entity state.
POST
Distributed Virtual Portgroup Rename Task
Renames this managed entity.
POST
Distributed Virtual Portgroup Set Custom Value
Assigns a value to a custom field.