Class: PIF
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
string
DNS
[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 |
string
IP
[RO/runtime]
IP address
| Default value: | "" | |
| Published in: | XenServer 4.1 (miami) | IP address |
string set
IPv6
[RO/runtime]
IPv6 address
| Default value: | {} | |
| Published in: | XenServer 6.1 (tampa) | |
string
MAC
[RO/constructor]
ethernet MAC address of physical interface
| Published in: | XenServer 4.0 (rio) | ethernet MAC address of physical interface |
int
MTU
[RO/constructor]
MTU in octets
| Published in: | XenServer 4.0 (rio) | MTU in octets |
PCI ref
PCI
[RO/runtime]
Link to underlying PCI device
| Default value: | OpaqueRef:NULL | |
| Published in: | XenServer 7.5 (kolkata) | |
int
VLAN
[RO/constructor]
VLAN tag for all traffic passing through this interface
| Published in: | XenServer 4.0 (rio) | VLAN tag for all traffic passing through this interface |
VLAN ref
VLAN_master_of
[RO/runtime]
Indicates which VLAN this interface receives untagged traffic from
| Default value: | Null | |
| Published in: | XenServer 4.1 (miami) | Indicates which VLAN this interface receives untagged traffic from |
VLAN ref set
VLAN_slave_of
[RO/runtime]
Indicates which VLANs this interface transmits tagged traffic to
| Published in: | XenServer 4.1 (miami) | Indicates which VLANs this interface transmits tagged traffic to |
Bond ref set
bond_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 ref
bond_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 set
capabilities
[RO/runtime]
Additional capabilities on the interface.
| Default value: | {} | |
| Published in: | XenServer 7.0 (dundee) | |
bool
currently_attached
[RO/runtime]
true if this interface is online
| Default value: | true | |
| Published in: | XenServer 4.1 (miami) | true if this interface is online |
string
device
[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) |
bool
disallow_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) |
string
gateway
[RO/runtime]
IP gateway
| Default value: | "" | |
| Published in: | XenServer 4.1 (miami) | IP gateway |
host ref
host
[RO/constructor]
physical machine to which this pif is connected
| Published in: | XenServer 4.0 (rio) | physical machine to which this pif is connected |
enum pif_igmp_status
igmp_snooping_status
[RO/runtime]
The IGMP snooping status of the corresponding network bridge
| Default value: | unknown | |
| Published in: | XenServer 7.3 (inverness) | |
enum ip_configuration_mode
ip_configuration_mode
[RO/runtime]
Sets if and how this interface gets an IP address
| Default value: | None | |
| Published in: | XenServer 4.1 (miami) | Sets if and how this interface gets an IP address |
enum ipv6_configuration_mode
ipv6_configuration_mode
[RO/runtime]
Sets if and how this interface gets an IPv6 address
| Default value: | None | |
| Published in: | XenServer 6.1 (tampa) | |
string
ipv6_gateway
[RO/runtime]
IPv6 gateway
| Default value: | "" | |
| Published in: | XenServer 6.1 (tampa) | |
bool
managed
[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) | |
bool
management
[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 ref
metrics
[RO/runtime]
metrics associated with this PIF
| Published in: | XenServer 4.0 (rio) | metrics associated with this PIF |
string
netmask
[RO/runtime]
IP netmask
| Default value: | "" | |
| Published in: | XenServer 4.1 (miami) | IP netmask |
network ref
network
[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) map
other_config
[RW]
Additional configuration
| Default value: | {} | |
| Published in: | XenServer 4.1 (miami) | Additional configuration |
bool
physical
[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 |
enum primary_address_type
primary_address_type
[RO/runtime]
Which protocol should define the primary address of this interface
| Default value: | IPv4 | |
| Published in: | XenServer 6.1 (tampa) | |
(string → string) map
properties
[RO/runtime]
Additional configuration properties for the interface.
| Default value: | {} | |
| Published in: | XenServer 6.5 (creedence) | |
network_sriov ref set
sriov_logical_PIF_of
[RO/runtime]
Indicates which network_sriov this interface is logical of
| Published in: | XenServer 7.5 (kolkata) | Indicates which network_sriov this interface is logical of |
network_sriov ref set
sriov_physical_PIF_of
[RO/runtime]
Indicates which network_sriov this interface is physical of
| Published in: | XenServer 7.5 (kolkata) | Indicates which network_sriov this interface is physical of |
tunnel ref set
tunnel_access_PIF_of
[RO/runtime]
Indicates to which tunnel this PIF gives access
| Published in: | XenServer 5.6 FP1 (cowley) | Indicates to which tunnel this PIF gives access |
tunnel ref set
tunnel_transport_PIF_of
[RO/runtime]
Indicates to which tunnel this PIF provides transport
| Published in: | XenServer 5.6 FP1 (cowley) | Indicates to which tunnel this PIF provides transport |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Messages
void
add_to_other_config
(session ref, PIF ref, string, string)
Add the given key-value pair to the other_config field of the given PIF.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | reference to the object | |
| string key | Key to add | |
| string value | Value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.1 (miami) | Additional configuration |
Deprecated
PIF ref
create_VLAN
(session ref, string, network ref, host ref, int)
Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead
| Parameters: | session ref session_id | Reference to a valid session |
| string device | physical interface on which to create the VLAN interface | |
| network ref network | network to which this interface should be connected | |
| host ref host | physical machine to which this PIF is connected | |
| int VLAN | VLAN tag for the new interface | |
| Minimum role: | pool-operator | |
| Result: | The reference of the created PIF object | |
| Errors: | VLAN_TAG_INVALID | You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave. |
| Published in: | XenServer 4.0 (rio) | Create a VLAN interface from an existing physical interface |
| Deprecated in: | XenServer 4.1 (miami) | Replaced by VLAN.create |
void
db_forget
(session ref, PIF ref)
Destroy a PIF database record.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | The ref of the PIF whose database record should be destroyed | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.0 (orlando) | Destroy a PIF database record. |
PIF ref
db_introduce
(session ref, string, network ref, host ref, string, int, int, bool, enum ip_configuration_mode, string, string, string, string, Bond ref, VLAN ref, bool, (string → string) map, bool, enum ipv6_configuration_mode, string set, string, enum primary_address_type, bool, (string → string) map)
Create a new PIF record in the database only
| Parameters: | session ref session_id | Reference to a valid session |
| string device | ||
| network ref network | ||
| host ref 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 ref bond_slave_of | ||
| VLAN ref VLAN_master_of | ||
| bool management | ||
| (string → string) map other_config | ||
| bool disallow_unplug | ||
| enum ipv6_configuration_mode ipv6_configuration_mode | ||
| string set IPv6 | ||
| string ipv6_gateway | ||
| enum primary_address_type primary_address_type | ||
| bool managed | ||
| (string → string) map properties | ||
| Minimum role: | pool-operator | |
| Result: | The ref of the newly created PIF record. | |
| Published in: | XenServer 5.0 (orlando) | Create a new PIF record in the database only |
Deprecated
void
destroy
(session ref, PIF ref)
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 |
void
forget
(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 |
string
get_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 |
string
get_IP
(session ref, PIF ref)
Get the IP 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) | IP address |
string set
get_IPv6
(session ref, PIF ref)
Get the IPv6 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 6.1 (tampa) | |
string
get_MAC
(session ref, PIF ref)
Get the MAC 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) | ethernet MAC address of physical interface |
int
get_MTU
(session ref, PIF ref)
Get the MTU 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) | MTU in octets |
PCI ref
get_PCI
(session ref, PIF ref)
Get the PCI 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.5 (kolkata) | |
int
get_VLAN
(session ref, PIF ref)
Get the VLAN 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) | VLAN tag for all traffic passing through this interface |
VLAN ref
get_VLAN_master_of
(session ref, PIF ref)
Get the VLAN_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 which VLAN this interface receives untagged traffic from |
VLAN ref set
get_VLAN_slave_of
(session ref, PIF ref)
Get the VLAN_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 VLANs this interface transmits tagged traffic to |
PIF ref set
get_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) |
(PIF ref → PIF record) map
get_all_records
(session ref)
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 set
get_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 ref
get_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 ref
get_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 set
get_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) | |
bool
get_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 |
string
get_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) |
bool
get_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) |
string
get_gateway
(session ref, PIF ref)
Get the gateway 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) | IP gateway |
host ref
get_host
(session ref, PIF ref)
Get the host 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) | physical machine to which this pif is connected |
enum pif_igmp_status
get_igmp_snooping_status
(session ref, PIF ref)
Get the igmp_snooping_status 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.3 (inverness) | |
enum ip_configuration_mode
get_ip_configuration_mode
(session ref, PIF ref)
Get the ip_configuration_mode 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) | Sets if and how this interface gets an IP address |
enum ipv6_configuration_mode
get_ipv6_configuration_mode
(session ref, PIF ref)
Get the ipv6_configuration_mode 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 6.1 (tampa) | |
string
get_ipv6_gateway
(session ref, PIF ref)
Get the ipv6_gateway 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 6.1 (tampa) | |
bool
get_managed
(session ref, PIF ref)
Get the managed 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 6.2 SP1 (vgpu-productisation) | |
bool
get_management
(session ref, PIF ref)
Get the management 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 whether the control software is listening for connections on this interface |
PIF_metrics ref
get_metrics
(session ref, PIF ref)
Get the metrics 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) | metrics associated with this PIF |
string
get_netmask
(session ref, PIF ref)
Get the netmask 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) | IP netmask |
network ref
get_network
(session ref, PIF ref)
Get the network 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) | virtual network to which this pif is connected |
(string → string) map
get_other_config
(session ref, PIF ref)
Get the other_config 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) | Additional configuration |
bool
get_physical
(session ref, PIF ref)
Get the physical 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 represents a physical network interface |
enum primary_address_type
get_primary_address_type
(session ref, PIF ref)
Get the primary_address_type 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 6.1 (tampa) | |
(string → string) map
get_properties
(session ref, PIF ref)
Get the properties 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 6.5 (creedence) | |
PIF record
get_record
(session ref, PIF ref)
Get a record containing the current state 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: | all fields from the object | |
| Published in: | XenServer 4.0 (rio) | A physical network interface (note separate VLANs are represented as several PIFs) |
network_sriov ref set
get_sriov_logical_PIF_of
(session ref, PIF ref)
Get the sriov_logical_PIF_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 7.5 (kolkata) | Indicates which network_sriov this interface is logical of |
network_sriov ref set
get_sriov_physical_PIF_of
(session ref, PIF ref)
Get the sriov_physical_PIF_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 7.5 (kolkata) | Indicates which network_sriov this interface is physical of |
tunnel ref set
get_tunnel_access_PIF_of
(session ref, PIF ref)
Get the tunnel_access_PIF_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 5.6 FP1 (cowley) | Indicates to which tunnel this PIF gives access |
tunnel ref set
get_tunnel_transport_PIF_of
(session ref, PIF ref)
Get the tunnel_transport_PIF_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 5.6 FP1 (cowley) | Indicates to which tunnel this PIF provides transport |
string
get_uuid
(session ref, PIF ref)
Get the uuid 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) | Unique identifier/object reference |
PIF ref
introduce
(session ref, host ref, string, string, bool)
Create a PIF object matching a particular network interface
| Parameters: | session ref session_id | Reference to a valid session |
| host ref host | The host on which the interface exists | |
| string MAC | The MAC address of the interface | |
| string device | The device name to use for the interface | |
| bool managed | Indicates whether the interface is managed by xapi (defaults to "true") | |
| Minimum role: | pool-operator | |
| Result: | The reference of the created PIF object | |
| Published in: | XenServer 4.1 (miami) | Create a PIF object matching a particular network interface |
void
plug
(session ref, PIF ref)
Attempt to bring up a physical interface
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | the PIF object to plug | |
| Minimum role: | pool-operator | |
| Errors: | TRANSPORT_PIF_NOT_CONFIGURED | The tunnel transport PIF has no IP configuration set. |
| Published in: | XenServer 4.1 (miami) | Attempt to bring up a physical interface |
void
reconfigure_ip
(session ref, PIF ref, enum ip_configuration_mode, string, string, string, string)
Reconfigure the IP address settings for this interface
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | the PIF object to reconfigure | |
| enum ip_configuration_mode mode | whether to use dynamic/static/no-assignment | |
| string IP | the new IP address | |
| string netmask | the new netmask | |
| string gateway | the new gateway | |
| string DNS | the new DNS settings | |
| Minimum role: | pool-operator | |
| Errors: | CLUSTERING_ENABLED | An operation was attempted while clustering was enabled on the cluster_host. |
| Published in: | XenServer 4.1 (miami) | Reconfigure the IP address settings for this interface |
void
reconfigure_ipv6
(session ref, PIF ref, enum ipv6_configuration_mode, string, string, string)
Reconfigure the IPv6 address settings for this interface
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | the PIF object to reconfigure | |
| enum ipv6_configuration_mode mode | whether to use dynamic/static/no-assignment | |
| string IPv6 | the new IPv6 address (in <addr>/<prefix length> format) | |
| string gateway | the new gateway | |
| string DNS | the new DNS settings | |
| Minimum role: | pool-operator | |
| Errors: | CLUSTERING_ENABLED | An operation was attempted while clustering was enabled on the cluster_host. |
| Published in: | XenServer 6.1 (tampa) | |
void
remove_from_other_config
(session ref, PIF ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | reference to the object | |
| string key | Key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.1 (miami) | Additional configuration |
void
scan
(session ref, host ref)
Scan for physical interfaces on a host and create PIF objects to represent them
| Parameters: | session ref session_id | Reference to a valid session |
| host ref host | The host on which to scan | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.1 (miami) | Scan for physical interfaces on a host and create PIF objects to represent them |
void
set_disallow_unplug
(session ref, PIF ref, bool)
Set whether unplugging the PIF is allowed
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | Reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Errors: | OTHER_OPERATION_IN_PROGRESS | Another operation involving the object is currently in progress |
| CLUSTERING_ENABLED | An operation was attempted while clustering was enabled on the cluster_host. | |
| Published in: | XenServer 5.0 (orlando) | Set whether unplugging the PIF is allowed |
void
set_other_config
(session ref, PIF ref, (string → string) map)
Set the other_config field of the given PIF.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | reference to the object | |
| (string → string) map value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.1 (miami) | Additional configuration |
void
set_primary_address_type
(session ref, PIF ref, enum primary_address_type)
Change the primary address type used by this PIF
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | the PIF object to reconfigure | |
| enum primary_address_type primary_address_type | Whether to prefer IPv4 or IPv6 connections | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 6.1 (tampa) | |
void
set_property
(session ref, PIF ref, string, string)
Set the value of a property of the PIF
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | The PIF | |
| string name | The property name | |
| string value | The property value | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 6.5 (creedence) | |
void
unplug
(session ref, PIF ref)
Attempt to bring down a physical interface
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref self | the PIF object to unplug | |
| Minimum role: | pool-operator | |
| Errors: | HA_OPERATION_WOULD_BREAK_FAILOVER_PLAN | 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. | |
| Published in: | XenServer 4.1 (miami) | Attempt to bring down a physical interface |