DATA MODEL DEFINITION

TR-106

Notice

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

• OF ACCURACY, COMPLETENESS, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE;
• THAT THE CONTENTS OF THIS BROADBAND FORUM XML DOCUMENT ARE SUITABLE FOR ANY PURPOSE, EVEN IF THAT PURPOSE IS KNOWN TO THE COPYRIGHT HOLDER;
• THAT THE IMPLEMENTATION OF THE CONTENTS OF THE DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

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

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

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

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

Table of Contents

• Data Types
• References
• Device:1.0 Data Model
• Data Model Definition
• Device.
• Device.Services.
• Device.DeviceInfo.
• Device.ManagementServer.
• Device.GatewayInfo.
• Device.Config.
• Device.Time.
• Device.UserInterface.
• Device.LAN.
• Device.LAN.DHCPOption.{i}.
• Device.LAN.Stats.
• Device.LAN.IPPingDiagnostics.
• Device.LAN.TraceRouteDiagnostics.
• Device.LAN.TraceRouteDiagnostics.RouteHops.{i}.
• Inform and Notification Requirements
• Forced Inform Parameters
• Forced Active Notification Parameters
• Default Active Notification Parameters
• Parameters for which Active Notification MAY be Denied
• Profile Definitions
• Notation
• Baseline:1 Profile
• GatewayInfo:1 Profile
• Time:1 Profile
• LAN:1 Profile
• IPPing:1 Profile
• TraceRoute:1 Profile

Data Types

Data Type	Base Type	Description
IPAddress	string	All IPv4 addresses and subnet masks are represented as strings in IPv4 dotted-decimal notation. All IPv6 addresses MUST be represented using any of the 3 standard textual representations as defined in [RFC3513] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used. Use of the lower-case letters is RECOMMENDED. 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 Unspecified or inapplicable IP addresses and subnet masks MUST be represented as empty strings unless otherwise specified by the parameter definition.
IPPrefix	string	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 Unspecified or inapplicable IP prefixes MUST be represented as empty strings unless otherwise specified by the parameter definition.
IPv4Address	string	IPv4 addresses and subnet masks are represented as strings in IPv4 dotted-decimal notation. Unspecified or inapplicable IP addresses and subnet masks MUST be represented as empty strings unless otherwise specified by the parameter definition.
MACAddress	string	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.

References

Device:1.0 Data Model

