Package com.xensource.xenapi
Class PIF
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PIF
A physical network interface (note separate VLANs are represented as several PIFs)
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given PIF.static PIF
createVLAN
(Connection c, String device, Network network, Host host, Long VLAN) Deprecated.since XenServer 4.1static Task
createVLANAsync
(Connection c, String device, Network network, Host host, Long VLAN) Deprecated.since XenServer 4.1void
Destroy a PIF database record.Destroy a PIF database record.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.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) Create a new PIF record in the database only Minimum allowed role: pool-operator First published in XenServer 5.0.void
Deprecated.since XenServer 4.1Deprecated.since XenServer 4.1boolean
If obj is a PIF, compares XenAPI references for equality.void
forget
(Connection c) Destroy the PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.Destroy the PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.getAll
(Connection c) Return a list of all the PIFs known to the system.static Map<PIF,
PIF.Record> Return a map of PIF references to PIF records for all PIFs known to the system.Get the bond_master_of field of the given PIF.Get the bond_slave_of field of the given PIF.static PIF
getByUuid
(Connection c, String uuid) Get a reference to the PIF instance with the specified UUID.Get the capabilities field of the given PIF.Get the currently_attached field of the given PIF.Get the device field of the given PIF.Get the disallow_unplug field of the given PIF.getDNS
(Connection c) Get the DNS field of the given PIF.Get the gateway field of the given PIF.Get the host field of the given PIF.Get the igmp_snooping_status field of the given PIF.getIP
(Connection c) Get the IP field of the given PIF.Get the ip_configuration_mode field of the given PIF.Get the IPv6 field of the given PIF.Get the ipv6_configuration_mode field of the given PIF.Get the ipv6_gateway field of the given PIF.getMAC
(Connection c) Get the MAC field of the given PIF.Get the managed field of the given PIF.Get the management field of the given PIF.Get the metrics field of the given PIF.getMTU
(Connection c) Get the MTU field of the given PIF.Get the netmask field of the given PIF.Get the network field of the given PIF.Get the other_config field of the given PIF.getPCI
(Connection c) Get the PCI field of the given PIF.Get the physical field of the given PIF.Get the primary_address_type field of the given PIF.Get the properties field of the given PIF.Get a record containing the current state of the given PIF.Get the sriov_logical_PIF_of field of the given PIF.Get the sriov_physical_PIF_of field of the given PIF.Get the tunnel_access_PIF_of field of the given PIF.Get the tunnel_transport_PIF_of field of the given PIF.Get the uuid field of the given PIF.Get the VLAN field of the given PIF.Get the VLAN_master_of field of the given PIF.Get the VLAN_slave_of field of the given PIF.int
hashCode()
static PIF
introduce
(Connection c, Host host, String MAC, String device) Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.static PIF
Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.static Task
introduceAsync
(Connection c, Host host, String MAC, String device) Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.static Task
introduceAsync
(Connection c, Host host, String MAC, String device, Boolean managed) Create a PIF object matching a particular network interface Minimum allowed role: pool-operator First published in XenServer 4.1.void
plug
(Connection c) Attempt to bring up a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.Attempt to bring up a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.void
reconfigureIp
(Connection c, Types.IpConfigurationMode mode, String IP, String netmask, String gateway, String DNS) Reconfigure the IP address settings for this interface Minimum allowed role: pool-operator First published in XenServer 4.1.reconfigureIpAsync
(Connection c, Types.IpConfigurationMode mode, String IP, String netmask, String gateway, String DNS) Reconfigure the IP address settings for this interface Minimum allowed role: pool-operator First published in XenServer 4.1.void
reconfigureIpv6
(Connection c, Types.Ipv6ConfigurationMode mode, String IPv6, String gateway, String DNS) Reconfigure the IPv6 address settings for this interface Minimum allowed role: pool-operator First published in XenServer 6.1.reconfigureIpv6Async
(Connection c, Types.Ipv6ConfigurationMode mode, String IPv6, String gateway, String DNS) Reconfigure the IPv6 address settings for this interface Minimum allowed role: pool-operator First published in XenServer 6.1.void
removeFromOtherConfig
(Connection c, 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 Minimum allowed role: pool-operator 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 Minimum allowed role: pool-operator First published in XenServer 4.1.void
setDisallowUnplug
(Connection c, Boolean value) Set whether unplugging the PIF is allowed Minimum allowed role: pool-operator First published in XenServer 5.0.setDisallowUnplugAsync
(Connection c, Boolean value) Set whether unplugging the PIF is allowed Minimum allowed role: pool-operator First published in XenServer 5.0.void
setOtherConfig
(Connection c, Map<String, 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 Minimum allowed role: pool-operator First published in XenServer 6.1.setPrimaryAddressTypeAsync
(Connection c, Types.PrimaryAddressType primaryAddressType) Change the primary address type used by this PIF Minimum allowed role: pool-operator First published in XenServer 6.1.void
setProperty
(Connection c, String name, String value) Set the value of a property of the PIF Minimum allowed role: pool-operator First published in XenServer 6.5.setPropertyAsync
(Connection c, String name, String value) Set the value of a property of the PIF Minimum allowed role: pool-operator First published in XenServer 6.5.void
unplug
(Connection c) Attempt to bring down a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.Attempt to bring down a physical interface Minimum allowed role: pool-operator First published in XenServer 4.1.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a PIF, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public PIF.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static PIF getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onuuid
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDevice
public String getDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNetwork
public Network getNetwork(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHost
public Host getHost(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMAC
public String getMAC(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMTU
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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVLAN
public Long getVLAN(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMetrics
public PIFMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPhysical
public Boolean getPhysical(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentlyAttached
public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpConfigurationMode
public Types.IpConfigurationMode getIpConfigurationMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIP
public String getIP(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNetmask
public String getNetmask(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGateway
public String getGateway(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDNS
public String getDNS(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getBondSlaveOf
public Bond getBondSlaveOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getBondMasterOf
public Set<Bond> getBondMasterOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVLANMasterOf
public VLAN getVLANMasterOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVLANSlaveOf
public Set<VLAN> getVLANSlaveOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getManagement
public Boolean getManagement(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDisallowUnplug
public Boolean getDisallowUnplug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTunnelAccessPIFOf
public Set<Tunnel> getTunnelAccessPIFOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTunnelTransportPIFOf
public Set<Tunnel> getTunnelTransportPIFOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv6ConfigurationMode
public Types.Ipv6ConfigurationMode getIpv6ConfigurationMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIPv6
public Set<String> getIPv6(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv6Gateway
public String getIpv6Gateway(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPrimaryAddressType
public Types.PrimaryAddressType getPrimaryAddressType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getManaged
public Boolean getManaged(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getProperties
public Map<String,String> getProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCapabilities
public Set<String> getCapabilities(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIgmpSnoopingStatus
public Types.PifIgmpStatus getIgmpSnoopingStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSriovPhysicalPIFOf
public Set<NetworkSriov> getSriovPhysicalPIFOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSriovLogicalPIFOf
public Set<NetworkSriov> getSriovLogicalPIFOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPCI
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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet 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 onotherConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createVLAN
@Deprecated(since="XenServer 4.1") public static PIF createVLAN(Connection c, String device, Network network, Host host, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VlanTagInvalid Deprecated.since XenServer 4.1Create 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 ondevice
- physical interface on which to create the VLAN interfacenetwork
- network to which this interface should be connectedhost
- physical machine to which this PIF is connectedVLAN
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
createVLANAsync
@Deprecated(since="XenServer 4.1") public static Task createVLANAsync(Connection c, String device, Network network, Host host, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VlanTagInvalid Deprecated.since XenServer 4.1Create 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 ondevice
- physical interface on which to create the VLAN interfacenetwork
- network to which this interface should be connectedhost
- physical machine to which this PIF is connectedVLAN
- VLAN tag for the new interface- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
destroy
@Deprecated(since="XenServer 4.1") public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.PifIsPhysical Deprecated.since XenServer 4.1Destroy 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
destroyAsync
@Deprecated(since="XenServer 4.1") public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.PifIsPhysical Deprecated.since XenServer 4.1Destroy 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
reconfigureIp
public void reconfigureIp(Connection c, Types.IpConfigurationMode mode, String IP, String netmask, String gateway, String DNS) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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 onmode
- whether to use dynamic/static/no-assignmentIP
- the new IP addressnetmask
- the new netmaskgateway
- the new gatewayDNS
- the new DNS settings- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.ClusteringEnabled
- An operation was attempted while clustering was enabled on the cluster_host.
-
reconfigureIpAsync
public Task reconfigureIpAsync(Connection c, Types.IpConfigurationMode mode, String IP, String netmask, String gateway, String DNS) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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 onmode
- whether to use dynamic/static/no-assignmentIP
- the new IP addressnetmask
- the new netmaskgateway
- the new gatewayDNS
- the new DNS settings- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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, IOException, 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 onmode
- whether to use dynamic/static/no-assignmentIPv6
- the new IPv6 address (in <addr>/<prefix length> format)gateway
- the new gatewayDNS
- the new DNS settings- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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, IOException, 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 onmode
- whether to use dynamic/static/no-assignmentIPv6
- the new IPv6 address (in <addr>/<prefix length> format)gateway
- the new gatewayDNS
- the new DNS settings- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.ClusteringEnabled
- An operation was attempted while clustering was enabled on the cluster_host.
-
setPrimaryAddressType
public void setPrimaryAddressType(Connection c, Types.PrimaryAddressType primaryAddressType) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onprimaryAddressType
- Whether to prefer IPv4 or IPv6 connections- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPrimaryAddressTypeAsync
public Task setPrimaryAddressTypeAsync(Connection c, Types.PrimaryAddressType primaryAddressType) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onprimaryAddressType
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
scan
public static void scan(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onhost
- The host on which to scan- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
scanAsync
public static Task scanAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onhost
- The host on which to scan- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
introduce
public static PIF introduce(Connection c, Host host, String MAC, String device) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onhost
- The host on which the interface existsMAC
- The MAC address of the interfacedevice
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
introduce
public static PIF introduce(Connection c, Host host, String MAC, String device, Boolean managed) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onhost
- The host on which the interface existsMAC
- The MAC address of the interfacedevice
- The device name to use for the interfacemanaged
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
introduceAsync
public static Task introduceAsync(Connection c, Host host, String MAC, String device) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onhost
- The host on which the interface existsMAC
- The MAC address of the interfacedevice
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
introduceAsync
public static Task introduceAsync(Connection c, Host host, String MAC, String device, Boolean managed) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onhost
- The host on which the interface existsMAC
- The MAC address of the interfacedevice
- The device name to use for the interfacemanaged
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
forget
public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
forgetAsync
public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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.
-
unplug
public void unplug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HaOperationWouldBreakFailoverPlan, Types.VifInUse, Types.PifDoesNotAllowUnplug, Types.PifHasFcoeSrInUse 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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 VIFsTypes.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.
-
unplugAsync
public Task unplugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HaOperationWouldBreakFailoverPlan, Types.VifInUse, Types.PifDoesNotAllowUnplug, Types.PifHasFcoeSrInUse 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.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 VIFsTypes.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.
-
setDisallowUnplug
public void setDisallowUnplug(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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 onvalue
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.ClusteringEnabled
- An operation was attempted while clustering was enabled on the cluster_host.
-
setDisallowUnplugAsync
public Task setDisallowUnplugAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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 onvalue
- New value to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.ClusteringEnabled
- An operation was attempted while clustering was enabled on the cluster_host.
-
plug
public void plug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.TransportPifNotConfigured
- The tunnel transport PIF has no IP configuration set.
-
plugAsync
public Task plugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.TransportPifNotConfigured
- The tunnel transport PIF has no IP configuration set.
-
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, IOExceptionCreate 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, IOExceptionCreate 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No descriptionipv6ConfigurationMode
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, IOExceptionCreate 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No descriptionipv6ConfigurationMode
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, throws Types.BadServerResponse, Types.XenAPIException, IOExceptionString> properties) 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No descriptionipv6ConfigurationMode
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, IOExceptionCreate 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No description- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, IOExceptionCreate 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No descriptionipv6ConfigurationMode
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, IOExceptionCreate 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No descriptionipv6ConfigurationMode
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
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, throws Types.BadServerResponse, Types.XenAPIException, IOExceptionString> properties) 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 ondevice
- No descriptionnetwork
- No descriptionhost
- No descriptionMAC
- No descriptionMTU
- No descriptionVLAN
- No descriptionphysical
- No descriptionipConfigurationMode
- No descriptionIP
- No descriptionnetmask
- No descriptiongateway
- No descriptionDNS
- No descriptionbondSlaveOf
- No descriptionVLANMasterOf
- No descriptionmanagement
- No descriptionotherConfig
- No descriptiondisallowUnplug
- No descriptionipv6ConfigurationMode
- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
dbForget
public void dbForget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
dbForgetAsync
public Task dbForgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setProperty
public void setProperty(Connection c, String name, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onname
- The property namevalue
- The property value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPropertyAsync
public Task setPropertyAsync(Connection c, String name, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 onname
- The property namevalue
- The property value- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<PIF> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<PIF,PIF.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-