|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_6_1.IUnknown
org.virtualbox_6_1.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: {EA2D467F-B6C2-4B9A-8EB5-6E2F275DD72E}
Field Summary |
---|
Fields inherited from class org.virtualbox_6_1.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
IDHCPServer(java.lang.String wrapped,
org.virtualbox_6_1.ObjectRefManager objMgr,
org.virtualbox_6_1.jaxws.VboxPortType port)
|
Method Summary | |
---|---|
void |
addGlobalOption(DhcpOpt option,
java.lang.String value)
6.0 legacy, will be removed in 6.1. |
void |
addVmSlotOption(java.lang.String vmname,
java.lang.Integer slot,
DhcpOpt option,
java.lang.String value)
6.0 legacy, will be removed in 6.1. |
void |
findLeaseByMAC(java.lang.String mac,
java.lang.Integer type,
Holder<java.lang.String> address,
Holder<java.lang.String> state,
Holder<java.lang.Long> issued,
Holder<java.lang.Long> expire)
Queries the persistent lease database by MAC address. |
IDHCPConfig |
getConfig(DHCPConfigScope scope,
java.lang.String name,
java.lang.Long slot,
java.lang.Boolean mayAdd)
Gets or adds a configuration. |
java.lang.Boolean |
getEnabled()
specifies if the DHCP server is enabled |
IEventSource |
getEventSource()
|
IDHCPGlobalConfig |
getGlobalConfig()
Global configuration that applies to all clients. |
java.util.List<java.lang.String> |
getGlobalOptions()
Legacy interface, will be removed in 6.1. |
java.util.List<IDHCPGroupConfig> |
getGroupConfigs()
Configuration groups that applies to selected clients, selection is flexible. |
java.util.List<IDHCPIndividualConfig> |
getIndividualConfigs()
Individual NIC configurations either by MAC address or VM + NIC number. |
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)
6.0 legacy, will be removed in 6.1. |
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()
Legacy interface, will be removed in 6.1. |
java.util.List<java.lang.String> |
getVmSlotOptions(java.lang.String vmname,
java.lang.Integer slot)
6.0 legacy, will be removed in 6.1. |
static IDHCPServer |
queryInterface(IUnknown obj)
|
void |
removeGlobalOption(DhcpOpt option)
6.0 legacy, will be removed in 6.1. |
void |
removeGlobalOptions()
Legacy interface, will be removed in 6.1. |
void |
removeVmSlotOption(java.lang.String vmname,
java.lang.Integer slot,
DhcpOpt option)
6.0 legacy, will be removed in 6.1. |
void |
removeVmSlotOptions(java.lang.String vmname,
java.lang.Integer slot)
6.0 legacy, will be removed in 6.1. |
void |
restart()
Restart running DHCP server process. |
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_6_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 |
---|
public IDHCPServer(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.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 IDHCPGlobalConfig getGlobalConfig()
public java.util.List<IDHCPGroupConfig> getGroupConfigs()
public java.util.List<IDHCPIndividualConfig> getIndividualConfigs()
public static IDHCPServer queryInterface(IUnknown obj)
public void addGlobalOption(DhcpOpt option, java.lang.String value)
public void removeGlobalOption(DhcpOpt option)
public void removeGlobalOptions()
public void addVmSlotOption(java.lang.String vmname, java.lang.Integer slot, DhcpOpt option, java.lang.String value)
public void removeVmSlotOption(java.lang.String vmname, java.lang.Integer slot, DhcpOpt option)
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. |
public void restart()
E_FAIL | Failed to restart the process. |
public void findLeaseByMAC(java.lang.String mac, java.lang.Integer type, Holder<java.lang.String> address, Holder<java.lang.String> state, Holder<java.lang.Long> issued, Holder<java.lang.Long> expire)
mac
- The MAC address to look up.type
- Reserved, MBZ.address
- The assigned address.state
- The lease state.issued
- Timestamp of when the lease was issued, in seconds since 1970-01-01 UTC.expire
- Timestamp of when the lease expires/expired, in seconds since 1970-01-01 UTC.
Expected result codes:
VBOX_E_OBJECT_NOT_FOUND | If MAC address not in the database. |
VBOX_E_FILE_ERROR | If not able to read the lease database file. |
public IDHCPConfig getConfig(DHCPConfigScope scope, java.lang.String name, java.lang.Long slot, java.lang.Boolean mayAdd)
scope
- The kind of configuration being sought or added.name
- Meaning depends on the scope:
- Ignored when the scope isDHCPConfigScope.Global
.
- A VM name or UUID forDHCPConfigScope.MachineNIC
.
- A MAC address forDHCPConfigScope.MAC
.
- A group name forDHCPConfigScope.Group
.slot
- The NIC slot when scope is set toDHCPConfigScope.MachineNIC
,
must be zero for all other scope values.mayAdd
- Set to TRUE if the configuration should be added if not found.
If set to FALSE the method will fail with VBOX_E_OBJECT_NOT_FOUND.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |