Broadband Forum

    DATA MODEL DEFINITION


TR-069 InternetGatewayDevice:1.1 Root Object definition
tr-098-1-0-0.xml (differences)

Notice

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband network system development and deployment. This Broadband Forum XML Document has been approved by members of the Forum. This Broadband Forum XML Document is not binding on the Broadband Forum, any of its members, or any developer or service provider. This Broadband Forum XML Document is subject to change, but only with approval of members of the Forum. This XML Document is copyrighted by the Broadband Forum, and all rights are reserved. Portions of this XML Document may be copyrighted by Broadband Forum members.

This Broadband Forum XML Document is provided AS IS, WITH ALL FAULTS. ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM XML DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW ANY REPRESENTATION OR WARRANTY, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY:

By using this Broadband Forum XML Document, users acknowledge that implementation may require licenses to patents. The Broadband Forum encourages but does not require its members to identify such patents. For a list of declarations made by Broadband Forum member companies, please see http://www.broadband-forum.org. No assurance is given that licenses to patents necessary to implement this XML Document will be available for license at all or on reasonable and non-discriminatory terms.

ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM XML DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW (A) ANY LIABILITY (INCLUDING DIRECT, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES UNDER ANY LEGAL THEORY) ARISING FROM OR RELATED TO THE USE OF OR RELIANCE UPON THIS XML DOCUMENT; AND (B) ANY OBLIGATION TO UPDATE OR CORRECT THIS XML DOCUMENT.

Broadband Forum XML Documents may be copied, downloaded, stored on a server or otherwise re-distributed in their entirety only, and may not be modified without the advance written permission of the Broadband Forum.

The text of this notice must be included in all copies.

Table of Contents

Data Types

The parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. The complete set of data types, along with the notation used to represent these types, is listed in [Appendix I.4/TR-106a7]. The following named data types are used by this specification.

Data Type Base Type Description
Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

The IEEE EUI 64-bit identifier as defined in [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

  • The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
  • The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.
IPAddress string(45)

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

IPPrefix string(49)

IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation [RFC4632]. This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

  • IPv4 example: 192.168.1.0/24
  • IPv6 example: 2001:edff:fe6a:f76::/64

If the IP address part is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n".

If the entire IP prefix is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition.

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

Can be any IPv4 address that is permitted by the IPAddress data type.

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type.

IPv6Address IPAddress

IPv6 address.

Can be any IPv6 address that is permitted by the IPAddress data type.

IPv6Prefix IPPrefix

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.

MACAddress string(17) All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition.
StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

UUID string(36:36) Universally Unique Identifier. See [RFC4122].
ZigBeeNetworkAddress string(4) The ZigBee 16-bit network address (NWK) as defined in [ZigBee2007]. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices.

References

[HTML4.01] HTML 4.01 Specification, W3C.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069, CPE WAN Management Protocol, Broadband Forum, 2004.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-098] TR-098, Internet Gateway Device Data Model for TR-069, Broadband Forum, 2005.
[TR-106] TR-106, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2005.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

InternetGatewayDevice:1.1 Data Model

For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 1.1, then it will indicate support for version 1.1. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
InternetGatewayDevice. object - The top-level object for an Internet Gateway Device. - 1.0
DeviceSummary string­(1024) - As defined in [TR-106]. - 1.1
LANDeviceNumberOfEntries unsignedInt - Number of instances of LANDevice. - 1.0
WANDeviceNumberOfEntries unsignedInt - Number of instances of WANDevice. - 1.0
InternetGatewayDevice.Services. object - This object contains general services information. - 1.1
InternetGatewayDevice.DeviceInfo. object - This object contains general device information. - 1.0
Manufacturer string­(64) - The manufacturer of the CPE (human readable string). - 1.0
ManufacturerOUI string­(6) - Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. The value MUST be a valid OUI as defined in [OUI]. - 1.0
ModelName string­(64) - Model name of the CPE (human readable string). - 1.0
Description string­(256) - A full description of the CPE device (human readable string). - 1.0
ProductClass string­(64) - Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. - 1.0
SerialNumber string­(64) - Serial number of the CPE. - 1.0
HardwareVersion string­(64) - A string identifying the particular CPE model and version. - 1.0
SoftwareVersion string­(64) -

A string identifying the software version currently installed in the CPE.

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21where the components mean: Major.Minor.Build.

- 1.0
ModemFirmwareVersion string­(64) - A string identifying the version of the modem firmware currently installed in the CPE. This is applicable only when the modem firmware is separable from the overall CPE software. - 1.0
EnabledOptions string­(1024) -

Comma-separated list (maximum list length 1024) of strings. The OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in [Table 48/TR-069]. Only those options are listed whose State indicates the option is enabled.

Comma-separated list of the OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in [TR-069]. Only those options are listed whose State indicates the option is enabled.

- 1.0
AdditionalHardwareVersion string­(64) - Comma-separated list (maximum list length 64) of strings. Represents any additional hardware version information the vendor may wish to supply. - 1.0
AdditionalSoftwareVersion string­(64) - Comma-separated list (maximum list length 64) of strings. Represents any additional software version information the vendor may wish to supply. - 1.0
SpecVersion string­(16) -

This parameter is deprecated

Represents the version of the specification implemented by the device. Currently 1.0 is the only available version.

"1.0" 1.0
ProvisioningCode string­(64) W

Identifier of the primary service provider and other provisioning information, which MAY be used by the Server to determine service provider-specific customization and provisioning parameters.

If not an empty string, this argument SHOULD be in the form of a hierarchical descriptor with one or more nodes specified. Each node in the hierarchy is represented as a 4-character sub-string, containing only numerals or upper-case letters. If there is more than one node indicated, each node is separated by a "." (dot). Examples: "TLCO" or "TLCO.GRP2".

- 1.0
UpTime unsignedInt - Time in seconds since the CPE was last restarted. - 1.0
FirstUseDate dateTime - Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset. - 1.0
DeviceLog string­(32768) - Vendor-specific log(s). - 1.0
VendorConfigFileNumberOfEntries unsignedInt - Number of instances of VendorConfigFile. - 1.0
InternetGatewayDevice.DeviceInfo.VendorConfigFile.{i}. object -

Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File.

At most one entry in this table can exist with a given value for Name.

- 1.0
Name string­(64) - Name of the vendor configuration file. - 1.0
Version string­(16) - A string identifying the configuration file version currently used in the CPE. - 1.0
Date dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 1.0
Description string­(256) - A description of the vendor configuration file (human-readable string). - 1.0
InternetGatewayDevice.DeviceConfig. object - This object contains general configuration parameters. - 1.0
PersistentData string­(256) W Arbitrary user data that must persist across CPE reboots. - 1.0
ConfigFile string­(32768) W A dump of the currently running configuration on the CPE. This parameter enables the ability to backup and restore the last known good state of the CPE. It returns a vendor-specific document that defines the state of the CPE. The document must be capable of restoring the CPE's state when written back to the CPE using SetParameterValues. - 1.0
InternetGatewayDevice.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 1.0
URL string­(256) W

URL for the CPE to connect to the ACS using the CPE WAN Management Protocol.

This parameter MUST be in the form of a valid HTTP or HTTPS URL [RFC2616]. An HTTPS URL indicates that the ACS supports SSL.

The host portion of this URL is used by the CPE for validatingserver-side the certificate fromauthentication the ACS when using certificate-basedSSL authenticationor TLS.

- 1.0
Username string­(256) W

Username used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This username is used only for HTTP-based authentication of the CPE.

- 1.0
Password string­(256) W

Password used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This password is used only for HTTP-based authentication of the CPE.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
PeriodicInformEnable boolean W Whether or not the CPE must periodically send CPE information to Server using the Inform method call. - 1.0
PeriodicInformInterval unsignedInt­[1:] W The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true. - 1.0
PeriodicInformTime dateTime W

An absolute time reference in UTC to determine when the CPE should initiate the Inform method calls. Each Inform call must occur at this reference time plus or minus an integer multiple of the PeriodicInformInterval.

A zero dateTime value (0000-00-00T00:00:00) indicates that no particular time reference is specified. That is, the CPE may locally choose the time reference, required only to adhere to the specified PeriodicInformInterval.

- 1.0
ParameterKey string­(32) -

The value of the ParameterKey argument from the most recent SetParameterValues, AddObject, or DeleteObject method call from the Server. If there have been no such calls, this value is empty.

ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS.

The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified.

The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string.

- 1.0
ConnectionRequestURL string­(256) -

HTTP URL for an ACS to make a Connection Request notification to the CPE.

In the form:

http://host:port/path

The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.

- 1.0
ConnectionRequestUsername string­(256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 1.0
ConnectionRequestPassword string­(256) W

Password used to authenticate an ACS making a Connection Request to the CPE.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
UpgradesManaged boolean W Indicates whether or not the ACS will manage upgrades for the CPE. If true, the CPE SHOULD not use other means other than the ACS to seek out available upgrades. If false, the CPE MAY use other means for this purpose. - 1.0
KickURL string­(256) -

Present only for a CPE that supports the Kicked RPC method.

LAN-accessible URL from which the CPE can be "kicked" to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE.

- 1.0
DownloadProgressURL string­(256) -

Present only for a CPE that provides a LAN-side web page to show progress during a file download.

LAN-accessible URL to which a web-server associated with the ACS may redirect a user's browser on initiation of a file download to observer the status of the download.

- 1.0
InternetGatewayDevice.Time. object - This object contains parameters relating an NTP or SNTP time client in the CPE. Support for this object is Optional. - 1.0
NTPServer1 string­(64) W First NTP timeserver. Either a host name or IP address. - 1.0
NTPServer2 string­(64) W Second NTP timeserver. Either a host name or IP address. - 1.0
NTPServer3 string­(64) W Third NTP timeserver. Either a host name or IP address. - 1.0
NTPServer4 string­(64) W Fourth NTP timeserver. Either a host name or IP address. - 1.0
NTPServer5 string­(64) W Fifth NTP timeserver. Either a host name or IP address. - 1.0
CurrentLocalTime dateTime - The current date and time in the CPE's local time zone. - 1.0
LocalTimeZone string­(6) W

The local time offset from UTC in the form:

+hh:mm
-hh:mm
- 1.0
LocalTimeZoneName string­(64) W Name of the local time zone (human readable string). - 1.0
DaylightSavingsUsed boolean W Whether or not daylight savings time is in use in the CPE's local time zone. - 1.0
DaylightSavingsStart dateTime W Date and time daylight savings time begins if used in local standard time. If daylight savings time is not used, this value is ignored. - 1.0
DaylightSavingsEnd dateTime W Date and time daylight savings time ends if used in local daylight time. If daylight savings time is not used, this value is ignored. - 1.0
InternetGatewayDevice.UserInterface. object - This object contains parameters relating to the user interface of the CPE. Support for this object is Optional. - 1.0
PasswordRequired boolean W

Present only if the CPE provides a password-protected LAN-side user interface.

Indicates whether or not the local user interface must require a password to be chosen by the user. If false, the choice of whether or not a password is used is left to the user.

- 1.0
PasswordUserSelectable boolean W

Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.

Indicates whether or not a password to protect the local user interface of the CPE may be selected by the user directly, or must be equal to the password used by the LAN-side Auto-Configuration protocol.

- 1.0
UpgradeAvailable boolean W Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user. - 1.0
WarrantyDate dateTime W Indicates the date and time in UTC that the warranty associated with the CPE is to expire. - 1.0
ISPName string­(64) W The name of the customer's ISP. - 1.0
ISPHelpDesk string­(32) W The help desk phone number of the ISP. - 1.0
ISPHomePage string­(256) W The URL of the ISP's home page. - 1.0
ISPHelpPage string­(256) W The URL of the ISP's on-line support page. - 1.0
ISPLogo base64­(4095) W Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less. - 1.0
ISPLogoSize unsignedInt­[0:4095] W

Un-encoded binary image size in bytes.

If ISPLogoSize input value is 0 then the ISPLogo is cleared.

ISPLogoSize can also be used as a check to verify correct transfer and conversion of Base64 string to image size.

- 1.0
ISPMailServer string­(256) W The URL of the ISP's mail server. - 1.0
ISPNewsServer string­(256) W The URL of the ISP's news server. - 1.0
TextColor string­(6) W The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
BackgroundColor string­(6) W The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088). - 1.0
ButtonColor string­(6) W The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
ButtonTextColor string­(6) W The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
AutoUpdateServer string­(256) W The server the CPE can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the InternetGatewayDevice.ManagementServer.UpgradesManaged parameter is true. - 1.0
UserUpdateServer string­(256) W The server where a user can check via a web browser if an update is available for download to a PC. This MUST NOT be used by the CPE if the InternetGatewayDevice.ManagementServer.UpgradesManaged parameter is true. - 1.0
ExampleLogin string­(40) W An example of a correct login, according to ISP-specific rules. - 1.0
ExamplePassword string­(30) W An example of a correct password, according to ISP-specific rules. - 1.0
InternetGatewayDevice.Layer3Forwarding. object - This object allows the handling of the routing and forwarding configuration of the device. - 1.0
DefaultConnectionService string­(256) W Specifies the default WAN interface. The content is the full hierarchical parameter name of the default layer-3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
ForwardNumberOfEntries unsignedInt - Number of forwarding instances. - 1.0
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}. object W

Layer-3 forwarding table.

This table MUST NOT include routes learned through dynamic layer-3 routing protocols, such as RIP or OSPF.

At most one enabled entry in this table can exist with all the same values for DestIPAddress, DestSubnetMask, SourceIPAddress and SourceSubnetMask.

- 1.0
Enable boolean W Enables or disables the forwarding entry. On creation, an entry is disabled by default. false 1.0
Status string -

Indicates the status of the forwarding entry. Enumeration of:

- 1.0
Type string W

Indicates the type of route. Enumeration of:

- 1.0
DestIPAddress string­(45) W [IPAddress] Destination address. An empty string or a value of "0.0.0.0" indicates no destination address is specified. - 1.0
DestSubnetMask string­(45) W [IPAddress] Destination subnet mask. An empty string or a value of "0.0.0.0" indicates no destination subnet mask is specified. - 1.0
SourceIPAddress string­(45) W [IPAddress] Source address. An empty string or a value of "0.0.0.0" indicates no source address is specified. - 1.0
SourceSubnetMask string­(45) W [IPAddress] Source subnet mask. An empty string or a value of "0.0.0.0" indicates no source subnet mask is specified. - 1.0
ForwardingPolicy int­[-1:] W

Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the QueueManagement object.

A value of -1 indicates no ForwardingPolicy is specified.

If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows.

-1 1.1
GatewayIPAddress string­(45) W [IPAddress] IP address of the gateway. - 1.0
Interface string W Specifies the WANegress interface associated with this entry. The content is the full hierarchical parameter name of the layer-3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
ForwardingMetric int­[-1:] W Forwarding metric. A value of -1 indicates this metric is not used. - 1.0
MTU unsignedInt­[1:1540] W The maximum allowed size of an Ethernet frame for this route. - 1.0
InternetGatewayDevice.Layer2Bridging. object - Layer-2 bridging table. Specifies bridges between layer-2 LAN and/or WAN interfaces. Bridges can be defined to include layer-2 filter criteria to selectively bridge traffic between interfaces. - 1.1
MaxBridgeEntries unsignedInt - The maximum number of entries available in the Bridge table. - 1.1
MaxFilterEntries unsignedInt - The maximum number of entries available in the Filter table. - 1.1
MaxMarkingEntries unsignedInt - The maximum number of entries available in the Marking table. - 1.1
BridgeNumberOfEntries unsignedInt - Number of entries in the Bridge table. - 1.1
FilterNumberOfEntries unsignedInt - Number of entries in the Filter table. - 1.1
MarkingNumberOfEntries unsignedInt - Number of entries in the Marking table. - 1.1
AvailableInterfaceNumberOfEntries unsignedInt - Number of entries in the AvailableInterfaces? table. - 1.1
InternetGatewayDevice.Layer2Bridging.Bridge.{i}. object W

