com.xensource.xenapi
Class PIF

java.lang.Object
  extended by com.xensource.xenapi.XenAPIObject
      extended by com.xensource.xenapi.PIF

public class PIF
extends XenAPIObject

A physical network interface (note separate VLANs are represented as several PIFs) First published in XenServer 4.0.


Nested Class Summary
static class PIF.Record
          Represents all the fields in a PIF
 
Field Summary
protected  java.lang.String ref
          The XenAPI reference (OpaqueRef) to this object.
 
Method Summary
 void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value)
          Add the given key-value pair to the other_config field of the given PIF.
static PIF createVLAN(Connection c, java.lang.String device, Network network, Host host, java.lang.Long VLAN)
          Deprecated.  
static Task createVLANAsync(Connection c, java.lang.String device, Network network, Host host, java.lang.Long VLAN)
          Deprecated.  
 void dbForget(Connection c)
          Destroy a PIF database record.
 Task dbForgetAsync(Connection c)
          Destroy a PIF database record.
static PIF dbIntroduce(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug)
          Create a new PIF record in the database only First published in XenServer 5.0.
static PIF dbIntroduce(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, java.util.Set<java.lang.String> IPv6, java.lang.String ipv6Gateway, Types.PrimaryAddressType primaryAddressType)
          Create a new PIF record in the database only First published in XenServer 5.0.
static PIF dbIntroduce(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, java.util.Set<java.lang.String> IPv6, java.lang.String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, java.lang.Boolean managed)
          Create a new PIF record in the database only First published in XenServer 5.0.
static PIF dbIntroduce(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, java.util.Set<java.lang.String> IPv6, java.lang.String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, java.lang.Boolean managed, java.util.Map<java.lang.String,java.lang.String> properties)
          Create a new PIF record in the database only First published in XenServer 5.0.
static Task dbIntroduceAsync(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug)
          Create a new PIF record in the database only First published in XenServer 5.0.
static Task dbIntroduceAsync(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, java.util.Set<java.lang.String> IPv6, java.lang.String ipv6Gateway, Types.PrimaryAddressType primaryAddressType)
          Create a new PIF record in the database only First published in XenServer 5.0.
static Task dbIntroduceAsync(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, java.util.Set<java.lang.String> IPv6, java.lang.String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, java.lang.Boolean managed)
          Create a new PIF record in the database only First published in XenServer 5.0.
static Task dbIntroduceAsync(Connection c, java.lang.String device, Network network, Host host, java.lang.String MAC, java.lang.Long MTU, java.lang.Long VLAN, java.lang.Boolean physical, Types.IpConfigurationMode ipConfigurationMode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, java.lang.Boolean management, java.util.Map<java.lang.String,java.lang.String> otherConfig, java.lang.Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, java.util.Set<java.lang.String> IPv6, java.lang.String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, java.lang.Boolean managed, java.util.Map<java.lang.String,java.lang.String> properties)
          Create a new PIF record in the database only First published in XenServer 5.0.
 void destroy(Connection c)
          Deprecated.  
 Task destroyAsync(Connection c)
          Deprecated.  
 boolean equals(java.lang.Object obj)
          If obj is a PIF, compares XenAPI references for equality.
 void forget(Connection c)
          Destroy the PIF object matching a particular network interface First published in XenServer 4.1.
 Task forgetAsync(Connection c)
          Destroy the PIF object matching a particular network interface First published in XenServer 4.1.
static java.util.Set<PIF> getAll(Connection c)
          Return a list of all the PIFs known to the system.
static java.util.Map<PIF,PIF.Record> getAllRecords(Connection c)
          Return a map of PIF references to PIF records for all PIFs known to the system.
 java.util.Set<Bond> getBondMasterOf(Connection c)
          Get the bond_master_of field of the given PIF.
 Bond getBondSlaveOf(Connection c)
          Get the bond_slave_of field of the given PIF.
static PIF getByUuid(Connection c, java.lang.String uuid)
          Get a reference to the PIF instance with the specified UUID.
 java.lang.Boolean getCurrentlyAttached(Connection c)
          Get the currently_attached field of the given PIF.
 java.lang.String getDevice(Connection c)
          Get the device field of the given PIF.
 java.lang.Boolean getDisallowUnplug(Connection c)
          Get the disallow_unplug field of the given PIF.
 java.lang.String getDNS(Connection c)
          Get the DNS field of the given PIF.
 java.lang.String getGateway(Connection c)
          Get the gateway field of the given PIF.
 Host getHost(Connection c)
          Get the host field of the given PIF.
 java.lang.String getIP(Connection c)
          Get the IP field of the given PIF.
 Types.IpConfigurationMode getIpConfigurationMode(Connection c)
          Get the ip_configuration_mode field of the given PIF.
 java.util.Set<java.lang.String> getIPv6(Connection c)
          Get the IPv6 field of the given PIF.
 Types.Ipv6ConfigurationMode getIpv6ConfigurationMode(Connection c)
          Get the ipv6_configuration_mode field of the given PIF.
 java.lang.String getIpv6Gateway(Connection c)
          Get the ipv6_gateway field of the given PIF.
 java.lang.String getMAC(Connection c)
          Get the MAC field of the given PIF.
 java.lang.Boolean getManaged(Connection c)
          Get the managed field of the given PIF.
 java.lang.Boolean getManagement(Connection c)
          Get the management field of the given PIF.
 PIFMetrics getMetrics(Connection c)
          Get the metrics field of the given PIF.
 java.lang.Long getMTU(Connection c)
          Get the MTU field of the given PIF.
 java.lang.String getNetmask(Connection c)
          Get the netmask field of the given PIF.
 Network getNetwork(Connection c)
          Get the network field of the given PIF.
 java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
          Get the other_config field of the given PIF.
 java.lang.Boolean getPhysical(Connection c)
          Get the physical field of the given PIF.
 Types.PrimaryAddressType getPrimaryAddressType(Connection c)
          Get the primary_address_type field of the given PIF.
 java.util.Map<java.lang.String,java.lang.String> getProperties(Connection c)
          Get the properties field of the given PIF.
 PIF.Record getRecord(Connection c)
          Get a record containing the current state of the given PIF.
 java.util.Set<Tunnel> getTunnelAccessPIFOf(Connection c)
          Get the tunnel_access_PIF_of field of the given PIF.
 java.util.Set<Tunnel> getTunnelTransportPIFOf(Connection c)
          Get the tunnel_transport_PIF_of field of the given PIF.
 java.lang.String getUuid(Connection c)
          Get the uuid field of the given PIF.
 java.lang.Long getVLAN(Connection c)
          Get the VLAN field of the given PIF.
 VLAN getVLANMasterOf(Connection c)
          Get the VLAN_master_of field of the given PIF.
 java.util.Set<VLAN> getVLANSlaveOf(Connection c)
          Get the VLAN_slave_of field of the given PIF.
 int hashCode()
           
static PIF introduce(Connection c, Host host, java.lang.String MAC, java.lang.String device)
          Create a PIF object matching a particular network interface First published in XenServer 4.1.
static PIF introduce(Connection c, Host host, java.lang.String MAC, java.lang.String device, java.lang.Boolean managed)
          Create a PIF object matching a particular network interface First published in XenServer 4.1.
static Task introduceAsync(Connection c, Host host, java.lang.String MAC, java.lang.String device)
          Create a PIF object matching a particular network interface First published in XenServer 4.1.
static Task introduceAsync(Connection c, Host host, java.lang.String MAC, java.lang.String device, java.lang.Boolean managed)
          Create a PIF object matching a particular network interface First published in XenServer 4.1.
 void plug(Connection c)
          Attempt to bring up a physical interface First published in XenServer 4.1.
 Task plugAsync(Connection c)
          Attempt to bring up a physical interface First published in XenServer 4.1.
 void reconfigureIp(Connection c, Types.IpConfigurationMode mode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS)
          Reconfigure the IP address settings for this interface First published in XenServer 4.1.
 Task reconfigureIpAsync(Connection c, Types.IpConfigurationMode mode, java.lang.String IP, java.lang.String netmask, java.lang.String gateway, java.lang.String DNS)
          Reconfigure the IP address settings for this interface First published in XenServer 4.1.
 void reconfigureIpv6(Connection c, Types.Ipv6ConfigurationMode mode, java.lang.String IPv6, java.lang.String gateway, java.lang.String DNS)
          Reconfigure the IPv6 address settings for this interface Experimental.
 Task reconfigureIpv6Async(Connection c, Types.Ipv6ConfigurationMode mode, java.lang.String IPv6, java.lang.String gateway, java.lang.String DNS)
          Reconfigure the IPv6 address settings for this interface Experimental.
 void removeFromOtherConfig(Connection c, java.lang.String key)
          Remove the given key and its corresponding value from the other_config field of the given PIF.
