Broadband Forum

    DATA MODEL DEFINITION


Component Objects for CWMP
tr-157-1-10-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

Update Bulk Data Collection for HTTP Transport

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

[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[IPDR-XDR] IPDR XDR Encoding Format, IPDR/XDR Encoding Format, TM Forum.
[IPDR-XML] IPDR XML File Encoding Format, IPDR/XML File Encoding Format, TM Forum.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4180] RFC4180, Common Format and MIME Type for Comma-Separated Values (CSV) Files, IETF, October 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.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[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-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2008.
[TR-157a10] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, 2015.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

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

Name Type Write Description Object Default Version
BulkData. object -

This object provides bulk data collection capabilities and global collection settings that affect the entire device.

Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server.

The IPDR solution is based on a service specification described in [TR-232].

The HTTP solution is based on transfer mechanisms described in [Annex A/TR-157a10].

The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server.

- 1.10
Enable boolean W

Enables or disables all collection profiles.

If false, bulk data will not be collected or reported.

- 1.10
Status string -

Indicates the status of the Bulk Data Collection mechanism. Enumeration of:

  • Enabled (Bulk Data Collection is enabled and working as intended)
  • Disabled (Bulk Data Collection is disabled)
  • Error (Bulk Data Collection is enabled, but there is an error condition preventing the successful collection of bulk data, OPTIONAL)
- 1.10
MinReportingInterval unsignedInt -

Minimum reporting interval in seconds that the CPE is capable of supporting.

A value of 0 indicates no minimum reporting interval.

- 1.10
Protocols string -

Comma-separated list of strings. Represents the IPDR and transport protocols that this device is capable of supporting. Each list item is an enumeration of:

- 1.10
EncodingTypes string -

Comma-separated list of strings. Represents the Encoding Types for the protocols that this device is capable of supporting. Each list item is an enumeration of:

  • XML (Used with the IPDR Streaming and File Protocols. [IPDR-XML])
  • XDR (Used with the IPDR Streaming and File Protocols. [IPDR-XDR])
  • CSV (Comma Separated Values. Used with the HTTP Protocol. [RFC4180])
  • JSON (JavaScript Object Notation. Used with the HTTP Protocol [RFC7159])
- 1.10
ParameterWildCardSupported boolean - When true, the Device supports the use of wildcards to determine the parameters that are reported using a Profile. - 1.10
MaxNumberOfProfiles int­[-1:] -

The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the ACS can create.

If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of profiles that can exist.

- 1.10
MaxNumberOfParameterReferences int­[-1:] -

The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via Profile.{i}.Parameter.{i}.Reference across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter).

If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of parameter that can be referenced via the bulk data collection mechanism.

- 1.10
ProfileNumberOfEntries unsignedInt - The number of entries in the Profile table. - 1.10
BulkData.Profile.{i}. object W

A set of Bulk Data Collection profiles.

Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the ACS to configure multiple reports to be generated at different times for different sets of data.

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.

- 1.10
Enable boolean W

Enables or disables this specific bulk data profile.

If false, this profile will not be collected or reported.

false 1.10
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.10
Name string­(255) W The name of the profile. - 1.10
NumberOfRetainedFailedReports int­[-1:] W

The number of failed reports to be retained and transmitted (in addition to the current report) at the end of the current reporting interval.

If the value of the EncodingType parameter is modified any outstanding failed reports are deleted.

If the CPE cannot retain the number of failed reports from previous reporting intervals while transmitting the report of the current reporting interval, then the oldest failed reports are deleted until the CPE is able to transmit the report from the current reporting interval.

A value of 0 indicates that failed reports are not to be retained for transmission in the next reporting interval.

A value of -1 indicates that the CPE will retain as many failed reports as possible.

0 1.10
Protocol string W The value MUST be a member of the list reported by the Protocols parameter. The Bulk Data Protocol being used for this collection profile. - 1.10
EncodingType string W The value MUST be a member of the list reported by the EncodingTypes parameter. The Bulk Data encoding type being used for this collection profile. - 1.10
ReportingInterval unsignedInt­[1:] W

The reporting interval in seconds. Each report is generated based on this interval and TimeReference.

The CPE MAY reject a request to set ReportingInterval to less than MinReportingInterval.

Reporting intervals MUST begin every ReportingInterval seconds.

If ReportingInterval is changed while collection is enabled, the first reporting interval begins immediately.

For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if the Protocol parameter is set to Streaming) its report at midnight every 24 hours.

86400 1.10
TimeReference dateTime W

An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations.

TimeReference is used only to set the "phase" of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future.

