Broadband Forum

    DATA MODEL DEFINITION


Component Objects for CWMP
tr-157-1-8-0.xml

License

Copyright (c) 2009-2017, Broadband Forum

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

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

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

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

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

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

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

Summary

Component Object definitions

TR-157 Issue 1 Amendment 8

Table of Contents

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

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

Data Type Base Type Description
Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

The IEEE EUI 64-bit identifier as defined in [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

  • The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
  • The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.

Possible patterns:

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

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

IPPrefix string(49)

IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation [RFC4632]. This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

  • IPv4 example: 192.168.1.0/24
  • IPv6 example: 2001:edff:fe6a:f76::/64

If the IP address part is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n".

If the entire IP prefix is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition.

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type.

IPv6Address IPAddress(45)

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.

MACAddress string(17)

All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

UUID string(36:36)

Universally Unique Identifier. See [RFC4122]. Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}
ZigBeeNetworkAddress string(4)

The ZigBee 16-bit network address (NWK) as defined in [ZigBee2007]. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. Possible patterns:

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

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

References

[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069, CPE WAN Management Protocol, Broadband Forum, 2004.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-069a5] TR-069 Amendment 5, CPE WAN Management Protocol, Broadband Forum, December 2013.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.
[TR-181i2] TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

TR-157:1.8 Data Model

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.8, then it will indicate support for version 1.8. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
ManagementServer. object -   - 1.8
SupportedConnReqMethods string -

Comma-separated list of strings. The connection request methods supported by this ManagementServer. Each list item is an enumeration of:

  • HTTP (The connection request method as specified in [Section 3.2.2 ACS Connection Initiation/TR-069], REQUIRED)
  • STUN (The connection request method as specified in [Annex G Connection Request via NAT Gateway/TR-069], OPTIONAL)
  • XMPP (The connection request method as specified in [Annex K XMPP Connection Request/TR-069a5], OPTIONAL)
- 1.8
ConnReqXMPPConnection string W The value MUST be the Path Name of the XMPP.Connection? instance that is used for connection requests to this ManagementServer. - 1.8
ConnReqAllowedJabberIDs string W

When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza will contian a "from" address that contains the Jabber ID of the initiating entity.

This parameter is a Comma-separated list (up to 32 items) of strings (maximum item length 256). Each entry represents a Jabber ID, or address, that is allowed to initiate an XMPP Connection Request.

Each Jabber ID is allowed to be either a "Full JID" (containing a local-part, domain-part, and resource-part in the following format: "local-part@domain-part/resource-part") or a "Bare JID" (containing a local-part and a domain-part in the following format: "local-part@domain-part"). "Full JID" entries require an exact match whereas "Bare JID" entries are a wildcard match and will match any Jabber ID with the same local-part and domain-part independent of the resource-part.

For example, if ConnReqAllowedJabberIDs contained "ACS1@tr069.example.com, ACS2@tr-069.example.com/resource1" then the following incoming "from" addresses would be allowed:

  • "ACS1@tr069.example.com/resource1"
  • "ACS1@tr069.example.com/resource2"
  • "ACS2@tr069.example.com/resource1"

And the following incoming "from" addresses would not be allowed:

  • "ACS2@tr069.example.com/resource2"
  • "ACS@tr069.example.com/resource"

If this Parameter is an empty string then all Jabber IDs are allowed and an XMPP Connection Request can not be deemed invalid due to the "from" address.

- 1.8
ConnReqJabberID string -

The value MUST be the value of the XMPP.Connection.{i}.JabberID? contained in the XMPP.Connection? instance referenced by the ConnReqXMPPConnection parameter.

If the ConnReqXMPPConnection parameter is empty or the XMPP.Connection? instance being reference is disabled, then this value will be empty.

If the XMPP.Connection? instance being referenced by the ConnReqXMPPConnection parameter is lost (XMPP.Connection.{i}.Status? parameter changes from Enabled to some other value), then the value of this parameter MUST remain unchanged until the connection can be reestablished and a new XMPP.Connection.{i}.JabberID? can be established. If the new XMPP.Connection.{i}.JabberID? is identical to the existing value, then the value of this parameter MUST NOT be altered and a VALUE CHANGE event MUST NOT be generated.

- 1.8
HTTPCompressionSupported string -

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in [Section 3.4.7/TR-069a5]. Each list item is an enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a7] MUST be adhered to.

- 1.8
HTTPCompression string W

The value MUST be a member of the list reported by the HTTPCompressionSupported parameter, or else be Disabled. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when communicating with the ACS.

The factory default value MUST be Disabled.

- 1.8
LightweightNotificationProtocolsSupported string -

Comma-separated list of strings. Indicates the Lightweight Notification Protocol(s) supported by this CPE. Each list item is an enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a7] MUST be adhered to.

- 1.8
LightweightNotificationProtocolsUsed string W

Comma-separated list of strings. Each list item MUST be a member of the list reported by the LightweightNotificationProtocolsSupported parameter, or else be an empty string. The value of this parameter represents the protocol(s) that will be used by the CPE when sending Lightweight Notifications.

An empty string means that Lightweight Notifications are disabled, despite any SetParameterAttributes that have been configured on various parameters.

- 1.8
UDPLightweightNotificationHost string­(256) W

Host name or address to be used when sending the UDP Lightweight Notifications.

UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationHost is not implemented or is an empty string, and UDP Lightweight Notifications are supported, the destination host MUST be the same as the ACS (as contained in the host portion of the URL?).

- 1.8
UDPLightweightNotificationPort unsignedInt W

The port number to be used when sending UDP Lightweight Notifications.

UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationPort is not implemented and UDP Lightweight Notifications are supported, the destination port MUST be 7547.

- 1.8
ManagementServer.StandbyPolicy. object -

Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of [Annex L/TR-069a5].

NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069.

- 1.8
CRUnawarenessMaxDuration int­[-1:] W

When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in seconds), the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for having been non CR-aware.

The factory default value MUST be -1.

- 1.8
MaxMissedPeriodic int­[-1:] W

When waking up from a non fully Timer-Aware Standby that made it miss more than this parameter's value Periodic Contacts, the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for exceeding that limit.

The factory default value MUST be -1.

- 1.8
NotifyMissedScheduled boolean W

When waking up from a non fully Timer-Aware Standby that made it miss at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if this parameter is true.

The factory default value MUST be false.

- 1.8
NetworkAwarenessCapable boolean - Indicates that the CPE is capable of CR-Aware Standby. - 1.8
SelfTimerCapable boolean - Indicates that the CPE is capable of Timer-Aware Standby. - 1.8
CRAwarenessRequested boolean W

If NetworkAwarenessCapable and this parameter are both true, the CPE MUST NOT go into a non CR-Aware Standby state.

The factory default value MUST be false.

- 1.8
PeriodicAwarenessRequested boolean W

If SelfTimerCapable and this parameter are both true, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.

The factory default value MUST be false.

- 1.8
ScheduledAwarenessRequested boolean W

If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact:

  • if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby;
  • if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.
- 1.8
XMPP. object - The XMPP represents the XMPP capabilities of the device as described in [Appendix III/TR-069a5]. - 1.8
ConnectionNumberOfEntries unsignedInt - The number of entries in the Connection table. - 1.8
XMPP.Connection.{i}. object W

The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with all the same values for Username, Domain and Resource.

- 1.8
Enable boolean W

Enables or disables this Connection.

This parameter is based on ifAdminStatus from [RFC2863].

false 1.8
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Username string­(256) W The proposed local-part of the Jabber ID of this Connection, and the value to be used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. - 1.8
Password string­(256) W

