Broadband Forum

    DATA MODEL DEFINITION


TR-069 InternetGatewayDevice:1.0 Root Object definition
tr-069-1-0-0.xml

License

Copyright (c) 2009-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

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]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

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.

Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){7}([0-9A-Fa-f][0-9A-Fa-f])
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(45)

IPv6 address.

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

IPv6Prefix IPPrefix(49)

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. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
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]. Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}
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. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f]){4}
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

[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.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

InternetGatewayDevice:1.0 Data Model

Name Type Write Description Object Default Version
InternetGatewayDevice. object - The top-level object for an Internet Gateway Device. - 1.0
LANDeviceNumberOfEntries unsignedInt - Number of instances of LANDevice. - 1.0
WANDeviceNumberOfEntries unsignedInt - Number of instances of WANDevice. - 1.0
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. - 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) - Represents the version of the specification implemented by the device. Currently 1.0 is the only available version. - 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 successfully established a network connection. - 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 validating the certificate from the ACS when using certificate-based authentication.

- 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. - 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.

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. - 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. - 1.0
DestSubnetMask string­(45) W [IPAddress] Destination subnet mask. - 1.0
SourceIPAddress string­(45) W [IPAddress] Source address. - 1.0
SourceSubnetMask string­(45) W [IPAddress] Source subnet mask. - 1.0
GatewayIPAddress string­(45) W [IPAddress] IP address of the gateway. - 1.0
Interface string W Specifies the WAN 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.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:64] 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
MinimumResponseTmie 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.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. - 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. - 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 required for a CPE with an ADSL2 or ADSL2+ modem WAN interface, and optional otherwise. - 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 required 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. - 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.

- 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 required 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 required 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. - 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 required 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. - 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
PortMappingNumberOfEntries unsignedInt - Total number of port mapping entries. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.PortMapping.{i}. object W

Port mapping table.

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. - 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 required for all 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 required 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. - 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 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
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
PortMappingNumberOfEntries unsignedInt - Total number of port mapping entries. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.PortMapping.{i}. object W

Port mapping table.

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. - 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 required for all 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

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter

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 is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:24:07.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --report=html --outfile=tr-069-1-0-0.html tr-069-1-0-0.xml