|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_5_2.IUnknown
org.virtualbox_5_2.IDHCPServer
public class IDHCPServer
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_2.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
IDHCPServer(java.lang.String wrapped,
org.virtualbox_5_2.ObjectRefManager objMgr,
org.virtualbox_5_2.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_2.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 |
---|
public IDHCPServer(java.lang.String wrapped, org.virtualbox_5_2.ObjectRefManager objMgr, org.virtualbox_5_2.jaxws.VboxPortType port)
Method Detail |
---|
public IEventSource getEventSource()
public java.lang.Boolean getEnabled()
public void setEnabled(java.lang.Boolean value)
value
- Booleanpublic java.lang.String getIPAddress()
public java.lang.String getNetworkMask()
public java.lang.String getNetworkName()
public java.lang.String getLowerIP()
public java.lang.String getUpperIP()
public java.util.List<java.lang.String> getGlobalOptions()
public java.util.List<java.lang.String> getVmConfigs()
public static IDHCPServer queryInterface(IUnknown obj)
public void addGlobalOption(DhcpOpt option, java.lang.String value)
public void addVmSlotOption(java.lang.String vmname, java.lang.Integer slot, DhcpOpt option, java.lang.String value)
public void removeVmSlotOptions(java.lang.String vmname, java.lang.Integer slot)
public java.util.List<java.lang.String> getVmSlotOptions(java.lang.String vmname, java.lang.Integer slot)
public java.util.List<java.lang.String> getMacOptions(java.lang.String mac)
public void setConfiguration(java.lang.String IPAddress, java.lang.String networkMask, java.lang.String FromIPAddress, java.lang.String ToIPAddress)
IPAddress
- server IP addressnetworkMask
- server network maskFromIPAddress
- server From IP address for address rangeToIPAddress
- server To IP address for address range
Expected result codes:
E_INVALIDARG | invalid configuration supplied |
public void start(java.lang.String networkName, java.lang.String trunkName, java.lang.String trunkType)
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. |
public void stop()
E_FAIL | Failed to stop the process. |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |