org.virtualbox_4_2
Class IDHCPServer

java.lang.Object
  extended by org.virtualbox_4_2.IUnknown
      extended by org.virtualbox_4_2.IDHCPServer

public class IDHCPServer
extends IUnknown

The IDHCPServer interface represents the vbox DHCP server configuration. To enumerate all the DHCP servers on the host, use the IVirtualBox.getDHCPServers() attribute. Interface ID: {6CFE387C-74FB-4CA7-BFF6-973BEC8AF7A3}


Field Summary
 
Fields inherited from class org.virtualbox_4_2.IUnknown
obj, port
 
Constructor Summary
IDHCPServer(java.lang.String wrapped, org.virtualbox_4_2.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getEnabled()
          specifies if the DHCP server is enabled
 java.lang.String getIPAddress()
          specifies server IP
 java.lang.String getLowerIP()
          specifies from IP address in server address range
 java.lang.String getNetworkMask()
          specifies server network mask
 java.lang.String getNetworkName()
          specifies internal network name the server is used for
 java.lang.String getUpperIP()
          specifies to IP address in server address range
static IDHCPServer queryInterface(IUnknown obj)
           
 void setConfiguration(java.lang.String IPAddress, java.lang.String networkMask, java.lang.String FromIPAddress, java.lang.String ToIPAddress)
          configures the server
 void setEnabled(java.lang.Boolean value)
          specifies if the DHCP server is enabled
 void start(java.lang.String networkName, java.lang.String trunkName, java.lang.String trunkType)
          Starts DHCP server process.
 void stop()
          Stops DHCP server process.
 
Methods inherited from class org.virtualbox_4_2.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IDHCPServer

public IDHCPServer(java.lang.String wrapped,
                   org.virtualbox_4_2.jaxws.VboxPortType port)
Method Detail

getEnabled

public java.lang.Boolean getEnabled()
specifies if the DHCP server is enabled

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
specifies if the DHCP server is enabled

Parameters:
value - Boolean

getIPAddress

public java.lang.String getIPAddress()
specifies server IP

Returns:
String

getNetworkMask

public java.lang.String getNetworkMask()
specifies server network mask

Returns:
String

getNetworkName

public java.lang.String getNetworkName()
specifies internal network name the server is used for

Returns:
String

getLowerIP

public java.lang.String getLowerIP()
specifies from IP address in server address range

Returns:
String

getUpperIP

public java.lang.String getUpperIP()
specifies to IP address in server address range

Returns:
String

queryInterface

public static IDHCPServer queryInterface(IUnknown obj)

setConfiguration

public void setConfiguration(java.lang.String IPAddress,
                             java.lang.String networkMask,
                             java.lang.String FromIPAddress,
                             java.lang.String ToIPAddress)
configures the server

Parameters:
IPAddress - server IP address
networkMask - server network mask
FromIPAddress - server From IP address for address range
ToIPAddress - server To IP address for address range Expected result codes:
E_INVALIDARG invalid configuration supplied

start

public void start(java.lang.String networkName,
                  java.lang.String trunkName,
                  java.lang.String trunkType)
Starts DHCP server process.

Parameters:
networkName - Name of internal network DHCP server should attach to.
trunkName - Name of internal network trunk.
trunkType - Type of internal network trunk. Expected result codes:
E_FAIL Failed to start the process.

stop

public void stop()
Stops DHCP server process. Expected result codes:
E_FAIL Failed to stop the process.