Bridge table.

At most one enabled entry in this table can exist with a given value for BridgeKey.

- 1.1
BridgeKey unsignedInt - Unique key for each Bridge table entry. - 1.1
BridgeEnable boolean W Enables or disables this Bridge table entry. false 1.1
BridgeStatus string -

The status of this Bridge table entry. Enumeration of:

"Disabled" 1.1
BridgeName string­(64) W Human-readable name for this Bridge table entry. <Empty> 1.1
VLANID unsignedInt­[0:4094] W

The 802.1Q VLAN ID associated with this Bridge.

A value of 0 indicates either Untagged or PriorityOnly tagging, which are treated identically.

0 1.1
InternetGatewayDevice.Layer2Bridging.Filter.{i}. object W

Filter table containing filter entries each of which is associated with one Bridge as specified by a Bridge table entry.

At most one enabled entry in this table can exist with a given value for FilterKey.

- 1.1
FilterKey unsignedInt - Unique key for each Filter table entry. - 1.1
FilterEnable boolean W Enables or disables this Filter table entry. false 1.1
FilterStatus string -

The status of this Filter table entry. Enumeration of:

"Disabled" 1.1
FilterBridgeReference int­[-1:] W The BridgeKey value of the Bridge table entry associated with this Filter. A value of -1 indicates the Filter table entry is not associated with a Bridge (and has no effect). -1 1.1
ExclusivityOrder unsignedInt W

Whether or not the Filter definition is exclusive of all others. And if the entry is exclusive, order of precedence.

A value of 1 or greater indicates an Exclusive Filter, where the value 1 indicates the first entry to be considered (highest precedence).

A value of 0 indicates a Non-Exclusive Filter.

For each packet, if the packet matches any Exclusive Filters, the packet is assigned to the Bridge associated with the highest precedence Exclusive Filter to which it matches (lowest ExclusivityOrder value).

If and only if the packet does not match any Exclusive Filters, the packet is assigned to all Bridges associated with each Non-Exclusive Filter for which it matches the defining criteria.

If a packet matches no Filter, it is discarded.

When the ExclusivityOrder is set to match that of an existing Exclusive Filter (1 or greater), the value for the existing entry and all higher numbered entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion or change in ExclusivityOrder of an Exclusive Filter causes ExclusivityOrder values of other Exclusive Filters (values 1 or greater) to be compacted.

Note that the use of Exclusive Filters to associate a layer-3 router interface with LAN and/or WAN interfaces via a Bridge entry overrides the default association between layer-3 and layer-2 objects implied by the InternetGatewayDevice object hierarchy.

0 1.1
FilterInterface string W

The interface or interfaces associated with this Filter table entry. The bridge corresponding to this Filter table entry is defined to admit packets on ingress to the bridge from the specified interfaces that meet all of the criteria specified in the Filter table entry. The following values are defined.

To associate this Filter with a single interface listed in the AvailableInterface table, the FilterInterface value is set to the value of corresponding AvailableInterfaceKey.

  • AllInterfaces indicates that this Filter is associated with all LAN and WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface or WANInterface).
  • LANInterfaces indicates that this Filter is associated with all LAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface).
  • WANInterfaces indicates that this Filter is associated with all WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType WANInterface).
  • an empty string indicates the Filter table entry is not associated with any interface (and has no effect)
<Empty> 1.1
VLANIDFilter int­[-1:4095] W

The 802.1Q VLAN ID of packets to admit to the specified Bridge through the interfaces specified for this Filter.

A value of -1 indicates that the default VLAN ID for the Bridge should be used instead (as specified by InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID for the Bridge table entry associated with this Filter table entry). On creation of a Filter entry, the default value for this parameter should be -1.

-1 1.1
AdmitOnlyVLANTagged boolean W

If true, on ingress to the interfaces associated with this Filter, the Bridge admits only packets tagged with a VLAN ID that matches the VLANIDFilter parameter (or instead, the VLAN ID for the Bridge if VLANIDFilter is unspecified).

If false, on ingress to the interfaces associated with this Filter, the Bridge admits both packets tagged with a VLAN ID that matches the VLANIDFilter parameter (or instead, the VLAN ID for the Bridge if VLANIDFilter is unspecified), and any Untagged or PriorityOnly packets. All Untagged or PriorityOnly packets are tagged on ingress with the value of the VLANID? parameter.

If the VLANIDFilter parameter (or instead, the VLAN ID for the Bridge if VLANIDFilter is unspecified) is equal to 0, then this parameter is ignored, and only packets that are Untagged or PriorityOnly packets are admitted.

false 1.1
EthertypeFilterList string­(256) W Comma-separated list (maximum list length 256) of unsigned integers. Comma-separated list of unsigned integers, each representing an Ethertype value. <Empty> 1.1
EthertypeFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit only those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit all packets except those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, packets are admitted regardless of Ethertype.

true 1.1
SourceMACAddressFilterList string­(512) W

Comma-separated list (maximum list length 512) of strings. Comma-separated list of MAC Addresses.

Each list entry may optionally specify a bit-mask, where matching of a packet's MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching.

For example, the list may be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33

<Empty> 1.1
SourceMACAddressFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, packets are admitted regardless of MAC address.

true 1.1
DestMACAddressFilterList string­(512) W

Comma-separated list (maximum list length 512) of strings. Comma-separated list of MAC Addresses.

Each list entry may optionally specify a bit-mask, where matching of a packet's MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching.

For example, the list may be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33

<Empty> 1.1
DestMACAddressFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, packets are admitted regardless of MAC address.

true 1.1
SourceMACFromVendorClassIDFilter string­(256) W A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if it its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value. <Empty> 1.1
SourceMACFromVendorClassIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromVendorClassIDFilter. If SourceMACFromVendorClassIDFilter is an empty string, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromVendorClassIDFilter. If the SourceMACFromVendorClassIDFilter is an empty string, packets are admitted regardless of MAC address.

true 1.1
DestMACFromVendorClassIDFilter string­(256) W A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if it its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value. <Empty> 1.1
DestMACFromVendorClassIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromVendorClassIDFilter. If DestMACFromVendorClassIDFilter is an empty string, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromVendorClassIDFilter. If the DestMACFromVendorClassIDFilter is an empty string, packets are admitted regardless of MAC address.

true 1.1
SourceMACFromClientIDFilter string­(256) W A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if it its DHCP Client Identifier (Option 61 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value. <Empty> 1.1
SourceMACFromClientIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If SourceMACFromClientIDFilter is an empty string, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If the SourceMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address.

true 1.1
DestMACFromClientIDFilter string­(256) W A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if it its DHCP Client Identifier (Option 61 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value. <Empty> 1.1
DestMACFromClientIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If DestMACFromClientIDFilter is an empty string, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If the DestMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address.

true 1.1
SourceMACFromUserClassIDFilter string­(256) W A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if it its DHCP User Class Identifier (Option 77 as defined in RFC 3004) in the most recent DHCP lease acquisition or renewal was equal to the specified value. <Empty> 1.1
SourceMACFromUserClassIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If SourceMACFromUserClassIDFilter is an empty string, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If the SourceMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address.

true 1.1
DestMACFromUserClassIDFilter string­(256) W A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if it its DHCP User Class Identifier (Option 77 as defined in RFC 3004) in the most recent DHCP lease acquisition or renewal was equal to the specified value. <Empty> 1.1
DestMACFromUserClassIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If DestMACFromUserClassIDFilter is an empty string, no packets are admitted.

If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If the DestMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address.

true 1.1
InternetGatewayDevice.Layer2Bridging.Marking.{i}. object W

Marking table identifying non-default layer-2 marking behavior for packets on egress from the specified interfaces.

At most one enabled entry in this table can exist with a given value for MarkingKey.

- 1.1
MarkingKey unsignedInt - Unique key for each Marking table entry. - 1.1
MarkingEnable boolean W Enables or disables this Marking table entry. false 1.1
MarkingStatus string -

The status of this Marking table entry. Enumeration of:

"Disabled" 1.1
MarkingBridgeReference int­[-1:] W

The BridgeKey value of the Bridge table entry associated with this Marking table entry. A value of -1 indicates the Marking table entry is not associated with a Bridge (and has no effect).

The effect of a Marking table entry applies only to packets that have been admitted to the specified bridge (regardless of the ingress interface).

-1 1.1
MarkingInterface string W

The interface or interfaces associated with this Marking table entry for which the specified marking behavior is to apply on egress from the associated bridge. The following values are defined.

To associate this Marking table entry with a single interface listed in the AvailableInterface table, the MarkingInterface value is set to the value of corresponding AvailableInterfaceKey.

  • AllInterfaces indicates that this Marking table entry is associated with all LAN and WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface or WANInterface).
  • LANInterfaces indicates that this Marking table entry is associated with all LAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface).
  • WANInterfaces indicates that this Marking table entry is associated with all WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType WANInterface).
  • an empty string indicates the Marking table entry table entry is not associated with any interface (and has no effect)

If there is more than one enabled Marking table entry that specifies one or more of the same interfaces for the same bridge (identical values of MarkingBridgeReference), then for packets on egress from the specified bridge to those interfaces, the applied marking MUST be that specified in the Marking table entry among those in conflict with the lowest MarkingKey value.

If an interface in a given bridge does not have a corresponding Marking table entry, the marking is left unchanged on egress.

<Empty> 1.1
VLANIDUntag boolean W

If true, on egress to the interfaces associated with this Marking table entry, all packets are Untagged. That is, the VLAN tag is stripped from the packet.

If false, on egress to the interfaces associated with this Marking table entry, all VLAN tags are left intact (including those added on ingress).

false 1.1
VLANIDMark int­[-1:4095] W

The 802.1Q VLAN ID to be used on egress to the interfaces associated with this Marking table entry (if VLANIDUntag is false).

A value of -1 indicates that the default VLAN ID for the Bridge should be used instead (as specified by InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID for the Bridge table entry associated with this Marking table entry).

-1 1.1
EthernetPriorityMark int­[-1:7] W Ethernet priority code (as defined in 802.1D) to mark traffic with that falls into this Bridge on egress to the interfaces associated with this Marking table entry. A value of -1 indicates no change from the incoming packet or the mark assigned by the classifier. -1 1.1
EthernetPriorityOverride boolean W

If false, on egress to the interfaces associated with this Marking table entry, the EthernetPriorityMark, if specified, is applied only to packets of priority 0.

If true, on egress to the interfaces associated with this Marking table entry, the EthernetPriorityMark, if specified, is to be applied to all packets on this Bridge.

If VLANIDUntag is true, then no priority marking is done since the tag containing the Ethernet priority is removed.

false 1.1
InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}. object -

Table containing all LAN and WAN interfaces that are available to be referenced by the Bridge table. Only interfaces that can carry layer-2 bridged traffic are included.

At most one entry in this table can exist with a given value for AvailableInterfaceKey.

- 1.1
AvailableInterfaceKey unsignedInt - Unique key for each Interface entry. - 1.1
InterfaceType string -

Whether the interface is a LAN-side or WAN-side interface, or a LAN-side or WAN-side connection to the Gateway's IP router. Enumeration of:

- 1.1
InterfaceReference string­(256) -

This table should contain a single entry for each available LAN and WAN interface.

For a WAN interface, this parameter is the full hierarchical parameter name of a particular WANConnectionDevice. A WANConnectionDevice is considered available (included in this table) only if it supports layer-2 bridged traffic. That is, this table MUST include only WANConnectionDevices that contain either a WANEthernetLinkConfig object, or that contain a WANDSLLinkConfig object for which the LinkType is EoA. For example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2

For a LAN interface, this parameter is the full hierarchical parameter name of a particular LAN**InterfaceConfig object, or a WLANConfiguration object. This table SHOULD include one entry for each such object. For example: InternetGatewayDevice.LANDevice.1.LANLANEthernetInterfaceConfig.2

For a WAN-side connection to the Gateway's IP router, this parameter is the full hierarchical parameter name of a particular WAN**Connection service. This table SHOULD include an entry for each layer-3 WAN connection. For example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1

For a LAN-side connection to the Gateway's IP router, this parameter is the full hierarchical parameter name of a particular LANDevice. This table SHOULD include an entry for each LANDevice, each of which is associated with a LAN-side layer-3 connection to the Gateway's IP router. For example: InternetGatewayDevice.LANDevice.2

- 1.1
InternetGatewayDevice.QueueManagement. object - Queue management configuration object. - 1.1
Enable boolean W Enables or disables all queuing operation. - 1.1
MaxQueues unsignedInt - The maximum number of queues supported by the CPE. Calculated as the sum of the number of different queues pointed to by Classification table. For each entry in the Classification table, the count includes a queue for each egress interface to which the corresponding classified traffic could reach. - 1.1
MaxClassificationEntries unsignedInt - The maximum number of entries available in the Classification table. - 1.1
ClassificationNumberOfEntries unsignedInt - The number of entries in the Classification table. - 1.1
MaxAppEntries unsignedInt - The maximum number of entries available in the App table. - 1.1
AppNumberOfEntries unsignedInt - The number of entries in the App table. - 1.1
MaxFlowEntries unsignedInt - The maximum number of entries available in the Flow table. - 1.1
FlowNumberOfEntries unsignedInt - The number of entries in the Flow table. - 1.1
MaxPolicerEntries unsignedInt - The maximum number of entries available in the Policer table. - 1.1
PolicerNumberOfEntries unsignedInt - The number of entries in the Policer table. - 1.1
MaxQueueEntries unsignedInt - The maximum number of entries available in the Queue table. - 1.1
QueueNumberOfEntries unsignedInt - The number of entries in the Queue table. - 1.1
DefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic not associated with any specified classifier. - 1.1
DefaultPolicer int­[-1:] W

Instance number of the Policer table entry for traffic not associated with any specified classifier.

A value of -1 indicates a null policer.

- 1.1
DefaultQueue unsignedInt W Instance number of the Queue table entry for traffic not associated with any specified classifier. - 1.1
DefaultDSCPMark int­[-2:] W

DSCP to mark traffic not associated with any specified classifier.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value as defined in [Appendix A/TR-098].

- 1.1
DefaultEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in 802.1D) to mark traffic not associated with any specified classifier.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value as defined in [Appendix A/TR-098].

- 1.1
AvailableAppList string­(1024) - Comma-separated list (maximum list length 1024) of strings. Comma-separated list of URNs, each indicating a protocol supported for use as a ProtocolIdentifier in the App table. This list may include any of the URNs defined in [Appendix A/TR-098] as well as other URNs defined elsewhere. - 1.1
InternetGatewayDevice.QueueManagement.Classification.{i}. object W Classification table. - 1.1
ClassificationKey unsignedInt - Unique key for each classification entry. - 1.1
ClassificationEnable boolean W Enables or disables this classifier. false 1.1
ClassificationStatus string -

The status of this classifier. Enumeration of:

"Disabled" 1.1
ClassificationOrder unsignedInt­[1:] W

Position of the classification entry in the order of precedence. A value of 1 indicates the first entry considered. For each packet, the highest ordered entry that matches the classification criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

- 1.1
ClassInterface string­(256) W

Classification criterion.

Specifies the LAN or WAN ingress interface associated with this entry. The content is the full hierarchical parameter name of the particular WANDevice, WANConnectionDevice, WAN**Connection, LANDevice, or LAN**InterfaceConfig object.

