2.18.
CLASS: VIF
CHAPTER 2.
API REFERENCE
2.18
Class: VIF
2.18.1
Fields for class: VIF
Name
VIF
Description
A virtual network interface.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RO
run
allowed operations
(vif operations) Set
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.
RO
run
current operations
(string
→
vif operations) Map
links each of the running tasks using
this object (by reference) to a cur-
rent operation enum which describes
the nature of the task.
RO
ins
device
string
order in which VIF backends are cre-
ated by xapi
RO
ins
network
network ref
virtual network to which this vif is
connected
RO
ins
VM
VM ref
virtual machine to which this vif is
connected
RO
ins
MAC
string
ethernet MAC address of virtual in-
terface, as exposed to guest
RO
ins
MTU
int
MTU in octets
RO
run
reserved
bool
true if the VIF is reserved pending a
reboot/migrate
RW
other config
(string
→
string) Map
additional configuration
RO
run
currently attached
bool
is the device currently attached
(erased on reboot)
RO
run
status code
int
error/success code associated with
last attach-operation (erased on re-
boot)
RO
run
status detail
string
error/success information associated
with last attach-operation status
(erased on reboot)
RO
run
runtime properties
(string
→
string) Map
Device runtime properties
RW
qos/algorithm type
string
QoS algorithm to use
RW
qos/algorithm params
(string
→
string) Map
parameters for chosen QoS algorithm
RO
run
qos/supported algorithms
string Set
supported QoS algorithms for this
VIF
RO
run
metrics
VIF metrics ref
metrics associated with this VIF
2.18.2
RPCs associated with class: VIF
RPC name: plug
Overview:
Hotplug the specified VIF, dynamically attaching it to the running VM.
Signature:
void plug (session_id s, VIF ref self)
Arguments:
162