mirror of
https://dev.iopsys.eu/bbf/bbfdm.git
synced 2026-03-14 21:20:28 +01:00
2261 lines
111 KiB
XML
2261 lines
111 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- DO NOT EDIT; generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:14:03.
|
|
report.pl -exitcode=fatals -cwmpindex=.. -nofontstyles -nowarnreport -quiet -report=xml -outfile=tr-106-1-2-0-full.xml tr-106-1-2-0.xml
|
|
See https://github.com/BroadbandForum/cwmp-xml-tools/tree/master/Report_Tool. -->
|
|
<!--
|
|
TR-069 Device:1.2 Root Object errata and clarifications
|
|
|
|
Copyright (c) 2008-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.
|
|
|
|
Summary:
|
|
TR-069 Device:1.2 Root Object errata and clarifications.
|
|
|
|
Version History:
|
|
November 2008: tr-106-1-2-0.xml, corresponds to TR-106 Amendment 2 section
|
|
3.4 (Common Object Definitions), section 3.5 (Inform Require-
|
|
ments), section 3.6 (Notification Requirements) and section 4
|
|
(Profile Definitions). Contains only the differences from
|
|
Device:1.2 as defined in TR-143.
|
|
September 2009: tr-106-1-2-0.xml (name unchanged)
|
|
- removed duplicate bibrefs
|
|
- fixed cwmp-datamodel.xsd to be cwmp-datamodel-1-0.xsd
|
|
-->
|
|
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-0"
|
|
xmlns:dmr="urn:broadband-forum-org:cwmp:datamodel-report-0-1"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="urn:broadband-forum-org:cwmp:datamodel-1-0 http://www.broadband-forum.org/cwmp/cwmp-datamodel-1-0.xsd urn:broadband-forum-org:cwmp:datamodel-report-0-1 http://www.broadband-forum.org/cwmp/cwmp-datamodel-report.xsd"
|
|
spec="urn:broadband-forum-org:tr-106-1-2-0">
|
|
<dataType name="IPAddress">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<string>
|
|
<size maxLength="45"/>
|
|
</string>
|
|
</dataType>
|
|
<dataType name="IPv4Address" base="IPAddress">
|
|
<description>
|
|
IPv4 address (or subnet mask).
|
|
Can be any IPv4 address that is permitted by the ''IPAddress'' data type.
|
|
</description>
|
|
<size maxLength="15"/>
|
|
</dataType>
|
|
<dataType name="IPv6Address" base="IPAddress">
|
|
<description>
|
|
IPv6 address.
|
|
Can be any IPv6 address that is permitted by the ''IPAddress'' data type.
|
|
</description>
|
|
<size maxLength="45"/>
|
|
</dataType>
|
|
<dataType name="IPPrefix">
|
|
<description>
|
|
IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|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 {{empty}} 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 {{empty}} unless otherwise specified by the parameter definition.
|
|
</description>
|
|
<string>
|
|
<size maxLength="49"/>
|
|
</string>
|
|
</dataType>
|
|
<dataType name="IPv4Prefix" base="IPPrefix">
|
|
<description>
|
|
IPv4 address prefix.
|
|
Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type.
|
|
</description>
|
|
<size maxLength="18"/>
|
|
</dataType>
|
|
<dataType name="IPv6Prefix" base="IPPrefix">
|
|
<description>
|
|
IPv6 address prefix.
|
|
Can be any IPv6 prefix that is permitted by the ''IPPrefix'' data type.
|
|
</description>
|
|
<size maxLength="49"/>
|
|
</dataType>
|
|
<dataType name="MACAddress">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<string>
|
|
<size maxLength="17"/>
|
|
<pattern value=""/>
|
|
<pattern value="([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])"/>
|
|
</string>
|
|
</dataType>
|
|
<dataType name="StatsCounter32">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<unsignedInt>
|
|
</unsignedInt>
|
|
</dataType>
|
|
<dataType name="StatsCounter64">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<unsignedLong>
|
|
</unsignedLong>
|
|
</dataType>
|
|
<dataType name="Alias">
|
|
<description>
|
|
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 {{bibref|TR-069a4|3.6.1}} and described in {{bibref|TR-069a4|Appendix II}}, 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.
|
|
</description>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</dataType>
|
|
<dataType name="Dbm1000">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<int>
|
|
</int>
|
|
</dataType>
|
|
<dataType name="UUID">
|
|
<description>
|
|
Universally Unique Identifier. See {{bibref|RFC4122}}.
|
|
</description>
|
|
<string>
|
|
<size minLength="36" maxLength="36"/>
|
|
<pattern value="[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}"/>
|
|
</string>
|
|
</dataType>
|
|
<dataType name="IEEE_EUI64">
|
|
<description>
|
|
The IEEE EUI 64-bit identifier as defined in {{bibref|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.
|
|
</description>
|
|
<string>
|
|
<size maxLength="23"/>
|
|
<pattern value=""/>
|
|
<pattern value="([0-9A-Fa-f][0-9A-Fa-f]:){7}([0-9A-Fa-f][0-9A-Fa-f])"/>
|
|
</string>
|
|
</dataType>
|
|
<dataType name="ZigBeeNetworkAddress">
|
|
<description>
|
|
The ZigBee 16-bit network address (NWK) as defined in {{bibref|ZigBee2007}}. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices.
|
|
</description>
|
|
<string>
|
|
<size maxLength="4"/>
|
|
<pattern value=""/>
|
|
<pattern value="([0-9A-Fa-f]){4}"/>
|
|
</string>
|
|
</dataType>
|
|
<bibliography>
|
|
<reference id="OUI">
|
|
<name>Organizationally Unique Identifiers (OUIs)</name>
|
|
<hyperlink>http://standards.ieee.org/faqs/OUI.html</hyperlink>
|
|
</reference>
|
|
<reference id="RFC862">
|
|
<name>RFC 862</name>
|
|
<title>Echo Protocol</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<date>1983</date>
|
|
<hyperlink>http://tools.ietf.org/html/rfc862</hyperlink>
|
|
</reference>
|
|
<reference id="RFC959">
|
|
<name>RFC 959</name>
|
|
<title>File Transfer Protocol</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<date>1985</date>
|
|
<hyperlink>http://tools.ietf.org/html/rfc959</hyperlink>
|
|
</reference>
|
|
<reference id="RFC2616">
|
|
<name>RFC 2616</name>
|
|
<title>Hypertext Transfer Protocol -- HTTP/1.1</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<date>1999</date>
|
|
<hyperlink>http://tools.ietf.org/html/rfc2616</hyperlink>
|
|
</reference>
|
|
<reference id="RFC3066">
|
|
<name>RFC 3066</name>
|
|
<title>Tags for the Identification of Languages</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<hyperlink>http://tools.ietf.org/html/rfc3066</hyperlink>
|
|
</reference>
|
|
<reference id="RFC3489">
|
|
<name>RFC 3489</name>
|
|
<title>STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<hyperlink>http://tools.ietf.org/html/rfc3489</hyperlink>
|
|
</reference>
|
|
<reference id="RFC3986">
|
|
<name>RFC 3986</name>
|
|
<title>Uniform Resource Identifier (URI): Generic Syntax</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<hyperlink>http://tools.ietf.org/html/rfc3986</hyperlink>
|
|
</reference>
|
|
<reference id="RFC4122">
|
|
<name>RFC 4122</name>
|
|
<title>A Universally Unique IDentifier (UUID) URN Namespace</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<date>2005</date>
|
|
<hyperlink>http://tools.ietf.org/html/rfc4122</hyperlink>
|
|
</reference>
|
|
<reference id="RFC4291">
|
|
<name>RFC 4291</name>
|
|
<title>IP Version 6 Addressing Architecture</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<date>2006</date>
|
|
<hyperlink>http://tools.ietf.org/html/rfc4291</hyperlink>
|
|
</reference>
|
|
<reference id="RFC4632">
|
|
<name>RFC 4632</name>
|
|
<title>Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan</title>
|
|
<organization>IETF</organization>
|
|
<category>RFC</category>
|
|
<date>2006</date>
|
|
<hyperlink>http://tools.ietf.org/html/rfc4632</hyperlink>
|
|
</reference>
|
|
<reference id="SOAP1.1">
|
|
<name>Simple Object Access Protocol (SOAP) 1.1</name>
|
|
<organization>W3C</organization>
|
|
<hyperlink>http://www.w3.org/TR/2000/NOTE-SOAP-20000508</hyperlink>
|
|
</reference>
|
|
<reference id="TR-069">
|
|
<name>TR-069</name>
|
|
<title>CPE WAN Management Protocol</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2004</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-069.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-069a1">
|
|
<name>TR-069 Amendment 1</name>
|
|
<title>CPE WAN Management Protocol</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2006</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-069_Amendment-1.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-069a2">
|
|
<name>TR-069 Amendment 2</name>
|
|
<title>CPE WAN Management Protocol</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2007</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-069_Amendment-2.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-069a4">
|
|
<name>TR-069 Amendment 4</name>
|
|
<title>CPE WAN Management Protocol</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2011</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-069_Amendment-4.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-106">
|
|
<name>TR-106</name>
|
|
<title>Data Model Template for TR-069-Enabled Devices</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2005</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-106.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-106a1">
|
|
<name>TR-106 Amendment 1</name>
|
|
<title>Data Model Template for TR-069-Enabled Devices</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2006</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-106_Amendment-1.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-106a2">
|
|
<name>TR-106 Amendment 2</name>
|
|
<title>Data Model Template for TR-069-Enabled Devices</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2008</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-106_Amendment-2.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-106a7">
|
|
<name>TR-106 Amendment 7</name>
|
|
<title>Data Model Template for TR-069-Enabled Devices</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2013</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-106_Amendment-7.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="TR-143">
|
|
<name>TR-143</name>
|
|
<title>Enabling Network Throughput Performance Tests and Statistical Monitoring</title>
|
|
<organization>Broadband Forum</organization>
|
|
<category>Technical Report</category>
|
|
<date>2008</date>
|
|
<hyperlink>http://www.broadband-forum.org/technical/download/TR-143.pdf</hyperlink>
|
|
</reference>
|
|
<reference id="ZigBee2007">
|
|
<name>ZigBee 2007 Specification</name>
|
|
<title>ZigBee 2007 Specification</title>
|
|
<organization>ZigBee Alliance</organization>
|
|
<date>October 2007</date>
|
|
<hyperlink>http://www.zigbee.org/Specifications/ZigBee/download.aspx</hyperlink>
|
|
</reference>
|
|
</bibliography>
|
|
<model name="Device:1.2">
|
|
<object name="Device." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
The top-level object for a Device.
|
|
</description>
|
|
<parameter name="DeviceSummary" access="readOnly" forcedInform="true" dmr:version="1.0">
|
|
<description>
|
|
See {{bibref|TR-106|section 3.7}}.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="1024"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.Services." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains general services information.
|
|
</description>
|
|
</object>
|
|
<object name="Device.Capabilities." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
</object>
|
|
<object name="Device.Capabilities.PerformanceDiagnostic." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.2">
|
|
<description>
|
|
The capabilities of the Performance Diagnostics (''DownloadDiagnostics'' and ''UploadDiagnostics'') for the device.
|
|
</description>
|
|
<parameter name="DownloadTransports" access="readOnly" dmr:version="1.2">
|
|
<description>
|
|
Supported ''DownloadDiagnostics'' transport protocols for a CPE device.
|
|
</description>
|
|
<syntax>
|
|
<list/>
|
|
<string>
|
|
<enumeration value="HTTP"/>
|
|
<enumeration value="FTP" optional="true"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UploadTransports" access="readOnly" dmr:version="1.2">
|
|
<description>
|
|
Supported ''UploadDiagnostics'' transport protocols for a CPE device.
|
|
</description>
|
|
<syntax>
|
|
<list/>
|
|
<string>
|
|
<enumeration value="HTTP"/>
|
|
<enumeration value="FTP" optional="true"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.DeviceInfo." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains general device information.
|
|
</description>
|
|
<parameter name="Manufacturer" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
The manufacturer of the CPE (human readable string).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ManufacturerOUI" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="6"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ModelName" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Model name of the CPE (human readable string).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Description" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
A full description of the CPE device (human readable string).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ProductClass" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="SerialNumber" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
Serial number of the CPE.
|
|
This value MUST remain fixed over the lifetime of the device, including across firmware updates.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="HardwareVersion" access="readOnly" forcedInform="true" dmr:version="1.0">
|
|
<description>
|
|
A string identifying the particular CPE model and version.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="SoftwareVersion" access="readOnly" forcedInform="true" dmr:version="1.0">
|
|
<description>
|
|
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''.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EnabledOptions" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<list>
|
|
<size maxLength="1024"/>
|
|
</list>
|
|
<string/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="AdditionalHardwareVersion" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
A comma-separated list of any additional versions. Represents any additional hardware version information the vendor might wish to supply.
|
|
</description>
|
|
<syntax>
|
|
<list>
|
|
<size maxLength="64"/>
|
|
</list>
|
|
<string/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="AdditionalSoftwareVersion" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
A comma-separated list of any additional versions. Represents any additional software version information the vendor might wish to supply.
|
|
</description>
|
|
<syntax>
|
|
<list>
|
|
<size maxLength="64"/>
|
|
</list>
|
|
<string/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ProvisioningCode" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DeviceStatus" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
Current operational status of the device.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<enumeration value="Up"/>
|
|
<enumeration value="Initializing"/>
|
|
<enumeration value="Error"/>
|
|
<enumeration value="Disabled"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UpTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Time in seconds since the CPE was last restarted.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="FirstUseDate" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DeviceLog" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Vendor-specific log(s).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="32768"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.ManagementServer." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains parameters relating to the CPE's association with an ACS.
|
|
</description>
|
|
<parameter name="URL" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Username" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Password" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax hidden="true">
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="PeriodicInformEnable" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="PeriodicInformInterval" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="PeriodicInformTime" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ParameterKey" access="readOnly" activeNotify="canDeny" forcedInform="true" dmr:version="1.0">
|
|
<description>
|
|
{{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}}.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="32"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ConnectionRequestURL" access="readOnly" forcedInform="true" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ConnectionRequestUsername" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Username used to authenticate an ACS making a Connection Request to the CPE.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ConnectionRequestPassword" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Password used to authenticate an ACS making a Connection Request to the CPE.
|
|
When read, this parameter returns {{empty}}, regardless of the actual value.
|
|
</description>
|
|
<syntax hidden="true">
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UpgradesManaged" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="KickURL" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DownloadProgressURL" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UDPConnectionRequestAddress" access="readOnly" dmr:version="1.1">
|
|
<description>
|
|
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''.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UDPConnectionRequestAddressNotificationLimit" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
The minimum time, in seconds, between Active Notifications resulting from changes to the {{param|UDPConnectionRequestAddress}} (if Active Notification is enabled).
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNEnable" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNServerAddress" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNServerPort" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="65535"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNUsername" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNPassword" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax hidden="true">
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNMaximumKeepAlivePeriod" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<int>
|
|
<range minInclusive="-1"/>
|
|
</int>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="STUNMinimumKeepAlivePeriod" access="readWrite" dmr:version="1.1">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NATDetected" access="readOnly" dmr:version="1.1">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.GatewayInfo." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains information associated with a connected Internet Gateway Device.
|
|
</description>
|
|
<parameter name="ManufacturerOUI" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
Organizationally unique identifier of the associated Internet Gateway Device. {{empty}} indicates that there is no associated Internet Gateway Device that has been detected.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="6"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ProductClass" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="SerialNumber" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
Serial number of the associated Internet Gateway Device. {{empty}} indicates that there is no associated Internet Gateway Device that has been detected.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.Config." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains general configuration parameters.
|
|
</description>
|
|
<parameter name="PersistentData" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Arbitrary user data that MUST persist across CPE reboots.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ConfigFile" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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''.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="32768"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.Time." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains parameters relating an NTP or SNTP time client in the CPE.
|
|
</description>
|
|
<parameter name="NTPServer1" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
First NTP timeserver. Either a host name or IP address.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NTPServer2" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Second NTP timeserver. Either a host name or IP address.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NTPServer3" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Third NTP timeserver. Either a host name or IP address.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NTPServer4" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Fourth NTP timeserver. Either a host name or IP address.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NTPServer5" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Fifth NTP timeserver. Either a host name or IP address.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentLocalTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
The current date and time in the CPE's local time zone.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="LocalTimeZone" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.UserInterface." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains parameters relating to the user interface of the CPE.
|
|
</description>
|
|
<parameter name="PasswordRequired" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="PasswordUserSelectable" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UpgradeAvailable" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="WarrantyDate" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Indicates the date and time in UTC that the warranty associated with the CPE is to expire.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPName" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The name of the customer's ISP.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="64"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPHelpDesk" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The help desk phone number of the ISP.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="32"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPHomePage" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The URL of the ISP's home page.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPHelpPage" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The URL of the ISP's on-line support page.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPLogo" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less.
|
|
</description>
|
|
<syntax>
|
|
<base64>
|
|
<size minLength="0" maxLength="4095"/>
|
|
</base64>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPLogoSize" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="4095"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPMailServer" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The URL of the ISP's mail server.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ISPNewsServer" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The URL of the ISP's news server.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TextColor" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="6"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="BackgroundColor" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="6"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ButtonColor" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="6"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ButtonTextColor" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088).
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="6"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="AutoUpdateServer" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UserUpdateServer" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="AvailableLanguages" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
Comma-separated list of user-interface languages that are available, where each language is specified according to RFC 3066 {{bibref|RFC3066}}.
|
|
</description>
|
|
<syntax>
|
|
<list>
|
|
<size maxLength="256"/>
|
|
</list>
|
|
<string/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentLanguage" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Current user-interface language, specified according to RFC 3066 {{bibref|RFC3066}}.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="16"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.LAN." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<parameter name="AddressingType" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The method used to assign an address to this interface. {{enum}}
|
|
The ability to modify this parameter is OPTIONAL.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<enumeration value="DHCP"/>
|
|
<enumeration value="Static"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="IPAddress" access="readWrite" forcedInform="true" dmr:version="1.0">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<dataType ref="IPAddress"/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="SubnetMask" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<dataType ref="IPAddress"/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DefaultGateway" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<syntax>
|
|
<string/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DNSServers" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<list>
|
|
<size maxLength="256"/>
|
|
</list>
|
|
<string/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="MACAddress" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The physical address of this interface. Writable only if {{param|MACAddressOverride}} is present and equal to {{true}}.
|
|
</description>
|
|
<syntax>
|
|
<dataType ref="MACAddress"/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="MACAddressOverride" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DHCPOptionNumberOfEntries" access="readOnly" dmr:version="1.0">
|
|
<description>
|
|
Number of entries in the DHCP option table.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.LAN.DHCPOption.{i}." access="readWrite" numEntriesParameter="DHCPOptionNumberOfEntries" minEntries="0" maxEntries="unbounded" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<parameter name="Request" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
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).
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Tag" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Tag of the DHCP option as defined in RFC 2132.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1" maxInclusive="254"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Value" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Base64 encoded octet string to be used as the Value of the DHCP option if {{param|Request}} is {{false}}.
|
|
</description>
|
|
<syntax>
|
|
<base64>
|
|
<size maxLength="255"/>
|
|
</base64>
|
|
<default type="object" value=""/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.LAN.Stats." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object contains statistics for the default IP interface.
|
|
</description>
|
|
<parameter name="ConnectionUpTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TotalBytesSent" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP payload bytes sent over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TotalBytesReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP payload bytes received over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TotalPacketsSent" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP packets sent over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TotalPacketsReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP packets received over this interface since the device was last restarted as specified in {{param|.DeviceInfo.UpTime}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentDayInterval" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentDayBytesSent" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP payload bytes sent over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentDayBytesReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP payload bytes received over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentDayPacketsSent" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP packets sent over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="CurrentDayPacketsReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP packets received over this interface since the beginning of the current-day interval as specified by {{param|CurrentDayInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="QuarterHourInterval" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="QuarterHourBytesSent" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP payload bytes sent over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="QuarterHourBytesReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP payload bytes received over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="QuarterHourPacketsSent" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP packets sent over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="QuarterHourPacketsReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Total number of IP packets received over this interface since the beginning of the quarter-hour interval as specified by {{param|QuarterHourInterval}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.LAN.IPPingDiagnostics." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object defines access to an IP-layer ping test for the default IP interface.
|
|
</description>
|
|
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<enumeration value="None"/>
|
|
<enumeration value="Requested"/>
|
|
<enumeration value="Complete"/>
|
|
<enumeration value="Error_CannotResolveHostName"/>
|
|
<enumeration value="Error_Internal"/>
|
|
<enumeration value="Error_Other"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Host" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Host name or address of the host to ping.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NumberOfRepetitions" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Number of repetitions of the ping test to perform before reporting the results.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Timeout" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Timeout in milliseconds for the ping test.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DataBlockSize" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Size of the data block in bytes to be sent for each ping.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1" maxInclusive="65535"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DSCP" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="63"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="SuccessCount" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="FailureCount" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Result parameter indicating the number of failed pings in the most recent ping test.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="AverageResponseTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="MinimumResponseTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="MaximumResponseTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.LAN.TraceRouteDiagnostics." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.0">
|
|
<description>
|
|
This object is defines access to an IP-layer trace-route test for the default IP interface.
|
|
</description>
|
|
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<enumeration value="None"/>
|
|
<enumeration value="Requested"/>
|
|
<enumeration value="Complete"/>
|
|
<enumeration value="Error_CannotResolveHostName"/>
|
|
<enumeration value="Error_MaxHopCountExceeded"/>
|
|
<enumeration value="Error_Internal"/>
|
|
<enumeration value="Error_Other"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Host" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Host name or address of the host to find a route to.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Timeout" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Timeout in milliseconds for the trace route test.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DataBlockSize" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
Size of the data block in bytes to be sent for each trace route.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1" maxInclusive="65535"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="MaxHopCount" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
The maximum number of hop used in outgoing probe packets (max TTL). The default is 30 hops.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="1" maxInclusive="64"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DSCP" access="readWrite" dmr:version="1.0">
|
|
<description>
|
|
DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="63"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ResponseTime" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="NumberOfRouteHops" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Result parameter indicating the number of hops within the discovered route. If a route could not be determined, this value MUST be zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.LAN.TraceRouteDiagnostics.RouteHops.{i}." access="readOnly" numEntriesParameter="NumberOfRouteHops" minEntries="0" maxEntries="unbounded" dmr:version="1.0">
|
|
<description>
|
|
Result parameter indicating the components of the discovered route. If a route could not be determined, there will be no instances of this object.
|
|
</description>
|
|
<parameter name="HopHost" access="readOnly" activeNotify="canDeny" dmr:version="1.0">
|
|
<description>
|
|
Result parameter indicating the Host Name or IP Address of a hop along the discovered route.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.DownloadDiagnostics." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<enumeration value="None" access="readOnly"/>
|
|
<enumeration value="Requested"/>
|
|
<enumeration value="Completed" access="readOnly"/>
|
|
<enumeration value="Error_InitConnectionFailed" access="readOnly"/>
|
|
<enumeration value="Error_NoResponse" access="readOnly"/>
|
|
<enumeration value="Error_TransferFailed" access="readOnly"/>
|
|
<enumeration value="Error_PasswordRequestFailed" access="readOnly"/>
|
|
<enumeration value="Error_LoginFailed" access="readOnly"/>
|
|
<enumeration value="Error_NoTransferMode" access="readOnly"/>
|
|
<enumeration value="Error_NoPASV" access="readOnly"/>
|
|
<enumeration value="Error_IncorrectSize" access="readOnly"/>
|
|
<enumeration value="Error_Timeout" access="readOnly"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Interface" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
{{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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
<pathRef refType="weak" targetType="row"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DownloadURL" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DSCP" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
The DiffServ code point for marking packets transmitted in the test.
|
|
The default value SHOULD be zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="63"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EthernetPriority" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
Ethernet priority code for marking packets transmitted in the test (if applicable).
|
|
The default value SHOULD be zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="7"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ROMTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="BOMTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EOMTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TestBytesReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between {{param|BOMTime}} and {{param|EOMTime}},
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TotalBytesReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
The total number of bytes received on the Interface between {{param|BOMTime}} and {{param|EOMTime}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TCPOpenRequestTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TCPOpenResponseTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.UploadDiagnostics." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<enumeration value="None" access="readOnly"/>
|
|
<enumeration value="Requested"/>
|
|
<enumeration value="Completed" access="readOnly"/>
|
|
<enumeration value="Error_InitConnectionFailed" access="readOnly"/>
|
|
<enumeration value="Error_NoResponse" access="readOnly"/>
|
|
<enumeration value="Error_PasswordRequestFailed" access="readOnly"/>
|
|
<enumeration value="Error_LoginFailed" access="readOnly"/>
|
|
<enumeration value="Error_NoTransferMode" access="readOnly"/>
|
|
<enumeration value="Error_NoPASV" access="readOnly"/>
|
|
<enumeration value="Error_NoCWD" access="readOnly"/>
|
|
<enumeration value="Error_NoSTOR" access="readOnly"/>
|
|
<enumeration value="Error_NoTransferComplete" access="readOnly"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Interface" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
{{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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
<pathRef refType="weak" targetType="row"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UploadURL" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="DSCP" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
DiffServ code point for marking packets transmitted in the test.
|
|
The default value SHOULD be zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="63"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EthernetPriority" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
Ethernet priority code for marking packets transmitted in the test (if applicable).
|
|
The default value SHOULD be zero.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt>
|
|
<range minInclusive="0" maxInclusive="7"/>
|
|
</unsignedInt>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TestFileLength" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
The size of the file (in bytes) to be uploaded to the server.
|
|
The CPE MUST insure the appropriate number of bytes are sent.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="ROMTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="BOMTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EOMTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TotalBytesSent" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
The total number of bytes sent on the Interface between {{param|BOMTime}} and {{param|EOMTime}}.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TCPOpenRequestTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TCPOpenResponseTime" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<object name="Device.UDPEchoConfig." access="readOnly" minEntries="1" maxEntries="1" dmr:version="1.2">
|
|
<description>
|
|
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}}.
|
|
</description>
|
|
<parameter name="Enable" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="Interface" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
{{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.
|
|
</description>
|
|
<syntax>
|
|
<string>
|
|
<size maxLength="256"/>
|
|
<pathRef refType="weak" targetType="row"/>
|
|
</string>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="SourceIPAddress" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address.
|
|
</description>
|
|
<syntax>
|
|
<dataType ref="IPAddress"/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="UDPPort" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
The UDP port on which the UDP server MUST listen and respond to UDP echo requests.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EchoPlusEnabled" access="readWrite" dmr:version="1.2">
|
|
<description>
|
|
If {{true}} the CPE will perform necessary packet processing for UDP Echo Plus packets.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="EchoPlusSupported" access="readOnly" dmr:version="1.2">
|
|
<description>
|
|
{{true}} if UDP Echo Plus is supported.
|
|
</description>
|
|
<syntax>
|
|
<boolean/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="PacketsReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
Incremented upon each valid UDP echo packet received.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="PacketsResponded" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
Incremented for each UDP echo response sent.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="BytesReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="BytesResponded" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled.
|
|
</description>
|
|
<syntax>
|
|
<unsignedInt/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TimeFirstPacketReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
<parameter name="TimeLastPacketReceived" access="readOnly" activeNotify="canDeny" dmr:version="1.2">
|
|
<description>
|
|
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.
|
|
</description>
|
|
<syntax>
|
|
<dateTime/>
|
|
</syntax>
|
|
</parameter>
|
|
</object>
|
|
<profile name="Baseline:1" dmr:version="1.0">
|
|
<object ref="Device." requirement="present">
|
|
<parameter ref="DeviceSummary" requirement="readOnly"/>
|
|
</object>
|
|
<object ref="Device.DeviceInfo." requirement="present">
|
|
<parameter ref="Manufacturer" requirement="readOnly"/>
|
|
<parameter ref="ManufacturerOUI" requirement="readOnly"/>
|
|
<parameter ref="ModelName" requirement="readOnly"/>
|
|
<parameter ref="Description" requirement="readOnly"/>
|
|
<parameter ref="SerialNumber" requirement="readOnly"/>
|
|
<parameter ref="HardwareVersion" requirement="readOnly"/>
|
|
<parameter ref="SoftwareVersion" requirement="readOnly"/>
|
|
<parameter ref="DeviceStatus" requirement="readOnly"/>
|
|
<parameter ref="UpTime" requirement="readOnly"/>
|
|
</object>
|
|
<object ref="Device.ManagementServer." requirement="present">
|
|
<parameter ref="URL" requirement="readWrite"/>
|
|
<parameter ref="Username" requirement="readWrite"/>
|
|
<parameter ref="Password" requirement="readWrite"/>
|
|
<parameter ref="PeriodicInformEnable" requirement="readWrite"/>
|
|
<parameter ref="PeriodicInformInterval" requirement="readWrite"/>
|
|
<parameter ref="PeriodicInformTime" requirement="readWrite"/>
|
|
<parameter ref="ParameterKey" requirement="readOnly"/>
|
|
<parameter ref="ConnectionRequestURL" requirement="readOnly"/>
|
|
<parameter ref="ConnectionRequestUsername" requirement="readWrite"/>
|
|
<parameter ref="ConnectionRequestPassword" requirement="readWrite"/>
|
|
<parameter ref="UpgradesManaged" requirement="readWrite"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="GatewayInfo:1" dmr:version="1.0">
|
|
<object ref="Device.GatewayInfo." requirement="present">
|
|
<parameter ref="ManufacturerOUI" requirement="readOnly"/>
|
|
<parameter ref="ProductClass" requirement="readOnly"/>
|
|
<parameter ref="SerialNumber" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="Time:1" dmr:version="1.0">
|
|
<object ref="Device.Time." requirement="present">
|
|
<parameter ref="NTPServer1" requirement="readWrite"/>
|
|
<parameter ref="NTPServer2" requirement="readWrite"/>
|
|
<parameter ref="CurrentLocalTime" requirement="readOnly"/>
|
|
<parameter ref="LocalTimeZone" requirement="readWrite"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="LAN:1" dmr:version="1.0">
|
|
<object ref="Device.LAN." requirement="present">
|
|
<parameter ref="AddressingType" requirement="readOnly"/>
|
|
<parameter ref="IPAddress" requirement="readOnly"/>
|
|
<parameter ref="SubnetMask" requirement="readOnly"/>
|
|
<parameter ref="DefaultGateway" requirement="readOnly"/>
|
|
<parameter ref="DNSServers" requirement="readOnly"/>
|
|
<parameter ref="MACAddress" requirement="readOnly"/>
|
|
</object>
|
|
<object ref="Device.LAN.Stats." requirement="present">
|
|
<parameter ref="ConnectionUpTime" requirement="readOnly"/>
|
|
<parameter ref="TotalBytesSent" requirement="readOnly"/>
|
|
<parameter ref="TotalBytesReceived" requirement="readOnly"/>
|
|
<parameter ref="TotalPacketsSent" requirement="readOnly"/>
|
|
<parameter ref="TotalPacketsReceived" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="IPPing:1" dmr:version="1.0">
|
|
<object ref="Device.LAN.IPPingDiagnostics." requirement="present">
|
|
<parameter ref="DiagnosticsState" requirement="readWrite"/>
|
|
<parameter ref="Host" requirement="readWrite"/>
|
|
<parameter ref="NumberOfRepetitions" requirement="readWrite"/>
|
|
<parameter ref="Timeout" requirement="readWrite"/>
|
|
<parameter ref="DataBlockSize" requirement="readWrite"/>
|
|
<parameter ref="DSCP" requirement="readWrite"/>
|
|
<parameter ref="SuccessCount" requirement="readOnly"/>
|
|
<parameter ref="FailureCount" requirement="readOnly"/>
|
|
<parameter ref="AverageResponseTime" requirement="readOnly"/>
|
|
<parameter ref="MinimumResponseTime" requirement="readOnly"/>
|
|
<parameter ref="MaximumResponseTime" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="TraceRoute:1" dmr:version="1.0">
|
|
<object ref="Device.LAN.TraceRouteDiagnostics." requirement="present">
|
|
<parameter ref="DiagnosticsState" requirement="readWrite"/>
|
|
<parameter ref="Host" requirement="readWrite"/>
|
|
<parameter ref="Timeout" requirement="readWrite"/>
|
|
<parameter ref="DataBlockSize" requirement="readWrite"/>
|
|
<parameter ref="MaxHopCount" requirement="readWrite"/>
|
|
<parameter ref="DSCP" requirement="readWrite"/>
|
|
<parameter ref="ResponseTime" requirement="readOnly"/>
|
|
<parameter ref="NumberOfRouteHops" requirement="readOnly"/>
|
|
</object>
|
|
<object ref="Device.LAN.TraceRouteDiagnostics.RouteHops.{i}." requirement="present">
|
|
<parameter ref="HopHost" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="Download:1" dmr:version="1.2">
|
|
<object ref="Device.Capabilities.PerformanceDiagnostic." requirement="present">
|
|
<parameter ref="DownloadTransports" requirement="readOnly"/>
|
|
</object>
|
|
<object ref="Device.DownloadDiagnostics." requirement="present">
|
|
<parameter ref="DiagnosticsState" requirement="readWrite"/>
|
|
<parameter ref="Interface" requirement="readWrite"/>
|
|
<parameter ref="DownloadURL" requirement="readWrite"/>
|
|
<parameter ref="DSCP" requirement="readWrite"/>
|
|
<parameter ref="EthernetPriority" requirement="readWrite"/>
|
|
<parameter ref="ROMTime" requirement="readOnly"/>
|
|
<parameter ref="BOMTime" requirement="readOnly"/>
|
|
<parameter ref="EOMTime" requirement="readOnly"/>
|
|
<parameter ref="TestBytesReceived" requirement="readOnly"/>
|
|
<parameter ref="TotalBytesReceived" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="DownloadTCP:1" dmr:version="1.2">
|
|
<object ref="Device.DownloadDiagnostics." requirement="present">
|
|
<parameter ref="TCPOpenRequestTime" requirement="readOnly"/>
|
|
<parameter ref="TCPOpenResponseTime" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="Upload:1" dmr:version="1.2">
|
|
<object ref="Device.Capabilities.PerformanceDiagnostic." requirement="present">
|
|
<parameter ref="UploadTransports" requirement="readOnly"/>
|
|
</object>
|
|
<object ref="Device.UploadDiagnostics." requirement="present">
|
|
<parameter ref="DiagnosticsState" requirement="readWrite"/>
|
|
<parameter ref="Interface" requirement="readWrite"/>
|
|
<parameter ref="UploadURL" requirement="readWrite"/>
|
|
<parameter ref="DSCP" requirement="readWrite"/>
|
|
<parameter ref="EthernetPriority" requirement="readWrite"/>
|
|
<parameter ref="ROMTime" requirement="readOnly"/>
|
|
<parameter ref="BOMTime" requirement="readOnly"/>
|
|
<parameter ref="EOMTime" requirement="readOnly"/>
|
|
<parameter ref="TestFileLength" requirement="readOnly"/>
|
|
<parameter ref="TotalBytesSent" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="UploadTCP:1" dmr:version="1.2">
|
|
<object ref="Device.UploadDiagnostics." requirement="present">
|
|
<parameter ref="TCPOpenRequestTime" requirement="readOnly"/>
|
|
<parameter ref="TCPOpenResponseTime" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="UDPEcho:1" dmr:version="1.2">
|
|
<object ref="Device.UDPEchoConfig." requirement="present">
|
|
<parameter ref="Enable" requirement="readWrite"/>
|
|
<parameter ref="Interface" requirement="readWrite"/>
|
|
<parameter ref="SourceIPAddress" requirement="readWrite"/>
|
|
<parameter ref="UDPPort" requirement="readWrite"/>
|
|
<parameter ref="PacketsReceived" requirement="readOnly"/>
|
|
<parameter ref="PacketsResponded" requirement="readOnly"/>
|
|
<parameter ref="BytesReceived" requirement="readOnly"/>
|
|
<parameter ref="BytesResponded" requirement="readOnly"/>
|
|
<parameter ref="TimeFirstPacketReceived" requirement="readOnly"/>
|
|
<parameter ref="TimeLastPacketReceived" requirement="readOnly"/>
|
|
<parameter ref="EchoPlusSupported" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="UDPEchoPlus:1" dmr:version="1.2">
|
|
<object ref="Device.UDPEchoConfig." requirement="present">
|
|
<parameter ref="EchoPlusEnabled" requirement="readWrite"/>
|
|
</object>
|
|
</profile>
|
|
<profile name="UDPConnReq:1" dmr:version="1.1">
|
|
<object ref="Device.ManagementServer." requirement="notSpecified">
|
|
<parameter ref="UDPConnectionRequestAddress" requirement="readOnly"/>
|
|
<parameter ref="UDPConnectionRequestAddressNotificationLimit" requirement="readWrite"/>
|
|
<parameter ref="STUNEnable" requirement="readWrite"/>
|
|
<parameter ref="STUNServerAddress" requirement="readWrite"/>
|
|
<parameter ref="STUNServerPort" requirement="readWrite"/>
|
|
<parameter ref="STUNUsername" requirement="readWrite"/>
|
|
<parameter ref="STUNPassword" requirement="readWrite"/>
|
|
<parameter ref="STUNMaximumKeepAlivePeriod" requirement="readWrite"/>
|
|
<parameter ref="STUNMinimumKeepAlivePeriod" requirement="readWrite"/>
|
|
<parameter ref="NATDetected" requirement="readOnly"/>
|
|
</object>
|
|
</profile>
|
|
</model>
|
|
</dm:document>
|