View Source XenAPI.PIF (XenAPI v0.2.0)

Link to this section Summary

Functions

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

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

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead (Raise error on XMLRPC failure)

Destroy a PIF database record.

Destroy a PIF database record. (Raise error on XMLRPC failure)

Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead

Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead (Raise error on XMLRPC failure)

Destroy the PIF object matching a particular network interface

Destroy the PIF object matching a particular network interface (Raise error on XMLRPC failure)

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

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

Return a map of PIF references to PIF records for all PIFs known to the system.

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

Get the bond_master_of field of the given PIF.

Get the bond_master_of field of the given PIF. (Raise error on XMLRPC failure)

Get the bond_slave_of field of the given PIF.

Get the bond_slave_of field of the given PIF. (Raise error on XMLRPC failure)

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

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

Get the capabilities field of the given PIF.

Get the capabilities field of the given PIF. (Raise error on XMLRPC failure)

Get the currently_attached field of the given PIF.

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

Get the DNS field of the given PIF.

Get the DNS field of the given PIF. (Raise error on XMLRPC failure)

Get the device field of the given PIF.

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

Get the disallow_unplug field of the given PIF.

Get the disallow_unplug field of the given PIF. (Raise error on XMLRPC failure)

Get the gateway field of the given PIF.

Get the gateway field of the given PIF. (Raise error on XMLRPC failure)

Get the host field of the given PIF.

Get the host field of the given PIF. (Raise error on XMLRPC failure)

Get the IP field of the given PIF.

Get the IP field of the given PIF. (Raise error on XMLRPC failure)

Get the IPv6 field of the given PIF.

Get the IPv6 field of the given PIF. (Raise error on XMLRPC failure)

Get the igmp_snooping_status field of the given PIF.

Get the igmp_snooping_status field of the given PIF. (Raise error on XMLRPC failure)

Get the ip_configuration_mode field of the given PIF.

Get the ip_configuration_mode field of the given PIF. (Raise error on XMLRPC failure)

Get the ipv6_configuration_mode field of the given PIF.

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

Get the ipv6_gateway field of the given PIF.

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

Get the MAC field of the given PIF.

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

Get the MTU field of the given PIF.

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

Get the managed field of the given PIF.

Get the managed field of the given PIF. (Raise error on XMLRPC failure)

Get the management field of the given PIF.

Get the management field of the given PIF. (Raise error on XMLRPC failure)

Get the metrics field of the given PIF.

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

Get the netmask field of the given PIF.

Get the netmask field of the given PIF. (Raise error on XMLRPC failure)

Get the network field of the given PIF.

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

Get the other_config field of the given PIF.

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

Get the PCI field of the given PIF.

Get the PCI field of the given PIF. (Raise error on XMLRPC failure)

Get the physical field of the given PIF.

Get the physical field of the given PIF. (Raise error on XMLRPC failure)

Get the primary_address_type field of the given PIF.

Get the primary_address_type field of the given PIF. (Raise error on XMLRPC failure)

Get the properties field of the given PIF.

Get the properties field of the given PIF. (Raise error on XMLRPC failure)

Get a record containing the current state of the given PIF.

Get a record containing the current state of the given PIF. (Raise error on XMLRPC failure)

Get the sriov_logical_PIF_of field of the given PIF.

Get the sriov_logical_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Get the sriov_physical_PIF_of field of the given PIF.

Get the sriov_physical_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Get the tunnel_access_PIF_of field of the given PIF.

Get the tunnel_access_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Get the tunnel_transport_PIF_of field of the given PIF.

Get the tunnel_transport_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Get the uuid field of the given PIF.

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

Get the VLAN field of the given PIF.

Get the VLAN field of the given PIF. (Raise error on XMLRPC failure)

Get the VLAN_master_of field of the given PIF.

Get the VLAN_master_of field of the given PIF. (Raise error on XMLRPC failure)

Get the VLAN_slave_of field of the given PIF.

Get the VLAN_slave_of field of the given PIF. (Raise error on XMLRPC failure)

Create a PIF object matching a particular network interface

Create a PIF object matching a particular network interface (Raise error on XMLRPC failure)

Attempt to bring up a physical interface

Attempt to bring up a physical interface (Raise error on XMLRPC failure)

Reconfigure the IP address settings for this interface

Reconfigure the IP address settings for this interface (Raise error on XMLRPC failure)

Reconfigure the IPv6 address settings for this interface

Reconfigure the IPv6 address settings for this interface (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given PIF. 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 PIF. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Scan for physical interfaces on a host and create PIF objects to represent them

Scan for physical interfaces on a host and create PIF objects to represent them (Raise error on XMLRPC failure)

Set whether unplugging the PIF is allowed

Set whether unplugging the PIF is allowed (Raise error on XMLRPC failure)

Set the other_config field of the given PIF.

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

Change the primary address type used by this PIF

Change the primary address type used by this PIF (Raise error on XMLRPC failure)

Set the value of a property of the PIF

Set the value of a property of the PIF (Raise error on XMLRPC failure)

Attempt to bring down a physical interface

Attempt to bring down a physical interface (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, pif_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, pif_ref, key, value)

View Source

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

Link to this function

create_VLAN(xen_session, device, network, host, arg)

View Source

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead

Link to this function

create_VLAN!(xen_session, device, network, host, arg)

View Source

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead (Raise error on XMLRPC failure)

Link to this function

db_forget(xen_session, pif_ref)

View Source

Destroy a PIF database record.

Link to this function

db_forget!(xen_session, pif_ref)

View Source

Destroy a PIF database record. (Raise error on XMLRPC failure)

Link to this function

db_introduce(xen_session, device, network, host, arg1, arg2, arg3, physical, ip_configuration_mode, arg4, netmask, gateway, arg5, bond_slave_of, arg6, management, other_config, disallow_unplug, ipv6_configuration_mode, arg7, ipv6_gateway, primary_address_type, managed, properties)

View Source

Create a new PIF record in the database only

Link to this function

db_introduce!(xen_session, device, network, host, arg1, arg2, arg3, physical, ip_configuration_mode, arg4, netmask, gateway, arg5, bond_slave_of, arg6, management, other_config, disallow_unplug, ipv6_configuration_mode, arg7, ipv6_gateway, primary_address_type, managed, properties)

View Source

Create a new PIF record in the database only (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, pif_ref)

View Source

Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead

Link to this function

destroy!(xen_session, pif_ref)

View Source

Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead (Raise error on XMLRPC failure)

Link to this function

forget(xen_session, pif_ref)

View Source

Destroy the PIF object matching a particular network interface

Link to this function

forget!(xen_session, pif_ref)

View Source

Destroy the PIF object matching a particular network interface (Raise error on XMLRPC failure)

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of PIF references to PIF records for all PIFs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_bond_master_of(xen_session, pif_ref)

View Source

Get the bond_master_of field of the given PIF.

Link to this function

get_bond_master_of!(xen_session, pif_ref)

View Source

Get the bond_master_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_bond_slave_of(xen_session, pif_ref)

View Source

Get the bond_slave_of field of the given PIF.

Link to this function

get_bond_slave_of!(xen_session, pif_ref)

View Source

Get the bond_slave_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_capabilities(xen_session, pif_ref)

View Source

Get the capabilities field of the given PIF.

Link to this function

get_capabilities!(xen_session, pif_ref)

View Source

Get the capabilities field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_currently_attached(xen_session, pif_ref)

View Source

Get the currently_attached field of the given PIF.

Link to this function

get_currently_attached!(xen_session, pif_ref)

View Source

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

Link to this function

get_DNS(xen_session, pif_ref)

View Source

Get the DNS field of the given PIF.

Link to this function

get_DNS!(xen_session, pif_ref)

View Source

Get the DNS field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_device(xen_session, pif_ref)

View Source

Get the device field of the given PIF.

Link to this function

get_device!(xen_session, pif_ref)

View Source

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

Link to this function

get_disallow_unplug(xen_session, pif_ref)

View Source

Get the disallow_unplug field of the given PIF.

Link to this function

get_disallow_unplug!(xen_session, pif_ref)

View Source

Get the disallow_unplug field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_gateway(xen_session, pif_ref)

View Source

Get the gateway field of the given PIF.

Link to this function

get_gateway!(xen_session, pif_ref)

View Source

Get the gateway field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_host(xen_session, pif_ref)

View Source

Get the host field of the given PIF.

Link to this function

get_host!(xen_session, pif_ref)

View Source

Get the host field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_IP(xen_session, pif_ref)

View Source

Get the IP field of the given PIF.

Link to this function

get_IP!(xen_session, pif_ref)

View Source

Get the IP field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_IPv6(xen_session, pif_ref)

View Source

Get the IPv6 field of the given PIF.

Link to this function

get_IPv6!(xen_session, pif_ref)

View Source

Get the IPv6 field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_igmp_snooping_status(xen_session, pif_ref)

View Source

Get the igmp_snooping_status field of the given PIF.

Link to this function

get_igmp_snooping_status!(xen_session, pif_ref)

View Source

Get the igmp_snooping_status field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_ip_configuration_mode(xen_session, pif_ref)

View Source

Get the ip_configuration_mode field of the given PIF.

Link to this function

get_ip_configuration_mode!(xen_session, pif_ref)

View Source

Get the ip_configuration_mode field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_ipv6_configuration_mode(xen_session, pif_ref)

View Source

Get the ipv6_configuration_mode field of the given PIF.

Link to this function

get_ipv6_configuration_mode!(xen_session, pif_ref)

View Source

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

Link to this function

get_ipv6_gateway(xen_session, pif_ref)

View Source

Get the ipv6_gateway field of the given PIF.

Link to this function

get_ipv6_gateway!(xen_session, pif_ref)

View Source

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

Link to this function

get_MAC(xen_session, pif_ref)

View Source

Get the MAC field of the given PIF.

Link to this function

get_MAC!(xen_session, pif_ref)

View Source

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

Link to this function

get_MTU(xen_session, pif_ref)

View Source

Get the MTU field of the given PIF.

Link to this function

get_MTU!(xen_session, pif_ref)

View Source

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

Link to this function

get_managed(xen_session, pif_ref)

View Source

Get the managed field of the given PIF.

Link to this function

get_managed!(xen_session, pif_ref)

View Source

Get the managed field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_management(xen_session, pif_ref)

View Source

Get the management field of the given PIF.

Link to this function

get_management!(xen_session, pif_ref)

View Source

Get the management field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_metrics(xen_session, pif_ref)

View Source

Get the metrics field of the given PIF.

Link to this function

get_metrics!(xen_session, pif_ref)

View Source

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

Link to this function

get_netmask(xen_session, pif_ref)

View Source

Get the netmask field of the given PIF.

Link to this function

get_netmask!(xen_session, pif_ref)

View Source

Get the netmask field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_network(xen_session, pif_ref)

View Source

Get the network field of the given PIF.

Link to this function

get_network!(xen_session, pif_ref)

View Source

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

Link to this function

get_other_config(xen_session, pif_ref)

View Source

Get the other_config field of the given PIF.

Link to this function

get_other_config!(xen_session, pif_ref)

View Source

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

Link to this function

get_PCI(xen_session, pif_ref)

View Source

Get the PCI field of the given PIF.

Link to this function

get_PCI!(xen_session, pif_ref)

View Source

Get the PCI field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_physical(xen_session, pif_ref)

View Source

Get the physical field of the given PIF.

Link to this function

get_physical!(xen_session, pif_ref)

View Source

Get the physical field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_primary_address_type(xen_session, pif_ref)

View Source

Get the primary_address_type field of the given PIF.

Link to this function

get_primary_address_type!(xen_session, pif_ref)

View Source

Get the primary_address_type field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_properties(xen_session, pif_ref)

View Source

Get the properties field of the given PIF.

Link to this function

get_properties!(xen_session, pif_ref)

View Source

Get the properties field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, pif_ref)

View Source

Get a record containing the current state of the given PIF.

Link to this function

get_record!(xen_session, pif_ref)

View Source

Get a record containing the current state of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_sriov_logical_PIF_of(xen_session, pif_ref)

View Source

Get the sriov_logical_PIF_of field of the given PIF.

Link to this function

get_sriov_logical_PIF_of!(xen_session, pif_ref)

View Source

Get the sriov_logical_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_sriov_physical_PIF_of(xen_session, pif_ref)

View Source

Get the sriov_physical_PIF_of field of the given PIF.

Link to this function

get_sriov_physical_PIF_of!(xen_session, pif_ref)

View Source

Get the sriov_physical_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_tunnel_access_PIF_of(xen_session, pif_ref)

View Source

Get the tunnel_access_PIF_of field of the given PIF.

Link to this function

get_tunnel_access_PIF_of!(xen_session, pif_ref)

View Source

Get the tunnel_access_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_tunnel_transport_PIF_of(xen_session, pif_ref)

View Source

Get the tunnel_transport_PIF_of field of the given PIF.

Link to this function

get_tunnel_transport_PIF_of!(xen_session, pif_ref)

View Source

Get the tunnel_transport_PIF_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, pif_ref)

View Source

Get the uuid field of the given PIF.

Link to this function

