org.virtualbox_5_1
Class IDHCPServer

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

public class IDHCPServer
extends IUnknown

The IDHCPServer interface represents the VirtualBox DHCP server configuration. To enumerate all the DHCP servers on the host, use theIVirtualBox.getDHCPServers()attribute. Interface ID: {00C8F974-92C5-44A1-8F3F-702469FDD04B}


Field Summary
 
Fields inherited from class org.virtualbox_5_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IDHCPServer(java.lang.String wrapped, org.virtualbox_5_1.ObjectRefManager objMgr, org.virtualbox_5_1.jaxws.VboxPortType port)
           
 
Method Summary
 void addGlobalOption(DhcpOpt option, java.lang.String value)
           
 void addVmSlotOption(java.lang.String vmname, java.lang.Integer slot, DhcpOpt option, java.lang.String value)
           
 java.lang.Boolean getEnabled()
          specifies if the DHCP server is enabled
 IEventSource getEventSource()
           
 java.util.List<java.lang.String> getGlobalOptions()
           
 java.lang.String getIPAddress()
          specifies server IP
 java.lang.String getLowerIP()
          specifies from IP address in server address range
 java.util.List<java.lang.String> getMacOptions(java.lang.String mac)
           
 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
 java.util.List<java.lang.String> getVmConfigs()
           
 java.util.List<java.lang.String> getVmSlotOptions(java.lang.String vmname, java.lang.Integer slot)
           
static IDHCPServer queryInterface(IUnknown obj)
           
 void removeVmSlotOptions(java.lang.String vmname, java.lang.Integer slot)
           
 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_5_1.IUnknown
getObjMgr, 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_5_1.ObjectRefManager objMgr,
                   org.virtualbox_5_1.jaxws.VboxPortType port)
Method Detail

getEventSource

public IEventSource getEventSource()

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

getGlobalOptions

public java.util.List<java.lang.String> getGlobalOptions()

getVmConfigs

public java.util.List<java.lang.String> getVmConfigs()

queryInterface

public static IDHCPServer queryInterface(IUnknown obj)

addGlobalOption

public void addGlobalOption(DhcpOpt option,
                            java.lang.String value)

addVmSlotOption

public void addVmSlotOption(java.lang.String vmname,
                            java.lang.Integer slot,
                            DhcpOpt option,
                            java.lang.String value)

removeVmSlotOptions

public void removeVmSlotOptions(java.lang.String vmname,
                                java.lang.Integer slot)

getVmSlotOptions

public java.util.List<java.lang.String> getVmSlotOptions(java.lang.String vmname,
                                                         java.lang.Integer slot)

getMacOptions

public java.util.List<java.lang.String> getMacOptions(java.lang.String mac)

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_INVALIDARGinvalid 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_FAILFailed to start the process.

stop

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