org.virtualbox_5_0
Class IHostNetworkInterface

java.lang.Object
  extended by org.virtualbox_5_0.IUnknown
      extended by org.virtualbox_5_0.IHostNetworkInterface

public class IHostNetworkInterface
extends IUnknown

Represents one of host's network interfaces. IP V6 address and network mask are strings of 32 hexadecimal digits grouped by four. Groups are separated by colons. For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030. Interface ID: {455F8C45-44A0-A470-BA20-27890B96DBA9}


Field Summary
 
Fields inherited from class org.virtualbox_5_0.IUnknown
obj, port
 
Constructor Summary
IHostNetworkInterface(java.lang.String wrapped, org.virtualbox_5_0.jaxws.VboxPortType port)
           
 
Method Summary
 void DHCPRediscover()
          refreshes the IP configuration for DHCP-enabled interface.
 void enableDynamicIPConfig()
          enables the dynamic IP configuration.
 void enableStaticIPConfig(java.lang.String IPAddress, java.lang.String networkMask)
          sets and enables the static IP V4 configuration for the given interface.
 void enableStaticIPConfigV6(java.lang.String IPV6Address, java.lang.Long IPV6NetworkMaskPrefixLength)
          sets and enables the static IP V6 configuration for the given interface.
 java.lang.Boolean getDHCPEnabled()
          Specifies whether the DHCP is enabled for the interface.
 java.lang.String getHardwareAddress()
          Returns the hardware address.
 java.lang.String getId()
          Returns the interface UUID.
 HostNetworkInterfaceType getInterfaceType()
          specifies the host interface type.
 java.lang.String getIPAddress()
          Returns the IP V4 address of the interface.
 java.lang.String getIPV6Address()
          Returns the IP V6 address of the interface.
 java.lang.Long getIPV6NetworkMaskPrefixLength()
          Returns the length IP V6 network mask prefix of the interface.
 java.lang.Boolean getIPV6Supported()
          Specifies whether the IP V6 is supported/enabled for the interface.
 HostNetworkInterfaceMediumType getMediumType()
          Type of protocol encapsulation used.
 java.lang.String getName()
          Returns the host network interface name.
 java.lang.String getNetworkMask()
          Returns the network mask of the interface.
 java.lang.String getNetworkName()
          Returns the name of a virtual network the interface gets attached to.
 java.lang.String getShortName()
          Returns the host network interface short name.
 HostNetworkInterfaceStatus getStatus()
          Status of the interface.
static IHostNetworkInterface queryInterface(IUnknown obj)
           
 
Methods inherited from class org.virtualbox_5_0.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IHostNetworkInterface

public IHostNetworkInterface(java.lang.String wrapped,
                             org.virtualbox_5_0.jaxws.VboxPortType port)
Method Detail

getName

public java.lang.String getName()
Returns the host network interface name.

Returns:
String

getShortName

public java.lang.String getShortName()
Returns the host network interface short name.

Returns:
String

getId

public java.lang.String getId()
Returns the interface UUID.

Returns:
String

getNetworkName

public java.lang.String getNetworkName()
Returns the name of a virtual network the interface gets attached to.

Returns:
String

getDHCPEnabled

public java.lang.Boolean getDHCPEnabled()
Specifies whether the DHCP is enabled for the interface.

Returns:
Boolean

getIPAddress

public java.lang.String getIPAddress()
Returns the IP V4 address of the interface.

Returns:
String

getNetworkMask

public java.lang.String getNetworkMask()
Returns the network mask of the interface.

Returns:
String

getIPV6Supported

public java.lang.Boolean getIPV6Supported()
Specifies whether the IP V6 is supported/enabled for the interface.

Returns:
Boolean

getIPV6Address

public java.lang.String getIPV6Address()
Returns the IP V6 address of the interface.

Returns:
String

getIPV6NetworkMaskPrefixLength

public java.lang.Long getIPV6NetworkMaskPrefixLength()
Returns the length IP V6 network mask prefix of the interface.

Returns:
Long

getHardwareAddress

public java.lang.String getHardwareAddress()
Returns the hardware address. For Ethernet it is MAC address.

Returns:
String

getMediumType

public HostNetworkInterfaceMediumType getMediumType()
Type of protocol encapsulation used.

Returns:
org.virtualbox_5_0.HostNetworkInterfaceMediumType

getStatus

public HostNetworkInterfaceStatus getStatus()
Status of the interface.

Returns:
org.virtualbox_5_0.HostNetworkInterfaceStatus

getInterfaceType

public HostNetworkInterfaceType getInterfaceType()
specifies the host interface type.

Returns:
org.virtualbox_5_0.HostNetworkInterfaceType

queryInterface

public static IHostNetworkInterface queryInterface(IUnknown obj)

enableStaticIPConfig

public void enableStaticIPConfig(java.lang.String IPAddress,
                                 java.lang.String networkMask)
sets and enables the static IP V4 configuration for the given interface.

Parameters:
IPAddress - IP address.
networkMask - network mask.

enableStaticIPConfigV6

public void enableStaticIPConfigV6(java.lang.String IPV6Address,
                                   java.lang.Long IPV6NetworkMaskPrefixLength)
sets and enables the static IP V6 configuration for the given interface.

Parameters:
IPV6Address - IP address.
IPV6NetworkMaskPrefixLength - network mask.

enableDynamicIPConfig

public void enableDynamicIPConfig()
enables the dynamic IP configuration.


DHCPRediscover

public void DHCPRediscover()
refreshes the IP configuration for DHCP-enabled interface.