The following are WAN interface examples:

  • InternetGatewayDevice.WANDevice.2
  • InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1

The following are LAN interface examples:

  • InternetGatewayDevice.LANDevice.3
  • InternetGatewayDevice.LANDevice.1.LANLANEthernetInterfaceConfig.2

The string WAN indicates this entry is to apply to traffic entering from any WAN interface.

The string LAN indicates this entry is to apply to traffic entering from any LAN interface.

The string Local indicates this entry is to apply to IP-layer traffic entering from a local source within the Internet Gateway Device.

An empty string indicates this classification entry is to apply to all sources.

<Empty> 1.1
DestIP string­(45) W

[IPAddress] Classification criterion.

Destination IP address. An empty string indicates this criterion is not used for classification.

<Empty> 1.1
DestMask string­(45) W [IPAddress] Destination IP address mask. If not an empty string, only the indicated network portion of the DestIP address is to be used for classification. An empty string indicates that the full DestIP address is to be used for classification. <Empty> 1.1
DestIPExclude boolean W

If false, the class includes only those packets that match the (masked) DestIP entry, if specified.

If true, the class includes all packets except those that match the (masked) DestIP entry, if specified.

false 1.1
SourceIP string­(45) W

[IPAddress] Classification criterion.

Source IP address. An empty string indicates this criterion is not used for classification.

<Empty> 1.1
SourceMask string­(45) W [IPAddress] Source IP address mask. If not an empty string, only the indicated network portion of the SourceIP address is to be used for classification. An empty string indicates that the full SourceIP address is to be used for classification. <Empty> 1.1
SourceIPExclude boolean W

If false, the class includes only those packets that match the (masked) SourceIP entry, if specified.

If true, the class includes all packets except those that match the (masked) SourceIP entry, if specified.

false 1.1
Protocol int­[-1:] W

Classification criterion.

Protocol number. A value of -1 indicates this criterion is not used for classification.

-1 1.1
ProtocolExclude boolean W

If false, the class includes only those packets that match the Protocol entry, if specified.

If true, the class includes all packets except those that match the Protocol entry, if specified.

false 1.1
DestPort int­[-1:] W

Classification criterion.

Destination port number. A value of -1 indicates this criterion is not used for classification.

-1 1.1
DestPortRangeMax int­[-1:] W

Classification criterion.

If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort.

A value of -1 indicates that no port range is specified.

-1 1.1
DestPortExclude boolean W

If false, the class includes only those packets that match the DestPort entry (or port range), if specified.

If true, the class includes all packets except those that match the DestPort entry (or port range), if specified.

false 1.1
SourcePort int­[-1:] W

Classification criterion.

Source port number. A value of -1 indicates this criterion is not used for classification.

-1 1.1
SourcePortRangeMax int­[-1:] W

Classification criterion.

If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort.

A value of -1 indicates that no port range is specified.

-1 1.1
SourcePortExclude boolean W

If false, the class includes only those packets that match the SourcePort entry (or port range), if specified.

If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified.

false 1.1
SourceMACAddress string­(17) W

[MACAddress] Classification criterion.

Source MAC Address. An empty string indicates this criterion is not used for classification.

<Empty> 1.1
SourceMACMask string­(45) W [IPAddress] Bit-mask for the MAC address, where matching of a packet's MAC address with the SourceMACAddress is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the SourceMACAdress are to be used for classification. <Empty> 1.1
SourceMACExclude boolean W

If false, the class includes only those packets that match the (masked) SourceMACAddress entry, if specified.

If true, the class includes all packets except those that match the (masked) SourceMACAddress entry, if specified.

false 1.1
DestMACAddress string­(17) W

[MACAddress] Classification criterion.

Destination MAC Address. An empty string indicates this criterion is not used for classification.

The use of destination MAC address as a classification criterion is primarily useful only for bridged traffic.

<Empty> 1.1
DestMACMask string­(45) W [IPAddress] Bit-mask for the MAC address, where matching of a packet's MAC address with the DestMACAddress is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the DestMACAdress are to be used for classification. <Empty> 1.1
DestMACExclude boolean W

If false, the class includes only those packets that match the (masked) DestMACAddress entry, if specified.

If true, the class includes all packets except those that match the (masked) DestMACAddress entry, if specified.

false 1.1
Ethertype int­[-1:] W

Classification criterion.

Ethertype as indicated in either the Ethernet or SNAP Type header. A value of -1 indicates this criterion is not used for classification.

-1 1.1
EthertypeExclude boolean W

If false, the class includes only those packets that match the Ethertype entry, if specified.

If true, the class includes all packets except those that match the Ethertype entry, if specified.

false 1.1
SSAP int­[-1:] W

Classification criterion.

SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification.

-1 1.1
SSAPExclude boolean W

If false, the class includes only those packets that match the SSAP entry, if specified.

If true, the class includes all packets except those that match the SSAP entry, if specified.

false 1.1
DSAP int­[-1:] W

Classification criterion.

DSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification.

-1 1.1
DSAPExclude boolean W

If false, the class includes only those packets that match the DSAP entry, if specified.

If true, the class includes all packets except those that match the DSAP entry, if specified.

false 1.1
LLCControl int­[-1:] W

Classification criterion.

Control element in the LLC header. A value of -1 indicates this criterion is not used for classification.

-1 1.1
LLCControlExclude boolean W

If false, the class includes only those packets that match the LLCControl entry, if specified.

If true, the class includes all packets except those that match the LLCControl entry, if specified.

false 1.1
SNAPOUI int­[-1:] W

Classification criterion.

OUI element in the SNAP header. A value of -1 indicates this criterion is not used for classification.

-1 1.1
SNAPOUIExclude boolean W

If false, the class includes only those packets that match the SNAPOUI entry, if specified.

If true, the class includes all packets except those that match the SNAPOUI entry, if specified.

false 1.1
SourceVendorClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132.

An empty string indicates this criterion is not used for classification.

<Empty> 1.1
SourceVendorClassIDExclude boolean W

If false, the class includes only those packets sourced from LAN devices that match the SourceVendorClassID entry, if specified.

If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorClassID entry, if specified.

false 1.1
DestVendorClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132.

An empty string indicates this criterion is not used for classification.

<Empty> 1.1
DestVendorClassIDExclude boolean W

If false, the class includes only those packets destined for LAN devices that match the DestVendorClassID entry, if specified.

If true, the class includes all packets except those destined for LAN devices that match the DestVendorClassID entry, if specified.

false 1.1
SourceClientID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132.

An empty string indicates this criterion is not used for classification.

<Empty> 1.1
SourceClientIDExclude boolean W

If false, the class includes only those packets sourced from LAN devices that match the SourceClientID entry, if specified.

If true, the class includes all packets except those sourced from LAN devices that match the SourceClientID entry, if specified.

false 1.1
DestClientID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132.

An empty string indicates this criterion is not used for classification.

<Empty> 1.1
DestClientIDExclude boolean W

If false, the class includes only those packets destined for LAN devices that match the DestClientID entry, if specified.

If true, the class includes all packets except those destined for LAN devices that match the DestClientID entry, if specified.

false 1.1
SourceUserClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004.

An empty string indicates this criterion is not used for classification.

<Empty> 1.1
SourceUserClassIDExclude boolean W

If false, the class includes only those packets sourced from LAN devices that match the SourceUserClassID entry, if specified.

If true, the class includes all packets except those sourced from LAN devices that match the SourceUserClassID entry, if specified.

false 1.1
DestUserClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004.

An empty string indicates this criterion is not used for classification.

<Empty> 1.1
DestUserClassIDExclude boolean W

If false, the class includes only those packets destined for LAN devices that match the DestUserClassID entry, if specified.

If true, the class includes all packets except those destined for LAN devices that match the DestUserClassID entry, if specified.

false 1.1
TCPACK boolean W

Classification criterion.

If false, this criterion is not used for classification.

If true, this criterion matches with all TCP segments that have the ACK control bit set.

false 1.1
TCPACKExclude boolean W

If false, the class includes only those packets that match the TCPACK entry, if specified.

If true, the class includes all packets except those that match the TCPACK entry, if specified.

false 1.1
IPLengthMin unsignedInt W

Classification criterion.

Minimum IP Packet Length (including header) in bytes.

0 1.1
IPLengthMax unsignedInt W

Classification criterion.

Maximum IP Packet Length (including header) in bytes.

A value of zero indicates that no maximum is specified (an umlimited maximum length).

0 1.1
IPLengthExclude boolean W

If false, the class includes only those packets whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. A value of zero for both IPLengthMin and IPLengthMax allows any length packet. An equal non-zero value of IPLengthMin and IPLengthMax allows only a packet with the exact length specified.

If true, the class includes all packets except those whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax.

false 1.1
DSCPCheck int­[-1:] W

Classification criterion.

DiffServ codepoint (defined in RFC 2474).

If set to a Class Selector Codepoint (defined in RFC 2474), all DSCP values that match the first 3 bits will be considered a valid match.

A value of -1 indicates this criterion is not used for classification.

-1 1.1
DSCPExclude boolean W

If false, the class includes only those packets that match the DSCPCheck entry, if specified.

If true, the class includes all packets except those that match the DSCPCheck entry, if specified.

false 1.1
DSCPMark int­[-2:] W

Classification result.

DSCP to mark traffic with that falls into this classification entry.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value as defined in [Appendix A/TR-098].

-1 1.1
EthernetPriorityCheck int­[-1:] W

Classification criterion.

Current Ethernet priority as defined in 802.1D. A value of -1 indicates this criterion is not used for classification.

-1 1.1
EthernetPriorityExclude boolean W

If false, the class includes only those packets that match the EthernetPriorityCheck entry, if specified.

If true, the class includes all packets except those that match the EthernetPriorityCheck entry, if specified.

false 1.1
EthernetPriorityMark int­[-2:] W

Classification result.

Ethernet priority code (as defined in 802.1D) to mark traffic with that falls into this classification entry.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value as defined in [Appendix A/TR-098].

-1 1.1
VLANIDCheck int­[-1:] W

Classification criterion.

Current Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for classification.

-1 1.1
VLANIDExclude boolean W

If false, the class includes only those packets that match the VLANIDCheck entry, if specified.

If true, the class includes all packets except those that match the VLANIDCheck entry, if specified.

false 1.1
ForwardingPolicy unsignedInt W

Classification result.

Identifier of the forwarding policy associated with traffic that falls in this classification.

0 1.1
ClassPolicer int­[-1:] W

Classification result.

Instance number of the Policer table entry for traffic that falls in this classification.

A value of -1 indicates a null policer.

-1 1.1
ClassQueue int­[-1:] W

Classification result.

Instance number of the Queue table entry for traffic that falls in this classification.

A value of -1 indicates a null queue.

ClassQueue and ClassApp are mutually exclusive and one of the two must be specified. If ClassQueue is null, ClassApp must be specified, and vice versa.

-1 1.1
ClassApp int­[-1:] W

Classification result.

Instance number of the App table entry for traffic that falls in this classification.

A value of -1 indicates a null App table entry.

ClassQueue and ClassApp are mutually exclusive and one of the two must be specified. If ClassQueue is null, ClassApp must be specified, and vice versa.

-1 1.1
InternetGatewayDevice.QueueManagement.App.{i}. object W Application table. - 1.1
AppKey unsignedInt - Unique key for each App table entry. - 1.1
AppEnable boolean W Enables or disables this App table entry. false 1.1
AppStatus string -

The status of this App table entry. Enumeration of:

"Disabled" 1.1
ProtocolIdentifier string­(256) W URN identifying the protocol associated with the given application. A set of defined URNs is given in [Appendix A/TR-098]. <Empty> 1.1
AppName string­(64) W Human-readable name associated with this entry in the App table. <Empty> 1.1
AppDefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic associated with this App table entry, but not associated with any specified flow. 0 1.1
AppDefaultPolicer int­[-1:] W

Instance number of the Policer table entry for traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates a null policer.

-1 1.1
AppDefaultQueue int­[-1:] W

Instance number of the Queue table entry for traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates a null queue.

-1 1.1
AppDefaultDSCPMark int­[-2:] W

DSCP to mark traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value as defined in [Appendix A/TR-098].

-1 1.1
AppDefaultEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in 802.1D) to mark traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value as defined in [Appendix A/TR-098].

-1 1.1
InternetGatewayDevice.QueueManagement.Flow.{i}. object W Flow table. - 1.1
FlowKey unsignedInt - Unique key for each Flow table entry. - 1.1
FlowEnable boolean W Enables or disables this Flow table entry. false 1.1
FlowStatus string -

The status of this Flow table entry. Enumeration of:

"Disabled" 1.1
FlowType string­(256) W URN identifying the type of flow to be associated with the specified queue and policer. A set of defined URNs is given in [Appendix A/TR-098]. <Empty> 1.1
FlowTypeParameters string­(256) W List of name-value pairs representing additional criteria to identify the flow type. The use and interpretation is specific to the particular FlowType URN.Encoded using the "x-www-form-urlencoded" content type defined in [HTML4.01]. <Empty> 1.1
FlowName string­(64) W Human-readable name associated with this entry in the Flow table. <Empty> 1.1
AppIdentifier int­[-1:] W Instance number of the App table entry associated with this flow. A value of -1 indicates the flow table is not associated with any App table entry. -1 1.1
FlowForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with this flow. 0 1.1
FlowPolicer int­[-1:] W

Instance number of the Policer table entry for traffic that falls in this flow.

A value of -1 indicates a null policer.

-1 1.1
FlowQueue int­[-1:] W

Instance number of the Queue table entry for traffic that falls in this flow.

A value of -1 indicates a null queue.

-1 1.1
FlowDSCPMark int­[-2:] W

DSCP to mark traffic with that falls into this flow.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value as defined in [Appendix A/TR-098].

-1 1.1
FlowEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in 802.1D) to mark traffic with that falls into this flow.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value as defined in [Appendix A/TR-098].

-1 1.1
InternetGatewayDevice.QueueManagement.Policer.{i}. object W Policer table. - 1.1
PolicerKey unsignedInt - Unique key for each policer entry. - 1.1
PolicerEnable boolean W Enables or disables this policer. false 1.1
PolicerStatus string -

The status of this policer. Enumeration of:

"Disabled" 1.1
CommittedRate unsignedInt W Committed rate allowed for this policer in bits-per-second. 0 1.1
CommittedBurstSize unsignedInt W Committed Burstsize in bytes. 0 1.1
ExcessBurstSize unsignedInt W

Excess Burstsize in bytes.

Applied for a SingleRateThreeColor meter.

0 1.1
PeakRate unsignedInt W

Peak rate allowed for this Meter in bits-per-second.

Applied for TwoRateThreeColor meters.

0 1.1
PeakBurstSize unsignedInt W

Peak Burstsize in bytes.

Applied for TwoRateThreeColor meters.

0 1.1
MeterType string W

Identifies the method of traffic measurement to be used for this policer. Enumeration of:

SimpleTokenBucket makes use of CommittedRate and CommittedBurstSize.

SingleRateThreeColor makes use of CommittedRate, CommittedBurstSize, and ExcessBurstSize as defined in RFC 2697.

TwoRateThreeColor makes use of CommittedRate, CommittedBurstSize, PeakRate, and PeakBurstSize as defined in RFC 2698.

"Simple­Token­Bucket" 1.1
PossibleMeterTypes string -

Comma-separated list of strings. Supported meter types. Each list item is an enumeration of:

- 1.1
ConformingAction string W

Instructions for how to handle traffic that is conforming. Possible patterns:

Null corresponds with no action.

A Count action increases the meter instance count statistics.

<DSCP Value> is an unsigned integer that corresponds with a mark action overwriting the traffic's DSCP with the configured DSCP.

"Null" 1.1
PartialConformingAction string W

Instructions for how to handle traffic that is partially conforming (colored yellow). Possible patterns:

Null corresponds with no action.

A Count action increases the meter instance count statistics.

<DSCP Value> is an unsigned integer that corresponds with a mark action overwriting the traffic's DSCP with the configured DSCP.Only applies for three-color meters.

"Drop" 1.1
NonConformingAction string W

Instructions for how to handle traffic that is non-conforming. Possible patterns:

Null corresponds with no action.

A Count action increases the meter instance count statistics.

<DSCP Value> is an unsigned integer that corresponds with a mark action overwriting the traffic's DSCP with the configured DSCP.

"Drop" 1.1
CountedPackets unsignedInt - Number of Packets counted as result of a count meter action. 0 1.1
CountedBytes unsignedInt - Number of Bytes counted as result of a count meter action. 0 1.1
InternetGatewayDevice.QueueManagement.Queue.{i}. object W Queue table. - 1.1
QueueKey unsignedInt - Unique key for each queue entry. - 1.1
QueueEnable boolean W Enables or disables this queue. false 1.1
QueueStatus string -

The status of this queue. Enumeration of:

"Disabled" 1.1
QueueInterface string­(256) W

Egress interfaces for which the specified queue must exist. This parameter must be in one of the following forms:

  • The full hierarchical parameter name of the particular WANDevice, WANConnectionDevice, WAN**Connection, LANDevice, or LAN**InterfaceConfig object.
  • The string WAN, which indicates this entry applies to all WAN interfaces.
  • The string LAN, which indicates this entry applies to all LAN interfaces.
  • an empty string, which indicates this classification entry is to apply to all interfaces.

Packets classified into this queue that exit through any other interface must instead use the default queuing behavior specified in the Queue table entry referenced by InternetGatewayDevice.QueueManagement.DefaultQueue.

For the default queue itself (the Queue table entry referenced by InternetGatewayDevice.QueueManagement.DefaultQueue), the value of the QueueInterface parameter MUST be ignored. That is, the default queue must exist on all egress interfaces.

<Empty> 1.1
QueueBufferLength unsignedInt - Number of bytes in the buffer. - 1.1
QueueWeight unsignedInt W Weight of this queue in case of WFQ or WRR, but only used for queues of equal precedence. 0 1.1
QueuePrecedence unsignedInt­[1:] W Precedence of this queue relative to others. Lower numbers imply greater precedence. 1 1.1
REDThreshold unsignedInt W Random Early Discard threshold; in case the DropAlgorithm is RED, this is the threshold to use. 0 1.1
REDPercentage unsignedInt W Random Early Discard percentage; in case the DropAlgorithm is RED, this is the percentage to use. 0 1.1
DropAlgorithm string W

Dropping algorithm used for this queue if congested. Enumeration of:

"DT" 1.1
SchedulerAlgorithm string W

Scheduling Algorithm used by scheduler. Enumeration of:

"SP" 1.1
ShapingRate int­[-1:] W

Rate to shape this queue's traffic.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. The rate is limited over the window period specified by ShapeWindow?.

If > 100, in bits per second.

A value of -1 indicates no shaping.

-1 1.1
ShapingBurstSize unsignedInt W Burst Size in bytes. 0 1.1
InternetGatewayDevice.LANConfigSecurity. object - This object contains generic device configuration information. - 1.0
ConfigPassword string­(64) W

A password to allow LAN access to protected auto-configuration services.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
InternetGatewayDevice.IPPingDiagnostics. object - This object is provides access to an IP-layer ping test. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

Value may be set to Requested to initiate the diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

- 1.0
Interface string­(256) W

Specifies the WAN or LAN IP-layer interface over which the test is to be performed. The content is the full hierarchical parameter name of the interface.

The following is a WAN interface example:

InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1

The following is a LAN interface example:

InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1
- 1.0
Host string­(256) W Host name or address of the host to ping. - 1.0
NumberOfRepetitions unsignedInt­[1:] W Number of repetitions of the ping test to perform before reporting the results. - 1.0
Timeout unsignedInt­[1:] W Timeout in milliseconds for the ping test. - 1.0
DataBlockSize unsignedInt­[1:65535] W Size of the data block in bytes to be sent for each ping. - 1.0
DSCP unsignedInt­[0:63] W DiffServ codepoint to be used for the test packets. By default the CPE should set this value to zero. - 1.0
SuccessCount unsignedInt - Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 1.0
FailureCount unsignedInt - Result parameter indicating the number of failed pings in the most recent ping test. - 1.0
AverageResponseTime unsignedInt - Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MinimumResponseTime unsignedInt - Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.1
MaximumResponseTime unsignedInt - Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
InternetGatewayDevice.LANDevice.{i}. object - Each instance contains all LAN-related objects for a given bridged subnet. - 1.0
LANEthernetInterfaceNumberOfEntries unsignedInt - Number of instances of LANEthernetInterfaceConfig in this LANDevice. - 1.0
LANUSBInterfaceNumberOfEntries unsignedInt - Number of instances of LANUSBInterfaceConfig in this LANDevice. - 1.0
LANWLANConfigurationNumberOfEntries unsignedInt - Number of instances of WLANConfiguration in this LANDevice. - 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. object - This object enables reporting of LAN-related device information and setting and configuring LAN IP addressing. - 1.0
DHCPServerConfigurable boolean W Enables the configuration of the DHCP server on the LAN interface. If this variable is set to false, the CPE should restore its default DHCP server settings. - 1.0
DHCPServerEnable boolean W Enables or disables the DHCP server on the LAN interface. - 1.0
DHCPRelay boolean - Indicates if the DHCP server performs the role of a server (0) or a relay (1) on the LAN interface. - 1.0
MinAddress string­(45) W [IPAddress] Specifies first address in the pool to be assigned by the DHCP server on the LAN interface. - 1.0
MaxAddress string­(45) W [IPAddress] Specifies last address in the pool to be assigned by the DHCP server on the LAN interface. - 1.0
ReservedAddresses string W [IPAddress] Comma-separated list of IPAddresses. Comma separated list of addresses marked reserved from the address allocation pool. - 1.0
SubnetMask string­(45) W [IPAddress] Specifies the client's network subnet mask. - 1.0
DNSServers string W [IPAddress] Comma-separated list of IPAddresses. Comma separated list of DNS servers offered to DHCP clients. Support for more than three DNS Servers is Optional. - 1.0
DomainName string­(64) W Sets the domain name to provide to clients on the LAN interface. - 1.0
IPRouters string W [IPAddress] Comma-separated list of IPAddresses. Comma separated list of IP addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is Optional. - 1.0
DHCPLeaseTime int­[-1:] W Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease. - 1.0
UseAllocatedWAN string W

Enumeration of:

If Normal, then DHCP addresses are to be allocated out of a private address pool.

If UseAllocatedSubnet, instructs the CPE to allocate DHCP addresses from the WAN subnet block for the WAN connection identified in AssociatedConnection.

If Passthrough, then the specified LAN Host identified by the Passthrough MAC address is given the WAN IP address.

- 1.0
AssociatedConnection string­(256) W Specifies the connection instance for the connection to be used for address allocation if UseAllocatedWAN is set to UseAllocatedSubnet or Passthrough. The content is the full hierarchical parameter name of the default layer-3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
PassthroughLease unsignedInt W

DHCP lease time in seconds given to the specified LAN Host when the WAN IP address is passed-through.

Note: A temporary private IP address with short lease (for example, 1 min) may be given to the passthrough LAN Host before the WAN IP address is acquired.

- 1.0
PassthroughMACAddress string­(17) W [MACAddress] Hardware address of the LAN Host that is used to passthrough the WAN IP address if UseAllocatedWAN is Passthrough. - 1.0
AllowedMACAddresses string W [MACAddress] Comma-separated list of MACAddresses. Hardware addresses that are allowed to connect to this connection if MACAddressControlEnabled is 1 for a given interface. - 1.0
IPInterfaceNumberOfEntries unsignedInt - Number of IP interface at LAN side of the CPE. 1 is a typical value for CPE not supporting Multihomed interfaces. Support for more than one interface instance is Optional. - 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}. object W

IP interface table.

At most one enabled entry in this table can exist with the same values for IPInterfaceIPAddress and IPInterfaceSubnetMask.

- 1.0
Enable boolean W Enables or disables this entry. On creation, an entry is disabled by default. false 1.0
IPInterfaceIPAddress string­(45) W [IPAddress] IP address of the LAN-side interface of the CPE. - 1.0
IPInterfaceSubnetMask string­(45) W [IPAddress] Subnet mask of the LAN-side interface of the IGD. - 1.0
IPInterfaceAddressingType string W

Represents the addressing method used to assign the LAN-side IP address of the CPE on this interface. Enumeration of:

- 1.0
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}. object -

This object models an Ethernet LAN connection on a CPE device. This object must be implemented for CPE that contain an Ethernet interface on the LAN side.

At most one entry in this table can exist with a given value for MACAddress.

- 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

- 1.0
MACAddress string­(17) - [MACAddress] The physical address of the interface. - 1.0
MACAddressControlEnabled boolean W Indicates whether MAC Address Control is enabled or not on this interface. MAC Address Control limits the clients that connect to those that match a list of allowed MAC addresses specified in InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses. - 1.0
MaxBitRate string W

The maximum upstream and downstream bit rate available to this connection. Enumeration of:

- 1.0
DuplexMode string W

The duplex mode available to this connection. Enumeration of:

- 1.0
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats. object - This object contains statistics for an Ethernet LAN interface on a CPE device. - 1.0
BytesSent unsignedInt - Total number of bytes sent over the interface since the CPE was last reset. - 1.0
BytesReceived unsignedInt - Total number of bytes received over the interface since the CPE was last reset. - 1.0
PacketsSent unsignedInt - Total number of packets sent over the interface since the CPE was last reset. - 1.0
PacketsReceived unsignedInt - Total number of packets received over the interface since the CPE was last reset. - 1.0
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}. object -

This object models a USB LAN connection on a CPE device. This object must be implemented for CPE that contain a USB interface on the LAN side.

At most one entry in this table can exist with a given value for MACAddress.

- 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

- 1.0
MACAddress string­(17) - [MACAddress] The physical address of the interface. - 1.0
MACAddressControlEnabled boolean W Indicates whether MAC Address Control is enabled or not on this interface. MAC Address Control limits the clients that connect to those that match a list of allowed MAC addresses specified in InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses. - 1.0
Standard string­(6) - USB version supported by the device. - 1.0
Type string -

Type of the USB interface. Enumeration of:

- 1.0
Rate string -

Speed of the USB interface. Enumeration of:

- 1.0
Power string -

Power configuration of the USB interface. Enumeration of:

- 1.0
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats. object - This object contains statistics for a USB LAN interface on a CPE device. - 1.0
BytesSent unsignedInt - Total number of bytes sent over the interface since the CPE was last reset. - 1.0
BytesReceived unsignedInt - Total number of bytes received over the interface since the CPE was last reset. - 1.0
CellsSent unsignedInt - Total number of cells sent over the interface since the CPE was last reset. - 1.0
CellsReceived unsignedInt - Total number of cells received over the interface since the CPE was last reset. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. object -

This object models an 802.11 LAN connection on a CPE device. This object must be implemented for CPE that contain an 802.11 interface on the LAN side.

At most one entry in this table can exist with a given value for BSSID, or with a given value for SSID.

- 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

- 1.0
BSSID string - The MAC address of the interface. - 1.0
MaxBitRate string­(4) W The maximum upstream and downstream bit rate available to this connection in Mbps. Either Auto, or the largest of the OperationalDataTransmitRates values. - 1.0
Channel unsignedInt­[0:255] W The current radio channel used by the connection. Note: There is currently no way of requesting automatic selection of a channel. - 1.0
SSID string­(32) W The current service set identifier in use by the connection. The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as a "password" for joining a particular radio network (BSS). Note: If an access point wishes to be known by more than one SSID, it must provide a WLANConfiguration instance for each SSID. - 1.0
BeaconType string W

The breacon types to be use with this connection. Enumeration of:

- 1.0
MACAddressControlEnabled boolean W Indicates whether MAC Address Control is enabled or not on this interface. MAC Address Control limits the clients that connect to those that match a list of allowed MAC addresses specified in InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses. - 1.0
Standard string -

Indicates which IEEE 802.11 mode the device is currently operating in. Enumeration of:

- 1.0
WEPKeyIndex unsignedInt­[1:4] W The index of the default WEP key. - 1.0
KeyPassphrase string­(63) W

A passphrase from which the WEP keys were generated. This parameter for information only-the CPE is not responsible for generating the key based on the passphrase.

This parameter is the same as the parameter InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.KeyPassprhase? for the same instance of WLANConfiguration. When either parameter is changed, the value of the other is changed as well.

This must either be a valid key length divided by 8, in which case each byte contributes 8 bits to the key, or else must consist of Hex digits and be a valid key length divided by 4, in which case each byte contributes 4 bits to the key.

Note: If a passphrase is used, all four WEP keys will be the same.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
WEPEncryptionLevel string­(64) -

Comma-separated list (maximum list length 64) of strings. Supported key lengths. Each list item is an enumeration of:

Any additional vendor-specific values must start with the key length in bits.

- 1.0
BasicEncryptionModes string­(31) W

Encryption modes that are available when basic 802.11 is enabled. WEPEncryption implies that all wireless clients can use WEP for data encryption. Enumeration of:

- 1.0
BasicAuthenticationMode string­(31) W

Authentication modes that are available when basic 802.11 is enabled. Enumeration of:

- 1.0
WPAEncryptionModes string­(31) W

Encryption modes that are available when WPA is enabled. Enumeration of:

- 1.0
WPAAuthenticationMode string­(31) W

Authentication modes that are available when WPA is enabled. Enumeration of:

- 1.0
IEEE11iEncryptionModes string­(31) W

Encryption modes that are available when 802.11i is enabled. Enumeration of:

- 1.0
IEEE11iAuthenticationMode string­(31) W

Authentication modes that are available when 802.11i is enabled. Enumeration of:

- 1.0
PossibleChannels string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Possible radio channels for the wireless standard (a, b or g) and the regulatory domain.

Ranges in the form "n-m" are permitted.

For example, for 802.11b and North America, would be "1-11".

- 1.0
BasicDataTransmitRates string­(256) W

Comma-separated list (maximum list length 256) of strings. Maximum access point data transmit rates in Mbps for unicast, multicast and broadcast frames.

For example, a value of "1,2", indicates that unicast, multicast and broadcast frames can be transmitted at 1 Mbps and 2 Mbps.

- 1.0
OperationalDataTransmitRates string­(256) W

Comma-separated list (maximum list length 256) of strings. Maximum access point data transmit rates in Mbps for unicast frames (a superset of BasicDataTransmitRates).

Given the value of BasicDataTransmitRates from the example above, OperationalDataTransmitRates might be "1,2,5.5,11", indicating that unicast frames can additionally be transmitted at 5.5 Mbps and 11 Mbps.

- 1.0
PossibleDataTransmitRates string­(256) -

Comma-separated list (maximum list length 256) of strings. Data transmit rates for unicast frames at which the access point will permit a station to connect (a subset of OperationalDataTransmitRates).

Given the values of BasicDataTransmitRates and OperationalDataTransmitRates from the examples above, PossibleDataTransmitRates might be "1,2,5.5", indicating that the AP will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps, even though it could theoretically accept connections at 11 Mbps.

- 1.0
InsecureOOBAccessEnabled boolean W Indicates whether insecure write access via mechanisms other than the CPE WAN Management Protocol is permitted to the parameters in this object. - 1.0
BeaconAdvertisementEnabled boolean W Indicates whether or not the access point is sending out beacons. - 1.0
RadioEnabled boolean W Indicates whether or not the access point radio is enabled. - 1.0
AutoRateFallBackEnabled boolean W Indicates whether the access point can automatically reduce the data rate in the event of undue noise or contention. - 1.0
LocationDescription string­(4096) W An XML description of information used to identify the access point by name and physical location. The CPE is not expected to parse this string, but simply to treat it as an opaque string. An empty string indicates no location has been set. - 1.0
RegulatoryDomain string­(3) W 802.11d Regulatory Domain String. First two octets are ISO/IEC 3166-1 two-character country code. The third octet is either " " (all environments), "O" (outside) or "I" (inside). - 1.0
TotalPSKFailures unsignedInt - The number of times pre-shared key (PSK) authentication has failed (relevant only to WPA and 802.11i). - 1.0
TotalIntegrityFailures unsignedInt - The number of times the MICHAEL integrity check has failed (relevant only to WPA and 802.11i) - 1.0
ChannelsInUse string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Channels that the access point determines to be currently in use (including any that it is using itself).

Ranges in the form "n-m" are permitted.

- 1.0
DeviceOperationMode string­(31) W

The current access-point operating mode. The optional modes permit the AP to be configured as a wireless bridge (to bridge two wired networks), repeater (a bridge that also serves wireless clients), or wireless station. Ad hoc stations are not supported. Enumeration of:

- 1.0
DistanceFromRoot unsignedInt W The number of hops from the root access point to the wireless repeater or bridge. - 1.0
PeerBSSID string W The MAC address of the peer in wireless repeater or bridge mode. - 1.0
AuthenticationServiceMode string W

Indicates whether another service is involved in client authentication (LinkAuthentication for a co-located authentication server; RadiusClient for an external RADIUS server). Enumeration of:

- 1.0
TotalBytesSent unsignedInt - Total number of bytes sent over the interface since the CPE was last reset. - 1.0
TotalBytesReceived unsignedInt - Total number of bytes received over the interface since the CPE was last reset. - 1.0
TotalPacketsSent unsignedInt - Total number of packets sent over the interface since the CPE was last reset. - 1.0
TotalPacketsReceived unsignedInt - Total number of packets received over the interface since the CPE was last reset. - 1.0
TotalAssociations unsignedInt - The number of devices currently associated with the access point. This corresponds to the number of entries in the AssociatedDeivce? table. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}. object -

A table of the devices currently associated with the access point. The size of this table is given by InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.TotalAssociations. This object must be implemented for CPE that contain an 802.11 interface on the LAN side.

At most one entry in this table can exist with a given value for AssociatedDeviceMACAddress.

- 1.0
AssociatedDeviceMACAddress string­(17) - [MACAddress] The MAC address of an associated device. - 1.0
AssociatedDeviceIPAddress string­(64) - The IP address or DNS name of an associated device. - 1.0
AssociatedDeviceAuthenticationState boolean - Whether an associated device has authenticated (true) or not (false). - 1.0
LastRequestedUnicastCipher string­(256) - The unicast cipher that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastRequestedMulticastCipher string­(256) - The multicast cipher that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastPMKId string­(256) - The pairwise master key (PMK) that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WEPKey.{i}. object -

This is a table of WEP keys. The size of this table is fixed with exactly 4 entries (with instance numbers 1 through 4). This object must be implemented for CPE that contain an 802.11 interface on the LAN side.

This table MUST contain exactly 4 entries.

- 1.0
WEPKey string­(128) W

A WEP key expressed as a hexadecimal string. The WEP encryption level is inferred from the key length, e.g. 10 characters for 40-bit encryption, or 26 characters for 104-bit encryption.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.{i}. object -

This is a table of preshared keys. The size of this table is fixed with exactly 10 entries (with instance numbers 1 through 10). This object must be implemented for CPE that contain an 802.11 interface on the LAN side.

This table MUST contain exactly 10 entries.

- 1.0
PreSharedKey string­(64) W

A literal WPA PSK expressed as a hexadecimal string.

The first table entry contains the default PreSharedKey (InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.PreSharedKey).

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
KeyPassphrase string­(63) W

A passphrase from which WEP or PSK keys were generated. This parameter for information only-the CPE is not responsible for generating the key based on the passphrase.

For WEP keys it must either be a valid key length divided by 8, in which case each byte contributes 8 bits to the key, or else must consist of Hex digits and be a valid key length divided by 4, in which case each byte contributes 4 bits to the key.

For WPA PSK, the key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 (RFC2898)..

Note: The 802.11i standard specifies rules for generation of WEP keys from a passphrase.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
AssociatedDeviceMACAddress string­(17) W [MACAddress] The MAC address associated with a preshared key, or an empty string if no MAC address is associated with the key. - 1.0
InternetGatewayDevice.LANDevice.{i}.Hosts. object - This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. - 1.0
HostNumberOfEntries unsignedInt - Number of entries in the Host table. - 1.0
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}. object -

Host table.

At most one entry in this table can exist with a given value for MACAddress.

- 1.0
IPAddress string­(45) - [IPAddress] Current IP Address of the host. - 1.0
AddressSource string -

Indicates whether the IP address of the host was allocated by the CPE using DHCP, was assigned to the host statically, or was assigned using automatic IP address allocation. Enumeration of:

- 1.0
LeaseTimeRemaining int­[-1:] - DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease. The value must be 0 (zero) if the AddressSource is not DHCP. - 1.0
MACAddress string­(17) - [MACAddress] MAC address of the host. - 1.0
HostName string­(64) - The device's host name or an empty string if unknown. - 1.0
InterfaceType string -

Type of physical interface through which this host is connected to the CPE. Enumeration of:

- 1.0
Active boolean -

Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE.

The ability to list inactive hosts is Optional. If the CPE includes inactive hosts in this table, this variable MUST be set to zero for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE.

- 1.0
InternetGatewayDevice.WANDevice.{i}. object - Each instance contains all objects associated with a particular physical WAN interface. - 1.0
WANConnectionNumberOfEntries unsignedInt - Number of instances of WANConnectionDevice in this WANDevice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig. object - This object models WAN interface properties common across all connection instances. - 1.0
EnabledForInternet boolean W Used to enable or disable access to and from the Internet across all connection instances. - 1.0
WANAccessType string -

Specifies the WAN access (modem) type. Enumeration of:

- 1.0
Layer1UpstreamMaxBitRate unsignedInt - Specifies the maximum upstream theoretical bit rate for the WAN device in bits per second. - 1.0
Layer1DownstreamMaxBitRate unsignedInt - Specifies the maximum downstream theoretical bit rate for the WAN device in bits per second. - 1.0
PhysicalLinkStatus string -

Indicates the state of the physical connection (link) from WANDevice to a connected entity. Enumeration of:

- 1.0
WANAccessProvider string­(256) - Name of the Service Provider providing link connectivity on the WAN. - 1.0
TotalBytesSent unsignedInt - The cumulative counter for total number of bytes sent upstream across all connection service instances on the WAN device. - 1.0
TotalBytesReceived unsignedInt - The cumulative counter for total number of bytes received downstream across all connection service instances on the WAN device. - 1.0
TotalPacketsSent unsignedInt - The cumulative counter for total number of packets (IP or PPP) sent upstream across all connection service instances on the WAN device. - 1.0
TotalPacketsReceived unsignedInt - The cumulative counter for total number of packets (IP or PPP) received downstream across all connection service instances on the WAN device. - 1.0
MaximumActiveConnections unsignedInt - Indicates the maximum number of active connections the CPE can simultaneously support. - 1.0
NumberOfActiveConnections unsignedInt - Number of WAN connection service instances currently active on this WAN interface. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.Connection.{i}. object -

Active connection table.

At most one entry in this table can exist with a given value for ActiveConnectionServiceID.

- 1.0
ActiveConnectionDeviceContainer string­(256) - Specifies a WAN connection device object associated with this connection instance. The content is the full hierarchical parameter name of the WAN connection device. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2. - 1.0
ActiveConnectionServiceID string­(256) - Specifies a WAN connection object associated with this connection instance. The content is the full hierarchical parameter name of the layer-3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig. object - This object models physical layer properties specific to a single physical connection of a DSL modem used for Internet access on a CPE. This object is required for a CPE with a DSL modem WAN interface, and is exclusive of any other WAN*InterfaceConfig object within a given WANDevice instance. - 1.0
Enable boolean W Enables or disables the link. - 1.0
Status string -

Status of the DSL physical link. Enumeration of:

- 1.0
ModulationType string -

Indicates the type of modulation used on the connection. Enumeration of:

- 1.0
LineEncoding string -

The line encoding method used in establishing the Layer 1 DSL connection between the CPE and the DSLAM. Note: Generally speaking, this variable does not change after provisioning. Enumeration of:

- 1.0
DataPath string -

Indicates whether the data path is fast (lower latency) or interleaved (lower error rate). Enumeration of:

- 1.0
InterleaveDepth unsignedInt - ADSL Interleaved depth. This variable is only applicable if DataPath = Interleaved. - 1.0
LineNumber int­[1:] - Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 1.0
UpstreamCurrRate unsignedInt - The current payload bandwidth (expressed in Kbps) of the upstream DSL channel. - 1.0
DownstreamCurrRate unsignedInt - The current payload bandwidth (expressed in Kbps) of the downstream DSL channel. - 1.0
UpstreamMaxRate unsignedInt - The current attainable rate (expressed in Kbps) of the upstream DSL channel. - 1.0
DownstreamMaxRate unsignedInt - The current attainable rate (expressed in Kbps) of the downstream DSL channel. - 1.0
UpstreamNoiseMargin int - The current signal-to-noise ratio (expressed in 0.1 db) of the upstream DSL connection. - 1.0
DownstreamNoiseMargin int - The current signal-to-noise ratio (expressed in 0.1 db) of the downstream DSL connection. - 1.0
UpstreamAttenuation int - The current upstream signal loss (expressed in 0.1 dB). - 1.0
DownstreamAttenuation int - The current downstream signal loss (expressed in 0.1 dB). - 1.0
UpstreamPower int - The current output power at the CPE's DSL interface (expressed in 0.1 dBmV), - 1.0
DownstreamPower int - The current received power at the CPE's DSL interface (expressed in 0.1 dBmV), - 1.0
ATURVendor string­(8) - ATU-R vendor identifier as defined in G.994.1 and T1.413. - 1.0
ATURCountry unsignedInt - T.35 country code of the ATU-R vendor as defined in G.994.1. - 1.0
ATURANSIStd unsignedInt - ATU-R T1.413 Revision Number as defined in T1.413 Issue 2. - 1.0
ATURANSIRev unsignedInt - ATU-R Vendor Revision Number as defined in T1.413 Issue 2. - 1.0
ATUCVendor string­(8) - ATU-C vendor identifier as defined in G.994.1 and T1.413. - 1.0
ATUCCountry unsignedInt - T.35 country code of the ATU-C vendor as defined in G.994.1. - 1.0
ATUCANSIStd unsignedInt - ATU-C T1.413 Revision Number as defined in T1.413 Issue 2. - 1.0
ATUCANSIRev unsignedInt - ATU-C Vendor Revision Number as defined in T1.413 Issue 2. - 1.0
TotalStart unsignedInt -

Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.

- 1.0
ShowtimeStart unsignedInt -

Number of seconds since the most recent DSL Showtime-the beginning of the period used for collection of Showtime statistics.

Number of seconds since the most recent DSL Showtime-the beginning of the period used for collection of Showtime[RFC2616] statistics.

- 1.0
LastShowtimeStart unsignedInt -

Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

- 1.0
CurrentDayStart unsignedInt -

Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.

- 1.0
QuarterHourStart unsignedInt -

Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.

- 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats. object - This object contains statistics for a WAN DSL physical interface. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Total. object - This object contains DSL total statistics. - 1.0
ReceiveBlocks unsignedInt - Total number of successfully received blocks. - 1.0
TransmitBlocks unsignedInt - Total number of successfully transmitted blocks. - 1.0
CellDelin unsignedInt - Total number of cell-delineation errors (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). - 1.0
LinkRetrain unsignedInt - Total number of link-retrain errors (Full Initialization Count as defined in ITU-T Rec. G.997.1). - 1.0
InitErrors unsignedInt - Total number of initialization errors (LINIT failures as defined in ITU-T Rec. G.997.1). - 1.0
InitTimeouts unsignedInt - Total number of initialization timeout errors. - 1.0
LossOfFraming unsignedInt - Total number of loss-of-framing errors (LOF failures as defined in ITU-T Rec. G.997.1). - 1.0
ErroredSecs unsignedInt - Total number of errored seconds (ES-L as defined in ITU-T Rec. G.997.1). - 1.0
SeverelyErroredSecs unsignedInt - Total number of severely errored seconds (SES-L as defined in ITU-T Rec. G.997.1). - 1.0
FECErrors unsignedInt - Total number of FEC errors detected (FEC-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCFECErrors unsignedInt - Total number of FEC errors detected by the ATU-C (FEC-CFE as defined in ITU-T Rec. G.997.1). - 1.0
HECErrors unsignedInt - Total number of HEC errors detected (HEC-P as defined in ITU-T Rec. G.997.1). - 1.0
ATUCHECErrors unsignedInt - Total number of HEC errors detected by the ATU-C (HEC-PFE as defined in ITU-T Rec. G.997.1). - 1.0
CRCErrors unsignedInt - Total number of CRC errors detected (CV-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCCRCErrors unsignedInt - Total number of CRC errors detected by the ATU-C (CV-CFE as defined in ITU-T Rec. G.997.1). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Showtime. object - This object contains DSL statistics accumulated since the most recent DSL Showtime. - 1.0
ReceiveBlocks unsignedInt - Number of successfully received blocks since the most recent DSL Showtime. - 1.0
TransmitBlocks unsignedInt - Number of successfully transmitted blocks since the most recent DSL Showtime. - 1.0
CellDelin unsignedInt - Number of cell-delineation errors since the most recent DSL Showtime (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). - 1.0
LinkRetrain unsignedInt - Number of link-retrain errors since the most recent DSL Showtime (Full Initialization Count as defined in ITU-T Rec. G.997.1). - 1.0
InitErrors unsignedInt - Number of initialization errors since the most recent DSL Showtime (LINIT failures as defined in ITU-T Rec. G.997.1). - 1.0
InitTimeouts unsignedInt - Number of initialization timeout errors since the most recent DSL Showtime. - 1.0
LossOfFraming unsignedInt - Number of loss-of-framing errors since the most recent DSL Showtime (LOF failures as defined in ITU-T Rec. G.997.1). - 1.0
ErroredSecs unsignedInt - Number of errored seconds since the most recent DSL Showtime (ES-L as defined in ITU-T Rec. G.997.1). - 1.0
SeverelyErroredSecs unsignedInt - Number of severely errored seconds since the most recent DSL Showtime (SES-L as defined in ITU-T Rec. G.997.1). - 1.0
FECErrors unsignedInt - Number of FEC errors detected since the most recent DSL Showtime (FEC-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCFECErrors unsignedInt - Number of FEC errors detected by the ATU-C since the most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. G.997.1). - 1.0
HECErrors unsignedInt - Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. G.997.1). - 1.0
ATUCHECErrors unsignedInt - Number of HEC errors detected by the ATU-C since the most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. G.997.1). - 1.0
CRCErrors unsignedInt - Number of CRC errors detected since the most recent DSL Showtime (CV-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCCRCErrors unsignedInt - Number of CRC errors detected by the ATU-C since the most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. G.997.1). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.LastShowtime. object - This object contains DSL statistics accumulated since the second most recent DSL Showtime. - 1.0
ReceiveBlocks unsignedInt - Number of successfully received blocks since the second most recent DSL Showtime. - 1.0
TransmitBlocks unsignedInt - Number of successfully transmitted blocks since the second most recent DSL Showtime. - 1.0
CellDelin unsignedInt - Number of cell-delineation errors since the second most recent DSL Showtime (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). - 1.0
LinkRetrain unsignedInt - Number of link-retrain errors since the second most recent DSL Showtime (Full Initialization Count as defined in ITU-T Rec. G.997.1). - 1.0
InitErrors unsignedInt - Number of initialization errors since the second most recent DSL Showtime (LINIT failures as defined in ITU-T Rec. G.997.1). - 1.0
InitTimeouts unsignedInt - Number of initialization timeout errors since the second most recent DSL Showtime. - 1.0
LossOfFraming unsignedInt - Number of loss-of-framing errors since the second most recent DSL Showtime (LOF failures as defined in ITU-T Rec. G.997.1). - 1.0
ErroredSecs unsignedInt - Number of errored seconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. G.997.1). - 1.0
SeverelyErroredSecs unsignedInt - Number of severely errored seconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. G.997.1). - 1.0
FECErrors unsignedInt - Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCFECErrors unsignedInt - Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. G.997.1). - 1.0
HECErrors unsignedInt - Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. G.997.1). - 1.0
ATUCHECErrors unsignedInt - Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. G.997.1). - 1.0
CRCErrors unsignedInt - Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCCRCErrors unsignedInt - Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. G.997.1). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.CurrentDay. object - This object contains DSL statistics accumulated during the current day. - 1.0
ReceiveBlocks unsignedInt - Number of successfully received blocks during the current day. - 1.0
TransmitBlocks unsignedInt - Number of successfully transmitted blocks during the current day. - 1.0
CellDelin unsignedInt - Number of cell-delineation errors during the current day (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). - 1.0
LinkRetrain unsignedInt - Number of link-retrain errors during the current day (Full Initialization Count as defined in ITU-T Rec. G.997.1). - 1.0
InitErrors unsignedInt - Number of initialization errors during the current day (LINIT failures as defined in ITU-T Rec. G.997.1). - 1.0
InitTimeouts unsignedInt - Number of initialization timeout errors during the current day. - 1.0
LossOfFraming unsignedInt - Number of loss-of-framing errors during the current day (LOF failures as defined in ITU-T Rec. G.997.1). - 1.0
ErroredSecs unsignedInt - Number of errored seconds during the current day (ES-L as defined in ITU-T Rec. G.997.1). - 1.0
SeverelyErroredSecs unsignedInt - Number of severely errored seconds during the current day (SES-L as defined in ITU-T Rec. G.997.1). - 1.0
FECErrors unsignedInt - Number of FEC errors detected during the current day (FEC-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCFECErrors unsignedInt - Number of FEC errors detected by the ATU-C during the current day (FEC-CFE as defined in ITU-T Rec. G.997.1). - 1.0
HECErrors unsignedInt - Number of HEC errors detected during the current day (HEC-P as defined in ITU-T Rec. G.997.1). - 1.0
ATUCHECErrors unsignedInt - Number of HEC errors detected by the ATU-C during the current day (HEC-PFE as defined in ITU-T Rec. G.997.1). - 1.0
CRCErrors unsignedInt - Number of CRC errors detected during the current day (CV-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCCRCErrors unsignedInt - Number of CRC errors detected by the ATU-C during the current day (CV-CFE as defined in ITU-T Rec. G.997.1). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.QuarterHour. object - This object contains DSL statistics accumulated during the current quarter hour. - 1.0
ReceiveBlocks unsignedInt - Number of successfully received blocks during the current quarter hour. - 1.0
TransmitBlocks unsignedInt - Number of successfully transmitted blocks during the current quarter hour. - 1.0
CellDelin unsignedInt - Number of cell-delineation errors during the current quarter hour (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). - 1.0
LinkRetrain unsignedInt - Number of link-retrain errors during the current quarter hour (Full Initialization Count as defined in ITU-T Rec. G.997.1). - 1.0
InitErrors unsignedInt - Number of initialization errors during the current quarter hour (LINIT failures as defined in ITU-T Rec. G.997.1). - 1.0
InitTimeouts unsignedInt - Number of initialization timeout errors during the current quarter hour. - 1.0
LossOfFraming unsignedInt - Number of loss-of-framing errors during the current quarter hour (LOF failures as defined in ITU-T Rec. G.997.1). - 1.0
ErroredSecs unsignedInt - Number of errored seconds during the current quarter hour (ES-L as defined in ITU-T Rec. G.997.1). - 1.0
SeverelyErroredSecs unsignedInt - Number of severely errored seconds during the current quarter hour (SES-L as defined in ITU-T Rec. G.997.1). - 1.0
FECErrors unsignedInt - Number of FEC errors detected during the current quarter hour (FEC-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCFECErrors unsignedInt - Number of FEC errors detected by the ATU-C during the current quarter hour (FEC-CFE as defined in ITU-T Rec. G.997.1). - 1.0
HECErrors unsignedInt - Number of HEC errors detected during the current quarter hour (HEC-P as defined in ITU-T Rec. G.997.1). - 1.0
ATUCHECErrors unsignedInt - Number of HEC errors detected by the ATU-C during the current quarter hour (HEC-PFE as defined in ITU-T Rec. G.997.1). - 1.0
CRCErrors unsignedInt - Number of CRC errors detected during the current quarter hour (CV-C as defined in ITU-T Rec. G.997.1). - 1.0
ATUCCRCErrors unsignedInt - Number of CRC errors detected by the ATU-C during the current quarter hour (CV-CFE as defined in ITU-T Rec. G.997.1). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig. object - This object models physical layer properties specific to a single Ethernet physical connection used for Internet access on a CPE. This object is required for a CPE with an Ethernet WAN interface, and is exclusive of any other WAN*InterfaceConfig object within a given WANDevice instance. Note that this object is not related to the Ethernet protocol layer sometimes used in associated with a DSL connection. - 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

- 1.0
MACAddress string­(17) - [MACAddress] The physical address of the interface. - 1.0
MaxBitRate string W

The maximum upstream and downstream bit rate available to this connection. Enumeration of:

- 1.0
DuplexMode string W

The duplex mode available to this connection. Enumeration of:

- 1.0
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig.Stats. object - This object contains statistics for an Ethernet WAN interface on a CPE device. - 1.0
BytesSent unsignedInt - Total number of bytes sent over the interface since the CPE was last reset. - 1.0
BytesReceived unsignedInt - Total number of bytes received over the interface since the CPE was last reset. - 1.0
PacketsSent unsignedInt - Total number of packets sent over the interface since the CPE was last reset. - 1.0
PacketsReceived unsignedInt - Total number of packets received over the interface since the CPE was last reset. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLConnectionManagement. object - This object is required for a CPE with a DSL modem WAN interface - 1.0
ConnectionServiceNumberOfEntries unsignedInt - Number of table entries in the ConnectionService table. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLConnectionManagement.ConnectionService.{i}. object -

This table contains an entry for each connection service.

At most one entry in this table can exist with a given value for WANConnectionService.

- 1.0
WANConnectionDevice string­(256) - Specifies a WAN connection device object associated with this connection instance. The content is the full hierarchical parameter name of the WAN connection device. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2. - 1.0
WANConnectionService string­(256) - Specifies a WAN connection object associated with this connection instance. The content is the full hierarchical parameter name of the layer-3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
DestinationAddress string­(256) -

Destination address of the WANConnectionDevice entry. One of:

  • PVC: VPI/VCI
  • SVC: ATM connection name
  • SVC: ATM address
- 1.0
LinkType string - Link Type of the WANConnectionDevice entry. One of Link Types as described in WANDSLLinkConfig - 1.0
ConnectionType string - Connection Type of the WANPPPConnection or WANIPConnection entry. One of PossibleConnectionTypes as described in WAN**Connection service. - 1.0
Name string­(32) - User-readable name of the connection. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics. object - This object is requiredto provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, andbut optionalmay otherwisealso be used for ADSL. - 1.0
LoopDiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

Value may be set to Requested to initiate the diagnostic test, which brings down the DSL connection while the test is operating. When writing, the only allowed value is Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.

When the diagnostic initiated by the ACS is completed, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the corresponding reason in the Inform message.

- 1.0
ACTPSDds int - Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
ACTPSDus int - Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
ACTATPds int - Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
ACTATPus int - Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
HLINSCds int - Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
HLINpsds string - Comma-separated list of integers. Downstream linear channel characteristics per subcarrier. Each successive pair of integers represents the real and imaginary parts of each complex value. Maximum number of complex pairs is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
QLNpsds string - Comma-separated list of integers. Downstream quiet line noise per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
SNRpsds string - Comma-separated list of integers. Downstream SNR per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
BITSpsds string - Comma-separated list of integers. Downstream bit allocation per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
GAINSpsds string - Comma-separated list of integers. Downstream gain allocation per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}. object W Each instance contains objects associated with a given WAN link. In this case of DSL, each instance corresponds to a single ATM VC. On creation of a WANConnectionDevice instance, there are initially no connection objects contained within. - 1.0
WANIPConnectionNumberOfEntries unsignedInt - Number of instances of WANIPConnection in this WANConnectionDevice. - 1.0
WANPPPConnectionNumberOfEntries unsignedInt - Number of instances of WANPPPConnection in this WANConnectionDevice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig. object - This object models the ATM layer properties specific to a single physical connection of a DSL modem used for Internet access on a CPE. This object is requirntended for a CPE with a DSL modem WAN interface, and is exclusive of any other WAN*LinkConfig object within a given WANConnectionDevice instance. - 1.0
Enable boolean W Enables or disables the link. On creation of a WANConnectionDevice, this object is disabled by default. false 1.0
LinkStatus string -

Status of the link. Enumeration of:

- 1.0
LinkType string W

Indicates the type of DSL connection and refers to the complete stack of protocol used for this connection. Enumeration of:

  • EoA (RFC2684 bridged Ethernet over ATM)
  • IPoA (RFC2684 routed IP over ATM)
  • PPPoA (RFC2364 PPP over ATM)
  • PPPoE (RFC2516 PPP over Ethernet on RFC2684 bridged Ethernet over ATM)
  • CIP (RFC1577 Classical IP over ATM)
  • Unconfigured
- 1.0
AutoConfig boolean - Indicates if the CPE is currently using some auto configuration mechanisms for this connection. If this variable is true, all writable variables in this connection instance become read-only. Any attempt to change one of these variables SHOULD fail and an error should be returned. - 1.0
ModulationType string -

Indicates the type of DSL modulation used on the interface associated with this connection (duplication from WANDSLInterfaceConfig). Enumeration of:

- 1.0
DestinationAddress string­(256) W

Destination address of this link. One of:

  • PVC: VPI/VCI
  • SVC: ATM connection name
  • SVC: ATM address
- 1.0
ATMEncapsulation string W

Identifies the connection encapsulation that will be used. Enumeration of:

- 1.0
FCSPreserved boolean W This flag tells if a checksum should be added in the ATM payload. It does not refer to the checksum of one of the ATM cells or AALX packets. In case of LLC or VCMUX encapsulation, this ATM checksum is the FCS field described in RFC 1483. It is only applicable in the upstream direction. - 1.0
VCSearchList string W

Comma-separated list of strings. Comma separated ordered list of VPI/VCI pairs to search if a link using the DestinationAddress cannot be established. In the form:

VPI1/VCI1, VPI2/VCI2, ...

Example:

0/35, 8/35, 1/35
- 1.0
ATMAAL string -

Describes the ATM Adaptation Layer (AAL) currently in use on the PVC. Enumeration of:

- 1.0
ATMTransmittedBlocks unsignedInt - The current count of successfully transmitted blocks. - 1.0
ATMReceivedBlocks unsignedInt - The current count of successfully received blocks. - 1.0
ATMQoS string W

Describes the ATM Quality Of Service (QoS) being used on the VC. Enumeration of:

- 1.0
ATMPeakCellRate unsignedInt W Specifies the upstream peak cell rate in cells per second. - 1.0
ATMMaximumBurstSize unsignedInt W Specifies the upstream maximum burst size in cells. - 1.0
ATMSustainableCellRate unsignedInt W Specifies the upstream sustainable cell rate, in cells per second, used for traffic shaping. - 1.0
AAL5CRCErrors unsignedInt - Count of the AAL5 layer cyclic redundancy check errors. - 1.0
ATMCRCErrors unsignedInt - Count of the ATM layer cyclic redundancy check errors. - 1.0
ATMHECErrors unsignedInt - Count of the number of Header Error Check related errors at the ATM layer. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANATMF5LoopbackDiagnostics. object - This object is provides access to an ATM-layer F5 OAM loopback test. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

Value may be set to Requested to initiate the diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

"None" 1.0
NumberOfRepetitions unsignedInt­[1:] W Number of repetitions of the ping test to perform before reporting the results. - 1.0
Timeout unsignedInt­[1:] W Timeout in milliseconds for the ping test. - 1.0
SuccessCount unsignedInt - Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 1.0
FailureCount unsignedInt - Result parameter indicating the number of failed pings in the most recent ping test. - 1.0
AverageResponseTime unsignedInt - Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MinimumResponseTime unsignedInt - Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MaximumResponseTime unsignedInt - Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANEthernetLinkConfig. object - This object models the Ethernet link layer properties specific to a single physical connection used for Internet access on a CPE. This object is requirntended for a CPE with an Ethernet WAN interface, and is exclusive of any other WAN*LinkConfig object within a given WANConnectionDevice instance. Note that this object is not related to the Ethernet protocol layer sometimes used in associated with a DSL connection. - 1.0
EthernetLinkStatus string -

Status of the Ethernet link. Enumeration of:

- 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPOTSLinkConfig. object - This object models the POTS link layer properties specific to a single physical connection used for Internet access on a CPE. This object is requirntended for a CPE with a POTS WAN interface, and is exclusive of any other WAN*LinkConfig object within a given WANConnectionDevice instance. - 1.0
Enable boolean W Enables or disables the link. On creation of a WANConnectionDevice, this object is disabled by default. false 1.0
LinkStatus string -

Status of the link. Enumeration of:

- 1.0
ISPPhoneNumber string­(64) W Specifies a list of strings separated by semicolon (;), each string representing a phone number to connect to a particular ISP. The digits of the phone number follow the semantics of the ITU-T E.164 specification. Delimiters such as brackets or hyphens between the digits of a phone number are to be ignored by the CPE. - 1.0
ISPInfo string­(64) W Information identifying the Internet Service Provider. The format of the string is vendor specific. - 1.0
LinkType string W

This variable indicates the type of POTS link used for the dialup connection. Enumeration of:

- 1.0
NumberOfRetries unsignedInt W The number of times the CPE should attempt an Internet connection setup before returning error. - 1.0
DelayBetweenRetries unsignedInt W The number of seconds the CPE should wait between attempts to setup an Internet connection. - 1.0
Fclass string -

Comma-separated list of strings. Specifies capabilities of the POTS modem - i.e., if it handles data (0), fax (1,2,2.0), voice (8), DSVD (80). Each list item is an enumeration of:

- 1.0
DataModulationSupported string -

The modulation standard currently being used for data. Enumeration of:

- 1.0
DataProtocol string -

The protocol standard currently being used for data transfers. Enumeration of:

- 1.0
DataCompression string -

The compression technology implemented on the modem. Enumeration of:

- 1.0
PlusVTRCommandSupported boolean - Capability for full duplex operation with data and voice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}. object W

This object enables configuration of IP connections on the WAN interface of a CPE. This object is requirntended only for all WANConnectionDevices not employing PPP addressing, and must not be active for WANConnectionDevices that do employ PPP addressing.

At most one enabled entry in this table can exist with a given value for ExternalIPAddress.

- 1.0
Enable boolean W Enables or disables the connection instance. On creation of a WANIPConnection instance, it is initially disabled. false 1.0
ConnectionStatus string -

Current status of the connection. Enumeration of:

- 1.0
PossibleConnectionTypes string -

Comma-separated list of strings. Types of connections possible for this connection instance. Each list item is an enumeration of:

- 1.0
ConnectionType string W

Specifies the connection type of the connection instance. Enumeration of:

- 1.0
Name string­(256) W User-readable name of this connection. - 1.0
Uptime unsignedInt - The time in seconds that this connection has been up. - 1.0
LastConnectionError string -

The cause of failure for the last connection setup attempt. Enumeration of:

- 1.0
AutoDisconnectTime unsignedInt W The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
IdleDisconnectTime unsignedInt W The time in seconds that if the connection remains idle, the CPE automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
WarnDisconnectDelay unsignedInt W Time in seconds the Status remains in the pending disconnect state before transitioning to disconnecting state to drop the connection. - 1.0
RSIPAvailable boolean - Indicates if Realm-specific IP (RSIP) is available as a feature on the CPE. - 1.0
NATEnabled boolean W Indicates if Network Address Translation (NAT) is enabled for this connection. This parameter MUST be writable if NAT is supported by the CPE. - 1.0
AddressingType string W

The method used to assign an address to the WAN side interface of the CPE for this connection. Enumeration of:

- 1.0
ExternalIPAddress string­(45) W [IPAddress] This is the external IP address used by NAT for this connection. This parameter is configurable only if the AddressingType is Static. - 1.0
SubnetMask string­(45) W [IPAddress] Subnet mask of the WAN interface. This parameter is configurable only if the AddressingType is Static. - 1.0
DefaultGateway string W The IP address of the default gateway for this connection. This parameter is configurable only if the AddressingType is Static. - 1.0
DNSEnabled boolean W Whether or not the device should attempt to query a DNS server across this connection. - 1.0
DNSOverrideAllowed boolean W Whether or not a manually set, non-empty DNS address can be overridden by a DNS entry received from the WAN. - 1.0
DNSServers string W [IPAddress] Comma-separated list of IPAddresses. Comma separated list of DNS server IP addresses for this connection. Support for more than three DNS Servers is Optional. - 1.0
MaxMTUSize unsignedInt­[1:1540] W The maximum allowed size of an Ethernet frame from LAN-side devices. - 1.0
MACAddress string­(17) W [MACAddress] The physical address of the WANIPConnection if applicable. Configurable only if MACAddressOverride is present and true. - 1.0
MACAddressOverride boolean W Whether the value of MACAddress parameter can be overridden. If false, the CPE's default value is used (or restored if it had previously been overridden). - 1.0
ConnectionTrigger string W

Trigger used to establish the IP connection. Enumeration of:

- 1.0
RouteProtocolRx string W

Defines the Rx protocol to be used. Enumeration of:

- 1.0
ShapingRate int­[-1:] W

Rate to shape this connection's egress traffic to.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. The rate is limited over the window period specified by ShapeWindow?.

If > 100, in bits per second.

A value of -1 indicates no shaping.

-1 1.1
ShapingBurstSize unsignedInt W Burst Size in bytes. 0 1.1
PortMappingNumberOfEntries unsignedInt - Total number of port mapping entries. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.PortMapping.{i}. object W

Port mapping table.

This table MUST NOT contain dynamic NAT binding entries.

At most one enabled entry in this table can exist with all the same values for RemoteHost, ExternalPort and PortMappingProtocol.

- 1.0
PortMappingEnabled boolean W Enables or disables the port mapping instance. On creation, an entry is disabled by default. false 1.0
PortMappingLeaseDuration unsignedInt W Determines the time to live, in seconds, of a port-mapping lease. A value of 0 means the port mapping is static. Static port mappings do not necessarily mean persistence of these mappings across device resets or reboots. - 1.0
RemoteHost string W

This parameter is the IP address of the source of inbound packets. An empty string indicates a "wildcard" (this will be a wildcard in most cases). CPE are required only to support wildcards.

When RemoteHost is a wildcard, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the InternalClient on the InternalPort.

When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped.

- 1.0
ExternalPort unsignedInt W

The external port that the NAT gateway would listen on for connection requests to a corresponding InternalPort. Inbound packets to this external port on the WAN interface should be forwarded to InternalClient on the InternalPort.

A value of zero (0) represents a "wildcard". If this value is a wildcard, connection request on all external ports (that are not otherwise mapped) will be forwarded to InternalClient. In the wildcard case, the value(s) of InternalPort on InternalClient are ignored.

- 1.0
InternalPort unsignedInt W The port on InternalClient that the gateway should forward connection requests to. A value of zero (0) is not allowed. - 1.0
PortMappingProtocol string W

The protocol of the port mapping. Enumeration of:

- 1.0
InternalClient string W

The IP address or DNS host name of an internal client (on the LAN).

Support for an IP address is mandatory, while support for DNS host names is optional.

This value cannot be an empty string.

It must be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously.

- 1.0
PortMappingDescription string­(256) W User-readable description of this port mapping. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Stats. object -

This object contains statistics for all connections within the same WANConnectionDevice that share a common MAC address. The contents of this object should be identical for each such connection.

This object is requiredintended foronly allfor WANConnectionDevices that can support an Ethernet-layer on this interface (e.g., PPPoE, IPoE).

- 1.0
EthernetBytesSent unsignedInt - Total number of bytes sent over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
EthernetBytesReceived unsignedInt - Total number of bytes received over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
EthernetPacketsSent unsignedInt - Total number of Ethernet packets sent over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
EthernetPacketsReceived unsignedInt - Total number of Ethernet packets received over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}. object W

This object enables configuration of PPP connections on the WAN interface of a CPE. This object is requirntended only for all WANConnectionDevices that employ PPP addressing, and must not be active for WANConnectionDevices that do not employ PPP addressing.

At most one enabled entry in this table can exist with a given value for ExternalIPAddress.

- 1.0
Enable boolean W Enables or disables the connection instance. On creation of a WANPPPConnection instance, it is initially disabled. false 1.0
ConnectionStatus string -

Current status of the connection. Enumeration of:

- 1.0
PossibleConnectionTypes string -

Comma-separated list of strings. Types of connections possible for this connection instance. Each list item is an enumeration of:

- 1.0
ConnectionType string W

Specifies the connection type of the connection instance. Enumeration of:

- 1.0
Name string­(256) W User-readable name of this connection. - 1.0
Uptime unsignedInt - The time in seconds that this connection has been up. - 1.0
LastConnectionError string -

The cause of failure for the last connection setup attempt. Enumeration of:

- 1.0
AutoDisconnectTime unsignedInt W The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
IdleDisconnectTime unsignedInt W The time in seconds that if the connection remains idle, the CPE automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
WarnDisconnectDelay unsignedInt W Time in seconds the Status remains in the pending disconnect state before transitioning to disconnecting state to drop the connection. - 1.0
RSIPAvailable boolean - Indicates if Realm-specific IP (RSIP) is available as a feature on the CPE. - 1.0
NATEnabled boolean W Indicates if Network Address Translation (NAT) is enabled for this connection. This parameter MUST be writable if NAT is supported by the CPE. - 1.0
Username string­(64) W Username to be used for authentication. - 1.0
Password string­(64) W

Password to be usef for authentication.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0
PPPEncryptionProtocol string -

Describes the PPP encryption protocol used between the WAN device and the ISP POP. Enumeration of:

- 1.0
PPPCompressionProtocol string -

Describes the PPP compression protocol used between the WAN device and the ISP POP. Enumeration of:

- 1.0
PPPAuthenticationProtocol string -

Describes the PPP authentication protocol used between the WAN device and the ISP POP. Enumeration of:

- 1.0
ExternalIPAddress string­(45) - [IPAddress] This is the external IP address used by NAT for this connection. - 1.0
RemoteIPAddress string­(45) - [IPAddress] The remote IP address for this connection. - 1.0
MaxMRUSize unsignedInt­[1:1540] W The maximum allowed size of frames sent from the remote peer. - 1.0
CurrentMRUSize unsignedInt­[1:1540] - The current MRU in use over this connection. - 1.0
DNSEnabled boolean W Whether or not the device should attempt to query a DNS server across this connection. - 1.0
DNSOverrideAllowed boolean W Whether or not a manually set, non-empty DNS address can be overridden by a DNS entry received from the WAN. - 1.0
DNSServers string W [IPAddress] Comma-separated list of IPAddresses. Comma separated list of DNS server IP addresses for this connection. Support for more than three DNS Servers is Optional. - 1.0
MACAddress string­(17) W [MACAddress] The physical address of the WANIPPPConnection if applicable. Configurable only if MACAddressOverride is present and true. - 1.0
MACAddressOverride boolean W Whether the value of MACAddress parameter can be overridden. If false, the CPE's default value is used (or restored if it had previously been overridden). - 1.0
TransportType string -

PPP transport type of the connection. Enumeration of:

- 1.0
PPPoEACName string­(256) W PPPoE Access Concentrator. - 1.0
PPPoEServiceName string­(256) W PPPoE Service Name. - 1.0
ConnectionTrigger string W

Trigger used to establish the IP connection. Enumeration of:

- 1.0
RouteProtocolRx string W

Defines the Rx protocol to be used. Enumeration of:

- 1.0
PPPLCPEcho unsignedInt - PPP LCP Echo period in seconds. - 1.0
PPPLCPEchoRetry unsignedInt - Number of PPP LCP Echo retries within an echo period. - 1.0
ShapingRate int­[-1:] W

Rate to shape this connection's egress traffic.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. The rate is limited over the window period specified by ShapeWindow?.

If > 100, in bits per second.

A value of -1 indicates no shaping.

-1 1.1
ShapingBurstSize unsignedInt W Burst Size in bytes. 0 1.1
PortMappingNumberOfEntries unsignedInt - Total number of port mapping entries. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.PortMapping.{i}. object W

Port mapping table.

This table MUST NOT contain dynamic NAT binding entries.

At most one enabled entry in this table can exist with all the same values for RemoteHost, ExternalPort and PortMappingProtocol.

- 1.0
PortMappingEnabled boolean W Enables or disables the port mapping instance. On creation, an entry is disabled by default. false 1.0
PortMappingLeaseDuration unsignedInt W Determines the time to live, in seconds, of a port-mapping lease. A value of 0 means the port mapping is static. Static port mappings do not necessarily mean persistence of these mappings across device resets or reboots. - 1.0
RemoteHost string W

This parameter is the IP address of the source of inbound packets. An empty string indicates a "wildcard" (this will be a wildcard in most cases). CPE are required only to support wildcards.

When RemoteHost is a wildcard, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the InternalClient on the InternalPort.

When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped.

- 1.0
ExternalPort unsignedInt W

The external port that the NAT gateway would listen on for connection requests to a corresponding InternalPort. Inbound packets to this external port on the WAN interface should be forwarded to InternalClient on the InternalPort.

A value of zero (0) represents a "wildcard". If this value is a wildcard, connection request on all external ports (that are not otherwise mapped) will be forwarded to InternalClient. In the wildcard case, the value(s) of InternalPort on InternalClient are ignored.

- 1.0
InternalPort unsignedInt W The port on InternalClient that the gateway should forward connection requests to. A value of zero (0) is not allowed. - 1.0
PortMappingProtocol string W

The protocol of the port mapping. Enumeration of:

- 1.0
InternalClient string W

The IP address or DNS host name of an internal client (on the LAN).

Support for an IP address is mandatory, while support for DNS host names is optional.

This value cannot be an empty string.

It must be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously.

- 1.0
PortMappingDescription string­(256) W User-readable description of this port mapping. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.Stats. object -

This object contains statistics for all connections within the same WANConnectionDevice that share a common MAC address. The contents of this object should be identical for each such connection.

This object is requiredintended foronly allfor WANConnectionDevices that can support an Ethernet-layer on this interface (e.g., PPPoE, IPoE).

- 1.0
EthernetBytesSent unsignedInt - Total number of bytes sent over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
EthernetBytesReceived unsignedInt - Total number of bytes received over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
EthernetPacketsSent unsignedInt - Total number of Ethernet packets sent over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0
EthernetPacketsReceived unsignedInt - Total number of Ethernet packets received over all connections within the same WANConnectionDevice that share a common MAC address since the CPE was last reset. - 1.0

Inform and Notification Requirements

Forced Inform Parameters

Parameter
InternetGatewayDevice.DeviceSummary
InternetGatewayDevice.DeviceInfo.HardwareVersion
InternetGatewayDevice.DeviceInfo.SoftwareVersion
InternetGatewayDevice.DeviceInfo.SpecVersion
InternetGatewayDevice.DeviceInfo.ProvisioningCode
InternetGatewayDevice.ManagementServer.ParameterKey
InternetGatewayDevice.ManagementServer.ConnectionRequestURL

Forced Active Notification Parameters

Parameter
InternetGatewayDevice.DeviceInfo.SoftwareVersion
InternetGatewayDevice.DeviceInfo.ProvisioningCode
InternetGatewayDevice.ManagementServer.ConnectionRequestURL

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter
InternetGatewayDevice.ManagementServer.
ParameterKey
InternetGatewayDevice.Time.
CurrentLocalTime
InternetGatewayDevice.Layer2Bridging.
MaxBridgeEntries
MaxFilterEntries
MaxMarkingEntries
InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}.
AvailableInterfaceKey
InterfaceType
InterfaceReference
InternetGatewayDevice.QueueManagement.
MaxQueues
MaxClassificationEntries
MaxAppEntries
MaxFlowEntries
MaxPolicerEntries
MaxQueueEntries
InternetGatewayDevice.QueueManagement.Policer.{i}.
PossibleMeterTypes
CountedPackets
CountedBytes
InternetGatewayDevice.IPPingDiagnostics.
DiagnosticsState
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats.
BytesSent
BytesReceived
CellsSent
CellsReceived
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.
TotalPSKFailures
TotalIntegrityFailures
ChannelsInUse
TotalBytesSent
TotalBytesReceived
TotalPacketsSent
TotalPacketsReceived
TotalAssociations
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}.
AssociatedDeviceMACAddress
AssociatedDeviceIPAddress
AssociatedDeviceAuthenticationState
LastRequestedUnicastCipher
LastRequestedMulticastCipher
LastPMKId
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}.
LeaseTimeRemaining
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.
TotalBytesSent
TotalBytesReceived
TotalPacketsSent
TotalPacketsReceived
MaximumActiveConnections
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.
UpstreamCurrRate
DownstreamCurrRate
UpstreamMaxRate
DownstreamMaxRate
UpstreamNoiseMargin
DownstreamNoiseMargin
UpstreamAttenuation
DownstreamAttenuation
UpstreamPower
DownstreamPower
TotalStart
ShowtimeStart
LastShowtimeStart
CurrentDayStart
QuarterHourStart
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Total.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Showtime.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.LastShowtime.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.CurrentDay.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.QuarterHour.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics.
LoopDiagnosticsState
ACTPSDds
ACTPSDus
ACTATPds
ACTATPus
HLINSCds
HLINpsds
QLNpsds
SNRpsds
BITSpsds
GAINSpsds
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig.
ATMTransmittedBlocks
ATMReceivedBlocks
AAL5CRCErrors
ATMCRCErrors
ATMHECErrors
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANATMF5LoopbackDiagnostics.
DiagnosticsState
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.
Uptime
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.PortMapping.{i}.
PortMappingLeaseDuration
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Stats.
EthernetBytesSent
EthernetBytesReceived
EthernetPacketsSent
EthernetPacketsReceived
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.
Uptime
CurrentMRUSize
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.PortMapping.{i}.
PortMappingLeaseDuration
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.Stats.
EthernetBytesSent
EthernetBytesReceived
EthernetPacketsSent
EthernetPacketsReceived

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object via AddObject and DeleteObject is REQUIRED.
A Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED.

Baseline:1 Profile

This table defines the Baseline:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice. P
DeviceSummary R
LANDeviceNumberOfEntries R
WANDeviceNumberOfEntries R
InternetGatewayDevice.­DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
SpecVersion R
ProvisioningCode W
UpTime R
DeviceLog R
InternetGatewayDevice.­ManagementServer. P
URL W
Username W
Password W
PeriodicInformEnable W
PeriodicInformInterval W
PeriodicInformTime W
ParameterKey R
ConnectionRequestURL R
ConnectionRequestUsername W
ConnectionRequestPassword W
UpgradesManaged W
InternetGatewayDevice.­Layer3Forwarding. P
DefaultConnectionService W
ForwardNumberOfEntries R
InternetGatewayDevice.­Layer3Forwarding.­Forwarding.­{i}. C
Enable W
Status R
Type W
DestIPAddress W
DestSubnetMask W
SourceIPAddress W
SourceSubnetMask W
GatewayIPAddress W
Interface W
ForwardingMetric W
InternetGatewayDevice.­LANConfigSecurity. P
ConfigPassword W
InternetGatewayDevice.­LANDevice.­{i}. P
LANEthernetInterfaceNumberOfEntries R
LANUSBInterfaceNumberOfEntries R
LANWLANConfigurationNumberOfEntries R
InternetGatewayDevice.­LANDevice.­{i}.­LANHostConfigManagement. P
DHCPServerConfigurable W
DHCPServerEnable W
DHCPRelay R
MinAddress W
MaxAddress W
ReservedAddresses W
SubnetMask W
DNSServers W
DomainName W
IPRouters W
IPInterfaceNumberOfEntries R
InternetGatewayDevice.­LANDevice.­{i}.­LANHostConfigManagement.­IPInterface.­{i}. P
Enable W
IPInterfaceIPAddress W
IPInterfaceSubnetMask W
IPInterfaceAddressingType W
InternetGatewayDevice.­LANDevice.­{i}.­Hosts. P
HostNumberOfEntries R
InternetGatewayDevice.­LANDevice.­{i}.­Hosts.­Host.­{i}. P
IPAddress R
AddressSource R
LeaseTimeRemaining R
MACAddress R
HostName R
InterfaceType R
Active R
InternetGatewayDevice.­WANDevice.­{i}. P
WANConnectionNumberOfEntries R
InternetGatewayDevice.­WANDevice.­{i}.­WANCommonInterfaceConfig. P
EnabledForInternet R
WANAccessType R
Layer1UpstreamMaxBitRate R
Layer1DownstreamMaxBitRate R
PhysicalLinkStatus R
TotalBytesSent R
TotalBytesReceived R
TotalPacketsSent R
TotalPacketsReceived R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}. P
WANIPConnectionNumberOfEntries R
WANPPPConnectionNumberOfEntries R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANIPConnection.­{i}. C
Enable W
ConnectionStatus R
PossibleConnectionTypes R
ConnectionType W
Name W
Uptime R
LastConnectionError R
RSIPAvailable R
NATEnabled W
AddressingType R
ExternalIPAddress R
SubnetMask R
DefaultGateway R
DNSEnabled R
DNSOverrideAllowed R
DNSServers R
MACAddress R
ConnectionTrigger W
RouteProtocolRx W
PortMappingNumberOfEntries R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANIPConnection.­{i}.­PortMapping.­{i}. C
PortMappingEnabled W
PortMappingLeaseDuration R
RemoteHost W
ExternalPort W
InternalPort W
PortMappingProtocol W
InternalClient W
PortMappingDescription W
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANIPConnection.­{i}.­Stats. P
EthernetBytesSent R
EthernetBytesReceived R
EthernetPacketsSent R
EthernetPacketsReceived R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANPPPConnection.­{i}. C
Enable W
ConnectionStatus R
PossibleConnectionTypes R
ConnectionType W
Name W
Uptime R
LastConnectionError R
RSIPAvailable R
NATEnabled W
Username W
Password W
ExternalIPAddress R
DNSEnabled R
DNSOverrideAllowed R
DNSServers R
MACAddress R
TransportType R
PPPoEACName W
PPPoEServiceName W
ConnectionTrigger W
RouteProtocolRx W
PortMappingNumberOfEntries R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANPPPConnection.­{i}.­PortMapping.­{i}. C
PortMappingEnabled W
PortMappingLeaseDuration R
RemoteHost W
ExternalPort W
InternalPort W
PortMappingProtocol W
InternalClient W
PortMappingDescription W
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANPPPConnection.­{i}.­Stats. P
EthernetBytesSent R
EthernetBytesReceived R
EthernetPacketsSent R
EthernetPacketsReceived R

EthernetLAN:1 Profile

This table defines the EthernetLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­LANDevice.­{i}.­LANEthernetInterfaceConfig.­{i}. P
Enable W
Status R
MACAddress R
MACAddressControlEnabled W
MaxBitRate W
DuplexMode W
InternetGatewayDevice.­LANDevice.­{i}.­LANEthernetInterfaceConfig.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R

USBLAN:1 Profile

This table defines the USBLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­LANDevice.­{i}.­LANUSBInterfaceConfig.­{i}. P
Enable W
Status R
MACAddress R
MACAddressControlEnabled W
Standard R
Type R
Rate R
Power R
InternetGatewayDevice.­LANDevice.­{i}.­LANUSBInterfaceConfig.­{i}.­Stats. P
BytesSent R
BytesReceived R
CellsSent R
CellsReceived R

WiFiLAN:1 Profile

This table defines the WiFiLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­LANDevice.­{i}.­WLANConfiguration.­{i}. P
Enable W
Status R
BSSID R
MaxBitRate W
Channel W
SSID W
BeaconType W
MACAddressControlEnabled W
Standard R
WEPKeyIndex W
KeyPassphrase W
WEPEncryptionLevel R
BasicEncryptionModes W
BasicAuthenticationMode W
WPAEncryptionModes W
WPAAuthenticationMode W
PossibleChannels R
BasicDataTransmitRates W
OperationalDataTransmitRates W
PossibleDataTransmitRates R
RadioEnabled W
AutoRateFallBackEnabled W
TotalBytesSent R
TotalBytesReceived R
TotalPacketsSent R
TotalPacketsReceived R
TotalAssociations R
InternetGatewayDevice.­LANDevice.­{i}.­WLANConfiguration.­{i}.­AssociatedDevice.­{i}. P
AssociatedDeviceMACAddress R
AssociatedDeviceIPAddress R
AssociatedDeviceAuthenticationState R
InternetGatewayDevice.­LANDevice.­{i}.­WLANConfiguration.­{i}.­WEPKey.­{i}. P
WEPKey W
InternetGatewayDevice.­LANDevice.­{i}.­WLANConfiguration.­{i}.­PreSharedKey.­{i}. P
PreSharedKey W
KeyPassphrase W

ADSLWAN:1 Profile

This table defines the ADSLWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLInterfaceConfig. P
Enable W
Status R
UpstreamCurrRate R
DownstreamCurrRate R
UpstreamMaxRate R
DownstreamMaxRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamAttenuation R
DownstreamAttenuation R
UpstreamPower R
DownstreamPower R
ATURVendor R
ATURCountry R
ATUCVendor R
ATUCCountry R
TotalStart R
ShowtimeStart R
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLInterfaceConfig.­Stats. P
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLInterfaceConfig.­Stats.­Total. P
ReceiveBlocks R
TransmitBlocks R
CellDelin R
LinkRetrain R
InitErrors R
InitTimeouts R
LossOfFraming R
ErroredSecs R
SeverelyErroredSecs R
FECErrors R
ATUCFECErrors R
HECErrors R
ATUCHECErrors R
CRCErrors R
ATUCCRCErrors R
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLInterfaceConfig.­Stats.­Showtime. P
ReceiveBlocks R
TransmitBlocks R
CellDelin R
LinkRetrain R
InitErrors R
InitTimeouts R
LossOfFraming R
ErroredSecs R
SeverelyErroredSecs R
FECErrors R
ATUCFECErrors R
HECErrors R
ATUCHECErrors R
CRCErrors R
ATUCCRCErrors R
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLConnectionManagement. P
ConnectionServiceNumberOfEntries R
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLConnectionManagement.­ConnectionService.­{i}. P
WANConnectionDevice R
WANConnectionService R
DestinationAddress R
LinkType R
ConnectionType R
Name R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}. C
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANDSLLinkConfig. P
Enable W
LinkStatus R
LinkType W
AutoConfig R
DestinationAddress W
ATMTransmittedBlocks R
ATMReceivedBlocks R
AAL5CRCErrors R
ATMCRCErrors R

EthernetWAN:1 Profile

This table defines the EthernetWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­WANDevice.­{i}.­WANEthernetInterfaceConfig. P
Enable W
Status R
MACAddress R
MaxBitRate W
DuplexMode W
InternetGatewayDevice.­WANDevice.­{i}.­WANEthernetInterfaceConfig.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANEthernetLinkConfig. P
EthernetLinkStatus R

POTSWAN:1 Profile

This table defines the POTSWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANPOTSLinkConfig. P
Enable W
LinkStatus R
ISPPhoneNumber R
ISPInfo R
LinkType R
NumberOfRetries R
DelayBetweenRetries R

QoS:1 Profile

This table defines the QoS:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­QueueManagement. P
Enable W
MaxQueues R
MaxClassificationEntries R
ClassificationNumberOfEntries R
MaxAppEntries R
AppNumberOfEntries R
MaxFlowEntries R
FlowNumberOfEntries R
MaxPolicerEntries R
PolicerNumberOfEntries R
MaxQueueEntries R
QueueNumberOfEntries R
DefaultForwardingPolicy W
DefaultPolicer W
DefaultQueue W
DefaultDSCPMark W
DefaultEthernetPriorityMark W
AvailableAppList R
InternetGatewayDevice.­QueueManagement.­Classification.­{i}. C
ClassificationKey R
ClassificationEnable W
ClassificationStatus R
ClassificationOrder W
ClassInterface W
DestIP W
DestMask W
DestIPExclude W
SourceIP W
SourceMask W
SourceIPExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortRangeMax W
DestPortExclude W
SourcePort W
SourcePortRangeMax W
SourcePortExclude W
SourceMACAddress W
SourceMACExclude W
DestMACAddress W
DestMACExclude W
DSCPCheck W
DSCPExclude W
DSCPMark W
EthernetPriorityCheck W
EthernetPriorityExclude W
EthernetPriorityMark W
VLANIDCheck W
VLANIDExclude W
ForwardingPolicy W
ClassPolicer W
ClassQueue W
InternetGatewayDevice.­QueueManagement.­Policer.­{i}. C
PolicerKey R
PolicerEnable W
PolicerStatus R
CommittedRate W
CommittedBurstSize W
MeterType W
PossibleMeterTypes R
ConformingAction W
NonConformingAction W
CountedPackets R
CountedBytes R
InternetGatewayDevice.­QueueManagement.­Queue.­{i}. C
QueueKey R
QueueEnable W
QueueStatus R
QueueInterface W
QueueBufferLength R
QueueWeight W
QueuePrecedence W
REDThreshold W
REDPercentage W
DropAlgorithm W
SchedulerAlgorithm W
ShapingRate W
ShapingBurstSize W
InternetGatewayDevice.­Layer3Forwarding.­Forwarding.­{i}. -
ForwardingPolicy W
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANIPConnection.­{i}. -
ShapingRate W
ShapingBurstSize W
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANPPPConnection.­{i}. -
ShapingRate W
ShapingBurstSize W

QoSDynamicFlow:1 Profile

This table defines the QoSDynamicFlow:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­QueueManagement.­App.­{i}. C
AppKey R
AppEnable W
AppStatus R
ProtocolIdentifier W
AppName W
AppDefaultForwardingPolicy W
AppDefaultPolicer W
AppDefaultQueue W
AppDefaultDSCPMark W
AppDefaultEthernetPriorityMark W
InternetGatewayDevice.­QueueManagement.­Flow.­{i}. C
FlowKey R
FlowEnable W
FlowStatus R
FlowType W
FlowTypeParameters W
FlowName W
AppIdentifier W
FlowForwardingPolicy W
FlowPolicer W
FlowQueue W
FlowDSCPMark W
FlowEthernetPriorityMark W
InternetGatewayDevice.­QueueManagement.­Classification.­{i}. -
ClassApp W

Bridging:1 Profile

This table defines the Bridging:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­Layer2Bridging. P
MaxBridgeEntries R
MaxFilterEntries R
MaxMarkingEntries R
BridgeNumberOfEntries R
FilterNumberOfEntries R
MarkingNumberOfEntries R
AvailableInterfaceNumberOfEntries R
InternetGatewayDevice.­Layer2Bridging.­Bridge.­{i}. C
BridgeKey R
BridgeEnable W
BridgeStatus R
BridgeName W
VLANID W
InternetGatewayDevice.­Layer2Bridging.­Filter.­{i}. C
FilterKey R
FilterEnable W
FilterStatus R
FilterBridgeReference W
ExclusivityOrder W
FilterInterface W
VLANIDFilter W
AdmitOnlyVLANTagged W
EthertypeFilterList W
EthertypeFilterExclude W
SourceMACAddressFilterList W
SourceMACAddressFilterExclude W
DestMACAddressFilterList W
DestMACAddressFilterExclude W
InternetGatewayDevice.­Layer2Bridging.­Marking.­{i}. C
MarkingKey R
MarkingEnable W
MarkingStatus R
MarkingBridgeReference W
MarkingInterface W
VLANIDUntag W
VLANIDMark W
EthernetPriorityMark W
EthernetPriorityOverride W
InternetGatewayDevice.­Layer2Bridging.­AvailableInterface.­{i}. P
AvailableInterfaceKey R
InterfaceType R
InterfaceReference R

Time:1 Profile

This table defines the Time:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­Time. P
NTPServer1 W
NTPServer2 W
CurrentLocalTime R
LocalTimeZone W
LocalTimeZoneName W
DaylightSavingsUsed W
DaylightSavingsStart W
DaylightSavingsEnd W

IPPing:1 Profile

This table defines the IPPing:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­IPPingDiagnostics. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
Timeout W
DataBlockSize W
DSCP W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

ATMLoopback:1 Profile

This table defines the ATMLoopback:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­WANDevice.­{i}.­WANConnectionDevice.­{i}.­WANATMF5LoopbackDiagnostics. P
DiagnosticsState W
NumberOfRepetitions W
Timeout W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

DSLDiagnostics:1 Profile

This table defines the DSLDiagnostics:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.1.

Name Requirement
InternetGatewayDevice.­WANDevice.­{i}.­WANDSLDiagnostics. P
LoopDiagnosticsState W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINpsds R
QLNpsds R
SNRpsds R
BITSpsds R
GAINSpsds R


Generated by Broadband Forum report.pl#277 (2014/06/30 version) on 2014/06/30 at 21:50:25.
report.pl --showdiffs --nowarnreport --report=html --outfile=tr-098-1-0-0.html tr-098-1-0-0.xml