View Source XenAPI.VIF (XenAPI v0.3.1)

A virtual network interface

Link to this section Summary

Functions

Associates an IPv4 address with this VIF

Associates an IPv4 address with this VIF (Raise error on XMLRPC failure)

Associates an IPv6 address with this VIF

Associates an IPv6 address with this VIF (Raise error on XMLRPC failure)

Add the given key-value pair to the other_config field of the given VIF.

Add the given key-value pair to the other_config field of the given VIF. (Raise error on XMLRPC failure)

Add the given key-value pair to the qos/algorithm_params field of the given VIF.

Add the given key-value pair to the qos/algorithm_params field of the given VIF. (Raise error on XMLRPC failure)

Configure IPv4 settings for this virtual interface

Configure IPv4 settings for this virtual interface (Raise error on XMLRPC failure)

Configure IPv6 settings for this virtual interface

Configure IPv6 settings for this virtual interface (Raise error on XMLRPC failure)

Create a new VIF instance, and return its handle. The constructor args are: device, network, VM, MAC, MTU, other_config, qos_algorithm_type, qos_algorithm_params, locking_mode, ipv4_allowed, ipv6_allowed (* = non-optional).

Create a new VIF instance, and return its handle. The constructor args are: device, network, VM, MAC, MTU, other_config, qos_algorithm_type, qos_algorithm_params, locking_mode, ipv4_allowed, ipv6_allowed (* = non-optional). (Raise error on XMLRPC failure)

Destroy the specified VIF instance.

Destroy the specified VIF instance. (Raise error on XMLRPC failure)

Return a list of all the VIFs known to the system.

Return a list of all the VIFs known to the system. (Raise error on XMLRPC failure)

Return a map of VIF references to VIF records for all VIFs known to the system.

Return a map of VIF references to VIF records for all VIFs known to the system. (Raise error on XMLRPC failure)

Get the allowed_operations field of the given VIF.

Get the allowed_operations field of the given VIF. (Raise error on XMLRPC failure)

Get a reference to the VIF instance with the specified UUID.

Get a reference to the VIF instance with the specified UUID. (Raise error on XMLRPC failure)

Get the current_operations field of the given VIF.

Get the current_operations field of the given VIF. (Raise error on XMLRPC failure)

Get the currently_attached field of the given VIF.

Get the currently_attached field of the given VIF. (Raise error on XMLRPC failure)

Get the device field of the given VIF.

Get the device field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv4_addresses field of the given VIF.

Get the ipv4_addresses field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv4_allowed field of the given VIF.

Get the ipv4_allowed field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv4_configuration_mode field of the given VIF.

Get the ipv4_configuration_mode field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv4_gateway field of the given VIF.

Get the ipv4_gateway field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv6_addresses field of the given VIF.

Get the ipv6_addresses field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv6_allowed field of the given VIF.

Get the ipv6_allowed field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv6_configuration_mode field of the given VIF.

Get the ipv6_configuration_mode field of the given VIF. (Raise error on XMLRPC failure)

Get the ipv6_gateway field of the given VIF.

Get the ipv6_gateway field of the given VIF. (Raise error on XMLRPC failure)

Get the locking_mode field of the given VIF.

Get the locking_mode field of the given VIF. (Raise error on XMLRPC failure)

Get the MAC field of the given VIF.

Get the MAC field of the given VIF. (Raise error on XMLRPC failure)

Get the MAC_autogenerated field of the given VIF.

Get the MAC_autogenerated field of the given VIF. (Raise error on XMLRPC failure)

Get the MTU field of the given VIF.

Get the MTU field of the given VIF. (Raise error on XMLRPC failure)

Get the metrics field of the given VIF.

Get the metrics field of the given VIF. (Raise error on XMLRPC failure)

Get the network field of the given VIF.

Get the network field of the given VIF. (Raise error on XMLRPC failure)

Get the other_config field of the given VIF.

Get the other_config field of the given VIF. (Raise error on XMLRPC failure)

Get the qos/algorithm_params field of the given VIF.

Get the qos/algorithm_params field of the given VIF. (Raise error on XMLRPC failure)

Get the qos/algorithm_type field of the given VIF.

Get the qos/algorithm_type field of the given VIF. (Raise error on XMLRPC failure)

Get the qos/supported_algorithms field of the given VIF.

Get the qos/supported_algorithms field of the given VIF. (Raise error on XMLRPC failure)

Get a record containing the current state of the given VIF. Returns XenAPI.VIF struct.

Get a record containing the current state of the given VIF. Returns XenAPI.VIF struct. (Raise error on XMLRPC failure)

Get the runtime_properties field of the given VIF.

Get the runtime_properties field of the given VIF. (Raise error on XMLRPC failure)

Get the status_code field of the given VIF.

Get the status_code field of the given VIF. (Raise error on XMLRPC failure)