Name	Type	Write	Description	Object Default	Version
Device.	object	-	The top-level object for a Device.	-	1.0
DeviceSummary	string­(1024)	-	See [Section 3.7/TR-106].	-	1.0
Device.Services.	object	-	This object contains general services information.	-	1.0
Device.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.21 where the components mean: Major.Minor.Build.	-	1.0
EnabledOptions	string­(1024)	-	Comma-separated list (maximum length 1024) of strings. Comma-separated list of the OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in [TR-069]. Only those options are listed whose State indicates the option is enabled.	-	1.0
AdditionalHardwareVersion	string­(64)	-	Comma-separated list (maximum length 64) of strings. A comma separated list of any additional versions. Represents any additional hardware version information the vendor may wish to supply.	-	1.0
AdditionalSoftwareVersion	string­(64)	-	Comma-separated list (maximum length 64) of strings. A comma separated list of any additional versions. Represents any additional software version information the vendor may wish to supply.	-	1.0
ProvisioningCode	string­(64)	W	Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters.	-	1.0
DeviceStatus	string	-	Current operational status of the device. Enumeration of: Up Initializing Error Disabled	-	1.0
UpTime	unsignedInt	-	Time in seconds since the CPE was last restarted.	-	1.0
FirstUseDate	dateTime	-	Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset.	-	1.0
DeviceLog	string­(32768)	-	Vendor-specific log(s).	-	1.0
Device.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. The host portion of this URL is used by the CPE for validating the ACS certificate when using SSL or TLS.	-	1.0
Username	string­(256)	W	Username used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol. This username is used only for HTTP-based authentication of the CPE.	-	1.0
Password	string­(256)	W	Password used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol. This password is used only for HTTP-based authentication of the CPE. When read, this parameter returns an empty string, regardless of the actual value. 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 the ACS 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)	-	ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS. The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified. The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string.	-	1.0
ConnectionRequestURL	string­(256)	-	HTTP URL for an ACS to make a Connection Request notification to the CPE. In the form: http://host:port/path The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.	-	1.0
ConnectionRequestUsername	string­(256)	W	Username used to authenticate an ACS making a Connection Request to the CPE.	-	1.0
ConnectionRequestPassword	string­(256)	W	Password used to authenticate an ACS making a Connection Request to the CPE. When read, this parameter returns an empty string, regardless of the actual value. 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
Device.GatewayInfo.	object	-	This object contains information associated with a connected Internet Gateway Device.	-	1.0
ManufacturerOUI	string­(6)	-	Organizationally unique identifier of the associated Internet Gateway Device. An empty string indicates that there is no associated Internet Gateway Device that has been detected.	-	1.0
ProductClass	string­(64)	-	Identifier of the product class of the associated Internet Gateway Device. An empty string indicates either that there is no associated Internet Gateway Device that has been detected, or the Internet Gateway Device does not support the use of the product-class parameter.	-	1.0
SerialNumber	string­(64)	-	Serial number of the associated Internet Gateway Device. An empty string indicates that there is no associated Internet Gateway Device that has been detected.	-	1.0
Device.Config.	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
Device.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­(256)	W	The local time zone definition, encoded according to IEEE 1003.1 (POSIX). The following is an example value: EST+5 EDT,M4.1.0/2,M10.5.0/2	-	1.0
Device.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 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 ManagementServer.UpgradesManaged? parameter is true.	-	1.0
AvailableLanguages	string­(256)	-	Comma-separated list (maximum length 256) of strings. Comma-separated list of user-interface languages that are available, where each language is specified according to RFC 3066 [RFC3066].	-	1.0
CurrentLanguage	string­(16)	W	Current user-interface language, specified according to RFC 3066 [RFC3066].	-	1.0
Device.LAN.	object	-	This object contains parameters relating to IP-based LAN connectivity of a device. This object relates only to IP-layer LAN capabilities. Lower-layer aspects of LAN connectivity are not considered part of the common data model defined in this specification. For a device that contains multiple IP interfaces, the scope of this object is limited to the default IP interface. Data that may be associated with other interfaces is not considered part of the common data model defined in this specification. Support for this object is Optional.	-	1.0
AddressingType	string	W	The method used to assign an address to this interface. Enumeration of: DHCP Static The ability to modify this parameter is optional.	-	1.0
IPAddress	string	W	[IPAddress] The current IP address assigned to this interface. The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.	-	1.0
SubnetMask	string	W	[IPAddress] The current subnet mask. The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.	-	1.0
DefaultGateway	string	W	The IP address of the current default gateway for this interface. The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.	-	1.0
DNSServers	string­(256)	W	Comma-separated list (maximum length 256) of strings. Comma-separated list of IP address of the DNS servers for this interface. The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP. If this parameter is modifiable, the device MAY ignore any DNS servers beyond the first two in the list.	-	1.0
MACAddress	string	W	[MACAddress] The physical address of this interface. Writable only if MACAddressOverride is present and equal to true.	-	1.0
MACAddressOverride	boolean	W	Whether the value of MACAddress parameter can be overridden. When true, MACAddress is writable. When false, MACAddress is not writable, and the default MAC address assigned by the device SHOULD be restored.	-	1.0
DHCPOptionNumberOfEntries	unsignedInt	-	Number of entries in the DHCP option table.	-	1.0
Device.LAN.DHCPOption.{i}.	object	W	This object is for configuration of DHCP options. Each instance of this object represents a DHCP option to be included by the DHCP client in client requests. The DHCP client MAY include any other options not specified in this table.	-	1.0
Request	boolean	W	Whether this entry represents a request to the DHCP server, or a value to be sent by the DHCP client. When true, this entry represents a request. In this case, the DHCP client MUST include the specified Tag in the Parameter Request List, as defined in RFC 2132. The Value parameter is ignored in this case. When false, this entry represents a value to be sent by the DHCP client. In this case, the DHCP client MUST include a DHCP option formed from the Tag and Value parameters (with the Length derived from the length of the Value parameter).	-	1.0
Tag	unsignedInt­[1:254]	W	Tag of the DHCP option as defined in RFC 2132.	-	1.0
Value	base64	W	Base64 encoded octet string to be used as the Value of the DHCP option if Request is false.	-	1.0
Device.LAN.Stats.	object	-	This object contains statistics for the default IP interface.	-	1.0
ConnectionUpTime	unsignedInt	-	The time in seconds that this IP interface has been connected. If the IP interface is using DHCP, this is the time that the DHCP client has been only in the Bound or Renewing states and the lower-layer interface has continuously maintained a link. If the IP interface is using static addressing, this is the time that the lower-layer interface has continuously maintained a link.	-	1.0
TotalBytesSent	unsignedInt	-	Total number of IP payload bytes sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime.	-	1.0
TotalBytesReceived	unsignedInt	-	Total number of IP payload bytes received over this interface since the device was last restarted as specified in DeviceInfo.UpTime.	-	1.0
TotalPacketsSent	unsignedInt	-	Total number of IP packets sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime.	-	1.0
TotalPacketsReceived	unsignedInt	-	Total number of IP packets received over this interface since the device was last restarted as specified in DeviceInfo.UpTime.	-	1.0
CurrentDayInterval	unsignedInt	-	Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The device MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.	-	1.0
CurrentDayBytesSent	unsignedInt	-	Total number of IP payload bytes sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.	-	1.0
CurrentDayBytesReceived	unsignedInt	-	Total number of IP payload bytes received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.	-	1.0
CurrentDayPacketsSent	unsignedInt	-	Total number of IP packets sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.	-	1.0
CurrentDayPacketsReceived	unsignedInt	-	Total number of IP packets received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.	-	1.0
QuarterHourInterval	unsignedInt	-	Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The device MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.	-	1.0
QuarterHourBytesSent	unsignedInt	-	Total number of IP payload bytes sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.	-	1.0
QuarterHourBytesReceived	unsignedInt	-	Total number of IP payload bytes received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.	-	1.0
QuarterHourPacketsSent	unsignedInt	-	Total number of IP packets sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.	-	1.0
QuarterHourPacketsReceived	unsignedInt	-	Total number of IP packets received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.	-	1.0
Device.LAN.IPPingDiagnostics.	object	-	This object is defines access to an IP-layer ping test for the default IP interface.	-	1.0
DiagnosticsState	string	W	Indicates availability of diagnostic data. Enumeration of: None Requested Complete Error_CannotResolveHostName 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
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
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
Device.LAN.TraceRouteDiagnostics.	object	-	This object is defines access to an IP-layer trace-route test for the default IP interface.	-	1.0
DiagnosticsState	string	W	Indicates availability of diagnostic data. Enumeration of: None Requested Complete Error_CannotResolveHostName Error_MaxHopCountExceeded 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
Host	string­(256)	W	Host name or address of the host to find a route to.	-	1.0
Timeout	unsignedInt­[1:]	W	Timeout in milliseconds for the trace route test.	-	1.0
DataBlockSize	unsignedInt­[1:65535]	W	Size of the data block in bytes to be sent for each trace route.	-	1.0
MaxHopCount	unsignedInt­[1:64]	W	The maximum number of hop used in outgoing probe packets (max TTL). The default is 30 hops.	-	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
ResponseTime	unsignedInt	-	Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value must be zero.	-	1.0
NumberOfRouteHops	unsignedInt	-	Result parameter indicating the number of hops within the discovered route. If a route could not be determined, this value must be zero.	-	1.0
Device.LAN.TraceRouteDiagnostics.RouteHops.{i}.	object	-	Result parameter indicating the components of the discovered route. If a route could not be determined, there will be no instances of this object.	-	1.0
HopHost	string­(256)	-	Result parameter indicating the Host Name or IP Address of a hop along the discovered route.	-	1.0

