A .NET (C#, Visual Basic.NET, etc) wrapper for the native DHCP management APIs exposed by Windows.
Install-Package DhcpServerApi
An initial focus has been made for read-only access to the data via the APIs, but the project can be easily extended to support read-write access.
Method 1: Discovering via directory services
// Discover DHCP Servers
foreach (var dhcpServer in DhcpServer.Servers)
{
Console.WriteLine(dhcpServer.Name);
}Method 2: Connecting directly
// Connect to DHCP Server
var dhcpServer = DhcpServer.Connect("SRV-DHCP-01"); // or 192.168.1.1
Console.WriteLine(dhcpServer.Name);// Connect to DHCP Server
var dhcpServer = DhcpServer.Servers.First();
// Display some configuration
Console.WriteLine("Protocol Support: {0}", dhcpServer.Configuration.ApiProtocolSupport);
Console.WriteLine("Database Name: {0}", dhcpServer.Configuration.DatabaseName);
Console.WriteLine("Database Path: {0}", dhcpServer.Configuration.DatabasePath);
// Show all bound interfaces
foreach (var binding in dhcpServer.BindingElements)
{
Console.WriteLine("Binding Interface Id: {0}", binding.InterfaceGuidId);
Console.WriteLine(" Description: {0}", binding.InterfaceDescription);
Console.WriteLine(" Adapter Address: {0}", binding.AdapterPrimaryIpAddress);
Console.WriteLine(" Adapter Subnet: {0}", binding.AdapterSubnetAddress);
}// Connect to DHCP Server
var dhcpServer = DhcpServer.Servers.First();
// Display scope information
foreach (var scope in dhcpServer.Scopes)
{
Console.WriteLine("Scope: ", scope.Name);
Console.WriteLine(" Address: ", scope.Address);
Console.WriteLine(" Mask: ", scope.Mask);
Console.WriteLine(" Range: ", scope.IpRange);
Console.WriteLine(" State: ", scope.State);
}Client leases can be retrieved globally (all leases on the server) or individually for each scope.
// Connect to DHCP Server
var dhcpServer = DhcpServer.Servers.Skip(1).First();
// Get a scope
var scope = dhcpServer.Scopes.First();
Console.WriteLine("Scope '{0}' Clients", scope.Name);
Console.WriteLine();
// Get active client leases
var activeClients = scope.Clients
.Where(c => c.AddressState == DhcpServerClientAddressStates.Active);
// Display client information
foreach (var client in activeClients)
{
Console.WriteLine("{0} [{1}] {2}, Expires: {3}",
client.IpAddress,
client.HardwareAddress,
client.Name,
client.LeaseExpires);
}// Connect to DHCP Server
var dhcpServer = DhcpServer.Servers.First();
// Get a scope
var scope = dhcpServer.Scopes.First();
Console.WriteLine("Scope '{0}' Reservations", scope.Name);
Console.WriteLine();
// Display reservation information
foreach (var reservation in scope.Reservations)
{
Console.WriteLine("{0} [{1}] {2}",
reservation.IpAddress,
reservation.HardwareAddress,
reservation.Client.Name);
}Options can be retrieved globally (all options on the server), for scopes or individual reservations.
// Connect to DHCP Server
var dhcpServer = DhcpServer.Servers.Skip(1).First();
// Get a scope
var scope = dhcpServer.Scopes.First();
Console.WriteLine("Scope '{0}' Options", scope.Name);
Console.WriteLine();
// Get option values
foreach (var optionValue in scope.OptionValues)
{
Console.WriteLine("{0} [{1}]:", optionValue.Option.Name, optionValue.OptionId);
foreach (var value in optionValue.Values)
{
Console.WriteLine(" {0} [{1}]", value.Value, value.Type);
}
}