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 {{bibref|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 {{bibref|RFC4007|Section 6}}. Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition. 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. 3GPP TS 23.003 Numbering, addressing and identification 3GPP CT WG4 https://www.3gpp.org/ftp/Specs/html-info/23003.htm Organizationally Unique Identifiers (OUIs) https://standards.ieee.org/faqs/regauth Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority IEEE March 1997 https://standards.ieee.org/regauth/oui/tutorials/EUI64.html IANA Uniform Resource Identifier (URI) Schemes Registry Uniform Resource Identifier (URI) Schemes IANA https://www.iana.org/assignments/uri-schemes RFC 862 Echo Protocol IETF RFC 1983 https://www.rfc-editor.org/rfc/rfc862 RFC 959 File Transfer Protocol IETF RFC 1985 https://www.rfc-editor.org/rfc/rfc958 RFC 2616 Hypertext Transfer Protocol - HTTP/1.1 IETF RFC 1999 https://www.rfc-editor.org/rfc/rfc2616 RFC 3066 Tags for the Identification of Languages IETF RFC https://www.rfc-editor.org/rfc/rfc3066 RFC 3489 STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs) IETF RFC https://www.rfc-editor.org/rfc/rfc3489 RFC 3986 Uniform Resource Identifier (URI): Generic Syntax IETF RFC https://www.rfc-editor.org/rfc/rfc3986 RFC 4007 IPv6 Scoped Address Architecture IETF RFC https://www.rfc-editor.org/rfc/rfc4007 RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace IETF RFC 2005 https://www.rfc-editor.org/rfc/rfc4122 RFC 4291 IP Version 6 Addressing Architecture IETF RFC 2006 https://www.rfc-editor.org/rfc/rfc4291 RFC 4632 Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan IETF 2006 https://www.rfc-editor.org/rfc/rfc4632 RFC7159 The JavaScript Object Notation (JSON) Data Interchange Format IETF RFC March 2014 https://www.rfc-editor.org/rfc/rfc7159 RFC 7230 Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing IETF RFC June 2014 https://www.rfc-editor.org/rfc/rfc7230 RFC 7252 The Constrained Application Protocol (CoAP) IETF RFC June 2014 https://www.rfc-editor.org/rfc/rfc7252 RFC 8141 Uniform Resource Names (URNs) IETF RFC April 2017 https://www.rfc-editor.org/rfc/rfc8141 TR-069 Amendment 2 CPE WAN Management Protocol Broadband Forum TR December 2007 TR-069 Amendment 6 CPE WAN Management Protocol Broadband Forum TR April 2018 TR-106 Amendment 2 Data Model Template for TR-069-Enabled Devices Broadband Forum TR November 2008 TR-106 Amendment 8 Data Model Template for CWMP Endpoints and USP Agents Broadband Forum TR May 2018 TR-143 Amendment 1 Corrigendum 1 Enabling Network Throughput Performance Tests and Statistical Monitoring Broadband Forum TR August 2015 Simple Object Access Protocol (SOAP) 1.1 W3C https://www.w3.org/TR/2000/NOTE-SOAP-20000508 ZigBee 2007 Specification ZigBee 2007 Specification ZigBee Alliance October 2007 https://csa-iot.org/all-solutions/zigbee The top-level object for a Device. See {{bibref|TR-106|section 3.7}}. This object contains general services information. This object contains general device information. The manufacturer of the CPE (human readable string). 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 {{bibref|OUI}}. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Model name of the CPE (human readable string). A full description of the CPE device (human readable string). 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 {{param|SerialNumber}} parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Serial number of the CPE. This value MUST remain fixed over the lifetime of the device, including across firmware updates. A string identifying the particular CPE model and version. 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''. 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 {{bibref|TR-069a2}}. Only those options are listed whose State indicates the option is enabled. A comma-separated list of any additional versions. Represents any additional hardware version information the vendor might wish to supply. A comma-separated list of any additional versions. Represents any additional software version information the vendor might wish to supply. 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. Current operational status of the device. Time in seconds since the CPE was last restarted. 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. If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value. Vendor-specific log(s). This object contains parameters relating to the CPE's association with an ACS. URL, as defined in {{bibref|RFC3986}}, 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. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. 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. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. 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 {{empty}}, regardless of the actual value. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call. The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if {{param|PeriodicInformEnable}} is {{true}}. An absolute time reference in UTC to determine when the CPE will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicInformInterval}}. {{param}} is used only to set the ''phase'' of the periodic Informs. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then periodic Informs will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified {{param|PeriodicInformInterval}}. If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. {{param}} provides the ACS a reliable and extensible means to track changes made by the ACS. The value of {{param}} 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 {{param}} 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 {{param}} MUST NOT be modified. The CPE MUST only modify the value of {{param}} as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of {{param}} MUST be set to {{empty}}. HTTP URL, as defined in {{bibref|RFC3986}}, 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. Username used to authenticate an ACS making a Connection Request to the CPE. Password used to authenticate an ACS making a Connection Request to the CPE. When read, this parameter returns {{empty}}, regardless of the actual value. 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. Note that an autonomous upgrade (reported via an "10 AUTONOMOUS TRANSFER COMPLETE" Inform Event code) SHOULD be regarded as a managed upgrade if it is performed according to ACS-specified policy. Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in {{bibref|RFC3986}}, 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. Present only for a CPE that provides a LAN-side web page to show progress during a file download. LAN-accessible URL, as defined in {{bibref|RFC3986}}, 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. Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see {{bibref|TR-069a2|Annex G}}). This parameter is represented in the form of an Authority element as defined in {{bibref|RFC3986}}. The value MUST be in one of the following two forms: : host:port : host * When {{param|STUNEnable}} is {{true}}, the ''host'' and ''port'' portions of this parameter MUST represent the public address and port corresponding to the NAT binding through which the ACS can send UDP Connection Request messages (once this information is learned by the CPE through the use of STUN). * When {{param|STUNEnable}} is {{false}}, the ''host'' and ''port'' portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages. The second form of this parameter MAY be used only if the port value is equal to ''80''. The minimum time, in seconds, between Active Notifications resulting from changes to the {{param|UDPConnectionRequestAddress}} (if Active Notification is enabled). Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via {{param|STUNEnable}}. If is {{empty}} and {{param|STUNEnable}} is {{true}}, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL. Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via {{param|STUNEnable}}. By default, this SHOULD be the equal to the default STUN port, 3478. If is not {{empty}}, the value of the STUN USERNAME attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server). If is {{empty}}, the CPE MUST NOT send STUN Binding Requests with message integrity. The value of the STUN Password to be used in computing the MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server). When read, this parameter returns {{empty}}, regardless of the actual value. If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port. A value of -1 indicates that no maximum period is specified. If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in {{bibref|RFC3489}}. When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use. A {{true}} value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE's source address and port. When {{param|STUNEnable}} is {{false}}, this value MUST be {{false}}. This object contains information associated with a connected Internet Gateway Device. Organizationally unique identifier of the associated Internet Gateway Device. {{empty}} indicates that there is no associated Internet Gateway Device that has been detected. Identifier of the product class of the associated Internet Gateway Device. {{empty}} 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. Serial number of the associated Internet Gateway Device. {{empty}} indicates that there is no associated Internet Gateway Device that has been detected. This object contains general configuration parameters. Arbitrary user data that MUST persist across CPE reboots. 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. An alternative to this parameter, e.g. when the configuration file is larger than the parameter size limit, is to use the Upload and Download RPCs with a FileType of ''1 Vendor Configuration File''. This object contains parameters relating an NTP or SNTP time client in the CPE. First NTP timeserver. Either a host name or IP address. Second NTP timeserver. Either a host name or IP address. Third NTP timeserver. Either a host name or IP address. Fourth NTP timeserver. Either a host name or IP address. Fifth NTP timeserver. Either a host name or IP address. The current date and time in the CPE's local time zone. 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 This object contains parameters relating to the user interface of the CPE. 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. 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. Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user. Indicates the date and time in UTC that the warranty associated with the CPE is to expire. The name of the customer's ISP. The help desk phone number of the ISP. The URL of the ISP's home page. The URL of the ISP's on-line support page. Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less. 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. The URL of the ISP's mail server. The URL of the ISP's news server. The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088). The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088). The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). 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 {{param|.ManagementServer.UpgradesManaged}} parameter is {{true}}. 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 {{param|.ManagementServer.UpgradesManaged}} parameter is {{true}}. Comma-separated list of user-interface languages that are available, where each language is specified according to RFC 3066 {{bibref|RFC3066}}. Current user-interface language, specified according to RFC 3066 {{bibref|RFC3066}}. 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 might be associated with other interfaces is not considered part of the common data model defined in this specification. The method used to assign an address to this interface. {{enum}} The ability to modify this parameter is OPTIONAL. The current IP address assigned to this interface. The ability to modify this parameter is OPTIONAL, and this parameter cannot be modified if the {{param|AddressingType}} is {{enum|DHCP|AddressingType}}. The current subnet mask. The ability to modify this parameter is OPTIONAL, and this parameter cannot be modified if the {{param|AddressingType}} is {{enum|DHCP|AddressingType}}. 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 {{param|AddressingType}} is {{enum|DHCP|AddressingType}}. 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 {{param|AddressingType}} is {{enum|DHCP|AddressingType}}. If this parameter is modifiable, the device MAY ignore any DNS servers beyond the first two in the list. The physical address of this interface. Writable only if {{param|MACAddressOverride}} is present and equal to {{true}}. Whether the value of MACAddress parameter can be overridden. * When {{true}}, {{param|MACAddress}} is writable. * When {{false}}, {{param|MACAddress}} is not writable, and the default MAC address assigned by the device SHOULD be restored. Number of entries in the DHCP option table. 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. 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 {{param|Tag}} in the Parameter Request List, as defined in RFC 2132. The {{param|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 {{param|Tag}} and {{param|Value}} parameters (with the Length derived from the length of the {{param|Value}} parameter). Tag of the DHCP option as defined in RFC 2132. Base64 encoded octet string to be used as the Value of the DHCP option if {{param|Request}} is {{false}}. This object contains statistics for the default IP interface. 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. Total number of IP payload bytes sent over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}. Total number of IP payload bytes received over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}. Total number of IP packets sent over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}. Total number of IP packets received over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}. 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 does not need to do so. Total number of IP payload bytes sent over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}. Total number of IP payload bytes received over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}. Total number of IP packets sent over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}. Total number of IP packets received over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}. 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 does not need to do so. Total number of IP payload bytes sent over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}. Total number of IP payload bytes received over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}. Total number of IP packets sent over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}. Total number of IP packets received over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}. This object defines access to an IP-layer ping test for the default IP interface. Indicates availability of diagnostic data. {{enum}} If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|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 {{param}} to {{enum|Requested}}. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. 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. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. Host name or address of the host to ping. Number of repetitions of the ping test to perform before reporting the results. Timeout in milliseconds for the ping test. Size of the data block in bytes to be sent for each ping. DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. 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. Result parameter indicating the number of failed pings in the most recent ping test. 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. 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. 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. This object is defines access to an IP-layer trace-route test for the default IP interface. Indicates availability of diagnostic data. {{enum}} If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|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 {{param}} to {{enum|Requested}}. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. 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. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. Host name or address of the host to find a route to. Timeout in milliseconds for the trace route test. Size of the data block in bytes to be sent for each trace route. The maximum number of hop used in outgoing probe packets (max TTL). The default is 30 hops. DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. 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. Result parameter indicating the number of hops within the discovered route. If a route could not be determined, this value MUST be zero. Result parameter indicating the components of the discovered route. If a route could not be determined, there will be no instances of this object. Result parameter indicating the Host Name or IP Address of a hop along the discovered route. The capabilities of the device. This is a constant read-only object, meaning that only a firmware upgrade will cause these values to be altered. The capabilities of the Performance Diagnostics (''DownloadDiagnostics'' and ''UploadDiagnostics'') for the device. Supported ''DownloadDiagnostics'' transport protocols for a CPE device. Supported ''UploadDiagnostics'' transport protocols for a CPE device. This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device. Indicate the availability of diagnostic data. {{enum}} If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|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 {{param}} to {{enum|Requested}}. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either {{enum|Completed}} (if the test completed successfully), or one of the ''Error'' values listed above. If the value of this parameter is anything other than {{enum|Completed}}, the values of the results parameters for this test are indeterminate. 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. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. {{reference|the IP-layer interface over which the test is to be performed}} The value of this parameter MUST be either a valid interface or {{empty}}. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If {{empty}} is specified, the CPE MUST use the default routing interface. The URL, as defined in {{bibref|RFC3986}}, for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP {{bibref|RFC2616}} or FTP {{bibref|RFC959}} URL. * When using FTP transport, FTP binary transfer MUST be used. * When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used. * When using HTTP transport the HTTP Authentication MUST NOT be used. The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the client sends the GET command. * For FTP this is the time at which the client sends the RTRV command. Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the first data packet is received. * For FTP this is the time at which the client receives the first data packet on the data connection. End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the last data packet is received. * For FTP this is the time at which the client receives the last packet on the data connection. The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between {{param|BOMTime}} and {{param|EOMTime}}, The total number of bytes received on the Interface between {{param|BOMTime}} and {{param|EOMTime}}. Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection. * For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection. Note: Interval of 1 microsecond SHOULD be supported. Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received. * For FTP this is the time at which the TCP ACK to the socket opening the data connection was received. Note: Interval of 1 microsecond SHOULD be supported. This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. Indicate the availability of diagnostic data. {{enum}} If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|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 {{param}} to {{enum|Requested}}. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either {{enum|Completed}} (if the test completed successfully), or one of the ''Error'' values listed above. If the value of this parameter is anything other than {{enum|Completed}}, the values of the results parameters for this test are indeterminate. 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. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. {{reference|the IP-layer interface over which the test is to be performed}} The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If {{empty}} is specified, the CPE MUST use the default routing interface. The URL, as defined in {{bibref|RFC3986}}, for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP {{bibref|RFC2616}} or FTP {{bibref|RFC959}} URL. * When using FTP transport, FTP binary transfer MUST be used. * When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used. * When using HTTP transport the HTTP Authentication MUST NOT be used. DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent. Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the client sends the PUT command * For FTP this is the time at which the STOR command is sent. Begin of transmission time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the first data packet is sent. * For FTP this is the time at which the client receives the ready for transfer notification. End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time when the HTTP successful response code is received. * For FTP this is the time when the client receives a transfer complete. The total number of bytes sent on the Interface between {{param|BOMTime}} and {{param|EOMTime}}. Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection. * For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection Note: Interval of 1 microsecond SHOULD be supported. Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 * For HTTP this is the Time at which the TCP ACK to the socket opening the HTTP connection was received. * For FTP this is the Time at which the TCP ACK to the socket opening the Data connection was received. Note: Interval of 1 microsecond SHOULD be supported. This object allows the CPE to be configured to perform the UDP Echo Service defined in {{bibref|RFC862}} and UDP Echo Plus Service defined in {{bibref|TR-143|Appendix A.1}}. MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared. {{reference|IP-layer interface over which the CPE MUST listen and receive UDP echo requests on}} The value of this parameter MUST be either a valid interface or {{empty}}. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If {{empty}} is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets. The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address. The UDP port on which the UDP server MUST listen and respond to UDP echo requests. If {{true}} the CPE will perform necessary packet processing for UDP Echo Plus packets. {{true}} if UDP Echo Plus is supported. Incremented upon each valid UDP echo packet received. Incremented for each UDP echo response sent. The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled. The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled. Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456, The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled. Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 The time that the server receives the most recent UDP echo packet.