Password used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120].

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.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.8
Domain string­(64) W The proposed domain-part of the Jabber ID of this Connection. - 1.8
Resource string­(64) W The proposed resource-part of the Jabber ID of this Connection. - 1.8
JabberID string - The complete Jabber ID as determined by the first-hop XMPP server at time of connection establishment. This Jabber ID will usually be the standard concatentation of the local-part (Username), domain-part (Domain), and resource-part (Resource) as defined in [Section 2.1/RFC6120] (local-part@domain-part/resource-part), but since the Jabber ID is owned by the first-hop XMPP Server there are cases where the value will be different. - 1.8
Status string -

The current operational state of this Connection (see [Section 4.2.2/TR-181i2]). Enumeration of:

When Enable is false then Status SHOULD normally be Disabled or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Enabled if still operable when the expected actions have completed); it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

- 1.8
LastChangeDate dateTime - The date and time at which this Connection entered into its current operational state. - 1.8
ServerConnectAlgorithm string W

The algorithm the Connection uses when connecting with the associated lists of servers. Enumeration of:

  • DNS-SRV (Use the connection algorithm as specified in [Section 3.2/RFC6120] where the value of the Domain parameter is used to look up the server address and port to use)
  • ServerTable (Use the instances of the Server table based on the values of the Server.{i}.Priority and Server.{i}.Weight parameters as the basis for reconnect. Instances must be reachable and reachable instances with the lowest value MUST be preferred)
"DNS-SRV" 1.8
KeepAliveInterval long­[-1:] W

The number of seconds that keep alive events as specified in [Section 4.6.1/RFC6120] are sent by this Connection.

A value of 0 disables the keep alive functionality. A value of -1 indicates that the keep alive interval is a vendor specific implementation.

[Section 4.6.4/RFC6120] recommends not checking more frequently than every 5 minutes (or 300 seconds).

-1 1.8
ServerConnectAttempts unsignedInt W

The number of times that this Connection attempts to connect to a given IP address before moving on to the current server's next IP address, or to the next server if the current server has no more IP addresses.

If ServerConnectAttempts, ServerRetryInitialInterval, ServerRetryIntervalMultiplier and ServerRetryMaxInterval all have their default values, the maximum reconnection wait intervals, in minutes, will be {1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, 512, 512, 512, 512}. After the initial attempt there are 15 further attempts, making a total of 16. The maximum reconnection wait interval is reached on the 10th retry, i.e. the 11th attempt.

NOTE: If this Connection fails to connect to any of the servers' IP addresses, fallback behavior SHOULD be as specified in [Section 3.2/RFC6120].

NOTE: If the value of this parameter is 0, server connection and reconnection behavior is implementation-dependent.

16 1.8
ServerRetryInitialInterval unsignedInt­[1:65535] W

The maximum first reconnection wait interval, in seconds, as specified in [Annex K XMPP Connection Request/TR-069a5].

The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval.

NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored.

60 1.8
ServerRetryIntervalMultiplier unsignedInt­[1000:65535] W

The reconnection interval multiplier as specified in [Annex K XMPP Connection Request/TR-069a5]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.

For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1).

NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored.

2000 1.8
ServerRetryMaxInterval unsignedInt­[1:] W

The maximum reconnection wait interval, in seconds.

If the nth reconnection wait interval calculated from ServerRetryInitialInterval and ServerRetryIntervalMultiplier exceeds the value of this parameter, then the Device MUST use the value of this parameter as the next reconnection wait interval.

NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored.

30720 1.8
UseTLS boolean W

This parameter allows an ACS to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate".

If the value of UseTLS is true then the CPE will initiate TLS negotiation if not required to by the XMPP Server.

If the value of UseTLS is false then the CPE will not initiate TLS negotiation if not required to by the XMPP Server.

false 1.8
TLSEstablished boolean -

This parameter represents the TLS state of this XMPP Connection.

If this XMPP Connection is established and is secured by TLS then the value of this parameter is true.

If this XMPP Connection is either not established or established but not secured by TLS then the value of this parameter is false.

- 1.8
ServerNumberOfEntries unsignedInt - The number of entries in the Server table. - 1.8
XMPP.Connection.{i}.Server.{i}. object W

