Broadband Forum

TR-069 Device:2 Root Data Model definition [CWMP]
tr-181-2-15-1-cwmp.xml (changes)

DATA MODEL DEFINITION

License

Copyright (c) 2010-2022, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
Copyright (c) 2017-2019, 2021 ARRIS Enterprises, LLC.

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.

Comments or questions about this Broadband Forum data model should be directed to <info@broadband-forum.org>.

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
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.
decimal -

Decimal value.

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

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.

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

Legend

Object definition.
Mountable Object definition.
Mount Point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

Device:2.15 Data Model ​(changes)

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

Name Type Syntax Write Description Object Default Version Spec
Device. object object​[1:1] - The top-level object for a Device. - 2.0 TR-181i2a14
Device.​WiFi. object object​[1:1] - The WiFi object is based on the IEEE 802.11 specifications ([802.11-2020]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0 TR-181i2a15
Device.​WiFi.​CCAMeasurementDiagnostic. object object​[1:1] - This object is to provide diagnostic information on a Clear Channel Assessment (CCA) measurement scan on this radio on the given channel using a specific DwellTime. - 2.15 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, 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 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 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 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.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead.

- 2.15 TR-181i2a15c1
Channel unsignedInt unsignedInt W The number of the Wi-Fi channel the clear channel assessment (CCA) measurement is run on. - 2.15 TR-181i2a15
DwellTime unsignedInt unsignedInt W The duration of the CCA measurement in milliseconds. - 2.15 TR-181i2a15
CCAReport hexBinary​(12:12) hexBinary​(12:12) -

The clear channel assessment (CCA) report in the format specified in [Section 9.4.2.21.3/802.11-2020].

When read, the value of this parameter MUST correspond to Channel. How this is achieved is a local matter to the CPE.

- 2.15 TR-181i2a15
Device.​WiFi.​RemoteMeasurementDiagnostic. object object​[1:1] - This object is to provide diagnostic information on a Remote Measurement of a Wi-Fi BSS. - 2.15 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, 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 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 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 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.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead.

- 2.15 TR-181i2a15c1
TargetBSS string​(17) MACAddress W [MACAddress] The BSSID of the remote BSS. - 2.15 TR-181i2a15
Timeout unsignedInt unsignedInt W The duration after which the request is timed out in seconds. - 2.15 TR-181i2a15
OperatingClass unsignedInt​(:255) unsignedInt​(:255) W The Operating Class in [Table E-4/802.11-2020] for which the measurement is requested. - 2.15 TR-181i2a15
Channel unsignedInt unsignedInt W The number of the channel for which the measurement is requested. - 2.15 TR-181i2a15
SignalStrength unsignedInt​(:255) unsignedInt​(:255) - The received signal strength (RSSI) as received by the radio measured in dBm. RSSI is encoded as per [Table 9-176/802.11-2020]. Reserved: 221 - 255. - 2.15 TR-181i2a15
Noise unsignedInt​(:255) unsignedInt​(:255) - An indicator of the average radio noise plus interference power as received by the radio. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. - 2.15 TR-181i2a15
Device.​IP. object object​[1:1] - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0 TR-181i2a15
Device.​IP.​Diagnostics. object object​[1:1] - The IP Diagnostics object. - 2.0 TR-181i2a15
Device.​IP.​Diagnostics.​IPLayerCapacityMetrics. object object​[1:1] -

This object defines the diagnostics configuration for a IP Layer Capacity test. IP Layer Capacity measurement is specified in [TR-471].

Files received in the IP Layer Capacity test do not require file storage on the CPE device.

- 2.14 TR-181i2a15c1
IPLayerCapSupportedSoftwareVersion string​(64) string​(64) - Indicates the installed version of the test software. The software version string will be implementation-dependent, and SHOULD identify both the implementation and the version (e.g., UDPST-7.2.1). - 2.15 TR-181i2a15
IPLayerCapSupportedControlProtocolVersion string​(64) string​(64) - Indicates the control protocol version supported by the test software. Refer to [TR-471] for more information. - 2.15 TR-181i2a15
UDPPayloadContent string string W

UDP Payload Content Type, If there is payload compression in the path and tests intend to characterize a possible advantage due to compression, then payload content SHOULD be supplied by a pseudo-random sequence generator, by using part of a compressed file, or by other means. Payload may also contain the test protocol PDUs. The default value SHOULD be zeroes. Enumeration of:

  • zeroes (All zero (0) payload content)
  • ones (All one (1) payload content)
  • alternates0and1 (Alternating zero (0) and one (1) payload content)
  • random (Random payload content)
- 2.15 TR-181i2a15
RIPREnable boolean boolean W Enables RIPRR (Replicated IP Packet Ratio) metric. The default value SHOULD be false. - 2.15 TR-181i2a15
NumberFirstModeTestSubIntervals unsignedInt​(0:100) unsignedInt​(0:100) W When the value >= 1, bimodal test mode is requested and the value represents the number of sub-intervals to be included in the first capacity test mode. The remaining sub-intervals of NumberTestSubIntervals are for the second capacity test mode. Value = 0 indicates that bimodal testing is disabled. The value MUST NOT be greater than NumberTestSubIntervals. The default value SHOULD be 0. - 2.15 TR-181i2a15
TimeoutNoTestTraffic unsignedInt​(500:1000) unsignedInt​(500:1000) W Timeout value. If no test traffic packets are received for TimeoutNoTestTraffic milliseconds, test will timeout. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. - 2.15 TR-181i2a15
TimeoutNoStatusMessage unsignedInt​(500:1000) unsignedInt​(500:1000) W Timeout value. If no status message packets are received for TimeoutNoStatusMessage milliseconds, test will timeout. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. - 2.15 TR-181i2a15
SeqErrThresh unsignedInt​(0:100) unsignedInt​(0:100) W This parameter is only meaningful if TestType is Search. Threshold for Loss or Reordering or Replication impairments measured (events where received packet sequence number did not increase by one). The default value SHOULD be 10. - 2.15 TR-181i2a15
ReordDupIgnoreEnable boolean boolean W This parameter is only meaningful if TestType is Search. When true (enabled) only Loss counts toward received packet sequence number errors, and reordering and Duplication impairments are ignored. When false (disabled), Loss, Reordering and Duplication are all counted as sequence number errors. The default value SHOULD be false (disabled). - 2.15 TR-181i2a15
MaxETHCapacityNoFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.15 TR-181i2a15
MaxETHCapacityWithFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
MaxETHCapacityWithFCSVLAN decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
ReplicatedRatioAtMax decimal decimal - Ratio of replicated packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
InterfaceEthMbpsAtMax decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
IPLayerCapacitySummary decimal decimal - The IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.15 TR-181i2a15
LossRatioSummary decimal decimal - Ratio of lost packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
RTTRangeSummary decimal decimal - The range of measured Round Trip Time (RTT) during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
PDVRangeSummary decimal decimal - The range of Packet Delay Variation (PDV) during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
MinOnewayDelaySummary decimal decimal - The minimum one-way delay during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
MinRTTSummary decimal decimal - The minimum RTT during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
ReorderedRatioSummary decimal decimal - Ratio of reordered packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
ReplicatedRatioSummary decimal decimal - Ratio of replicated packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
InterfaceEthMbpsSummary decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for the entire time interval of duration TestInterval, divided by the duration of TestInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
Device.​IP.​Diagnostics.​IPLayerCapacityMetrics.​ModalResult.​{i}. object​[1:] object​[1:∞] -

Modal test results. Only returned when bimodal test mode is enabled (NumberFirstModeTestSubIntervals >=1). If returned, it MUST contain 1 or more entries, with instance number 1 corresponding to the second mode and instance number 2 corresponding to the third mode.

Results for the Maximum in each mode/instance are calculated based on IncrementalResult.{i}. data within the boundary of its corresponding mode.

This table MUST contain at least 1 entry.

- 2.15 TR-181i2a15
MaxIPLayerCapacity decimal decimal - The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values within corresponding mode across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
TimeOfMax dateTime dateTime - Time in UTC of end of the sub-interval when MaxIPLayerCapacity was measured. If the value of MaxIPLayerCapacity occurred in multiple sub-intervals, this MUST be the earliest of these sub-intervals. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z - 2.15 TR-181i2a15
MaxETHCapacityNoFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
MaxETHCapacityWithFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
MaxETHCapacityWithFCSVLAN decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
LossRatioAtMax decimal decimal - Ratio of lost packets to total packets during sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
RTTRangeAtMax decimal decimal - The range of Round Trip Time (RTT) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
PDVRangeAtMax decimal decimal - The range of Packet Delay Variation (PDV) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
MinOnewayDelayAtMax decimal decimal - The minimum one-way delay during the sub-interval of MaxIPLayerCapacity. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
ReorderedRatioAtMax decimal decimal - Ratio of reordered packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
ReplicatedRatioAtMax decimal decimal - Ratio of replicated packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
InterfaceEthMbpsAtMax decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
Device.​IP.​Diagnostics.​IPLayerCapacityMetrics.​IncrementalResult.​{i}. object​[0:] object​[0:∞] - Results for time segmented tests (tests where NumberTestSubIntervals > 1). This data is calculated across all connections in the test. A new object is created every TestSubInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when new test is started or results are otherwise cleared. - 2.14 TR-181i2a15
ReplicatedRatio decimal decimal - Ratio of replicated packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
InterfaceEthMbps decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at TimeOfSubInterval, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
Device.​Routing. object object​[1:1] - Routing object that contains the Router table and RIP protocol object. - 2.0 TR-181i2a15
Device.​Routing.​Babel. object object​[1:1] - This object provides parameters for configuration, troubleshooting, and monitoring of the Babel routing protocol [RFC8966]. This data model is based on the Babel information model defined in [RFC9046]. - 2.15 TR-181i2a15
StatsReset boolean boolean W

When set to true, all Babel statistics counters are reset to zero. Statistics are provided in InterfaceSetting.{i}.Stats..

The value of this parameter is not part of the device configuration and is always false when read.

- 2.15 TR-181i2a15c1
Device.​Routing.​Babel.​MACKeySet.​{i}. object​[0:] object​[0:∞] W

This object provides parameters related to use of the HMAC security mechanism [RFC8967] to sign and verify Babel packets.

At most one entry in this table can exist with a given value for Alias.

- 2.15 TR-181i2a15
Device.​Routing.​Babel.​MACKeySet.​{i}.​MACKey.​{i}. object​[0:] object​[0:∞] W

This object provides the MAC keys used to calculate MACs for verification and sending by the MACKeySet instance.

At most one entry in this table can exist with a given value for Alias.

- 2.15 TR-181i2a15
MACTestState string DiagnosticsState W

[DiagnosticsState] This parameter allows the MAC key and MAC algorithm to be tested to see if they produce an expected outcome. The command calculates a MAC for InputString using the KeyValue and the algorithm indicated by MACKeyAlgorithm and compares that to the value of InputMAC. If the values match, the output Match is true.

Indicates the availability of diagnostics data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, 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 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 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 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.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead.

- 2.15 TR-181i2a15c1
InputString hexBinary hexBinary W Setting MACTestState to Requested calculates a MAC of InputString using the KeyValue and the algorithm indicated by MACKeyAlgorithm. - 2.15 TR-181i2a15c1
InputMAC hexBinary hexBinary W Whenever a MAC is calculated from InputString that MAC is then compared to InputMAC. - 2.15 TR-181i2a15c1
Match boolean boolean - Match is true if the calculated MAC and InputMAC are the same. - 2.15 TR-181i2a15c1
Device.​USPAgent. object object​[1:1] - This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the DeviceInfo object. - 2.15 TR-181i2a15c1
EndpointID string string - The unique USP identifier for this USP Agent. - 2.15 TR-181i2a15
SoftwareVersion string​(64) string​(64) -

The current USP Agent software version; not the version of the overall device firmware, which is located in DeviceInfo.SoftwareVersion.

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.

- 2.15 TR-181i2a15
UpTime unsignedInt unsignedInt - Time in seconds since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device). - 2.15 TR-181i2a15
SupportedProtocols string​[1:] list​[1:] of string -

Comma-separated list (at least 1 items) of strings. USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol. Each list item is an enumeration of:

- 2.15 TR-181i2a15
SupportedFingerprintAlgorithms string​[] list of string -

Comma-separated list of strings, each entry is an algorithm for calculating firgerprints that is supported by the Agent.

Each list item is an enumeration of:

- 2.15 TR-181i2a15
AdvertisedDeviceSubtypes string​[] list of string W Comma-separated list of strings, each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in [RFC6762]. - 2.15 TR-181i2a15
MaxSubscriptionChangeAdoptionTime unsignedInt​(5:) unsignedInt​(5:) W

The acceptable amount of time in seconds between the alteration of the Agent's Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered.

For example, if this parameter is set to 30 seconds, then once a Subscription has been updated, the Agent has 30 seconds before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription).

- 2.15 TR-181i2a15
MTPNumberOfEntries unsignedInt unsignedInt - The number of entries in the MTP table. - 2.15 TR-181i2a15
ControllerNumberOfEntries unsignedInt unsignedInt - The number of entries in the Controller table. - 2.15 TR-181i2a15
CertificateNumberOfEntries unsignedInt unsignedInt - The number of entries in the Certificate table. - 2.15 TR-181i2a15
AddCertificate string​(65535) string​(65535) W