static void scan(Connection c, Host host)
          Scan for physical interfaces on a host and create PIF objects to represent them First published in XenServer 4.1.
static Task scanAsync(Connection c, Host host)
          Scan for physical interfaces on a host and create PIF objects to represent them First published in XenServer 4.1.
 void setDisallowUnplug(Connection c, java.lang.Boolean disallowUnplug)
          Set the disallow_unplug field of the given PIF.
 void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)
          Set the other_config field of the given PIF.
 void setPrimaryAddressType(Connection c, Types.PrimaryAddressType primaryAddressType)
          Change the primary address type used by this PIF Experimental.
 Task setPrimaryAddressTypeAsync(Connection c, Types.PrimaryAddressType primaryAddressType)
          Change the primary address type used by this PIF Experimental.
 void setProperty(Connection c, java.lang.String name, java.lang.String value)
          Set the value of a property of the PIF First published in XenServer 6.5.
 Task setPropertyAsync(Connection c, java.lang.String name, java.lang.String value)
          Set the value of a property of the PIF First published in XenServer 6.5.
 java.lang.String toWireString()
           
 void unplug(Connection c)
          Attempt to bring down a physical interface First published in XenServer 4.1.
 Task unplugAsync(Connection c)
          Attempt to bring down a physical interface First published in XenServer 4.1.
 
Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ref

protected final java.lang.String ref
The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()
Specified by:
toWireString in class XenAPIObject
Returns:
The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)
If obj is a PIF, compares XenAPI references for equality.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getRecord

public PIF.Record getRecord(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Get a record containing the current state of the given PIF. First published in XenServer 4.0.

Returns:
all fields from the object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getByUuid

public static PIF getByUuid(Connection c,
                            java.lang.String uuid)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Get a reference to the PIF instance with the specified UUID. First published in XenServer 4.0.

Parameters:
uuid - UUID of object to return
Returns:
reference to the object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException
Get the uuid field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getDevice

public java.lang.String getDevice(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Get the device field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getNetwork

public Network getNetwork(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Get the network field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getHost

public Host getHost(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException
Get the host field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getMAC

public java.lang.String getMAC(Connection c)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Get the MAC field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getMTU

public java.lang.Long getMTU(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Get the MTU field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getVLAN

public java.lang.Long getVLAN(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Get the VLAN field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getMetrics

public PIFMetrics getMetrics(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Get the metrics field of the given PIF. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getPhysical

public java.lang.Boolean getPhysical(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException
Get the physical field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getCurrentlyAttached

public java.lang.Boolean getCurrentlyAttached(Connection c)
                                       throws Types.BadServerResponse,
                                              Types.XenAPIException,
                                              org.apache.xmlrpc.XmlRpcException
Get the currently_attached field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getIpConfigurationMode

public Types.IpConfigurationMode getIpConfigurationMode(Connection c)
                                                 throws Types.BadServerResponse,
                                                        Types.XenAPIException,
                                                        org.apache.xmlrpc.XmlRpcException
Get the ip_configuration_mode field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getIP

public java.lang.String getIP(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Get the IP field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getNetmask

public java.lang.String getNetmask(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException
Get the netmask field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getGateway

public java.lang.String getGateway(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException
Get the gateway field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getDNS

public java.lang.String getDNS(Connection c)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Get the DNS field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getBondSlaveOf

public Bond getBondSlaveOf(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException
Get the bond_slave_of field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getBondMasterOf

public java.util.Set<Bond> getBondMasterOf(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
Get the bond_master_of field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getVLANMasterOf

public VLAN getVLANMasterOf(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Get the VLAN_master_of field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getVLANSlaveOf

public java.util.Set<VLAN> getVLANSlaveOf(Connection c)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException
Get the VLAN_slave_of field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getManagement

public java.lang.Boolean getManagement(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Get the management field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException
Get the other_config field of the given PIF. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getDisallowUnplug

public java.lang.Boolean getDisallowUnplug(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
Get the disallow_unplug field of the given PIF. First published in XenServer 5.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getTunnelAccessPIFOf

public java.util.Set<Tunnel> getTunnelAccessPIFOf(Connection c)
                                           throws Types.BadServerResponse,
                                                  Types.XenAPIException,
                                                  org.apache.xmlrpc.XmlRpcException
Get the tunnel_access_PIF_of field of the given PIF. First published in XenServer 5.6 FP1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getTunnelTransportPIFOf

public java.util.Set<Tunnel> getTunnelTransportPIFOf(Connection c)
                                              throws Types.BadServerResponse,
                                                     Types.XenAPIException,
                                                     org.apache.xmlrpc.XmlRpcException
Get the tunnel_transport_PIF_of field of the given PIF. First published in XenServer 5.6 FP1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getIpv6ConfigurationMode

public Types.Ipv6ConfigurationMode getIpv6ConfigurationMode(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException
Get the ipv6_configuration_mode field of the given PIF. Experimental. First published in XenServer 6.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getIPv6

public java.util.Set<java.lang.String> getIPv6(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException
Get the IPv6 field of the given PIF. Experimental. First published in XenServer 6.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getIpv6Gateway

public java.lang.String getIpv6Gateway(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Get the ipv6_gateway field of the given PIF. Experimental. First published in XenServer 6.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getPrimaryAddressType

public Types.PrimaryAddressType getPrimaryAddressType(Connection c)
                                               throws Types.BadServerResponse,
                                                      Types.XenAPIException,
                                                      org.apache.xmlrpc.XmlRpcException
Get the primary_address_type field of the given PIF. Experimental. First published in XenServer 6.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getManaged

public java.lang.Boolean getManaged(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Get the managed field of the given PIF. First published in XenServer 6.2 SP1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties(Connection c)
                                                               throws Types.BadServerResponse,
                                                                      Types.XenAPIException,
                                                                      org.apache.xmlrpc.XmlRpcException
Get the properties field of the given PIF. First published in XenServer 6.5.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                           java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException
Set the other_config field of the given PIF. First published in XenServer 4.1.

Parameters:
otherConfig - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                             java.lang.String key,
                             java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Add the given key-value pair to the other_config field of the given PIF. First published in XenServer 4.1.

Parameters:
key - Key to add
value - Value to add
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                                  java.lang.String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
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. First published in XenServer 4.1.

Parameters:
key - Key to remove
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setDisallowUnplug

public void setDisallowUnplug(Connection c,
                              java.lang.Boolean disallowUnplug)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Set the disallow_unplug field of the given PIF. First published in XenServer 5.0.

Parameters:
disallowUnplug - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createVLANAsync

@Deprecated
public static Task createVLANAsync(Connection c,
                                              java.lang.String device,
                                              Network network,
                                              Host host,
                                              java.lang.Long VLAN)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException,
                                   Types.VlanTagInvalid
Deprecated. 

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead First published in XenServer 4.0.

Parameters:
device - physical interface on which to create the VLAN interface
network - network to which this interface should be connected
host - physical machine to which this PIF is connected
VLAN - VLAN tag for the new interface
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VlanTagInvalid

createVLAN

@Deprecated
public static PIF createVLAN(Connection c,
                                        java.lang.String device,
                                        Network network,
                                        Host host,
                                        java.lang.Long VLAN)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException,
                             Types.VlanTagInvalid
Deprecated. 

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead First published in XenServer 4.0.

Parameters:
device - physical interface on which to create the VLAN interface
network - network to which this interface should be connected
host - physical machine to which this PIF is connected
VLAN - VLAN tag for the new interface
Returns:
The reference of the created PIF object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VlanTagInvalid

destroyAsync

@Deprecated
public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException,
                         Types.PifIsPhysical
Deprecated. 

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

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.PifIsPhysical

destroy

@Deprecated
public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException,
                    Types.PifIsPhysical
Deprecated. 

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

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.PifIsPhysical

reconfigureIpAsync

public Task reconfigureIpAsync(Connection c,
                               Types.IpConfigurationMode mode,
                               java.lang.String IP,
                               java.lang.String netmask,
                               java.lang.String gateway,
                               java.lang.String DNS)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Reconfigure the IP address settings for this interface First published in XenServer 4.1.

Parameters:
mode - whether to use dynamic/static/no-assignment
IP - the new IP address
netmask - the new netmask
gateway - the new gateway
DNS - the new DNS settings
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

reconfigureIp

public void reconfigureIp(Connection c,
                          Types.IpConfigurationMode mode,
                          java.lang.String IP,
                          java.lang.String netmask,
                          java.lang.String gateway,
                          java.lang.String DNS)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Reconfigure the IP address settings for this interface First published in XenServer 4.1.

Parameters:
mode - whether to use dynamic/static/no-assignment
IP - the new IP address
netmask - the new netmask
gateway - the new gateway
DNS - the new DNS settings
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

reconfigureIpv6Async

public Task reconfigureIpv6Async(Connection c,
                                 Types.Ipv6ConfigurationMode mode,
                                 java.lang.String IPv6,
                                 java.lang.String gateway,
                                 java.lang.String DNS)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Reconfigure the IPv6 address settings for this interface Experimental. First published in XenServer 6.1.

Parameters:
mode - whether to use dynamic/static/no-assignment
IPv6 - the new IPv6 address (in / format)
gateway - the new gateway
DNS - the new DNS settings
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

reconfigureIpv6

public void reconfigureIpv6(Connection c,
                            Types.Ipv6ConfigurationMode mode,
                            java.lang.String IPv6,
                            java.lang.String gateway,
                            java.lang.String DNS)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Reconfigure the IPv6 address settings for this interface Experimental. First published in XenServer 6.1.

Parameters:
mode - whether to use dynamic/static/no-assignment
IPv6 - the new IPv6 address (in / format)
gateway - the new gateway
DNS - the new DNS settings
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setPrimaryAddressTypeAsync

public Task setPrimaryAddressTypeAsync(Connection c,
                                       Types.PrimaryAddressType primaryAddressType)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Change the primary address type used by this PIF Experimental. First published in XenServer 6.1.

Parameters:
primaryAddressType - Whether to prefer IPv4 or IPv6 connections
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setPrimaryAddressType

public void setPrimaryAddressType(Connection c,
                                  Types.PrimaryAddressType primaryAddressType)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Change the primary address type used by this PIF Experimental. First published in XenServer 6.1.

Parameters:
primaryAddressType - Whether to prefer IPv4 or IPv6 connections
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

scanAsync

public static Task scanAsync(Connection c,
                             Host host)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Scan for physical interfaces on a host and create PIF objects to represent them First published in XenServer 4.1.

Parameters:
host - The host on which to scan
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

scan

public static void scan(Connection c,
                        Host host)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException
Scan for physical interfaces on a host and create PIF objects to represent them First published in XenServer 4.1.

Parameters:
host - The host on which to scan
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                                  Host host,
                                  java.lang.String MAC,
                                  java.lang.String device)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Create a PIF object matching a particular network interface First published in XenServer 4.1.

Parameters:
host - The host on which the interface exists
MAC - The MAC address of the interface
device - The device name to use for the interface
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

introduce

public static PIF introduce(Connection c,
                            Host host,
                            java.lang.String MAC,
                            java.lang.String device)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Create a PIF object matching a particular network interface First published in XenServer 4.1.

Parameters:
host - The host on which the interface exists
MAC - The MAC address of the interface
device - The device name to use for the interface
Returns:
The reference of the created PIF object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                                  Host host,
                                  java.lang.String MAC,
                                  java.lang.String device,
                                  java.lang.Boolean managed)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Create a PIF object matching a particular network interface First published in XenServer 4.1.

Parameters:
host - The host on which the interface exists
MAC - The MAC address of the interface
device - The device name to use for the interface
managed - Indicates whether the interface is managed by xapi (defaults to "true") First published in XenServer 6.2 SP1.
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

introduce

public static PIF introduce(Connection c,
                            Host host,
                            java.lang.String MAC,
                            java.lang.String device,
                            java.lang.Boolean managed)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Create a PIF object matching a particular network interface First published in XenServer 4.1.

Parameters:
host - The host on which the interface exists
MAC - The MAC address of the interface
device - The device name to use for the interface
managed - Indicates whether the interface is managed by xapi (defaults to "true") First published in XenServer 6.2 SP1.
Returns:
The reference of the created PIF object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

forgetAsync

public Task forgetAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.PifTunnelStillExists
Destroy the PIF object matching a particular network interface First published in XenServer 4.1.

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.PifTunnelStillExists

forget

public void forget(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException,
                   Types.PifTunnelStillExists
Destroy the PIF object matching a particular network interface First published in XenServer 4.1.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.PifTunnelStillExists

unplugAsync

public Task unplugAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException
Attempt to bring down a physical interface First published in XenServer 4.1.

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

unplug

public void unplug(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException
Attempt to bring down a physical interface First published in XenServer 4.1.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

plugAsync

public Task plugAsync(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException,
                      Types.TransportPifNotConfigured
Attempt to bring up a physical interface First published in XenServer 4.1.

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.TransportPifNotConfigured

plug

public void plug(Connection c)
          throws Types.BadServerResponse,
                 Types.XenAPIException,
                 org.apache.xmlrpc.XmlRpcException,
                 Types.TransportPifNotConfigured
Attempt to bring up a physical interface First published in XenServer 4.1.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.TransportPifNotConfigured

dbIntroduceAsync

public static Task dbIntroduceAsync(Connection c,
                                    java.lang.String device,
                                    Network network,
                                    Host host,
                                    java.lang.String MAC,
                                    java.lang.Long MTU,
                                    java.lang.Long VLAN,
                                    java.lang.Boolean physical,
                                    Types.IpConfigurationMode ipConfigurationMode,
                                    java.lang.String IP,
                                    java.lang.String netmask,
                                    java.lang.String gateway,
                                    java.lang.String DNS,
                                    Bond bondSlaveOf,
                                    VLAN VLANMasterOf,
                                    java.lang.Boolean management,
                                    java.util.Map<java.lang.String,java.lang.String> otherConfig,
                                    java.lang.Boolean disallowUnplug)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduce

public static PIF dbIntroduce(Connection c,
                              java.lang.String device,
                              Network network,
                              Host host,
                              java.lang.String MAC,
                              java.lang.Long MTU,
                              java.lang.Long VLAN,
                              java.lang.Boolean physical,
                              Types.IpConfigurationMode ipConfigurationMode,
                              java.lang.String IP,
                              java.lang.String netmask,
                              java.lang.String gateway,
                              java.lang.String DNS,
                              Bond bondSlaveOf,
                              VLAN VLANMasterOf,
                              java.lang.Boolean management,
                              java.util.Map<java.lang.String,java.lang.String> otherConfig,
                              java.lang.Boolean disallowUnplug)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
Returns:
The ref of the newly created PIF record.
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduceAsync

public static Task dbIntroduceAsync(Connection c,
                                    java.lang.String device,
                                    Network network,
                                    Host host,
                                    java.lang.String MAC,
                                    java.lang.Long MTU,
                                    java.lang.Long VLAN,
                                    java.lang.Boolean physical,
                                    Types.IpConfigurationMode ipConfigurationMode,
                                    java.lang.String IP,
                                    java.lang.String netmask,
                                    java.lang.String gateway,
                                    java.lang.String DNS,
                                    Bond bondSlaveOf,
                                    VLAN VLANMasterOf,
                                    java.lang.Boolean management,
                                    java.util.Map<java.lang.String,java.lang.String> otherConfig,
                                    java.lang.Boolean disallowUnplug,
                                    Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
                                    java.util.Set<java.lang.String> IPv6,
                                    java.lang.String ipv6Gateway,
                                    Types.PrimaryAddressType primaryAddressType)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
ipv6ConfigurationMode - First published in XenServer 6.0.
IPv6 - First published in XenServer 6.0.
ipv6Gateway - First published in XenServer 6.0.
primaryAddressType - First published in XenServer 6.0.
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduce

public static PIF dbIntroduce(Connection c,
                              java.lang.String device,
                              Network network,
                              Host host,
                              java.lang.String MAC,
                              java.lang.Long MTU,
                              java.lang.Long VLAN,
                              java.lang.Boolean physical,
                              Types.IpConfigurationMode ipConfigurationMode,
                              java.lang.String IP,
                              java.lang.String netmask,
                              java.lang.String gateway,
                              java.lang.String DNS,
                              Bond bondSlaveOf,
                              VLAN VLANMasterOf,
                              java.lang.Boolean management,
                              java.util.Map<java.lang.String,java.lang.String> otherConfig,
                              java.lang.Boolean disallowUnplug,
                              Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
                              java.util.Set<java.lang.String> IPv6,
                              java.lang.String ipv6Gateway,
                              Types.PrimaryAddressType primaryAddressType)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
ipv6ConfigurationMode - First published in XenServer 6.0.
IPv6 - First published in XenServer 6.0.
ipv6Gateway - First published in XenServer 6.0.
primaryAddressType - First published in XenServer 6.0.
Returns:
The ref of the newly created PIF record.
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduceAsync

public static Task dbIntroduceAsync(Connection c,
                                    java.lang.String device,
                                    Network network,
                                    Host host,
                                    java.lang.String MAC,
                                    java.lang.Long MTU,
                                    java.lang.Long VLAN,
                                    java.lang.Boolean physical,
                                    Types.IpConfigurationMode ipConfigurationMode,
                                    java.lang.String IP,
                                    java.lang.String netmask,
                                    java.lang.String gateway,
                                    java.lang.String DNS,
                                    Bond bondSlaveOf,
                                    VLAN VLANMasterOf,
                                    java.lang.Boolean management,
                                    java.util.Map<java.lang.String,java.lang.String> otherConfig,
                                    java.lang.Boolean disallowUnplug,
                                    Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
                                    java.util.Set<java.lang.String> IPv6,
                                    java.lang.String ipv6Gateway,
                                    Types.PrimaryAddressType primaryAddressType,
                                    java.lang.Boolean managed)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
ipv6ConfigurationMode - First published in XenServer 6.0.
IPv6 - First published in XenServer 6.0.
ipv6Gateway - First published in XenServer 6.0.
primaryAddressType - First published in XenServer 6.0.
managed - First published in XenServer 6.2 SP1.
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduce

public static PIF dbIntroduce(Connection c,
                              java.lang.String device,
                              Network network,
                              Host host,
                              java.lang.String MAC,
                              java.lang.Long MTU,
                              java.lang.Long VLAN,
                              java.lang.Boolean physical,
                              Types.IpConfigurationMode ipConfigurationMode,
                              java.lang.String IP,
                              java.lang.String netmask,
                              java.lang.String gateway,
                              java.lang.String DNS,
                              Bond bondSlaveOf,
                              VLAN VLANMasterOf,
                              java.lang.Boolean management,
                              java.util.Map<java.lang.String,java.lang.String> otherConfig,
                              java.lang.Boolean disallowUnplug,
                              Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
                              java.util.Set<java.lang.String> IPv6,
                              java.lang.String ipv6Gateway,
                              Types.PrimaryAddressType primaryAddressType,
                              java.lang.Boolean managed)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
ipv6ConfigurationMode - First published in XenServer 6.0.
IPv6 - First published in XenServer 6.0.
ipv6Gateway - First published in XenServer 6.0.
primaryAddressType - First published in XenServer 6.0.
managed - First published in XenServer 6.2 SP1.
Returns:
The ref of the newly created PIF record.
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduceAsync

public static Task dbIntroduceAsync(Connection c,
                                    java.lang.String device,
                                    Network network,
                                    Host host,
                                    java.lang.String MAC,
                                    java.lang.Long MTU,
                                    java.lang.Long VLAN,
                                    java.lang.Boolean physical,
                                    Types.IpConfigurationMode ipConfigurationMode,
                                    java.lang.String IP,
                                    java.lang.String netmask,
                                    java.lang.String gateway,
                                    java.lang.String DNS,
                                    Bond bondSlaveOf,
                                    VLAN VLANMasterOf,
                                    java.lang.Boolean management,
                                    java.util.Map<java.lang.String,java.lang.String> otherConfig,
                                    java.lang.Boolean disallowUnplug,
                                    Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
                                    java.util.Set<java.lang.String> IPv6,
                                    java.lang.String ipv6Gateway,
                                    Types.PrimaryAddressType primaryAddressType,
                                    java.lang.Boolean managed,
                                    java.util.Map<java.lang.String,java.lang.String> properties)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
ipv6ConfigurationMode - First published in XenServer 6.0.
IPv6 - First published in XenServer 6.0.
ipv6Gateway - First published in XenServer 6.0.
primaryAddressType - First published in XenServer 6.0.
managed - First published in XenServer 6.2 SP1.
properties - First published in XenServer 6.5.
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbIntroduce

public static PIF dbIntroduce(Connection c,
                              java.lang.String device,
                              Network network,
                              Host host,
                              java.lang.String MAC,
                              java.lang.Long MTU,
                              java.lang.Long VLAN,
                              java.lang.Boolean physical,
                              Types.IpConfigurationMode ipConfigurationMode,
                              java.lang.String IP,
                              java.lang.String netmask,
                              java.lang.String gateway,
                              java.lang.String DNS,
                              Bond bondSlaveOf,
                              VLAN VLANMasterOf,
                              java.lang.Boolean management,
                              java.util.Map<java.lang.String,java.lang.String> otherConfig,
                              java.lang.Boolean disallowUnplug,
                              Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
                              java.util.Set<java.lang.String> IPv6,
                              java.lang.String ipv6Gateway,
                              Types.PrimaryAddressType primaryAddressType,
                              java.lang.Boolean managed,
                              java.util.Map<java.lang.String,java.lang.String> properties)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Create a new PIF record in the database only First published in XenServer 5.0.

Parameters:
device -
network -
host -
MAC -
MTU -
VLAN -
physical -
ipConfigurationMode -
IP -
netmask -
gateway -
DNS -
bondSlaveOf -
VLANMasterOf -
management -
otherConfig -
disallowUnplug -
ipv6ConfigurationMode - First published in XenServer 6.0.
IPv6 - First published in XenServer 6.0.
ipv6Gateway - First published in XenServer 6.0.
primaryAddressType - First published in XenServer 6.0.
managed - First published in XenServer 6.2 SP1.
properties - First published in XenServer 6.5.
Returns:
The ref of the newly created PIF record.
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbForgetAsync

public Task dbForgetAsync(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Destroy a PIF database record. First published in XenServer 5.0.

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

dbForget

public void dbForget(Connection c)
              throws Types.BadServerResponse,
                     Types.XenAPIException,
                     org.apache.xmlrpc.XmlRpcException
Destroy a PIF database record. First published in XenServer 5.0.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setPropertyAsync

public Task setPropertyAsync(Connection c,
                             java.lang.String name,
                             java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Set the value of a property of the PIF First published in XenServer 6.5.

Parameters:
name - The property name
value - The property value
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setProperty

public void setProperty(Connection c,
                        java.lang.String name,
                        java.lang.String value)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException
Set the value of a property of the PIF First published in XenServer 6.5.

Parameters:
name - The property name
value - The property value
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<PIF> getAll(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Return a list of all the PIFs known to the system. First published in XenServer 4.0.

Returns:
references to all objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<PIF,PIF.Record> getAllRecords(Connection c)
                                                   throws Types.BadServerResponse,
                                                          Types.XenAPIException,
                                                          org.apache.xmlrpc.XmlRpcException
Return a map of PIF references to PIF records for all PIFs known to the system. First published in XenServer 4.0.

Returns:
records of all objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException