VirtualBox Main API
|
The IDHCPServer interface represents the VirtualBox DHCP server configuration. More...
Public Member Functions | |
void | addGlobalOption (in DhcpOpt option, in wstring value) |
void | addVmSlotOption (in wstring vmname, in long slot, in DhcpOpt option, in wstring value) |
void | removeVmSlotOptions (in wstring vmname, in long slot) |
void | getVmSlotOptions (in wstring vmname, in long slot,[retval] out wstring[] option) |
void | getMacOptions (in wstring mac,[retval] out wstring[] option) |
void | setConfiguration (in wstring IPAddress, in wstring networkMask, in wstring FromIPAddress, in wstring ToIPAddress) |
configures the server | |
void | start (in wstring networkName, in wstring trunkName, in wstring trunkType) |
Starts DHCP server process. | |
void | stop () |
Stops DHCP server process. |
Public Attributes | |
readonly attribute IEventSource | eventSource |
attribute boolean | enabled |
specifies if the DHCP server is enabled | |
readonly attribute wstring | IPAddress |
specifies server IP | |
readonly attribute wstring | networkMask |
specifies server network mask | |
readonly attribute wstring | networkName |
specifies internal network name the server is used for | |
readonly attribute wstring | lowerIP |
specifies from IP address in server address range | |
readonly attribute wstring | upperIP |
specifies to IP address in server address range | |
readonly attribute wstring[] | globalOptions |
readonly attribute wstring[] | vmConfigs |
The IDHCPServer interface represents the VirtualBox DHCP server configuration.
To enumerate all the DHCP servers on the host, use the @link IVirtualBox::DHCPServers IVirtualBox::DHCPServers@endlink<b></b> attribute.
{FF0774C5-1F62-4BC3-919C-7FC942BF1D25}
void IDHCPServer::addGlobalOption | ( | in DhcpOpt | option, |
in wstring | value | ||
) |
void IDHCPServer::addVmSlotOption | ( | in wstring | vmname, |
in long | slot, | ||
in DhcpOpt | option, | ||
in wstring | value | ||
) |
void IDHCPServer::removeVmSlotOptions | ( | in wstring | vmname, |
in long | slot | ||
) |
void IDHCPServer::getVmSlotOptions | ( | in wstring | vmname, |
in long | slot, | ||
[retval] out wstring[] | option | ||
) |
void IDHCPServer::getMacOptions | ( | in wstring | mac, |
[retval] out wstring[] | option | ||
) |
void IDHCPServer::setConfiguration | ( | in wstring | IPAddress, |
in wstring | networkMask, | ||
in wstring | FromIPAddress, | ||
in wstring | ToIPAddress | ||
) |
configures the server
IPAddress | server IP address |
networkMask | server network mask |
FromIPAddress | server From IP address for address range |
ToIPAddress | server To IP address for address range |
E_INVALIDARG | invalid configuration supplied |
void IDHCPServer::start | ( | in wstring | networkName, |
in wstring | trunkName, | ||
in wstring | trunkType | ||
) |
Starts DHCP server process.
networkName | Name of internal network DHCP server should attach to. |
trunkName | Name of internal network trunk. |
trunkType | Type of internal network trunk. |
E_FAIL | Failed to start the process. |
void IDHCPServer::stop | ( | ) |
Stops DHCP server process.
@par Expected result codes: <table><tr>
E_FAIL
Failed to stop the process.
readonly attribute IEventSource IDHCPServer::eventSource |
attribute boolean IDHCPServer::enabled |
specifies if the DHCP server is enabled
readonly attribute wstring IDHCPServer::IPAddress |
specifies server IP
readonly attribute wstring IDHCPServer::networkMask |
specifies server network mask
readonly attribute wstring IDHCPServer::networkName |
specifies internal network name the server is used for
readonly attribute wstring IDHCPServer::lowerIP |
specifies from IP address in server address range
readonly attribute wstring IDHCPServer::upperIP |
specifies to IP address in server address range
readonly attribute wstring [] IDHCPServer::globalOptions |
readonly attribute wstring [] IDHCPServer::vmConfigs |