Provides a mechanism to allow an ACS to add a new certificate to Certificate.{i}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in Controller.{i}.Credential or ControllerTrust.Credential.{i}.Credential that references the new Certificate.{i} entry. The Agent will use the Serial Number and Issuer fields from the content provided in this parameter to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted.

The value of this parameter is the X.509 certificate in Privacy-enhanced Electronic Mail (PEM) [RFC7468] format.

The value of this parameter is not part of the device configuration and is always an empty string when read.

- 2.15 TR-181i2a15c1
Device.​USPAgent.​MTP.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a MTP used by the local Agent.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Enable boolean boolean W

Enable/Disable this MTP instance.

If this MTP instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.

false 2.15 TR-181i2a15
Status string string -

The current operational state of the MTP instance. Enumeration of:

  • Up
  • Down (Value when this MTP instance cannot establish communication)
  • Error (Value when this MTP instance is misconfigured, OPTIONAL)
- 2.15 TR-181i2a15
Protocol string string W

The value MUST be a member of the list reported by the SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint.

This parameter discriminates between the CoAP, STOMP, WebSocket and MQTT union objects.

"Web­Socket" 2.15 TR-181i2a15
EnableMDNS boolean boolean W

This parameter, when true, enables the advertisement of DNS-SD services defined for this MTP instance using mDNS as defined in [RFC6762].

This parameter cannot be set to true if there are multiple MTP instances with the same value of the Protocol parameter.

When true, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN).

The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this MTP instance and the interfaces defined by the DNS.SD.AdvertisedInterfaces parameter.

true 2.15 TR-181i2a15
Device.​USPAgent.​MTP.​{i}.​CoAP. object​[0:1] object​[0:1] -
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters.
This object was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2.
This object MUST be present if, and only if, Protocol is CoAP.
- 2.15 TR-181i2a15
Interfaces string​[] list of string W

Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance that this server will use as its host address to receive USP messages. If the referenced object is deleted, the corresponding item MUST be removed from the list.

An empty string will bind this server to all interfaces for this device.

- 2.15 TR-181i2a15
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the CoAP Server to receive USP messages. 5683 2.15 TR-181i2a15
Path string string W The path that is used by the CoAP Server in order to receive USP messages. - 2.15 TR-181i2a15
IsEncrypted boolean boolean -
This parameter represents whether or not communications that utilize this CoAP object instance are encrypted.
This parameter was DEPRECATED in 2.14 because the EnableEncryption parameter will dictate whether all connections to this CoAP server instance are or are not encrypted.
- 2.15 TR-181i2a15
EnableEncryption boolean boolean W When true, encryption MUST be used for this MTP instance. true 2.15 TR-181i2a15
Device.​USPAgent.​MTP.​{i}.​STOMP. object​[0:1] object​[0:1] -

If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server.

This object MUST be present if, and only if, Protocol is STOMP.

- 2.15 TR-181i2a15
Reference string string W The value MUST be the Path Name of a row in the STOMP.Connection table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP. <Empty> 2.15 TR-181i2a15
Destination string string W The STOMP destination where the Agent will be listening to incoming USP messages. <Empty> 2.15 TR-181i2a15
DestinationFromServer string string -

The STOMP destination contained in the subscribe-dest header of the CONNECTED STOMP Frame.

If the Agent doesn't receive a subscribe-dest header in the CONNECTED STOMP Frame, then the value of this Parameter MUST be set to an empty string.

If this parameter's value is not empty then this is the STOMP destination address for this Agent, but if the value is empty the Destination Parameter contains the STOMP destination address for this Agent.

<Empty> 2.15 TR-181i2a15
Device.​USPAgent.​MTP.​{i}.​WebSocket. object​[0:1] object​[0:1] -

If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters.

This object MUST be present if, and only if, Protocol is WebSocket.

- 2.15 TR-181i2a15
Interfaces string​[] list of string W

Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance that this server will use as its host address to receive USP messages. If the referenced object is deleted, the corresponding item MUST be removed from the list.

An empty string will bind this server to all interfaces for this device.

- 2.15 TR-181i2a15
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the WebSocket Server to receive USP messages. 5683 2.15 TR-181i2a15
Path string string W The service path that is provided by the WebSocket Server in order to exchange USP messages. The value MUST be used as defined in [Section 3.3/RFC3986]. - 2.15 TR-181i2a15
EnableEncryption boolean boolean W When true, encryption MUST be used for all connections to this MTP instance. true 2.15 TR-181i2a15
KeepAliveInterval unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds between when WebSocket ping control frames are transmitted by the Agent's WebSocket server to the Controller's WebSocket client. - 2.15 TR-181i2a15
Device.​USPAgent.​MTP.​{i}.​MQTT. object​[0:1] object​[0:1] -

If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how the Agent communicates with the MQTT broker.

This object MUST be present if, and only if, Protocol is MQTT.

- 2.15 TR-181i2a15
Reference string string W The value MUST be the Path Name of a row in the MQTT.Client table. A reference to the MQTT Client used by this Agent when communicating via the MQTT MTP. <Empty> 2.15 TR-181i2a15
ResponseTopicConfigured string​(65535) string​(65535) W The Agent's configured "reply to" topic. When MQTT 5.0 is being used, this value is put in the PUBLISH Response Topic property for all PUBLISH packets with a USP Record, if no Response Information (value recorded in ResponseTopicDiscovered) is included in the CONNACK. When MQTT 3.1.1 is being used, this value is put at the end of the PUBLISH Topic Name property (as specified in [Section "MQTT Binding"/TR-369]. If the value of ResponseTopicConfigured is not a subset (wildcarded or precise match) of any of the Reference MQTT.Client.{i}.Subscription.{i}.Topic values the Agent MUST subscribe to this Topic. The value MUST NOT contain any wild card characters (“+”, “#”). - 2.15 TR-181i2a15
ResponseTopicDiscovered string​(65535) string​(65535) - Duplicate of Reference MQTT.Client.{i}.ResponseInformation. This is the value of the CONNACK Response Information property supplied by a MQTT 5.0 server and is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If a value is received from the MQTT 5.0 server, it will be used instead of any value configured in ResponseTopicConfigured. - 2.15 TR-181i2a15
PublishQoS unsignedInt​(0:2) unsignedInt​(0:2) W

The Agent MUST use this QoS value when sending a USP Record on this MTP.

If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server.

- 2.15 TR-181i2a15
Device.​USPAgent.​Controller.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a USP Controller that has access to this USP Agent.

On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for EndpointID.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
EndpointID string string W The unique USP identifier for this USP Controller. <Empty> 2.15 TR-181i2a15
ControllerCode string​(128) string​(128) W

Information about the configuration state of an Agent as it pertains to the Controller instance. This is not information related to an operator's installation or usage of the protocol, that information is maintained in ProvisioningCode.

This parameter could be used in scenarios where the Controller needs to perform some kind of initialization or periodic configuration monitoring. For example, a Controller might perform some initial configuration of an Agent on first contact (perhaps to configure the Subscriptions). The Controller could inspect this parameter to determine the current state of the Agent's configuration, allowing the Controller to streamline the configuration process.

<Empty> 2.15 TR-181i2a15
ProvisioningCode string​(64) string​(64) W Identifying information which MAY be used by the Controller instance to determine Controller instance specific customization and provisioning parameters. <Empty> 2.15 TR-181i2a15
Enable boolean boolean W

Enable/Disable this Controller instance.

If the Controller instance is to be disabled, the Agent MUST send the ValueChange notification to all subscribed recipients, even if the recipient is the disabled Controller itself. This notification is the last notification sent to this Controller until it is enabled again. The USP Endpoint MUST terminate the MTP connection. When false, messages (notifications) are not sent to the remote endpoint represented by this Controller instance, and any MTP session establishment are refused.

false 2.15 TR-181i2a15
AssignedRole string​[] list of string W Each list item MUST be the Path Name of a row in the ControllerTrust.Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that has been assigned to this Controller instance by means other than the ControllerTrust.Credential.{i}.Role parameter. - 2.15 TR-181i2a15
InheritedRole string​[] list of string - Each list item MUST be the Path Name of a row in the ControllerTrust.Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that has been assigned to this Controller instance from the ControllerTrust.Credential.{i}.Role parameter associated with the CA credential (ControllerTrust.Credential.{i}.Credential) used to validate the Controller certificate. - 2.15 TR-181i2a15
Credential string string W

The value MUST be the Path Name of a row in the Certificate table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

Comma-separated list of strings, the set of certificates from Certificate.{i} that a Controller can present for use in authenticating the identity of this Controller instance.

- 2.15 TR-181i2a15
PeriodicNotifInterval unsignedInt​(1:) unsignedInt​(1:) W If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is the duration in seconds of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller. - 2.15 TR-181i2a15
PeriodicNotifTime dateTime dateTime W

If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the PeriodicNotifInterval.

PeriodicNotifTime is used only to set the phase of the Periodic Event Notifications. The actual value of PeriodicNotifTime can be arbitrarily far into the past or future.

For example, if PeriodicNotifInterval is 86400 (a day) and if PeriodicNotifTime is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicNotifTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified PeriodicNotifInterval.

If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the PeriodicNotifTime parameter was set to the Unknown Time value.

- 2.15 TR-181i2a15
USPNotifRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

This parameter is related to the retry mechanism for Notifications.

Configures the first retry wait interval, in seconds, as specified in [Section "Responses to Notifications and Notification Retry"/TR-369].

A value of 5 corresponds to the default behavior.

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

5 2.15 TR-181i2a15
USPNotifRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

This parameter is related to the retry mechanism for Notifications.

Configures the retry interval multiplier as specified in [Section "Responses to Notifications and Notification Retry"/TR-369].

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

A value of 2000 corresponds to the default behavior.

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

2000 2.15 TR-181i2a15
MTPNumberOfEntries unsignedInt unsignedInt - The number of entries in the MTP table. - 2.15 TR-181i2a15
SendOnBoardRequest boolean boolean W

When set to true, requests the Agent to send a USP OnBoardRequest notification to this Controller.

The value of this parameter is not part of the device configuration and is always false when read.

- 2.15 TR-181i2a15c1
Device.​USPAgent.​Controller.​{i}.​MTP.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a MTP used by this Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for Protocol.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Enable boolean boolean W

Enable/Disable this MTP instance.

If this MTP instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.

false 2.15 TR-181i2a15
Protocol string string W

The value MUST be a member of the list reported by the SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint.

This parameter discriminates between the CoAP, STOMP, WebSocket and MQTT union objects.

"Web­Socket" 2.15 TR-181i2a15
Order unsignedInt​(1:) unsignedInt​(1:) W

The order (relative priority) to use when determining which MTP to use for communicating to the Controller.

A value of 1 indicates the highest precedence. For each configured MTP, the instance with the lowest value is attempted first.

When more than one MTP instance has the same value, then each instance with the same value SHOULD be attempted at the same time.

The value of Order on creation of a MTP table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

- 2.15 TR-181i2a15
Device.​USPAgent.​Controller.​{i}.​MTP.​{i}.​CoAP. object​[0:1] object​[0:1] -
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters.
This object was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2.
This object MUST be present if, and only if, Protocol is CoAP.
- 2.15 TR-181i2a15
Host string​(256) string​(256) W The hostname or IP Address of the Controller's CoAP server. - 2.15 TR-181i2a15
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the Controller's CoAP Server to receive USP messages. - 2.15 TR-181i2a15
Path string string W The path that is used by the Controller's CoAP Server in order to receive USP messages. - 2.15 TR-181i2a15
EnableEncryption boolean boolean W When true, encryption MUST be used as specified in [Section "MTP Message Encryption"/TR-369]. true 2.15 TR-181i2a15
Device.​USPAgent.​Controller.​{i}.​MTP.​{i}.​STOMP. object​[0:1] object​[0:1] -

If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server.

This object MUST be present if, and only if, Protocol is STOMP.

- 2.15 TR-181i2a15
Reference string string W The value MUST be the Path Name of a row in the STOMP.Connection table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP. <Empty> 2.15 TR-181i2a15
Destination string string W The STOMP destination where the Controller will be listening to incoming USP messages. <Empty> 2.15 TR-181i2a15
Device.​USPAgent.​Controller.​{i}.​MTP.​{i}.​WebSocket. object​[0:1] object​[0:1] -

If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters.

This object MUST be present if, and only if, Protocol is WebSocket.

- 2.15 TR-181i2a15
Host string​(256) string​(256) W The hostname or IP Address of the Controller's WebSocket server. - 2.15 TR-181i2a15
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the Controller's WebSocket server to receive USP messages. - 2.15 TR-181i2a15
Path string string W The service path that is provided by the Controller's WebSocket server in order to exchange USP messages. The value MUST be used as defined in [Section 3.3/RFC3986]. - 2.15 TR-181i2a15
IsEncrypted boolean boolean -
This parameter represents whether or not communications that utilize this WebSocket object instance are encrypted.
This parameter was DEPRECATED in 2.14 because the EnableEncryption parameter will dictate whether this WebSocket is or is not encrypted.
- 2.15 TR-181i2a15
EnableEncryption boolean boolean W When true, encryption MUST be used for this MTP instance. true 2.15 TR-181i2a15
KeepAliveInterval unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds between when WebSocket ping control frames are transmitted by the Agent's WebSocket client to the Controller's WebSocket server. - 2.15 TR-181i2a15
CurrentRetryCount unsignedInt unsignedInt - The current retry count of the session. When zero (0), the session is not in a retry state. - 2.15 TR-181i2a15
SessionRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

Configures the first retry wait interval, in seconds, as specified in [Section "WebSocket Session Retry"/TR-369].

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

5 2.15 TR-181i2a15
SessionRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

Configures the retry interval multiplier as specified in [Section "WebSocket Session Retry"/TR-369].

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

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

2000 2.15 TR-181i2a15
Device.​USPAgent.​Controller.​{i}.​MTP.​{i}.​MQTT. object​[0:1] object​[0:1] -

If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker.

This object MUST be present if, and only if, Protocol is MQTT.

- 2.15 TR-181i2a15
Reference string string W The value MUST be the Path Name of a row in the MQTT.Client table. A reference to the MQTT Client used by this Controller when communicating via the MQTT MTP. <Empty> 2.15 TR-181i2a15
Topic string​(65535) string​(65535) W The topic name the USP Controller has subscribed to, to be used for Notify messages send by the USP Agent. - 2.15 TR-181i2a15
PublishRetainResponse boolean boolean W If set to true the Agent MUST set the RETAIN flag in MQTT PUBLISH messages carrying a USP Response Message to 1, unless the MQTT server sent Retain Available = 0 (MQTT 5.0) in its CONNACK (in which case, the Agent MUST set the RETAIN flag to 0). false 2.15 TR-181i2a15
PublishRetainNotify boolean boolean W If set to true the Agent MUST set the RETAIN flag in MQTT PUBLISH messages carrying a USP Notify Message to 1, unless the MQTT server sent Retain Available = 0 (MQTT 5.0) in its CONNACK (in which case, the Agent MUST set the RETAIN flag to 0). false 2.15 TR-181i2a15
Device.​USPAgent.​Certificate.​{i}. object​[0:] object​[0:∞] -

Each instance of this table represents information related to a X.509 certificate (see [RFC5280]) of a Controller or Certificate Authority. Instances are referenced from Controller.{i}.Credential and ControllerTrust.Credential.{i}.Credential.

At most one entry in this table can exist with the same values for both SerialNumber and Issuer, or with a given value for Alias.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.
- 2.15 TR-181i2a15
Enable boolean boolean W Enable/Disable this Certificate instance. - 2.15 TR-181i2a15
SerialNumber string​(64) string​(64) - The Serial Number field in an X.509 certificate, see [RFC5280]. - 2.15 TR-181i2a15
Issuer string​(256) string​(256) - The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 2.15 TR-181i2a15
Device.​USPAgent.​ControllerTrust. object object​[1:1] - This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.15 TR-181i2a15
UntrustedRole string​[:1] list​[:1] of string W

Each list item MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list (up to 1 items) of strings, each entry is a Role that is associated with Controllers whose identity cannot be authenticated. The value of the UntrustedRole parameter is appended to the Controller.{i}.AssignedRole parameter.

In some instances, this policy is set by the Agent and cannot be modified by Controllers. If the Agent does not allow modification of this parameter, the Agent MUST respond with an error to the request to set this parameter.

- 2.15 TR-181i2a15
BannedRole string string W

The value MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Role that is associated with Controllers indicate banned access.

When assigned to a Controller or associated with an entry in the Credential table, this MUST be the only value of the BannedRole parameter of the Controller.{i}.AssignedRole parameter.

The Agent SHOULD refuse to accept USP messages from, or send USP messages to, any Controller that has this Role.

- 2.15 TR-181i2a15
TOFUAllowed boolean boolean W When true, Agent has active policy that allows for self-signed certificates and certificates from unknown Certificate Authorities (CAs) to be trusted on first use (TOFU). - 2.15 TR-181i2a15
TOFUInactivityTimer unsignedInt unsignedInt W

Inactivity timer in seconds.

This timer is started when trust on first use (TOFU) policy is used to accept a Controller certificate. If no USP Message is received before this timer elapses, the Agent MUST tear down the MTP connection and underlying (D)TLS session.

A value of 0 means that the TOFU inactivity timer is effectively disabled.

- 2.15 TR-181i2a15
RoleNumberOfEntries unsignedInt unsignedInt - The number of entries in the Role table. - 2.15 TR-181i2a15
CredentialNumberOfEntries unsignedInt unsignedInt - The number of entries in the Credential table. - 2.15 TR-181i2a15
ChallengeNumberOfEntries unsignedInt unsignedInt - The number of entries in the Challenge table. - 2.15 TR-181i2a15
Device.​USPAgent.​ControllerTrust.​Role.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model.

If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for Name.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Enable boolean boolean W Enable/Disable this Role instance. false 2.15 TR-181i2a15
Name string string W The Role assigned to this Role instance. - 2.15 TR-181i2a15
PermissionNumberOfEntries unsignedInt unsignedInt - The number of entries in the Permission table. - 2.15 TR-181i2a15
Device.​USPAgent.​ControllerTrust.​Role.​{i}.​Permission.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role.

If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for Order.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Enable boolean boolean W Enable/Disable this Permission instance. false 2.15 TR-181i2a15
Order unsignedInt unsignedInt W

The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same Role.

The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority).

0 2.15 TR-181i2a15
Targets string​[] list of string W

Comma-separated list of strings, each entry is a target to which the value of the permissions parameters are assigned.

When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter.

When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance.

When an entry is a value of a Search Path as defined in [TR-369] that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this Permission instance.

<Empty> 2.15 TR-181i2a15
Param string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Parameter type of Targets:

  1. Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM.
  2. Write: Grants the capability to update the value of the Parameter via Add or Set.
  3. Execute: Grants no capabilities; Parameters can not be executed.
  4. Notify: Grants the capability to use this Parameter in the ReferenceList of a ValueChange Subscription.
---- 2.15 TR-181i2a15
Obj string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Object type of Targets:

  1. Read: Grants the capability to read the meta-information of the Object via GetSupportedDM.
  2. Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.).
  3. Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Object in the ReferenceList of an ObjectCreation (for multi-instance objects only) Subscription.
---- 2.15 TR-181i2a15
InstantiatedObj string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Instantiated Object type of Targets:

  1. Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances and read the value of Parameters related to the Instantiated Object via a Get containing a search expression or wildcard in place of the instance identifier.
  2. Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.).
  3. Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription.
---- 2.15 TR-181i2a15
CommandEvent string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Command and Event type of Targets:

  1. Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM.
  2. Write: Grants no capabilities; Commands are executed instead of written to and Events are read only.
  3. Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event.
  4. Notify: Grants the capability to use this Event or Command in the ReferenceList of an Event or OperationComplete Subscription.
---- 2.15 TR-181i2a15
Device.​USPAgent.​ControllerTrust.​Credential.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown.

When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered "trusted".

If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Role entry is automatically applied to the Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for Credential.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Enable boolean boolean W Enable/Disable this Credential instance. false 2.15 TR-181i2a15
Role string​[] list of string W

