Class PIF


public class PIF extends XenAPIObject
A physical network interface (note separate VLANs are represented as several PIFs) First published in XenServer 4.0.
Author:
Cloud Software Group, Inc.
  • Field Details

    • ref

      protected final String ref
      The XenAPI reference (OpaqueRef) to this object.
  • Method Details

    • toWireString

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

      public boolean equals(Object obj)
      If obj is a PIF, compares XenAPI references for equality.
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class 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. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      all fields from the object
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getByUuid

      public static PIF getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get a reference to the PIF instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      uuid - UUID of object to return
      Returns:
      reference to the object
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getUuid

      public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the uuid field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getDevice

      public String getDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the device field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getNetwork

      public Network getNetwork(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the network field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getHost

      public Host getHost(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the host field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getMAC

      public String getMAC(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the MAC field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getMTU

      public Long getMTU(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the MTU field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getVLAN

      public Long getVLAN(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the VLAN field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getMetrics

      public PIFMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the metrics field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getPhysical

      public Boolean getPhysical(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the physical field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getCurrentlyAttached

      public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the currently_attached field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getIP

      public String getIP(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the IP field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getNetmask

      public String getNetmask(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the netmask field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getGateway

      public String getGateway(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the gateway field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getDNS

      public String getDNS(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the DNS field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getBondMasterOf

      public Set<Bond> getBondMasterOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the bond_master_of field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getVLANSlaveOf

      public Set<VLAN> getVLANSlaveOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the VLAN_slave_of field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getManagement

      public Boolean getManagement(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the management field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getOtherConfig

      public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the other_config field of the given PIF. Minimum allowed role: read-only First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getDisallowUnplug

      public Boolean getDisallowUnplug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the disallow_unplug field of the given PIF. Minimum allowed role: read-only First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getTunnelAccessPIFOf

      public 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. Minimum allowed role: read-only First published in XenServer 5.6 FP1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getTunnelTransportPIFOf

      public 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. Minimum allowed role: read-only First published in XenServer 5.6 FP1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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. Minimum allowed role: read-only First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getIPv6

      public Set<String> getIPv6(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the IPv6 field of the given PIF. Minimum allowed role: read-only First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getIpv6Gateway

      public String getIpv6Gateway(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ipv6_gateway field of the given PIF. Minimum allowed role: read-only First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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. Minimum allowed role: read-only First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getManaged

      public Boolean getManaged(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the managed field of the given PIF. Minimum allowed role: read-only First published in XenServer 6.2 SP1.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getProperties

      public Map<String,String> getProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the properties field of the given PIF. Minimum allowed role: read-only First published in XenServer 6.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getCapabilities

      public Set<String> getCapabilities(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the capabilities field of the given PIF. Minimum allowed role: read-only First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getIgmpSnoopingStatus

      public Types.PifIgmpStatus getIgmpSnoopingStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the igmp_snooping_status field of the given PIF. Minimum allowed role: read-only First published in XenServer 7.3.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getSriovPhysicalPIFOf

      public Set<NetworkSriov> getSriovPhysicalPIFOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the sriov_physical_PIF_of field of the given PIF. Minimum allowed role: read-only First published in XenServer 7.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getSriovLogicalPIFOf

      public Set<NetworkSriov> getSriovLogicalPIFOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the sriov_logical_PIF_of field of the given PIF. Minimum allowed role: read-only First published in XenServer 7.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getPCI

      public PCI getPCI(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the PCI field of the given PIF. Minimum allowed role: read-only First published in XenServer 7.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      value of the field
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • setOtherConfig

      public void setOtherConfig(Connection c, Map<String,String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the other_config field of the given PIF. Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      otherConfig - New value to set
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • addToOtherConfig

      public void addToOtherConfig(Connection c, String key, 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. Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      key - Key to add
      value - Value to add
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • removeFromOtherConfig

      public void removeFromOtherConfig(Connection c, 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. Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      key - Key to remove
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • createVLANAsync

      @Deprecated public static Task createVLANAsync(Connection c, String device, Network network, Host host, 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 Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.VlanTagInvalid - 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.
    • createVLAN

      @Deprecated public static PIF createVLAN(Connection c, String device, Network network, Host host, 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 Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.VlanTagInvalid - 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.
    • 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 Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.PifIsPhysical - 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.
    • 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 Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.PifIsPhysical - 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.
    • reconfigureIpAsync

      public Task reconfigureIpAsync(Connection c, Types.IpConfigurationMode mode, String IP, String netmask, String gateway, String DNS) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.ClusteringEnabled
      Reconfigure the IP address settings for this interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • reconfigureIp

      public void reconfigureIp(Connection c, Types.IpConfigurationMode mode, String IP, String netmask, String gateway, String DNS) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.ClusteringEnabled
      Reconfigure the IP address settings for this interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • reconfigureIpv6Async

      public Task reconfigureIpv6Async(Connection c, Types.Ipv6ConfigurationMode mode, String IPv6, String gateway, String DNS) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.ClusteringEnabled
      Reconfigure the IPv6 address settings for this interface Minimum allowed role: pool-operator First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      mode - whether to use dynamic/static/no-assignment
      IPv6 - the new IPv6 address (in <addr>/<prefix length> format)
      gateway - the new gateway
      DNS - the new DNS settings
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • reconfigureIpv6

      public void reconfigureIpv6(Connection c, Types.Ipv6ConfigurationMode mode, String IPv6, String gateway, String DNS) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.ClusteringEnabled
      Reconfigure the IPv6 address settings for this interface Minimum allowed role: pool-operator First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      mode - whether to use dynamic/static/no-assignment
      IPv6 - the new IPv6 address (in <addr>/<prefix length> format)
      gateway - the new gateway
      DNS - the new DNS settings
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • 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 Minimum allowed role: pool-operator First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      primaryAddressType - Whether to prefer IPv4 or IPv6 connections
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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 Minimum allowed role: pool-operator First published in XenServer 6.1.
      Parameters:
      c - The connection the call is made on
      primaryAddressType - Whether to prefer IPv4 or IPv6 connections
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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 Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      host - The host on which to scan
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • 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 Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      host - The host on which to scan
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • introduceAsync

      public static Task introduceAsync(Connection c, Host host, String MAC, String device) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • introduce

      public static PIF introduce(Connection c, Host host, String MAC, String device) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • introduceAsync

      public static Task introduceAsync(Connection c, Host host, String MAC, String device, Boolean managed) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • introduce

      public static PIF introduce(Connection c, Host host, String MAC, String device, Boolean managed) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      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 - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • forgetAsync

      public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.PifTunnelStillExists, Types.ClusteringEnabled
      Destroy the PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.PifTunnelStillExists - Operation cannot proceed while a tunnel exists on this interface.
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • forget

      public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.PifTunnelStillExists, Types.ClusteringEnabled
      Destroy the PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.PifTunnelStillExists - Operation cannot proceed while a tunnel exists on this interface.
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • unplugAsync

      Attempt to bring down a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.HaOperationWouldBreakFailoverPlan - 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.
      Types.VifInUse - Network has active VIFs
      Types.PifDoesNotAllowUnplug - The operation you requested cannot be performed because the specified PIF does not allow unplug.
      Types.PifHasFcoeSrInUse - The operation you requested cannot be performed because the specified PIF has FCoE SR in use.
    • unplug

      Attempt to bring down a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.HaOperationWouldBreakFailoverPlan - 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.
      Types.VifInUse - Network has active VIFs
      Types.PifDoesNotAllowUnplug - The operation you requested cannot be performed because the specified PIF does not allow unplug.
      Types.PifHasFcoeSrInUse - The operation you requested cannot be performed because the specified PIF has FCoE SR in use.
    • setDisallowUnplugAsync

      public Task setDisallowUnplugAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OtherOperationInProgress, Types.ClusteringEnabled
      Set whether unplugging the PIF is allowed Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      value - New value to set
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.OtherOperationInProgress - Another operation involving the object is currently in progress
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • setDisallowUnplug

      public void setDisallowUnplug(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OtherOperationInProgress, Types.ClusteringEnabled
      Set whether unplugging the PIF is allowed Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      value - New value to set
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.OtherOperationInProgress - Another operation involving the object is currently in progress
      Types.ClusteringEnabled - An operation was attempted while clustering was enabled on the cluster_host.
    • plugAsync

      public Task plugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.TransportPifNotConfigured
      Attempt to bring up a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.TransportPifNotConfigured - The tunnel transport PIF has no IP configuration set.
    • plug

      public void plug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.TransportPifNotConfigured
      Attempt to bring up a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
      Types.TransportPifNotConfigured - The tunnel transport PIF has no IP configuration set.
    • dbIntroduceAsync

      public static Task dbIntroduceAsync(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduce

      public static PIF dbIntroduce(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      Returns:
      The ref of the newly created PIF record.
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduceAsync

      public static Task dbIntroduceAsync(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, Set<String> IPv6, String ipv6Gateway, Types.PrimaryAddressType primaryAddressType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      ipv6ConfigurationMode - No description First published in XenServer 6.0.
      IPv6 - No description First published in XenServer 6.0.
      ipv6Gateway - No description First published in XenServer 6.0.
      primaryAddressType - No description First published in XenServer 6.0.
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduce

      public static PIF dbIntroduce(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, Set<String> IPv6, String ipv6Gateway, Types.PrimaryAddressType primaryAddressType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      ipv6ConfigurationMode - No description First published in XenServer 6.0.
      IPv6 - No description First published in XenServer 6.0.
      ipv6Gateway - No description First published in XenServer 6.0.
      primaryAddressType - No description First published in XenServer 6.0.
      Returns:
      The ref of the newly created PIF record.
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduceAsync

      public static Task dbIntroduceAsync(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, Set<String> IPv6, String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, Boolean managed) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      ipv6ConfigurationMode - No description First published in XenServer 6.0.
      IPv6 - No description First published in XenServer 6.0.
      ipv6Gateway - No description First published in XenServer 6.0.
      primaryAddressType - No description First published in XenServer 6.0.
      managed - No description First published in XenServer 6.2 SP1.
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduce

      public static PIF dbIntroduce(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, Set<String> IPv6, String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, Boolean managed) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      ipv6ConfigurationMode - No description First published in XenServer 6.0.
      IPv6 - No description First published in XenServer 6.0.
      ipv6Gateway - No description First published in XenServer 6.0.
      primaryAddressType - No description First published in XenServer 6.0.
      managed - No description First published in XenServer 6.2 SP1.
      Returns:
      The ref of the newly created PIF record.
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduceAsync

      public static Task dbIntroduceAsync(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, Set<String> IPv6, String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, Boolean managed, Map<String,String> properties) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      ipv6ConfigurationMode - No description First published in XenServer 6.0.
      IPv6 - No description First published in XenServer 6.0.
      ipv6Gateway - No description First published in XenServer 6.0.
      primaryAddressType - No description First published in XenServer 6.0.
      managed - No description First published in XenServer 6.2 SP1.
      properties - No description First published in XenServer 6.5.
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbIntroduce

      public static PIF dbIntroduce(Connection c, String device, Network network, Host host, String MAC, Long MTU, Long VLAN, Boolean physical, Types.IpConfigurationMode ipConfigurationMode, String IP, String netmask, String gateway, String DNS, Bond bondSlaveOf, VLAN VLANMasterOf, Boolean management, Map<String,String> otherConfig, Boolean disallowUnplug, Types.Ipv6ConfigurationMode ipv6ConfigurationMode, Set<String> IPv6, String ipv6Gateway, Types.PrimaryAddressType primaryAddressType, Boolean managed, Map<String,String> properties) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      device - No description
      network - No description
      host - No description
      MAC - No description
      MTU - No description
      VLAN - No description
      physical - No description
      ipConfigurationMode - No description
      IP - No description
      netmask - No description
      gateway - No description
      DNS - No description
      bondSlaveOf - No description
      VLANMasterOf - No description
      management - No description
      otherConfig - No description
      disallowUnplug - No description
      ipv6ConfigurationMode - No description First published in XenServer 6.0.
      IPv6 - No description First published in XenServer 6.0.
      ipv6Gateway - No description First published in XenServer 6.0.
      primaryAddressType - No description First published in XenServer 6.0.
      managed - No description First published in XenServer 6.2 SP1.
      properties - No description First published in XenServer 6.5.
      Returns:
      The ref of the newly created PIF record.
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbForgetAsync

      public Task dbForgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Destroy a PIF database record. Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • dbForget

      public void dbForget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Destroy a PIF database record. Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • setPropertyAsync

      public Task setPropertyAsync(Connection c, String name, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the value of a property of the PIF Minimum allowed role: pool-operator First published in XenServer 6.5.
      Parameters:
      c - The connection the call is made on
      name - The property name
      value - The property value
      Returns:
      Task
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • setProperty

      public void setProperty(Connection c, String name, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the value of a property of the PIF Minimum allowed role: pool-operator First published in XenServer 6.5.
      Parameters:
      c - The connection the call is made on
      name - The property name
      value - The property value
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getAll

      public static 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. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      references to all objects
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getAllRecords

      public static 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. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      records of all objects
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.