DATA MODEL DEFINITION
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.
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.
|Data Type||Base Type||Description|
Base64 encoded binary (no line-length limitation).
A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.
|boolean||-||Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).|
|dateTime||-||The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.|
Integer in the range -2147483648 to +2147483647, inclusive.
For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.
|string||-||For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.|
Unsigned integer in the range 0 to 4294967295, inclusive.
For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.
|[RFC3489]||RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.|
|[RFC3986]||RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.|
|[SOAP1.1]||Simple Object Access Protocol (SOAP) 1.1, W3C.|
|[TR-069a1]||TR-069 Amendment 1, CPE WAN Management Protocol, Broadband Forum, December 2006.|
|[TR-106a1]||TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2006.|
For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.1, then it will indicate support for version 1.1. The version number associated with each object and parameter is shown in the Version column.
|Device.||object||-||The top-level object for a Device.||-||1.0|
|Device.ManagementServer.||object||-||This object contains parameters relating to the CPE's association with an ACS.||-||1.0|
Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069a1]).
This parameter is represented in the form of an Authority element as defined in [RFC3986]. The value MUST be in one of the following two forms:
The second form of this parameter MAY be used only if the port value is equal to 80.
|UDPConnectionRequestAddressNotificationLimit||unsignedInt||W||The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled).||-||1.1|
|STUNEnable||boolean||W||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.||-||1.1|
Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable.
If is an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL.
Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable.
By default, this SHOULD be the equal to the default STUN port, 3478.
If is not an empty string, 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 an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity.
The value of the STUN Password to be used in computing the MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server).
When read, this parameter returns an empty string, regardless of the actual value.
When read, this parameter returns an empty string, regardless of the actual value.
If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port.
A value of -1 indicates that no maximum period is specified.
|STUNMinimumKeepAlivePeriod||unsignedInt||W||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 [RFC3489].||-||1.1|
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 STUNEnable is false, this value MUST be false.
|R||Read support is REQUIRED.|
|W||Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.|
|P||The object is REQUIRED to be present.|
|C||Creation and deletion of instances of the object is REQUIRED.|
|A||Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.|
|D||Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.|