Each list item MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Comma-separated list of strings, the (set of) Role(s) applied to a Controller authenticated through this Credential instance.

The roles are added to the Controller's current list of Roles by replacing the value of the Controller.{i}.InheritedRole parameter.

If the Controller is already known to the Agent, with an associated Role, this parameter has no impact.

- 2.15 TR-181i2a15
Credential string string W The value MUST be the Path Name of a row in the Certificate table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the Certificate.{i} instance for use in the authentication of certificates provided by a Controller and authorization of Controllers, and for authentication of certificates used for MTP encryption. - 2.15 TR-181i2a15
AllowedUses string string W

Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize. Enumeration of:

  • MTP-only (The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers)
  • MTP-and-USP (The CA can authorize MTP (domain) connectivity and authenticate Controllers)
  • MTP-and-broker (The CA can authorize MTP (domain) connectivity and the presenter of this certificate is trusted to have authenticated the identity of Endpoints whose Records it transmits such that the from_id can be trusted without additional authentication. See ["Authentication and Authorization"/TR-369] for additional description of the Trusted Broker function)
- 2.15 TR-181i2a15
Device.​USPAgent.​ControllerTrust.​Challenge.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents information that is used to challenge a Controller in order to assign a Role to the Controller or to determine the authenticity of a Certificate.

The Controller requests a type of challenge from an Agent using the RequestChallenge command.

The Agent returns the value of the Instruction for that type of challenge to the Controller which the Controller then provides a third-party.

The third-party responds to the Instruction which the Controller then sends to the Agent using the ChallengeResponse command.

The Agent verifies the response to the Challenges and executes an implementation specific Agent logic in order to establish trust with the Controller.

This could include (but is not limited to):

  • Assignment of roles to the Controller is done by appending the non-duplicate roles of the Role parameter to the value of the Controller.{i}.AssignedRole parameter.
  • Use the Controller's certificate to which the challenge response was received in order to authenticate the identity of the Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Description string string W The description of this Challenge instance. - 2.15 TR-181i2a15
Role string​[] list of string W

Each list item MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Comma-separated list of strings, the (set of) role(s) appended (non-duplicate values only) to the value of the Controller.{i}.AssignedRole parameter.

- 2.15 TR-181i2a15
Enable boolean boolean W Enable/Disable this Challenge instance. false 2.15 TR-181i2a15
Type string string W

The type of challenge that will be verified from the challenge response provided by the third-party through the Controller. Enumeration of:

  • Passphrase (The challenge uses a passphrase the third-party is expected to match)
- 2.15 TR-181i2a15
Value base64 base64 W

The value of the challenge that is specific to the type of challenge.

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

- 2.15 TR-181i2a15
ValueType string string W

The media type with a format as defined by [RFC6838] of the content of the Value parameter. Enumeration of:

- 2.15 TR-181i2a15
Instruction base64 base64 W The instruction that is provided to the external party by the Controller requesting the challenge. - 2.15 TR-181i2a15
InstructionType string string W

The media type with a format as defined by [RFC6838] of the content of the Instruction parameter. Enumeration of:

- 2.15 TR-181i2a15
Retries unsignedInt unsignedInt W The number of consecutive failed USP ChallengeResponse() attempts against this Challenge instance (as determined by the USP RequestChallenge().ChallengeRef associated with USP ChallengeResponse().ChallengeID parameters) that are allowed before a LockoutPeriod is started for this Challenge instance. Counts of failed attempts for a Challenge instance are reset after a successful USP ChallengeResponse() for the Challenge instance or after a started LockoutPeriod expires. - 2.15 TR-181i2a15
LockoutPeriod int​(0:) int​(0:) W

Once the Retries value has been reached by failed USP ChallengeResponse() attempts against this Challenge instance (as determined by the USP RequestChallenge().ChallengeRef associated with USP ChallengeResponse().ChallengeID parameters), the value of this parameter represents the amount of time (in seconds) that the Agent will prevent any USP ChallengeResponse() or USP RequestChallenge() against this Challenge instance from succeeding. Any attempt to issue a USP RequestChallenge() or USP ChallengeResponse() command where the associated USP RequestChallenge().ChallengeRef points to this Challenge instance during the lockout period will result in an Error response with 7002 as the error code. When a started lockout period has expired, the count of failed attempts for this Challenge instance will be reset. If the Agent chooses to delete USP ChallengeResponse().ChallengeID values for a locked out Challenge, the Agent can send the 7004 error code for values it does not recognize.

A value of zero means that a lockout period doesn't apply and the USP RequestChallenge() command can be attempted without the need to wait between failed challenges.

30 2.15 TR-181i2a15
Device.​Users. object object​[1:1] - Users object that contains the User, Group, and Role tables. - 2.0 TR-181i2a15c1
Device.​Users.​CheckCredentialsDiagnostics. object object​[1:1] - This object is to provide diagnostic information to check whether Username and Password are valid for allowing access to the user interface on the device. If not valid, then an indication of why they are not valid is output. - 2.15 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, 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 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 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 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.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead.

- 2.15 TR-181i2a15c1
Username string string W The user name for logging in to the user interface on the device. - 2.15 TR-181i2a15c1
Password string string W The password for logging in to the user interface on the device. - 2.15 TR-181i2a15c1
Device.​STOMP. object object​[1:1] - The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.15 TR-181i2a15
ConnectionNumberOfEntries unsignedInt unsignedInt - The number of entries in the Connection table. - 2.15 TR-181i2a15
Device.​STOMP.​Connection.​{i}. object​[0:] object​[0:∞] W

The Connection represents a STOMP connection between the Agent and a STOMP server.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

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

