A physical network interface (note separate VLANs are represented as several PIFs)
Published in:
XenServer 4.0 (rio)
A physical network interface (note separate VLANs are represented as several PIFs)
Enums
pif_igmp_status
Values:
enabled
IGMP Snooping is enabled in the corresponding backend bridge.'
disabled
IGMP Snooping is disabled in the corresponding backend bridge.'
unknown
IGMP snooping status is unknown. If this is a VLAN master, then please consult the underlying VLAN slave PIF.
ip_configuration_mode
Values:
None
Do not acquire an IP address
DHCP
Acquire an IP address by DHCP
Static
Static IP address configuration
ipv6_configuration_mode
Values:
None
Do not acquire an IPv6 address
DHCP
Acquire an IPv6 address by DHCP
Static
Static IPv6 address configuration
Autoconf
Router assigned prefix delegation IPv6 allocation
primary_address_type
Values:
IPv4
Primary address is the IPv4 address
IPv6
Primary address is the IPv6 address
Fields
Bond ref setbond_master_of[RO/runtime]
Indicates this PIF represents the results of a bond
Published in:
XenServer 4.1 (miami)
Indicates this PIF represents the results of a bond
Bond refbond_slave_of[RO/runtime]
Indicates which bond this interface is part of
Default value:
Null
Published in:
XenServer 4.1 (miami)
Indicates which bond this interface is part of
string setcapabilities[RO/runtime]
Additional capabilities on the interface.
Default value:
{}
Published in:
XenServer 7.0 (dundee)
boolcurrently_attached[RO/runtime]
true if this interface is online
Default value:
true
Published in:
XenServer 4.1 (miami)
true if this interface is online
stringdevice[RO/constructor]
machine-readable name of the interface (e.g. eth0)
Published in:
XenServer 4.0 (rio)
machine-readable name of the interface (e.g. eth0)
booldisallow_unplug[RO/runtime]
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)
Default value:
false
Published in:
XenServer 5.0 (orlando)
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)
stringDNS[RO/runtime]
Comma separated list of the IP addresses of the DNS servers to use
Default value:
""
Published in:
XenServer 4.1 (miami)
Comma separated list of the IP addresses of the DNS servers to use
Sets if and how this interface gets an IPv6 address
Default value:
None
Published in:
XenServer 6.1 (tampa)
stringipv6_gateway[RO/runtime]
IPv6 gateway
Default value:
""
Published in:
XenServer 6.1 (tampa)
stringMAC[RO/constructor]
ethernet MAC address of physical interface
Published in:
XenServer 4.0 (rio)
ethernet MAC address of physical interface
boolmanaged[RO/constructor]
Indicates whether the interface is managed by xapi. If it is not, then xapi will not configure the interface, the commands PIF.plug/unplug/reconfigure_ip(v6) cannot be used, nor can the interface be bonded or have VLANs based on top through xapi.
Default value:
true
Published in:
XenServer 6.2 SP1 (vgpu-productisation)
boolmanagement[RO/runtime]
Indicates whether the control software is listening for connections on this interface
Default value:
false
Published in:
XenServer 4.1 (miami)
Indicates whether the control software is listening for connections on this interface
PIF_metrics refmetrics[RO/runtime]
metrics associated with this PIF
Published in:
XenServer 4.0 (rio)
metrics associated with this PIF
intMTU[RO/constructor]
MTU in octets
Published in:
XenServer 4.0 (rio)
MTU in octets
stringnetmask[RO/runtime]
IP netmask
Default value:
""
Published in:
XenServer 4.1 (miami)
IP netmask
network refnetwork[RO/constructor]
virtual network to which this pif is connected
Published in:
XenServer 4.0 (rio)
virtual network to which this pif is connected
(string → string) mapother_config[RW]
Additional configuration
Default value:
{}
Published in:
XenServer 4.1 (miami)
Additional configuration
PCI refPCI[RO/runtime]
Link to underlying PCI device
Default value:
OpaqueRef:NULL
Published in:
XenServer 7.5 (kolkata)
boolphysical[RO/runtime]
true if this represents a physical network interface
Default value:
false
Published in:
XenServer 4.1 (miami)
true if this represents a physical network interface
Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
the PIF object to destroy
Minimum role:
pool-operator
Errors:
PIF_IS_PHYSICAL
You tried to destroy a PIF, but it represents an aspect of the physical host configuration, and so cannot be destroyed. The parameter echoes the PIF handle you gave.
Published in:
XenServer 4.0 (rio)
Destroy the PIF object (provided it is a VLAN interface)
Deprecated in:
XenServer 4.1 (miami)
Replaced by VLAN.destroy and Bond.destroy
voidforget(session ref, PIF ref)
Destroy the PIF object matching a particular network interface
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
The PIF object to destroy
Minimum role:
pool-operator
Errors:
PIF_TUNNEL_STILL_EXISTS
Operation cannot proceed while a tunnel exists on this interface.
CLUSTERING_ENABLED
An operation was attempted while clustering was enabled on the cluster_host.
Published in:
XenServer 4.1 (miami)
Destroy the PIF object matching a particular network interface
PIF ref setget_all(session ref)
Return a list of all the PIFs known to the system.
Parameters:
session ref session_id
Reference to a valid session
Minimum role:
read-only
Result:
references to all objects
Published in:
XenServer 4.0 (rio)
A physical network interface (note separate VLANs are represented as several PIFs)
Return a map of PIF references to PIF records for all PIFs known to the system.
Parameters:
session ref session_id
Reference to a valid session
Minimum role:
read-only
Result:
records of all objects
Published in:
XenServer 4.0 (rio)
A physical network interface (note separate VLANs are represented as several PIFs)
Bond ref setget_bond_master_of(session ref, PIF ref)
Get the bond_master_of field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.1 (miami)
Indicates this PIF represents the results of a bond
Bond refget_bond_slave_of(session ref, PIF ref)
Get the bond_slave_of field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.1 (miami)
Indicates which bond this interface is part of
PIF refget_by_uuid(session ref, string)
Get a reference to the PIF instance with the specified UUID.
Parameters:
session ref session_id
Reference to a valid session
string uuid
UUID of object to return
Minimum role:
read-only
Result:
reference to the object
Published in:
XenServer 4.0 (rio)
A physical network interface (note separate VLANs are represented as several PIFs)
string setget_capabilities(session ref, PIF ref)
Get the capabilities field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 7.0 (dundee)
boolget_currently_attached(session ref, PIF ref)
Get the currently_attached field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.1 (miami)
true if this interface is online
stringget_device(session ref, PIF ref)
Get the device field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.0 (rio)
machine-readable name of the interface (e.g. eth0)
boolget_disallow_unplug(session ref, PIF ref)
Get the disallow_unplug field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 5.0 (orlando)
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)
stringget_DNS(session ref, PIF ref)
Get the DNS field of the given PIF.
Parameters:
session ref session_id
Reference to a valid session
PIF ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.1 (miami)
Comma separated list of the IP addresses of the DNS servers to use
This operation cannot be performed because it would invalidate VM failover planning such that the system would be unable to guarantee to restart protected VMs after a Host failure.
VIF_IN_USE
Network has active VIFs
PIF_DOES_NOT_ALLOW_UNPLUG
The operation you requested cannot be performed because the specified PIF does not allow unplug.
PIF_HAS_FCOE_SR_IN_USE
The operation you requested cannot be performed because the specified PIF has FCoE SR in use.