com.xensource.xenapi
Class PIF.Record

java.lang.Object
  com.xensource.xenapi.PIF.Record

All Implemented Interfaces:

Types.Record

Enclosing class:

PIF

public static class PIF.Record
extends Object
implements Types.Record

Represents all the fields in a PIF

Field Summary

Set<Bond>	bondMasterOf Indicates this PIF represents the results of a bond First published in XenServer 4.1.
Bond	bondSlaveOf Indicates which bond this interface is part of First published in XenServer 4.1.
Boolean	currentlyAttached true if this interface is online First published in XenServer 4.1.
String	device machine-readable name of the interface (e.g.
Boolean	disallowUnplug Prevent this PIF from being unplugged; set this to notify the management tool-stack that the PIF has a special use and should not be unplugged under any circumstances (e.g.
String	DNS IP address of DNS servers to use First published in XenServer 4.1.
String	gateway IP gateway First published in XenServer 4.1.
Host	host physical machine to which this pif is connected
String	IP IP address First published in XenServer 4.1.
Types.IpConfigurationMode	ipConfigurationMode Sets if and how this interface gets an IP address First published in XenServer 4.1.
Set<String>	IPv6 IPv6 address Experimental.
Types.Ipv6ConfigurationMode	ipv6ConfigurationMode Sets if and how this interface gets an IPv6 address Experimental.
String	ipv6Gateway IPv6 gateway Experimental.
String	MAC ethernet MAC address of physical interface
Boolean	managed Indicates whether the interface is managed by xapi.
Boolean	management Indicates whether the control software is listening for connections on this interface First published in XenServer 4.1.
PIFMetrics	metrics metrics associated with this PIF
Long	MTU MTU in octets
String	netmask IP netmask First published in XenServer 4.1.
Network	network virtual network to which this pif is connected
Map<String,String>	otherConfig Additional configuration First published in XenServer 4.1.
Boolean	physical true if this represents a physical network interface First published in XenServer 4.1.
Types.PrimaryAddressType	primaryAddressType Which protocol should define the primary address of this interface Experimental.
Set<Tunnel>	tunnelAccessPIFOf Indicates to which tunnel this PIF gives access First published in XenServer 5.6 FP1.
Set<Tunnel>	tunnelTransportPIFOf Indicates to which tunnel this PIF provides transport First published in XenServer 5.6 FP1.
String	uuid Unique identifier/object reference
Long	VLAN VLAN tag for all traffic passing through this interface
VLAN	VLANMasterOf Indicates wich VLAN this interface receives untagged traffic from First published in XenServer 4.1.
Set<VLAN>	VLANSlaveOf Indicates which VLANs this interface transmits tagged traffic to First published in XenServer 4.1.

Constructor Summary

PIF.Record()

Method Summary

Map<String,Object>	toMap() Convert a PIF.Record to a Map
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uuid

public String uuid

Unique identifier/object reference

device

public String device

machine-readable name of the interface (e.g. eth0)

network

public Network network

virtual network to which this pif is connected

host

public Host host

physical machine to which this pif is connected

MAC

public String MAC

ethernet MAC address of physical interface

MTU

public Long MTU

MTU in octets

VLAN

public Long VLAN

VLAN tag for all traffic passing through this interface

metrics

public PIFMetrics metrics

metrics associated with this PIF

physical

public Boolean physical

true if this represents a physical network interface First published in XenServer 4.1.

currentlyAttached

public Boolean currentlyAttached

true if this interface is online First published in XenServer 4.1.

ipConfigurationMode

public Types.IpConfigurationMode ipConfigurationMode

Sets if and how this interface gets an IP address First published in XenServer 4.1.

IP

public String IP

IP address First published in XenServer 4.1.

netmask

public String netmask

IP netmask First published in XenServer 4.1.

gateway

public String gateway

IP gateway First published in XenServer 4.1.

DNS

public String DNS

IP address of DNS servers to use First published in XenServer 4.1.

bondSlaveOf

public Bond bondSlaveOf

Indicates which bond this interface is part of First published in XenServer 4.1.

bondMasterOf

public Set<Bond> bondMasterOf

Indicates this PIF represents the results of a bond First published in XenServer 4.1.

VLANMasterOf

public VLAN VLANMasterOf

Indicates wich VLAN this interface receives untagged traffic from First published in XenServer 4.1.

VLANSlaveOf

public Set<VLAN> VLANSlaveOf

Indicates which VLANs this interface transmits tagged traffic to First published in XenServer 4.1.

management

public Boolean management

Indicates whether the control software is listening for connections on this interface First published in XenServer 4.1.

otherConfig

public Map<String,String> otherConfig

Additional configuration First published in XenServer 4.1.

disallowUnplug

public Boolean disallowUnplug

Prevent this PIF from being unplugged; set this to notify the management tool-stack that the PIF has a special use and should not be unplugged under any circumstances (e.g. because you're running storage traffic over it) First published in XenServer 5.0.

tunnelAccessPIFOf

public Set<Tunnel> tunnelAccessPIFOf

Indicates to which tunnel this PIF gives access First published in XenServer 5.6 FP1.

tunnelTransportPIFOf

public Set<Tunnel> tunnelTransportPIFOf

Indicates to which tunnel this PIF provides transport First published in XenServer 5.6 FP1.

ipv6ConfigurationMode

public Types.Ipv6ConfigurationMode ipv6ConfigurationMode

Sets if and how this interface gets an IPv6 address Experimental. First published in XenServer 6.1.

IPv6

public Set<String> IPv6

IPv6 address Experimental. First published in XenServer 6.1.

ipv6Gateway

public String ipv6Gateway

IPv6 gateway Experimental. First published in XenServer 6.1.

primaryAddressType

public Types.PrimaryAddressType primaryAddressType

Which protocol should define the primary address of this interface Experimental. First published in XenServer 6.1.

managed

public Boolean managed

Indicates whether the interface is managed by xapi. If it is not, then xapi will not configure the interface, the commands PIF.plug/unplug/reconfigure_ip(v6) can not be used, nor can the interface be bonded or have VLANs based on top through xapi. First published in XenServer 6.2 SP1.

Constructor Detail

PIF.Record

public PIF.Record()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

toMap

public Map<String,Object> toMap()

Convert a PIF.Record to a Map

Specified by:

toMap in interface Types.Record