/Classes/PIF

Classes / PIF / index.html

A physical network interface (note separate VLANs are represented as several PIFs)

Fields

string uuid
Unique identifier/object reference
string device
machine-readable name of the interface (e.g. eth0)
network network
virtual network to which this pif is connected
host host
physical machine to which this pif is connected
string MAC
ethernet MAC address of physical interface
int MTU
MTU in octets
int VLAN
VLAN tag for all traffic passing through this interface
string device_name
actual dom0 device name
PIF_metrics metrics
metrics associated with this PIF
bool physical
true if this represents a physical network interface
bool currently_attached
true if this interface is online
enum ip_configuration_mode ip_configuration_mode
Sets if and how this interface gets an IP address
string IP
IP address
string netmask
IP netmask
string gateway
IP gateway
string DNS
IP address of DNS servers to use
Bond bond_slave_of
Indicates which bond this interface is part of
Set[Bond] bond_master_of
Indicates this PIF represents the results of a bond
VLAN VLAN_master_of
Indicates wich VLAN this interface receives untagged traffic from
Set[VLAN] VLAN_slave_of
Indicates which VLANs this interface transmits tagged traffic to
bool management
Indicates whether the control software is listening for connections on this interface
Map[string,string] other_config
Additional configuration
bool disallow_unplug
Prevent this PIF from being unplugged; set this to notify the management tool-stack that the PIF has a special use and should not be unplugged under any circumstances (e.g. because you're running storage traffic over it)
Set[tunnel] tunnel_access_PIF_of
Indicates to which tunnel this PIF gives access
Set[tunnel] tunnel_transport_PIF_of
Indicates to which tunnel this PIF provides transport

Implicit messages

Record[PIF] get_record (session session_id, PIF self)
Get a record containing the current state of the given PIF.
PIF get_by_uuid (session session_id, string uuid)
Get a reference to the PIF instance with the specified UUID.
Set[PIF] get_all (session session_id)
Return a list of all the PIFs known to the system.
Map[PIF,Record[PIF]] get_all_records (session session_id)
Return a map of PIF references to PIF records for all PIFs known to the system.

Explicit messages

PIF create_VLAN (session session_id, string device, network network, host host, int VLAN)
[deprecated]Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead
void destroy (session session_id, PIF self)
[deprecated]Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead
void reconfigure_ip (session session_id, PIF self, enum ip_configuration_mode mode, string IP, string netmask, string gateway, string DNS)
Reconfigure the IP address settings for this interface
void scan (session session_id, host host)
Scan for physical interfaces on a host and create PIF objects to represent them
Set[PIF] scan_bios (session session_id, host host)
Scan for physical interfaces on a host and create PIF objects to represent them. Use BIOS-based device names.
PIF introduce (session session_id, host host, string MAC, string device)
Create a PIF object matching a particular network interface
void forget (session session_id, PIF self)
Destroy the PIF object matching a particular network interface
void unplug (session session_id, PIF self)
Attempt to bring down a physical interface
void plug (session session_id, PIF self)
Attempt to bring up a physical interface
PIF db_introduce (session session_id, string device, network network, host host, string MAC, int MTU, int VLAN, bool physical, enum ip_configuration_mode ip_configuration_mode, string IP, string netmask, string gateway, string DNS, Bond bond_slave_of, VLAN VLAN_master_of, bool management, Map[string,string] other_config, bool disallow_unplug)
Create a new PIF record in the database only
void db_forget (session session_id, PIF self)
Destroy a PIF database record.