[API Proposal]: Add `DhcpLeaseExpires` and `DhcpLeaseObtained` to IPv4InterfaceProperties

Open
#107,659 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp
Domain
api, networking

Research direction

Start with src/libraries/System.Net.NetworkInformation/src/System/Net/NetworkInformation/IPv4InterfaceProperties.cs and the existing IsDhcpEnabled implementation. Then inspect how the library queries Win32_NetworkAdapterConfiguration for related properties. Done means the proposed lease properties are exposed through IPv4InterfaceProperties and return the corresponding DHCP lease values.

Written by the indexing model from the issue text.

Description

api-suggestion area-System.Net
Background and motivation

We should be able to easily retrieve all of the properties displayed with ipconfig /all with the classes in the System.Net.NetworkInformation namespace:


CleanShot 2024-09-10 at 18 42 16@2x


The IPv4InterfaceProperties class in System.Net.NetworkInformation yields a number of the IPv4 metrics for network adapters. It includes IsDhcpEnabled but not the DhcpLeaseExpires or the DhcpLeaseObtained properties from WMI. The current workaround is to query WMI directly using the Win32_NetworkAdapterConfiguration class.

API Proposal
namespace System.Net.NetworkInformation;

// src/libraries/System.Net.NetworkInformation/src/System/Net/NetworkInformation/IPv4InterfaceProperties.cs
public class IPv4InterfaceProperties
{
    // ... add these two properties:
    public DateTime DhcpLeaseExpires { get; }
    public DateTime DhcpLeaseObtained { get; }
}
API Usage
// Print the DHCP lease origin and expiration for each network interface:
foreach (var ifc in NetworkInterface.GetAllNetworkInterfaces())
{
    var ipv4Props = ifc.GetIPProperties().GetIPv4Properties();
    Console.WriteLine($"Name: {ifc.Name}");
    Console.WriteLine($"DHCP Lease Obtained: {ipv4Props.DhcpLeaseObtained}");
    Console.WriteLine($"DHCP Lease Expires: {ipv4Props.DhcpLeaseExpires}");
}
Alternative Designs

Perhaps an IPAddress instance has better access to these properties?

Risks

None that I can see. We are already querying WMI for other properties from the Win32_NetworkAdapterConfiguration class.

Dominant language
C#
Stars
18.3k
Forks
5.6k
PR metrics pending

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/runtime

All issues in dotnet/runtime

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.