Network APIs

Network APIs

Represents a network accessible by either hosts or virtual machines.

This can be a physical network or a logical network, such as a VLAN.

Networks are created:

  • explicitly when configuring a host.
  • automatically when adding a host to VirtualCenter.
  • automatically when adding a new virtual machine to a host or to VirtualCenter.

To configure network access for hosts and virtual machines, use DistributedVirtualSwitch and DistributedVirtualPortgroup managed objects.

Operations
POST
Network Destroy Task
Destroys this object, deleting its contents and removing it from its parent folder (if any).
POST
Network Destroy Network
Removes a network.
GET
Network Get Alarm Actions Enabled
Whether alarm actions are enabled for this entity.
GET
Network Get Available Field
List of custom field definitions that are valid for the object's type.
GET
Network Get Config Issue
Current configuration issues that have been detected for this entity.
GET
Network Get Config Status
The configStatus indicates whether or not the system has detected a configuration issue involving this entity.
GET
Network Get Custom Value
Custom field values.
GET
Network Get Declared Alarm State
A set of alarm states for alarms that apply to this managed entity.
GET
Network Get Disabled Method
List of operations that are disabled, given the current runtime state of the entity.
GET
Network Get Effective Role
Access rights the current session has to this entity.
GET
Network Get Host
Hosts attached to this network.
GET
Network Get Name
Name of this entity, unique relative to its parent.
GET
Network Get Overall Status
General health of this managed entity.
GET
Network Get Parent
Parent of this entity.
GET
Network Get Permission
List of permissions defined for this entity.
GET
Network Get Recent Task
The set of recent tasks operating on this managed entity.
GET
Network Get Summary
Properties of a network.
GET
Network Get Tag
The set of tags associated with this managed entity.
GET
Network Get Triggered Alarm State
A set of alarm states for alarms triggered by this entity or by its descendants.
GET
Network Get Value
List of custom field values.
GET
Network Get Vm
Virtual machines using this network.
POST
Network Reload
Reload the entity state.
POST
Network Rename Task
Renames this managed entity.
POST
Network Set Custom Value
Assigns a value to a custom field.