Physical Address
304 North Cardinal St.
Dorchester Center, MA 02124
ISO/IEC 29341-26-13: UPnP WANCommonInterfaceConfig Service — WAN Interface Monitoring
Technical Analysis of the WANCommonInterfaceConfig Service for Monitoring Physical and Link-Layer WAN Interface Parameters
Overview of WANCommonInterfaceConfig
ISO/IEC 29341-26-13 defines the WANCommonInterfaceConfig service, a foundational UPnP service that provides monitoring and configuration capabilities for the physical WAN interface of an Internet Gateway Device. Unlike the connection-oriented services (WANIPConnection and WANPPPConnection), this service focuses on the underlying interface — reporting link status, physical layer parameters, aggregate traffic statistics, and common interface configuration settings.
The WANCommonInterfaceConfig service is always instantiated once per gateway device, regardless of how many WAN connection services are active. It serves as the common monitoring point for the physical WAN port.
This service is essential for network management applications, bandwidth monitoring tools, and quality-of-service (QoS) optimization systems. It provides the raw metrics needed to calculate throughput, identify link flaps, and detect duplex mismatches — information that is difficult to obtain through other UPnP services. The service exposes both read-only status variables and a limited set of configuration actions for common interface parameters.
Key State Variables and Monitoring Capabilities
The WANCommonInterfaceConfig service exposes a rich set of state variables that can be broadly categorized into physical layer status, traffic counters, and interface configuration. The PhysicalLinkStatus variable reports the current state of the physical medium (Up, Down, or Initializing), while PhysicalMedium identifies the underlying transport — DSL, Ethernet, Cable, POTS, Satellite, or Wireless. The service also reports EnabledForInternet, indicating whether the WAN interface is authorized for internet traffic.
Traffic counters in WANCommonInterfaceConfig are cumulative 32-bit values that may wrap around on high-throughput interfaces. For gigabit-speed WAN links, counters can wrap in under 35 seconds. Implementations should poll counters at intervals shorter than the theoretical wrap time and detect rollovers.
The traffic monitoring capability is one of the most frequently used features. The service provides eight distinct counter variables: TotalBytesSent, TotalBytesReceived, TotalPacketsSent, TotalPacketsReceived, TotalErrorsSent, TotalErrorsReceived, TotalDiscardsSent, and TotalDiscardsReceived. These counters cover the full set of interface statistics that network engineers expect from a managed switch or router interface.
| State Variable | Type | Description | Engineering Use |
|---|---|---|---|
| PhysicalLinkStatus | string | Up, Down, or Initializing | Link availability monitoring |
| PhysicalMedium | string | DSL, Ethernet, Cable, POTS, Satellite, Wireless | Access technology identification |
| TotalBytesSent | ui4 | Total bytes transmitted | Upload throughput calculation |
| TotalBytesReceived | ui4 | Total bytes received | Download throughput calculation |
| TotalErrorsSent | ui4 | Total transmit errors | Fault detection and SQI |
| TotalErrorsReceived | ui4 | Total receive errors | Physical layer health |
| EnabledForInternet | boolean | Whether WAN is enabled for internet | Service provisioning |
Engineering Applications and Implementation Patterns
Bandwidth monitoring is the primary use case for WANCommonInterfaceConfig. By periodically sampling TotalBytesSent and TotalBytesReceived, a control point can calculate real-time throughput rates. The recommended sampling interval is 5-10 seconds — frequent enough for meaningful real-time graphs, but not so frequent as to cause unnecessary UPnP SOAP traffic. The service also provides GetCommonLinkProperties action, which returns the MaxActiveConnections and WANAccessType (e.g., “PPPoE Broadband”, “IP Broadband”, “Cable Broadband”).
Combine WANCommonInterfaceConfig counters with connection state from WANIPConnection or WANPPPConnection to build a comprehensive gateway health dashboard. A physical link that is Up but with no active connection can indicate an upstream authentication or provisioning failure.
Error analysis is another critical application. The ratio of TotalErrorsReceived to TotalPacketsReceived provides an interface-level error rate. A rate consistently above 0.1% typically indicates a physical layer problem — faulty cabling, signal degradation (on DSL links), or electromagnetic interference. For DSL connections, some gateways additionally expose DownstreamBitRate and UpstreamBitRate via vendor-extended variables, though these are not part of the core standard.
The WANCommonInterfaceConfig counters (ui4 — unsigned 32-bit) are NOT persistence-safe. A gateway reboot resets all counters to zero. For long-term bandwidth accounting, the control point must store its own baseline values and detect counter resets by comparing against previous samples. A sample where the new value is less than the previous value indicates either a counter wrap or a device reboot.
For advanced deployments, the GetWANAccessProvider action (optional in the standard) can retrieve a URL pointing to the ISP’s provisioning portal, enabling automated firmware update checks and service plan information retrieval through the gateway itself.
Frequently Asked Questions
Q: Can WANCommonInterfaceConfig differentiate between upstream and downstream traffic?
A: Yes, the service maintains separate counters for sent (upstream) and received (downstream) bytes and packets, enabling per-direction bandwidth calculation.
A: Yes, the service maintains separate counters for sent (upstream) and received (downstream) bytes and packets, enabling per-direction bandwidth calculation.
Q: Does this service provide link speed/duplex information?
A: The core standard does not directly expose speed and duplex settings, but the CommonLinkProperties action provides WANAccessType, and some vendor implementations extend the service with proprietary variables for line rate. The true PhyRate is often accessible via TR-098 or TR-181 data models on carrier-grade CPE.
A: The core standard does not directly expose speed and duplex settings, but the CommonLinkProperties action provides WANAccessType, and some vendor implementations extend the service with proprietary variables for line rate. The true PhyRate is often accessible via TR-098 or TR-181 data models on carrier-grade CPE.
Q: How does WANCommonInterfaceConfig relate to the WANConnectionDevice?
A: WANCommonInterfaceConfig is a sibling service within the WANDevice root hierarchy. The WANConnectionDevice contains the connection-specific services (WANIPConnection, WANPPPConnection), while WANCommonInterfaceConfig resides directly under WANDevice and monitors the physical interface shared by all connections.
A: WANCommonInterfaceConfig is a sibling service within the WANDevice root hierarchy. The WANConnectionDevice contains the connection-specific services (WANIPConnection, WANPPPConnection), while WANCommonInterfaceConfig resides directly under WANDevice and monitors the physical interface shared by all connections.
Q: Are the traffic counters accurate for billing purposes?
A: No. The 32-bit counter width, potential wrap-around, and lack of persistence across reboots make these counters unsuitable for billing-grade accounting. They are designed for real-time monitoring and rough capacity planning, not financial transactions.
A: No. The 32-bit counter width, potential wrap-around, and lack of persistence across reboots make these counters unsuitable for billing-grade accounting. They are designed for real-time monitoring and rough capacity planning, not financial transactions.