Inform and Notification Requirements

Forced Inform Parameters

Forced Active Notification Parameters

Default Active Notification Parameters

Parameters for which Active Notification MAY be Denied

Profile Definitions

Notation

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

Baseline:1 Profile

Name	Requirement
Device.	P
DeviceSummary	R
Device.­DeviceInfo.	P
Manufacturer	R
ManufacturerOUI	R
ModelName	R
Description	R
SerialNumber	R
HardwareVersion	R
SoftwareVersion	R
DeviceStatus	R
UpTime	R
Device.­ManagementServer.	P
URL	W
Username	W
Password	W
PeriodicInformEnable	W
PeriodicInformInterval	W
PeriodicInformTime	W
ParameterKey	R
ConnectionRequestURL	R
ConnectionRequestUsername	W
ConnectionRequestPassword	W
UpgradesManaged	W

GatewayInfo:1 Profile

Name	Requirement
Device.­GatewayInfo.	P
ManufacturerOUI	R
ProductClass	R
SerialNumber	R

Time:1 Profile

Name	Requirement
Device.­Time.	P
NTPServer1	W
NTPServer2	W
CurrentLocalTime	R
LocalTimeZone	W

LAN:1 Profile

Name	Requirement
Device.­LAN.	P
AddressingType	R
IPAddress	R
SubnetMask	R
DefaultGateway	R
DNSServers	R
MACAddress	R
Device.­LAN.­Stats.	P
ConnectionUpTime	R
TotalBytesSent	R
TotalBytesReceived	R
TotalPacketsSent	R
TotalPacketsReceived	R

IPPing:1 Profile

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

TraceRoute:1 Profile

Name	Requirement
Device.­LAN.­TraceRouteDiagnostics.	P
DiagnosticsState	W
Host	W
Timeout	W
DataBlockSize	W
MaxHopCount	W
DSCP	W
ResponseTime	R
NumberOfRouteHops	R
Device.­LAN.­TraceRouteDiagnostics.­RouteHops.­{i}.	P
HopHost	R