Get the status_detail field of the given VIF.

Get the status_detail field of the given VIF. (Raise error on XMLRPC failure)

Get the uuid field of the given VIF.

Get the uuid field of the given VIF. (Raise error on XMLRPC failure)

Get the VM field of the given VIF.

Get the VM field of the given VIF. (Raise error on XMLRPC failure)

Move the specified VIF to the specified network, even while the VM is running

Move the specified VIF to the specified network, even while the VM is running (Raise error on XMLRPC failure)

Hotplug the specified VIF, dynamically attaching it to the running VM

Hotplug the specified VIF, dynamically attaching it to the running VM (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given VIF. If the key is not in that Map, then do nothing.

Remove the given key and its corresponding value from the other_config field of the given VIF. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing.

Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Removes an IPv4 address from this VIF

Removes an IPv4 address from this VIF (Raise error on XMLRPC failure)

Removes an IPv6 address from this VIF

Removes an IPv6 address from this VIF (Raise error on XMLRPC failure)

Set the IPv4 addresses to which traffic on this VIF can be restricted

Set the IPv4 addresses to which traffic on this VIF can be restricted (Raise error on XMLRPC failure)

Set the IPv6 addresses to which traffic on this VIF can be restricted

Set the IPv6 addresses to which traffic on this VIF can be restricted (Raise error on XMLRPC failure)

Set the locking mode for this VIF

Set the locking mode for this VIF (Raise error on XMLRPC failure)

Set the other_config field of the given VIF.

Set the other_config field of the given VIF. (Raise error on XMLRPC failure)

Set the qos/algorithm_params field of the given VIF.

Set the qos/algorithm_params field of the given VIF. (Raise error on XMLRPC failure)

Set the qos/algorithm_type field of the given VIF.

Set the qos/algorithm_type field of the given VIF. (Raise error on XMLRPC failure)

Hot-unplug the specified VIF, dynamically unattaching it from the running VM

Hot-unplug the specified VIF, dynamically unattaching it from the running VM (Raise error on XMLRPC failure)

Forcibly unplug the specified VIF

Forcibly unplug the specified VIF (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_ipv4_allowed(xen_session, vif_ref, value)

View Source

Associates an IPv4 address with this VIF

Link to this function

add_ipv4_allowed!(xen_session, vif_ref, value)

View Source

Associates an IPv4 address with this VIF (Raise error on XMLRPC failure)

Link to this function

add_ipv6_allowed(xen_session, vif_ref, value)

View Source

Associates an IPv6 address with this VIF

Link to this function

add_ipv6_allowed!(xen_session, vif_ref, value)

View Source

Associates an IPv6 address with this VIF (Raise error on XMLRPC failure)

Link to this function

add_to_other_config(xen_session, vif_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given VIF.

Link to this function

add_to_other_config!(xen_session, vif_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

add_to_qos_algorithm_params(xen_session, vif_ref, key, value)

View Source

Add the given key-value pair to the qos/algorithm_params field of the given VIF.

Link to this function

add_to_qos_algorithm_params!(xen_session, vif_ref, key, value)

View Source

Add the given key-value pair to the qos/algorithm_params field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

configure_ipv4(xen_session, vif_ref, mode, address, gateway)

View Source

Configure IPv4 settings for this virtual interface

Link to this function

configure_ipv4!(xen_session, vif_ref, mode, address, gateway)

View Source

Configure IPv4 settings for this virtual interface (Raise error on XMLRPC failure)

Link to this function

configure_ipv6(xen_session, vif_ref, mode, address, gateway)

View Source

Configure IPv6 settings for this virtual interface

Link to this function

configure_ipv6!(xen_session, vif_ref, mode, address, gateway)

View Source

Configure IPv6 settings for this virtual interface (Raise error on XMLRPC failure)

Link to this function

create(xen_session, args)

View Source

Create a new VIF instance, and return its handle. The constructor args are: device, network, VM, MAC, MTU, other_config, qos_algorithm_type, qos_algorithm_params, locking_mode, ipv4_allowed, ipv6_allowed (* = non-optional).

Link to this function

create!(xen_session, args)

View Source

Create a new VIF instance, and return its handle. The constructor args are: device, network, VM, MAC, MTU, other_config, qos_algorithm_type, qos_algorithm_params, locking_mode, ipv4_allowed, ipv6_allowed (* = non-optional). (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, vif_ref)

View Source

Destroy the specified VIF instance.

Link to this function

destroy!(xen_session, vif_ref)

View Source

Destroy the specified VIF instance. (Raise error on XMLRPC failure)

Return a list of all the VIFs known to the system.

Return a list of all the VIFs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of VIF references to VIF records for all VIFs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of VIF references to VIF records for all VIFs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_allowed_operations(xen_session, vif_ref)

View Source

Get the allowed_operations field of the given VIF.

Link to this function

get_allowed_operations!(xen_session, vif_ref)

View Source

Get the allowed_operations field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the VIF instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the VIF instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, vif_ref)

View Source

Get the current_operations field of the given VIF.

Link to this function

get_current_operations!(xen_session, vif_ref)

View Source

Get the current_operations field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_currently_attached(xen_session, vif_ref)

View Source

Get the currently_attached field of the given VIF.

Link to this function

get_currently_attached!(xen_session, vif_ref)

View Source

Get the currently_attached field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_device(xen_session, vif_ref)

View Source

Get the device field of the given VIF.

Link to this function

get_device!(xen_session, vif_ref)

View Source

Get the device field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv4_addresses(xen_session, vif_ref)

View Source

Get the ipv4_addresses field of the given VIF.

Link to this function

get_ipv4_addresses!(xen_session, vif_ref)

View Source

Get the ipv4_addresses field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv4_allowed(xen_session, vif_ref)

View Source

Get the ipv4_allowed field of the given VIF.

Link to this function

get_ipv4_allowed!(xen_session, vif_ref)

View Source

Get the ipv4_allowed field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv4_configuration_mode(xen_session, vif_ref)

View Source

Get the ipv4_configuration_mode field of the given VIF.

Link to this function

get_ipv4_configuration_mode!(xen_session, vif_ref)

View Source

Get the ipv4_configuration_mode field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv4_gateway(xen_session, vif_ref)

View Source

Get the ipv4_gateway field of the given VIF.

Link to this function

get_ipv4_gateway!(xen_session, vif_ref)

View Source

Get the ipv4_gateway field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv6_addresses(xen_session, vif_ref)

View Source

Get the ipv6_addresses field of the given VIF.

Link to this function

get_ipv6_addresses!(xen_session, vif_ref)

View Source

Get the ipv6_addresses field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv6_allowed(xen_session, vif_ref)

View Source

Get the ipv6_allowed field of the given VIF.

Link to this function

get_ipv6_allowed!(xen_session, vif_ref)

View Source

Get the ipv6_allowed field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv6_configuration_mode(xen_session, vif_ref)

View Source

Get the ipv6_configuration_mode field of the given VIF.

Link to this function

get_ipv6_configuration_mode!(xen_session, vif_ref)

View Source

Get the ipv6_configuration_mode field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv6_gateway(xen_session, vif_ref)

View Source

Get the ipv6_gateway field of the given VIF.

Link to this function

get_ipv6_gateway!(xen_session, vif_ref)

View Source

Get the ipv6_gateway field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_locking_mode(xen_session, vif_ref)

View Source

Get the locking_mode field of the given VIF.

Link to this function

get_locking_mode!(xen_session, vif_ref)

View Source

Get the locking_mode field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_MAC(xen_session, vif_ref)

View Source

Get the MAC field of the given VIF.

Link to this function

get_MAC!(xen_session, vif_ref)

View Source

Get the MAC field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_MAC_autogenerated(xen_session, vif_ref)

View Source

Get the MAC_autogenerated field of the given VIF.

Link to this function

get_MAC_autogenerated!(xen_session, vif_ref)

View Source

Get the MAC_autogenerated field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_MTU(xen_session, vif_ref)

View Source

Get the MTU field of the given VIF.

Link to this function

get_MTU!(xen_session, vif_ref)

View Source

Get the MTU field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_metrics(xen_session, vif_ref)

View Source

Get the metrics field of the given VIF.

Link to this function

get_metrics!(xen_session, vif_ref)

View Source

Get the metrics field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_network(xen_session, vif_ref)

View Source

Get the network field of the given VIF.

Link to this function

get_network!(xen_session, vif_ref)

View Source

Get the network field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, vif_ref)

View Source

Get the other_config field of the given VIF.

Link to this function

get_other_config!(xen_session, vif_ref)

View Source

Get the other_config field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_qos_algorithm_params(xen_session, vif_ref)

View Source

Get the qos/algorithm_params field of the given VIF.

Link to this function

get_qos_algorithm_params!(xen_session, vif_ref)

View Source

Get the qos/algorithm_params field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_qos_algorithm_type(xen_session, vif_ref)

View Source

Get the qos/algorithm_type field of the given VIF.

Link to this function

get_qos_algorithm_type!(xen_session, vif_ref)

View Source

Get the qos/algorithm_type field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_qos_supported_algorithms(xen_session, vif_ref)

View Source

Get the qos/supported_algorithms field of the given VIF.

Link to this function

get_qos_supported_algorithms!(xen_session, vif_ref)

View Source

Get the qos/supported_algorithms field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, vif_ref)

View Source

Get a record containing the current state of the given VIF. Returns XenAPI.VIF struct.

Link to this function

get_record!(xen_session, vif_ref)

View Source

Get a record containing the current state of the given VIF. Returns XenAPI.VIF struct. (Raise error on XMLRPC failure)

Link to this function

get_runtime_properties(xen_session, vif_ref)

View Source

Get the runtime_properties field of the given VIF.

Link to this function

get_runtime_properties!(xen_session, vif_ref)

View Source

Get the runtime_properties field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_status_code(xen_session, vif_ref)

View Source

Get the status_code field of the given VIF.

Link to this function

get_status_code!(xen_session, vif_ref)

View Source

Get the status_code field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_status_detail(xen_session, vif_ref)

View Source

Get the status_detail field of the given VIF.

Link to this function

get_status_detail!(xen_session, vif_ref)

View Source

Get the status_detail field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, vif_ref)

