Skip to content

Oadm.Sdk.Network

Helpers for plugins that serve the network: interfaces, port errors, rate limits, firewall rules.

Type Description
IFirewallRules The host firewall as far as plugins may change it.
IServerNetworkInterfaces Lists the server’s network interfaces.
IWindowsServiceProbe Windows: whether a Windows service runs (it may hold a port).
Type Description
FirewallRuleKeeper Keeps one firewall rule in line with a service’s enabled state (NTP server, DHCP server): FirewallRuleKeeper.SyncAsync opens the rule when the service is enabled and closes it when disabled or stopped.
HostOsInfo The operating system the server runs on.
InterfaceOptions Builds the entries of an interface select.
KeyedRateLimiter<TKey> Token buckets per client key (address, MAC) in a bounded LRU table plus one global bucket, shared by the network service plugins (NTP, DHCP).
PortBindErrors Maps a failed bind of a service port (NTP 123, DHCP 67) per OS and builds the shared parts of the status texts.
ScQueryServiceProbe Runs sc.exe query (state names are not localized) with a 3 s timeout; false elsewhere.
SystemNetworkInterfaces IServerNetworkInterfaces over NetworkInterface.GetAllNetworkInterfaces (Windows, Linux, macOS).
Type Description
FirewallRule An inbound allow rule for the server executable on one local port (profiles Domain and Private).
InterfaceOption One entry of a service page’s interface select (the server’s interfaces, listed by the server).
KeyedRateLimitOptions Limits of KeyedRateLimiter.
ServerNetworkInterface One network interface of the OADM server (for core plugins that serve the network, e.g.
ServiceStatus The status line of a network service plugin (NTP server, DHCP server): kind ok / neutral / warning / error, a plain text for technicians and an optional detail (tooltip) with the fix.
Type Description
RateLimitResult The answer of KeyedRateLimiter.Check for one request.
Type Description
BindErrorKind What a failed bind of a service port means.
FirewallProtocol The protocol of a firewall rule.
HostOs The server’s operating system, for OS-specific status texts (bind errors, setup hints).
RateLimitDecision What to do with a request (KeyedRateLimiter.Check).