GetNetworkInfo Best Practices for Network Diagnostics

GetNetworkInfo Explained: Parameters, Returns, and Examples

GetNetworkInfo is a utility function commonly found in networking libraries and system APIs that retrieves information about a network interface or environment. This article explains typical parameters, return values, usage patterns, and concrete examples in multiple contexts (scripting, system APIs, and web/mobile environments). Assumed defaults: synchronous call that returns structured data; examples use pseudocode and common languages (Python, JavaScript, PowerShell).

Typical Parameters

• interface (string) — Optional. Name or identifier of the network interface (e.g., “eth0”, “en0”, “Wi-Fi”). If omitted, function may return info for all interfaces or the primary active interface.
• includeStatistics (boolean) — Optional, default false. If true, include traffic counters (bytes sent/received, packets, errors).
• includeAddresses (boolean) — Optional, default true. If false, omit IP/MAC addresses to reduce data.
• family (string) — Optional, values: “ipv4”, “ipv6”, “both”. Select address family to return.
• timeout (integer ms) — Optional. Maximum time to wait for data from system calls or remote services.
• raw (boolean) — Optional. If true, return low-level OS-specific structures; otherwise return normalized cross-platform objects.

Typical Return Structure

Most implementations return a structured object or dictionary with fields such as:

• name — Interface name (string).
• mac — MAC address (string).
• addresses — List of address objects: { family, address, netmask, scope }.
• mtu — Maximum Transmission Unit (integer).
• state — Link state (e.g., “up”, “down”).
• speed — Link speed in Mbps (integer, optional).
• statistics — { bytesSent, bytesReceived, packetsSent, packetsReceived, errorsIn, errorsOut } (present when includeStatistics = true).
• type — Interface type (e.g., “ethernet”, “wifi”, “loopback”).
• rawInfo — OS-specific blob when raw = true.

Error Cases and Edge Conditions

• Interface not found → return null or throw NotFound error.
• Permissions denied → error indicating elevated privileges required (reading some stats may need admin).
• Unsupported property (e.g., speed on virtual interfaces) → property omitted or set to null.
• Timeouts → partial data or timeout exception.

Examples

1) Python (psutil-based pseudocode)

python
Copy CodeCopied
import psutil def get_network_info(interface=None, include_statistics=False):
addrs = psutil.net_if_addrs()
    stats = psutil.net_if_stats()
    io = psutil.net_io_counters(pernic=True) if include_statistics else {}
    results = []
    targets = [interface] if interface else addrs.keys()
    for name in targets:
        if name not in addrs:
            continue
        info = {
            “name”: name,
            “mac”: next((a.address for a in addrs[name] if a.family == psutil.AF_LINK), None),
            “addresses”: [{“family”: str(a.family), “address”: a.address, “netmask”: a.netmask} for a in addrs[name] if a.address],
            “mtu”: stats[name].mtu if name in stats else None,
            “state”: “up” if stats.get(name) and stats[name].isup else “down”
        }
        if include_statistics and name in io:
            info[“statistics”] = {
                “bytesSent”: io[name].bytes_sent,
                “bytesReceived”: io[name].bytesrecv             }
        results.append(info)
    return results 

javascript
 ffON2NH02oMAcqyoh2UU MQCbz04ET5EljRmK3YpQ CPXAhl7VTkj2dHDyAYAf” data-copycode=“true” role=“button” aria-label=“Copy Code”>Copy CodeCopied
const os = require(‘os’);

function getNetworkInfo(interfaceName) {
  const nets = os.networkInterfaces();
  if (interfaceName) {
    return nets[interfaceName] || null;
  }
  return nets; // raw per-OS structure
}

powershell
Copy CodeCopied
function Get-NetworkInfo {
  param([string]\(Interface</span><span class="token" style="color: rgb(57, 58, 52);">)</span><span> </span><span>  </span><span class="token" style="color: rgb(54, 172, 170);">\)adapters = Get-NetAdapter
  if (\(Interface</span><span class="token" style="color: rgb(57, 58, 52);">)</span><span> </span><span class="token" style="color: rgb(57, 58, 52);">{</span><span> </span><span class="token" style="color: rgb(54, 172, 170);">\)adapters = \(adapters</span><span> </span><span class="token" style="color: rgb(57, 58, 52);">|</span><span> </span><span class="token" style="color: rgb(57, 58, 52);">Where-Object</span><span> Name </span><span class="token" style="color: rgb(57, 58, 52);">-eq</span><span> </span><span class="token" style="color: rgb(54, 172, 170);">\)Interface }
  \(adapters</span><span> </span><span class="token" style="color: rgb(57, 58, 52);">|</span><span> </span><span class="token" style="color: rgb(57, 58, 52);">ForEach-Object</span><span> </span><span class="token" style="color: rgb(57, 58, 52);">{</span><span> </span><span>    </span><span class="token" style="color: rgb(54, 172, 170);">\)ips = Get-NetIPAddress -InterfaceIndex \(_</span><span class="token" style="color: rgb(57, 58, 52);">.</span><span>ifIndex </span><span>    </span><span class="token">[pscustomobject]</span><span>@</span><span class="token" style="color: rgb(57, 58, 52);">{</span><span> </span><span>      Name = </span><span class="token" style="color: rgb(54, 172, 170);">\).Name       Mac  = $.MacAddress       State = \(_</span><span class="token" style="color: rgb(57, 58, 52);">.</span><span>Status </span><span>      MTU = </span><span class="token" style="color: rgb(54, 172, 170);">\)_.Mtu       Addresses = $ips | Select-Object AddressFamily,IPAddress,PrefixLength     }
  }
}