View Source XenAPI.PIF (XenAPI v0.1.2)
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)
Create a new PIF record in the database only
Create a new PIF record in the database only (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
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)
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 SourceCreate a new PIF record in the database only
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 SourceCreate a new PIF record in the database only (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_ip(xen_session, pif_ref, mode, arg1, netmask, gateway, arg2)
View SourceReconfigure the IP address settings for this interface
reconfigure_ip!(xen_session, pif_ref, mode, arg1, netmask, gateway, arg2)
View SourceReconfigure the IP address settings for this interface (Raise error on XMLRPC failure)
Reconfigure the IPv6 address settings for this interface
reconfigure_ipv6!(xen_session, pif_ref, mode, arg1, gateway, arg2)
View SourceReconfigure 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)
set_primary_address_type(xen_session, pif_ref, primary_address_type)
View SourceChange the primary address type used by this PIF
set_primary_address_type!(xen_session, pif_ref, primary_address_type)
View SourceChange 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)