get_uuid!(xen_session, pif_ref)

View Source

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

Link to this function

get_VLAN(xen_session, pif_ref)

View Source

Get the VLAN field of the given PIF.

Link to this function

get_VLAN!(xen_session, pif_ref)

View Source

Get the VLAN field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_VLAN_master_of(xen_session, pif_ref)

View Source

Get the VLAN_master_of field of the given PIF.

Link to this function

get_VLAN_master_of!(xen_session, pif_ref)

View Source

Get the VLAN_master_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

get_VLAN_slave_of(xen_session, pif_ref)

View Source

Get the VLAN_slave_of field of the given PIF.

Link to this function

get_VLAN_slave_of!(xen_session, pif_ref)

View Source

Get the VLAN_slave_of field of the given PIF. (Raise error on XMLRPC failure)

Link to this function

introduce(xen_session, host, arg, device, managed)

View Source

Create a PIF object matching a particular network interface

Link to this function

introduce!(xen_session, host, arg, device, managed)

View Source

Create a PIF object matching a particular network interface (Raise error on XMLRPC failure)

Link to this function

plug(xen_session, pif_ref)

View Source

Attempt to bring up a physical interface

Link to this function

plug!(xen_session, pif_ref)

View Source

Attempt to bring up a physical interface (Raise error on XMLRPC failure)

Link to this function

reconfigure_ip(xen_session, pif_ref, mode, arg1, netmask, gateway, arg2)

View Source

Reconfigure the IP address settings for this interface

Link to this function

reconfigure_ip!(xen_session, pif_ref, mode, arg1, netmask, gateway, arg2)

View Source

Reconfigure the IP address settings for this interface (Raise error on XMLRPC failure)

Link to this function

reconfigure_ipv6(xen_session, pif_ref, mode, arg1, gateway, arg2)

View Source

Reconfigure the IPv6 address settings for this interface

Link to this function

reconfigure_ipv6!(xen_session, pif_ref, mode, arg1, gateway, arg2)

View Source

Reconfigure the IPv6 address settings for this interface (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, pif_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, pif_ref, key)

View Source

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

Scan for physical interfaces on a host and create PIF objects to represent them

Link to this function

scan!(xen_session, host)

View Source

Scan for physical interfaces on a host and create PIF objects to represent them (Raise error on XMLRPC failure)

Link to this function

set_disallow_unplug(xen_session, pif_ref, value)

View Source

Set whether unplugging the PIF is allowed

Link to this function

set_disallow_unplug!(xen_session, pif_ref, value)

View Source

Set whether unplugging the PIF is allowed (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, pif_ref, value)

View Source

Set the other_config field of the given PIF.

Link to this function

set_other_config!(xen_session, pif_ref, value)

View Source

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

Link to this function

set_primary_address_type(xen_session, pif_ref, primary_address_type)

View Source

Change the primary address type used by this PIF

Link to this function

set_primary_address_type!(xen_session, pif_ref, primary_address_type)

View Source

Change the primary address type used by this PIF (Raise error on XMLRPC failure)

Link to this function

set_property(xen_session, pif_ref, name, value)

View Source

Set the value of a property of the PIF

Link to this function

set_property!(xen_session, pif_ref, name, value)

View Source

Set the value of a property of the PIF (Raise error on XMLRPC failure)

Link to this function

unplug(xen_session, pif_ref)

View Source

Attempt to bring down a physical interface

Link to this function

unplug!(xen_session, pif_ref)

View Source

Attempt to bring down a physical interface (Raise error on XMLRPC failure)