If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately.

The Unknown Time value as defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals.

If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value.

For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a "ITPush" mode) its report at midnight every 24 hours.

Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start.

0001-01-01T00:00:00Z 1.10
StreamingHost string­(256) W This is the host name or IP Address of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). - 1.10
StreamingPort unsignedInt­[0:65535] W This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). 4737 1.10
StreamingSessionID unsignedInt­[48:57, 65:90] W

This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming).

An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues.

Within the IPDR Streaming Protocol specification the Session ID has a type of a single 'char', but we are restricting the range even further (ASCII values of '0' - '9' and 'A' - 'Z'.

- 1.10
FileTransferURL string­(256) W This is the URL within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). - 1.10
FileTransferUsername string­(64) W

Username used for authentication of the FileTransferURL.

This is the FileTransferUsername that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

- 1.10
FileTransferPassword string­(64) W

Password used for authentication of the FileTransferURL.

This is the FileTransferPassword that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

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

- 1.10
ControlFileFormat string­(128) W

If this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File) then the control file names will be of the following format:

<ControlFilePrefix>_<ControlFilePolicy>.<ControlFileSuffix>

Where the following rules apply:

  • ControlFilePrefix MUST NOT contain an underscore '_' or any other character not suitable for a file name.
  • ControlFilePolicy MUST contain one or more 'N' characters, where the number of 'N' characters denotes the number of digits in the sequence number, including leading zeros as necessary to match the number of 'N' characters.
  • ControlFileSuffix is a file extension.

For example, BulkData_NNNN.log where "BulkData" would be the prefix, "NNNN" would be the policy, and "log" would be the suffix. Files adhering to this file format would look like: BulkData_0000.log, BulkData_0001.log, etc.

- 1.10
ParameterNumberOfEntries unsignedInt - The number of entries in the Parameter table. - 1.10
BulkData.Profile.{i}.Parameter.{i}. object W

Bulk data parameter table.

Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported.

- 1.10
Name string­(64) W

Name of the parameter in the report body.

If the value of this parameter is an empty string, then the value of the Reference parameter is used as the name.

When the value Reference parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in [Annex A.3.2.1/TR-157a10].

- 1.10
Reference string­(256) W

The value MUST be the Path Name of a parameter or object. Represents the parameter(s) that are part of this Bulk Data collection profile. The value MUST be a path name of a parameter or an object.

When the ParameterWildCardSupported parameter has a value of true, patterns for instance identifiers are permitted with wildcards (an "*" character) in place of instance identifiers; any attempt to set the value otherwise MUST be rejected by the CPE.

In the case where a partial parameter path is specified, the sub-objects of the resolved pattern and contained parameters will be part of the bulk data collected and reported. If the path name refers to an object then it MUST end with a '.'.

<Empty> 1.10
BulkData.Profile.{i}.CSVEncoding. object - This object defines the properties to be used when the Profile object's EncodingType parameter value is CSV. - 1.10
FieldSeparator string W Field separator to use when encoding CSV data. "," 1.10
RowSeparator string W Row separator to use when encoding CSV data. "&#13;&#10;" 1.10
EscapeCharacter string W Escape character to use when encoding CSV data. "&quot;" 1.10
ReportFormat string W

This parameter describes the formatting used for reports defined by this profile as described in [Annex A.3.4/TR-157a10].

Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616]. Enumeration of:

  • ParameterPerRow (Reports are formatted with each parameter formatted as a row entry)
  • ParameterPerColumn (Reports are formatted with each parameter formatted as a column entry)
"Parameter­Per­Column" 1.10
RowTimestamp string W

The format of the timestamp to use for data inserted into the row. Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in [Table 12/TR-069] is followed)
  • None (Timestamp is not inserted in the row)
"Unix-Epoch" 1.10
BulkData.Profile.{i}.JSONEncoding. object - This object defines the properties to be used when the Profile object's EncodingType parameter value is JSON. - 1.10
ReportFormat string W

This parameter describes the formatting used for the report as described in [Annex A.3.5/TR-157a10].

Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616]. Enumeration of:

  • ObjectHierarchy (Reports are formatted with each object in the object hierarchy of the data model encoded as a corresponding hierarchy of JSON Objects with the parameters of the object specified as name/value pairs of the JSON Object)
  • NameValuePair (Reports are formatted with each parameter of the data model encoded as a corresponding array of JSON Objects with the parameters specified as name/value pairs)
"Object­Hierarchy" 1.10
ReportTimestamp string W