The Server represents an XMPP server to be used for a Connection.

This table is only relevant when Connection.{i}.ServerConnectAlgorithm is set to ServerTable. If Connection.{i}.ServerConnectAlgorithm is set to DNS-SRV then any instances of this table are ignored by this Connection.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with the same values for ServerAddress and Port.

- 1.8
Enable boolean W

Enables or disables this Server.

This parameter is based on ifAdminStatus from [RFC2863].

false 1.8
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Priority unsignedInt­[0:65535] W The priority of this Server that is used by the Connection when determining the Server to connect. The Connection MUST contact the Server with the lowest-numbered priority that the Connection can reach as defined in [RFC2782]. The selection of Servers with the same Priority value utilizes the Weight parameter to determine which Server is selected by the Connection. - 1.8
Weight long­[-1:65535] W This parameter specifies a relative weight for entries with the same Priority. The mechanism is defined in [RFC2782]. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. - 1.8
ServerAddress string­(256) W

Fully Qualified Domain Name (FQDN) or IP address of the XMPP server for this Connection.

If the value of this Parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attemtped (in an implemnetation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on Priority and Weight) SHOULD be used.

- 1.8
Port unsignedInt­[0:65535] W Port number of the XMPP server for this Connection. 5222 1.8
XMPP.Connection.{i}.Stats. object - XMPP Connection statistics information for this resource. - 1.8
ReceivedMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been received on this Connection. 0 1.8
TransmittedMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been transmitted by this Connection. 0 1.8
ReceivedErrorMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been received on this Connection where the type attribute had a value of "error". 0 1.8
TransmittedErrorMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been transmitted by this Connection where the type attribute had a value of "error". 0 1.8

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter
ManagementServer.ConnReqJabberID

Parameters for which Active Notification MAY be Denied

Parameter

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

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

StandbyPolicy:1 Profile

This table defines the StandbyPolicy:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.8. Note that support for this profile implies support for the requirements of [Annex L/TR-069a5].

Name Requirement
ManagementServer.­StandbyPolicy. P
CRUnawarenessMaxDuration W
MaxMissedPeriodic W
NotifyMissedScheduled W
NetworkAwarenessCapable R
SelfTimerCapable R
CRAwarenessRequested W
PeriodicAwarenessRequested W
ScheduledAwarenessRequested W

XMPPBasic:1 Profile

This table defines the XMPPBasic:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.8.

Name Requirement
XMPP. P
ConnectionNumberOfEntries R
XMPP.­Connection.­{i}. C
Enable W
Username W
Password W
Domain W
Resource W
JabberID R
Status R
LastChangeDate R

XMPPAdvanced:1 Profile

The XMPPAdvanced:1 profile for the TR-157:1 data model is defined as the union of the XMPPBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.8.

Name Requirement
XMPP.­Connection.­{i}. C
ServerConnectAlgorithm W
KeepAliveInterval W
ServerNumberOfEntries R
UseTLS W
TLSEstablished R
XMPP.­Connection.­{i}.­Server.­{i}. C
Enable W
Priority W
Weight W
ServerAddress W
Port W
XMPP.­Connection.­{i}.­Stats. P
ReceivedMessages R
TransmittedMessages R
ReceivedErrorMessages R
TransmittedErrorMessages R

XMPPReconnect:1 Profile

This table defines the XMPPReconnect:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.8.

Name Requirement
XMPP.­Connection.­{i}. C
ServerConnectAttempts W
ServerRetryInitialInterval W
ServerRetryIntervalMultiplier W
ServerRetryMaxInterval W

XMPPConnReq:1 Profile

The XMPPConnReq:1 profile for the TR-157:1 data model is defined as the union of the XMPPBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.8.

Name Requirement
ManagementServer. P
SupportedConnReqMethods R
ConnReqXMPPConnection W
ConnReqAllowedJabberIDs W
ConnReqJabberID R


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