View Source

Get the uuid field of the given VIF.

Link to this function

get_uuid!(xen_session, vif_ref)

View Source

Get the uuid field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

get_VM(xen_session, vif_ref)

View Source

Get the VM field of the given VIF.

Link to this function

get_VM!(xen_session, vif_ref)

View Source

Get the VM field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

move(xen_session, vif_ref, network)

View Source

Move the specified VIF to the specified network, even while the VM is running

Link to this function

move!(xen_session, vif_ref, network)

View Source

Move the specified VIF to the specified network, even while the VM is running (Raise error on XMLRPC failure)

Link to this function

plug(xen_session, vif_ref)

View Source

Hotplug the specified VIF, dynamically attaching it to the running VM

Link to this function

plug!(xen_session, vif_ref)

View Source

Hotplug the specified VIF, dynamically attaching it to the running VM (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, vif_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given VIF. If the key is not in that Map, then do nothing.

Link to this function

remove_from_other_config!(xen_session, vif_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given VIF. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

remove_from_qos_algorithm_params(xen_session, vif_ref, key)

View Source

Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing.

Link to this function

remove_from_qos_algorithm_params!(xen_session, vif_ref, key)

View Source

Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

remove_ipv4_allowed(xen_session, vif_ref, value)

View Source

Removes an IPv4 address from this VIF

Link to this function

remove_ipv4_allowed!(xen_session, vif_ref, value)

View Source

Removes an IPv4 address from this VIF (Raise error on XMLRPC failure)

Link to this function

remove_ipv6_allowed(xen_session, vif_ref, value)

View Source

Removes an IPv6 address from this VIF

Link to this function

remove_ipv6_allowed!(xen_session, vif_ref, value)

View Source

Removes an IPv6 address from this VIF (Raise error on XMLRPC failure)

Link to this function

set_ipv4_allowed(xen_session, vif_ref, value)

View Source

Set the IPv4 addresses to which traffic on this VIF can be restricted

Link to this function

set_ipv4_allowed!(xen_session, vif_ref, value)

View Source

Set the IPv4 addresses to which traffic on this VIF can be restricted (Raise error on XMLRPC failure)

Link to this function

set_ipv6_allowed(xen_session, vif_ref, value)

View Source

Set the IPv6 addresses to which traffic on this VIF can be restricted

Link to this function

set_ipv6_allowed!(xen_session, vif_ref, value)

View Source

Set the IPv6 addresses to which traffic on this VIF can be restricted (Raise error on XMLRPC failure)

Link to this function

set_locking_mode(xen_session, vif_ref, value)

View Source

Set the locking mode for this VIF

Link to this function

set_locking_mode!(xen_session, vif_ref, value)

View Source

Set the locking mode for this VIF (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, vif_ref, value)

View Source

Set the other_config field of the given VIF.

Link to this function

set_other_config!(xen_session, vif_ref, value)

View Source

Set the other_config field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

set_qos_algorithm_params(xen_session, vif_ref, value)

View Source

Set the qos/algorithm_params field of the given VIF.

Link to this function

set_qos_algorithm_params!(xen_session, vif_ref, value)

View Source

Set the qos/algorithm_params field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

set_qos_algorithm_type(xen_session, vif_ref, value)

View Source

Set the qos/algorithm_type field of the given VIF.

Link to this function

set_qos_algorithm_type!(xen_session, vif_ref, value)

View Source

Set the qos/algorithm_type field of the given VIF. (Raise error on XMLRPC failure)

Link to this function

unplug(xen_session, vif_ref)

View Source

Hot-unplug the specified VIF, dynamically unattaching it from the running VM

Link to this function

unplug!(xen_session, vif_ref)

View Source

Hot-unplug the specified VIF, dynamically unattaching it from the running VM (Raise error on XMLRPC failure)

Link to this function

unplug_force(xen_session, vif_ref)

View Source

Forcibly unplug the specified VIF

Link to this function

unplug_force!(xen_session, vif_ref)

View Source

Forcibly unplug the specified VIF (Raise error on XMLRPC failure)