The format of timestamp to use for the JSON Object named "CollectionTime" as described in [TR-157a10]. Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in [Table 12/TR-069] is followed)
  • None (Timestamp is not inserted)
"Unix-Epoch" 1.10
BulkData.Profile.{i}.HTTP. object - This object defines the properties to be used when transporting bulk data using the HTTP/HTTPS protocol. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the CPE MUST support HTTP Basic and Digest Access Authentication as defined in [RFC2616]. - 1.10
URL string­(1024) W The URL, as defined in [RFC3986], for the collection server to receive the Bulk Data transmitted by the CPE. - 1.10
Username string­(256) W Username used to authenticate the CPE when making a connection to the collection server. - 1.10
Password string­(256) W

Password used to authenticate the CPE when making a connection to the collection server.

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

- 1.10
CompressionsSupported string -

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE for the purposes of transferring bulk data. Each list item is an enumeration of:

- 1.10
Compression string W The value MUST be a member of the list reported by the CompressionsSupported parameter, or else be None. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when transferring data to the collection server. "None" 1.10
MethodsSupported string -

Comma-separated list of strings. Indicates the HTTP method(s) supported by this CPE for the purposes of transferring bulk data. Each list item is an enumeration of:

- 1.10
Method string W The value MUST be a member of the list reported by the MethodsSupported parameter. The value of this parameter represents the HTTP method to be used by the CPE when transferring data to the collection server. "POST" 1.10
UseDateHeader boolean W When true, the CPE encodes the HTTP Date Header [Section 14.18/RFC2616] in the HTTP client request. true 1.10
RetryEnable boolean W When true, the CPE retries unsuccessful attempts to transfer data. false 1.10
RetryMinimumWaitInterval unsignedInt­[1:65535] W

Configures the data transfer retry wait interval, in seconds, as specified in [Annex A.2.2.1/TR-157a10].

The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

5 1.10
RetryIntervalMultiplier unsignedInt­[1000:65535] W

Configures the retry interval multiplier as specified in [Annex A.2.2.1/TR-157a10].

This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.

The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

2000 1.10
RequestURIParameterNumberOfEntries unsignedInt - The number of entries in the RequestURIParameter table. - 1.10
BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. object W This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by [Annex A.2.1/TR-157a10]. - 1.10
Name string­(64) W

Name of the Request-URI parameter.

If Name is an empty string, the name of the Request-URI parameter is the value of Reference.

- 1.10
Reference string­(256) W

The value MUST be the path name of the Request-URI parameter.

If the value of this parameter is empty, then this object is not encoded in the report header.

<Empty> 1.10

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

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.

BulkDataColl:1 Profile

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

Name Requirement
BulkData. P
Enable W
Status R
MinReportingInterval R
Protocols R
EncodingTypes R
ProfileNumberOfEntries R
BulkData.­Profile.­{i}. C
Enable W
Alias W
Protocol W
EncodingType W
ReportingInterval W
TimeReference W
ParameterNumberOfEntries R
BulkData.­Profile.­{i}.­Parameter.­{i}. C
Reference W

BulkDataStreaming:1 Profile

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

Name Requirement
BulkData.­Profile.­{i}. C
StreamingHost W
StreamingPort W
StreamingSessionID W

BulkDataFileTransfer:1 Profile

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

Name Requirement
BulkData.­Profile.­{i}. C
FileTransferURL W
FileTransferUsername W
FileTransferPassword W
ControlFileFormat W

BulkDataHTTP:1 Profile

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

Name Requirement
BulkData.­Profile.­{i}.­HTTP. P
URL W
Username W
Password W
CompressionsSupported R
Compression W
MethodsSupported R
Method W
UseDateHeader W
RetryEnable W
RetryMinimumWaitInterval W
RetryIntervalMultiplier W
RequestURIParameterNumberOfEntries R
BulkData.­Profile.­{i}.­HTTP.­RequestURIParameter.­{i}. C
Name W
Reference W

BulkDataCSVEncoding:1 Profile

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

Name Requirement
BulkData.­Profile.­{i}.­CSVEncoding. P
FieldSeparator W
RowSeparator W
EscapeCharacter W
ReportFormat W
RowTimestamp W

BulkDataJSONEncoding:1 Profile

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

Name Requirement
BulkData.­Profile.­{i}.­JSONEncoding. P
ReportFormat W
ReportTimestamp W

BulkDataReports:1 Profile

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

Name Requirement
BulkData. P
ParameterWildCardSupported R
BulkData.­Profile.­{i}. C
Name W
NumberOfRetainedFailedReports W
BulkData.­Profile.­{i}.­Parameter.­{i}. C
Name W


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