- 2.15 TR-181i2a15
Alias string​(64) Alias W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 2.15 TR-181i2a15
Enable boolean boolean W

Enables or disables this Connection.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.15 TR-181i2a15
Status string 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 Unknown if the state of the interface can not be determined for some reason.

- 2.15 TR-181i2a15
LastChangeDate dateTime dateTime - The date and time at which this Connection entered into its current operational state. - 2.15 TR-181i2a15
Host string​(256) string​(256) W The hostname or IP Address of the STOMP Server. - 2.15 TR-181i2a15
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number of the STOMP Server. 61613 2.15 TR-181i2a15
Username string​(256) string​(256) W The username part of the credentials to be used when authenticating this Connection during connection establishment with the STOMP Server. - 2.15 TR-181i2a15
Password string​(256) string​(256) W

The password part of the credentials to be used when authenticating this Connection during connection establishment with the STOMP Server.

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

- 2.15 TR-181i2a15
VirtualHost string​(256) string​(256) W

The Virtual Host to use when establishing the connection.

Some STOMP Server implementations utilize virtual hosts to place a context around credentials, permissions, and internal resources.

<Empty> 2.15 TR-181i2a15
EnableHeartbeats boolean boolean W

Enable or disable the STOMP Heart-beating mechanism as described in STOMP (for this Connection).

When the STOMP Heart-beat mechanism is enabled, OutgoingHeartbeat and IncomingHeartbeat determine how the heart-beat header within the CONNECT frame is formatted.

When the STOMP Heart-beat mechanism is disabled, OutgoingHeartbeat and IncomingHeartbeat are ignored and the CONNECT frame MUST NOT contain a heart-beat header element.

Any changes to this parameter will not take effect until the next connection.

false 2.15 TR-181i2a15
OutgoingHeartbeat unsignedInt unsignedInt W

Represents the Outgoing heart-beat timing (in milliseconds) of the STOMP Heart-beating mechanism as described in STOMP (for this Connection).

The Outgoing heart-beat represents what the sender of the frame can do. A value of 0 means that it cannot send heart-beats.

Any changes to this parameter will not take effect until the next connection.

0 2.15 TR-181i2a15
IncomingHeartbeat unsignedInt unsignedInt W

Represents the Incoming heart-beat timing (in milliseconds) of the STOMP Heart-beating mechanism as described in STOMP (for this Connection).

The Incoming heart-beat represents what the sender of the frame would like to get. A value of 0 means that it does not want to receive heart-beats.

Any changes to this parameter will not take effect until the next connection.

0 2.15 TR-181i2a15
ServerRetryInitialInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

The maximum first reconnection wait interval, in seconds, as specified in [TR-369].

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

60 2.15 TR-181i2a15
ServerRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

The reconnection interval multiplier as specified in [TR-369]. 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).

The server retry mechanism reaches its upper limit at 10 reconnection attempts. Meaning, that if the number of reconnection attempts exceeds 10, then the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (10 - 1).

2000 2.15 TR-181i2a15
ServerRetryMaxInterval unsignedInt​(1:) 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 Agent MUST use the value of this parameter as the next reconnection wait interval.

30720 2.15 TR-181i2a15
IsEncrypted boolean boolean -
This parameter represents whether or not communications that utilize this Connection object instance are encrypted.
This parameter was DEPRECATED in 2.14 because the EnableEncryption parameter will dictate whether all connections for this STOMP instance are or are not encrypted.
- 2.15 TR-181i2a15
EnableEncryption boolean boolean W When true, encryption MUST be used for this STOMP Connection Connection. true 2.15 TR-181i2a15

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
Device.USPAgent.
UpTime

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.

IPLayerCapacityTest:1 Profile

This table defines the IPLayerCapacityTest:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.15.

Name Requirement
Device.​IP.​Diagnostics. P
IPLayerCapacitySupported R
Device.​IP.​Diagnostics.​IPLayerCapacityMetrics. P
DiagnosticsState W
IPLayerCapSupportedSoftwareVersion R
IPLayerCapSupportedControlProtocolVersion R
IPLayerCapSupportedMetrics R
Role W
Host R
JumboFramesPermitted R
DSCP W
TestType W
IPDVEnable W
TestSubInterval W
StatusFeedbackInterval W
SeqErrThresh W
ReordDupIgnoreEnable R
LowerThresh W
UpperThresh W
HighSpeedDelta W
SlowAdjThresh W
MaxIPLayerCapacity R
TimeOfMax R
MaxETHCapacityNoFCS R
MaxETHCapacityWithFCS R
MaxETHCapacityWithFCSVLAN R
LossRatioAtMax R
RTTRangeAtMax R
PDVRangeAtMax R
IPLayerCapacitySummary R
LossRatioSummary R
MinRTTSummary R

Baseline:4 Profile

This table defines the Baseline:4 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.15.

Name Requirement
Device. P
RootDataModelVersion R
InterfaceStackNumberOfEntries R
Device.​DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
ProvisioningCode W
UpTime R
Device.​InterfaceStack.​{i}. P
HigherLayer R
LowerLayer R
Device.​DNS. P
SupportedRecordTypes R
Device.​DNS.​Client. P
Enable W
Status R
ServerNumberOfEntries R
Device.​DNS.​Client.​Server.​{i}. C
Enable W
Status R
DNSServer W
Interface W
Type R
Device.​ManagementServer. P
URL W
Username W
Password W
PeriodicInformEnable W
PeriodicInformInterval W
PeriodicInformTime W
ParameterKey R
ConnectionRequestURL R
ConnectionRequestUsername W
ConnectionRequestPassword W
UpgradesManaged W


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 17:04:00 (INTERIM VERSION).
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-15-1-cwmp-diffs.html tr-181-2-15-1-cwmp.xml