/Classes/VIF

Classes / VIF / index.html

A virtual network interface

Fields

string uuid
Unique identifier/object reference
Set[enum vif_operations] allowed_operations
list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Map[string,enum vif_operations] current_operations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
string device
order in which VIF backends are created by xapi
network network
virtual network to which this vif is connected
VM VM
virtual machine to which this vif is connected
string MAC
ethernet MAC address of virtual interface, as exposed to guest
int MTU
MTU in octets
bool reserved
true if the VIF is reserved pending a reboot/migrate
Map[string,string] other_config
additional configuration
bool currently_attached
is the device currently attached (erased on reboot)
int status_code
error/success code associated with last attach-operation (erased on reboot)
string status_detail
error/success information associated with last attach-operation status (erased on reboot)
Map[string,string] runtime_properties
Device runtime properties
string qos_algorithm_type
QoS algorithm to use
Map[string,string] qos_algorithm_params
parameters for chosen QoS algorithm
Set[string] qos_supported_algorithms
supported QoS algorithms for this VIF
VIF_metrics metrics
metrics associated with this VIF
bool MAC_autogenerated
true if the MAC was autogenerated; false indicates it was set manually

Implicit messages

Record[VIF] get_record (session session_id, VIF self)
Get a record containing the current state of the given VIF.
VIF get_by_uuid (session session_id, string uuid)
Get a reference to the VIF instance with the specified UUID.
VIF create (session session_id, string device, network network, VM VM, string MAC, int MTU, Map[string,string] other_config, string qos_algorithm_type, Map[string,string] qos_algorithm_params)
Create a new VIF instance, and return its handle.
void destroy (session session_id, VIF self)
Destroy the specified VIF instance.
Set[VIF] get_all (session session_id)
Return a list of all the VIFs known to the system.
Map[VIF,Record[VIF]] get_all_records (session session_id)
Return a map of VIF references to VIF records for all VIFs known to the system.

Explicit messages

void plug (session session_id, VIF self)
Hotplug the specified VIF, dynamically attaching it to the running VM
void unplug (session session_id, VIF self)
Hot-unplug the specified VIF, dynamically unattaching it from the running VM