Broadband Forum

TR-143 Issue 1 Amendment 1
tr-143-1-1-0.xml

DATA MODEL DEFINITION

License

Copyright (c) 2008-2017, Broadband Forum

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

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

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

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

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

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

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

Summary

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

IPAddress string(45)

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

References

[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2013.
[TR-143a1] TR-143 Amendment 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, December 2014.

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.

TR-143:1.1 Data Model

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.1, then it will indicate support for version 1.1. The version number associated with each object and parameter is shown in the Version column.

Name Type Syntax Write Description Object Default Version Spec
IPv4DownloadDiagnosticsSupported boolean boolean - Indicates that Download Diagnostics over IPv4 is supported. - 1.0 TR-143a1
IPv6DownloadDiagnosticsSupported boolean boolean - Indicates that Download Diagnostics over IPv6 is supported. - 1.0 TR-143a1
IPv4UploadDiagnosticsSupported boolean boolean - Indicates that Upload Diagnostics over IPv4 is supported. - 1.0 TR-143a1
IPv6UploadDiagnosticsSupported boolean boolean - Indicates that Upload Diagnostics over IPv6 is supported. - 1.0 TR-143a1
IPv4UDPEchoDiagnosticsSupported boolean boolean - Indicates that UDPEcho Diagnostics over IPv4 is supported. - 1.0 TR-143a1
IPv6UDPEchoDiagnosticsSupported boolean boolean - Indicates that UDPEcho Diagnostics over IPv6 is supported. - 1.0 TR-143a1
IPv4ServerSelectionDiagnosticsSupported boolean boolean - Indicates that ServerSelection Diagnostics over IPv4 is supported. - 1.0 TR-143a1
IPv6ServerSelectionDiagnosticsSupported boolean boolean - Indicates that ServerSelection Diagnostics over IPv6 is supported. - 1.0 TR-143a1
DownloadDiagnostics. object object​[1:1] -

This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.

Files received in the DownloadDiagnostics do not require file storage on the CPE device.

- 1.0 TR-143c2
DiagnosticsState string string W

Indicate the availability of diagnostic 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 value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

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

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

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

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None and remove all object instances from PerConnectionResult and IncrementalResult.

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 and remove all object instances from PerConnectionResult and IncrementalResult.

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 and remove all object instances from PerConnectionResult and IncrementalResult.

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.

- 1.0 TR-143c2
TR-143a1
Interface string​(256) string​(256) W

The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1

If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

- 1.0 TR-143c2
TR-143a1
DownloadURL string​(256) string​(256) W

The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.

  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.

Note: For time based tests (TimeBasedTestDuration > 0) the ACS MAY add a hint to duration of the test to the URL. See [Section 4.3/TR-143a1] for more details.

- 1.0 TR-143c2
TR-143a1
DownloadTransports string​[] list of string -

Comma-separated list of strings. Supported DownloadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:

- 1.0 TR-143c2
DownloadDiagnosticMaxConnections unsignedInt​(1:) unsignedInt​(1:) - Indicates the maximum number of connections that are supported by Download Diagnostics. - 1.0 TR-143a1
DownloadDiagnosticsMaxIncrementalResult unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in IncrementalResult that the CPE will store. - 1.0 TR-143a1
DSCP unsignedInt​(0:63) unsignedInt​(0:63) W

The DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

- 1.0 TR-143c2
EthernetPriority unsignedInt​(0:7) unsignedInt​(0:7) W

Ethernet priority code for marking packets transmitted in the test (if applicable).

The default value SHOULD be zero.

- 1.0 TR-143c2
TimeBasedTestDuration unsignedInt​(0:999) unsignedInt​(0:999) W Controls time based testing [Section 4.3/TR-143a1]. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. - 1.0 TR-143a1
TimeBasedTestMeasurementInterval unsignedInt​(0:999) unsignedInt​(0:999) W

The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP download test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled.

For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration.

- 1.0 TR-143a1
TimeBasedTestMeasurementOffset unsignedInt​(0:255) unsignedInt​(0:255) W

This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval to allow the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers.

This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0.

- 1.0 TR-143a1
ProtocolVersion string string W

Indicates the IP protocol version to be used. The default value SHOULD be Any. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
- 1.0 TR-143a1
NumberOfConnections unsignedInt​(1:) unsignedInt​(1:) W The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than DownloadDiagnosticMaxConnections. - 1.0 TR-143a1
IPAddressUsed string​(45) IPAddress - [IPAddress] Indicates which IP address was used to send the request. - 1.0 TR-143a1
ROMTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.

If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.

- 1.0 TR-143c2
TR-143a1
BOMTime dateTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.

If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.

- 1.0 TR-143c2
TR-143a1
EOMTime dateTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.

If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.

- 1.0 TR-143c2
TR-143a1
TestBytesReceived unsignedInt unsignedInt - The number of bytes received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime across all connections. - 1.0 TR-143c2
TR-143a1
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143c2
TR-143a1
TotalBytesSent unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143a1
TestBytesReceivedUnderFullLoading unsignedInt unsignedInt - The number of bytes of the test file received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections. - 1.0 TR-143a1
TotalBytesReceivedUnderFullLoading unsignedInt unsignedInt - The total number of bytes (at the IP layer) received in between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 1.0 TR-143a1
TotalBytesSentUnderFullLoading unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 1.0 TR-143a1
PeriodOfFullLoading unsignedInt unsignedInt - The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 1.0 TR-143a1
TCPOpenRequestTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.

- 1.0 TR-143c2
TR-143a1
TCPOpenResponseTime dateTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.

- 1.0 TR-143c2
TR-143a1
PerConnectionResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the PerConnectionResult table. - 1.0 TR-143a1
EnablePerConnectionResults boolean boolean W The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false. - 1.0 TR-143a1
IncrementalResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the IncrementalResult table. - 1.0 TR-143a1
DownloadDiagnostics.​PerConnectionResult.​{i}. object​[0:] object​[0:∞] - Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 1.0 TR-143a1
ROMTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.
- 1.0 TR-143a1
BOMTime dateTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.
- 1.0 TR-143a1
EOMTime dateTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.
- 1.0 TR-143a1
TestBytesReceived unsignedInt unsignedInt - The number of bytes of the test file received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime. - 1.0 TR-143a1
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143a1
TotalBytesSent unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143a1
TCPOpenRequestTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.
- 1.0 TR-143a1
TCPOpenResponseTime dateTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.
- 1.0 TR-143a1
DownloadDiagnostics.​IncrementalResult.​{i}. object​[0:] object​[0:∞] - Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 1.0 TR-143a1
TestBytesReceived unsignedInt unsignedInt - Change in the value of TestBytesReceivedUnderFullLoading between StartTime and EndTime. - 1.0 TR-143a1
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at StartTime and at EndTime and subtracting. - 1.0 TR-143a1
TotalBytesSent unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at StartTime and at EndTime and subtracting. - 1.0 TR-143a1
StartTime dateTime dateTime -

The start time of this interval which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

- 1.0 TR-143a1
EndTime dateTime dateTime -

The end time of this interval which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

- 1.0 TR-143a1
UploadDiagnostics. object object​[1:1] -

This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

- 1.0 TR-143c2
DiagnosticsState string string W

Indicate the availability of diagnostic 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 value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

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

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

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

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None and remove all object instances from UploadDiagnostics and IncrementalResult.

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 and remove all object instances from PerConnectionResult and IncrementalResult.

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 and remove all object instances from PerConnectionResult and IncrementalResult.

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.

- 1.0 TR-143c2
TR-143a1
Interface string​(256) string​(256) W

The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1

If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

- 1.0 TR-143c2
TR-143a1
UploadURL string​(256) string​(256) W

The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.

  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
- 1.0 TR-143c2
UploadTransports string​[] list of string -

Comma-separated list of strings. Supported UploadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:

- 1.0 TR-143c2
UploadDiagnosticsMaxConnections unsignedInt​(1:) unsignedInt​(1:) - Indicates the maximum number of connections that are supported by Upload Diagnostics. - 1.0 TR-143a1
UploadDiagnosticsMaxIncrementalResult unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in IncrementalResult that the CPE will store. - 1.0 TR-143a1
DSCP unsignedInt​(0:63) unsignedInt​(0:63) W

DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

- 1.0 TR-143c2
EthernetPriority unsignedInt​(0:7) unsignedInt​(0:7) W

Ethernet priority code for marking packets transmitted in the test (if applicable).

The default value SHOULD be zero.

- 1.0 TR-143c2
TestFileLength unsignedInt unsignedInt W

The size of the file (in bytes) to be uploaded to the server.

The CPE MUST insure the appropriate number of bytes are sent.

- 1.0 TR-143c2
TimeBasedTestDuration unsignedInt​(0:999) unsignedInt​(0:999) W Controls time based testing [Section 4.3/TR-143a1]. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. - 1.0 TR-143a1
TimeBasedTestMeasurementInterval unsignedInt​(0:999) unsignedInt​(0:999) W

The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP upload test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled.

For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration.

- 1.0 TR-143a1
TimeBasedTestMeasurementOffset unsignedInt​(0:255) unsignedInt​(0:255) W

This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval and allows the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers.

This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0.

- 1.0 TR-143a1
ProtocolVersion string string W

Indicates the IP protocol version to be used. The default value SHOULD be Any. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
- 1.0 TR-143a1
NumberOfConnections unsignedInt​(1:) unsignedInt​(1:) W The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than UploadDiagnosticsMaxConnections. - 1.0 TR-143a1
IPAddressUsed string​(45) IPAddress - [IPAddress] Indicates which IP address was used to send the request. - 1.0 TR-143a1
ROMTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.

If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.

- 1.0 TR-143c2
TR-143a1
BOMTime dateTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.

If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.

- 1.0 TR-143c2
TR-143a1
EOMTime dateTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.

If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.

- 1.0 TR-143c2
TR-143a1
TestBytesSent unsignedInt unsignedInt - The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime acrosss all connections. - 1.0 TR-143a1
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143a1
TotalBytesSent unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143c2
TR-143a1
TestBytesSentUnderFullLoading unsignedInt unsignedInt - The number of bytes of the test file sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections. - 1.0 TR-143a1
TotalBytesReceivedUnderFullLoading unsignedInt unsignedInt - The total number of bytes (at the IP layer) received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 1.0 TR-143a1
TotalBytesSentUnderFullLoading unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 1.0 TR-143a1
PeriodOfFullLoading unsignedInt unsignedInt - The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 1.0 TR-143a1
TCPOpenRequestTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.

- 1.0 TR-143c2
TR-143a1
TCPOpenResponseTime dateTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.

- 1.0 TR-143c2
TR-143a1
PerConnectionResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the PerConnectionResult table. - 1.0 TR-143a1
EnablePerConnectionResults boolean boolean W The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false. - 1.0 TR-143a1
IncrementalResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the IncrementalResult table. - 1.0 TR-143a1
UploadDiagnostics.​PerConnectionResult.​{i}. object​[0:] object​[0:∞] - Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 1.0 TR-143a1
ROMTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.
- 1.0 TR-143a1
BOMTime dateTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.
- 1.0 TR-143a1
EOMTime dateTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.
- 1.0 TR-143a1
TestBytesSent unsignedInt unsignedInt - The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime. - 1.0 TR-143a1
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143a1
TotalBytesSent unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 1.0 TR-143a1
TCPOpenRequestTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.
- 1.0 TR-143a1
TCPOpenResponseTime dateTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.
- 1.0 TR-143a1
UploadDiagnostics.​IncrementalResult.​{i}. object​[0:] object​[0:∞] - Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 1.0 TR-143a1
TestBytesSent unsignedInt unsignedInt - Change in the value of TestBytesSent between StartTime and EndTime. - 1.0 TR-143a1
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at StartTime and at EndTime and subtracting. - 1.0 TR-143a1
TotalBytesSent unsignedInt unsignedInt - The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at StartTime and at EndTime and subtracting. - 1.0 TR-143a1
StartTime dateTime dateTime -

The start time of this interval which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

- 1.0 TR-143a1
EndTime dateTime dateTime -

The end time of this interval which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

- 1.0 TR-143a1
UDPEchoDiagnostics. object object​[1:1] - This object defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143a1] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143a1]. - 1.0 TR-143a1
DiagnosticsState string string W

Indicate the availability of diagnostic 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 value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above.

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

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None and remove all object instances from IndividualPacketResult.

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 and remove all object instances from IndividualPacketResult.

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 and remove all object instances from IndividualPacketResult.

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.

- 1.0 TR-143a1
Interface string​(256) string​(256) W

None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. Example: Device.IP.Interface.1

If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

- 1.0 TR-143a1
Host string​(256) string​(256) W Host name or address of the host to perform tests to. - 1.0 TR-143a1
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W Port on the host to perform tests to. - 1.0 TR-143a1
NumberOfRepetitions unsignedInt​(1:) unsignedInt​(1:) W Number of repetitions of the test to perform before reporting the results. The default value SHOULD be 1. - 1.0 TR-143a1
Timeout unsignedInt​(1:) unsignedInt​(1:) W Timeout in milliseconds for the test. That is, the amount of time to wait for the return of a packet that was sent to the Host. - 1.0 TR-143a1
DataBlockSize unsignedInt​(1:65535) unsignedInt​(1:65535) W Size of the data block in bytes to be sent for each packet. The default value SHOULD be 24. - 1.0 TR-143a1
DSCP unsignedInt​(0:63) unsignedInt​(0:63) W DiffServ codepoint to be used for the test packets. The default value SHOULD be zero. - 1.0 TR-143a1
InterTransmissionTime unsignedInt​(1:65535) unsignedInt​(1:65535) W The time in milliseconds between the NumberOfRepetitions of packets sent during a given test. The default value SHOULD be 1000. - 1.0 TR-143a1
ProtocolVersion string string W

Indicates the IP protocol version to be used. The default value SHOULD be Any. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
- 1.0 TR-143a1
IPAddressUsed string​(45) IPAddress - [IPAddress] Indicates which IP address was used to send the request. - 1.0 TR-143a1
SuccessCount unsignedInt unsignedInt - Result parameter indicating the number of successful packets (those in which a successful response was received prior to the timeout) in the most recent test. - 1.0 TR-143a1
FailureCount unsignedInt unsignedInt - Result parameter indicating the number of failed packets (those in which a successful response was not received prior to the timeout) in the most recent test. - 1.0 TR-143a1
AverageResponseTime unsignedInt unsignedInt - Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 1.0 TR-143a1
MinimumResponseTime unsignedInt unsignedInt - Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 1.0 TR-143a1
MaximumResponseTime unsignedInt unsignedInt - Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 1.0 TR-143a1
EnableIndividualPacketResults boolean boolean W The results must be returned in the IndividualPacketResult table for every repetition of the test when set to true. The default value SHOULD be false. - 1.0 TR-143a1
IndividualPacketResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the IndividualPacketResult table. - 1.0 TR-143a1
UDPEchoDiagnosticsMaxResults unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in IndividualPacketResult that the CPE will store. If a test would create more rows than UDPEchoDiagnosticsMaxResults only the first UDPEchoDiagnosticsMaxResults rows are present in IndividualPacketResult. - 1.0 TR-143a1
UDPEchoDiagnostics.​IndividualPacketResult.​{i}. object​[0:] object​[0:∞] - This object provides the results from individual UDPEchoPlus test packets collected during a test if EnableIndividualPacketResults is set to true. When DiagnosticsState is set to Completed it should contain NumberOfRepetitions objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet. All instances are removed when DiagnosticsState is set to Requested or None. - 1.0 TR-143a1
PacketSuccess boolean boolean - Indicates that the response to this UDP Echo Plus packet sent was received by the client. When this value is true, then all the remaining parameters in this instance are valid. Otherwise only the values originally set by the CPE client (e.g. PacketSendTime and TestGenSN) MAY be set to valid values. - 1.0 TR-143a1
PacketSendTime dateTime dateTime -

Time the client sent this UDP Echo Plus packet in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

- 1.0 TR-143a1
PacketReceiveTime dateTime dateTime -

Time the client receives the response packet in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

If this response is never received, PacketReceiveTime SHOULD be set to the Unknown Time value as specified in [Section 3.2.2/TR-106a7].

- 1.0 TR-143a1
TestGenSN unsignedInt unsignedInt - The TestGenSN field in the UDPEcho Plus packet [Section A.1.4/TR-143a1] sent by the CPE client. - 1.0 TR-143a1
TestRespSN unsignedInt unsignedInt - The TestRespSN field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) for this Echo Plus packet sent by the CPE client. If PacketSuccess is false, TestRespSN SHOULD be 0. - 1.0 TR-143a1
TestRespRcvTimeStamp unsignedInt unsignedInt - The TestRespRcvTimeStamp field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If PacketSuccess is false, TestRespRcvTimeStamp SHOULD be 0. - 1.0 TR-143a1
TestRespReplyTimeStamp unsignedInt unsignedInt -

The TestRespReplyTimeStamp field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) to record the server reply time of this UDP Echo Plus packet sent from the CPE client.

That is, the time that the server returned the UDP Echo Plus packet. If PacketSuccess is false, TestRespReplyTimeStamp SHOULD be 0.

- 1.0 TR-143a1
TestRespReplyFailureCount unsignedInt unsignedInt - The count value that was set by the UDP Echo Plus server (i.e. Host) to record the number of dropped echo response packets by the server. This count is incremented if a valid echo request packet is received at a UDP EchoPlus server but for some reason cannot be responded to (e.g. due to local buffer overflow, CPU utilization, etc...). If PacketSuccess is false, TestRespReplyFailureCount SHOULD be 0. - 1.0 TR-143a1
ServerSelectionDiagnostics. object object​[1:1] - This object provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out. - 1.0 TR-143a1
DiagnosticsState string string W

Indicates availability of diagnostic 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 value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

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

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

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

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to 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.

- 1.0 TR-143a1
Interface string​(256) string​(256) W

None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. Example: Device.IP.Interface.1

If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

- 1.0 TR-143a1
ProtocolVersion string string W

Indicates the IP protocol version to be used. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)

The factory default value MUST be Any.

- 1.0 TR-143a1
Protocol string string W

The protocol over which the test is to be performed. Enumeration of:

- 1.0 TR-143a1
HostList string​[:10]​(256) list​[:10] of string​(256) W Comma-separated list (up to 10 items) of strings (maximum number of characters 256). Each entry is a Host name or address of a host to ping. - 1.0 TR-143a1
NumberOfRepetitions unsignedInt​(1:) unsignedInt​(1:) W Number of repetitions of the ping test to perform for each HostList entry before reporting the results. - 1.0 TR-143a1
Timeout unsignedInt​(1:) unsignedInt​(1:) W Timeout in milliseconds for each iteration of the ping test where the total number of iterations is the value of NumberOfRepetitions times the number of entities in the HostList Parameter. - 1.0 TR-143a1
FastestHost string string - Result parameter indicating the Host (one of the items within the HostList Parameter) with the smallest average response time. - 1.0 TR-143a1
MinimumResponseTime unsignedInt unsignedInt - Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero. - 1.0 TR-143a1
AverageResponseTime unsignedInt unsignedInt - Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero. - 1.0 TR-143a1
MaximumResponseTime unsignedInt unsignedInt - Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero. - 1.0 TR-143a1
IPAddressUsed string​(45) IPAddress - [IPAddress] Indicates which IP address was used to send the request to the host identified in FastestHost. - 1.0 TR-143a1
Capabilities. object object​[1:1] - The capabilities of the device. This is a constant read-only object, meaning that only a firmware upgrade will cause these values to be altered. - 1.0 TR-143c2
Capabilities.​PerformanceDiagnostic. object object​[1:1] - The capabilities of the Performance Diagnostics (DownloadDiagnostics and UploadDiagnostics) for the device. - 1.0 TR-143c2
DownloadTransports string​[] list of string -

Comma-separated list of strings. Supported DownloadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:

- 1.0 TR-143c2
DownloadDiagnosticMaxConnections unsignedInt​(1:) unsignedInt​(1:) - Indicates the maximum number of connections that are supported by Download Diagnostics. - 1.0 TR-143a1
DownloadDiagnosticsMaxIncrementalResult unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in DownloadDiagnostics.IncrementalResult? that the CPE will store. - 1.0 TR-143a1
UploadTransports string​[] list of string -

Comma-separated list of strings. Supported UploadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:

- 1.0 TR-143c2
UploadDiagnosticsMaxConnections unsignedInt​(1:) unsignedInt​(1:) - Indicates the maximum number of connections that are supported by Upload Diagnostics. - 1.0 TR-143a1
UploadDiagnosticsMaxIncrementalResult unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in UploadDiagnostics.IncrementalResult? that the CPE will store. - 1.0 TR-143a1
UDPEchoDiagnosticsMaxResults unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in UDPEchoDiagnostics.IndividualPacketResult? that the CPE will store. If a test would create more rows than UDPEchoDiagnosticsMaxResults only the first UDPEchoDiagnosticsMaxResults rows are present in UDPEchoDiagnostics.IndividualPacketResult?. - 1.0 TR-143a1

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
DownloadDiagnostics.
DiagnosticsState
DownloadDiagnostics.
IPAddressUsed
DownloadDiagnostics.
ROMTime
DownloadDiagnostics.
BOMTime
DownloadDiagnostics.
EOMTime
DownloadDiagnostics.
TestBytesReceived
DownloadDiagnostics.
TotalBytesReceived
DownloadDiagnostics.
TCPOpenRequestTime
DownloadDiagnostics.
TCPOpenResponseTime
DownloadDiagnostics.
EnablePerConnectionResults
DownloadDiagnostics.PerConnectionResult.{i}.
ROMTime
DownloadDiagnostics.PerConnectionResult.{i}.
BOMTime
DownloadDiagnostics.PerConnectionResult.{i}.
EOMTime
DownloadDiagnostics.PerConnectionResult.{i}.
TestBytesReceived
DownloadDiagnostics.PerConnectionResult.{i}.
TotalBytesReceived
DownloadDiagnostics.PerConnectionResult.{i}.
TotalBytesSent
DownloadDiagnostics.PerConnectionResult.{i}.
TCPOpenRequestTime
DownloadDiagnostics.PerConnectionResult.{i}.
TCPOpenResponseTime
DownloadDiagnostics.IncrementalResult.{i}.
TestBytesReceived
DownloadDiagnostics.IncrementalResult.{i}.
StartTime
DownloadDiagnostics.IncrementalResult.{i}.
EndTime
UploadDiagnostics.
DiagnosticsState
UploadDiagnostics.
ROMTime
UploadDiagnostics.
BOMTime
UploadDiagnostics.
EOMTime
UploadDiagnostics.
TotalBytesSent
UploadDiagnostics.
TCPOpenRequestTime
UploadDiagnostics.
TCPOpenResponseTime
UploadDiagnostics.
EnablePerConnectionResults
UploadDiagnostics.PerConnectionResult.{i}.
ROMTime
UploadDiagnostics.PerConnectionResult.{i}.
BOMTime
UploadDiagnostics.PerConnectionResult.{i}.
EOMTime
UploadDiagnostics.PerConnectionResult.{i}.
TestBytesSent
UploadDiagnostics.PerConnectionResult.{i}.
TotalBytesReceived
UploadDiagnostics.PerConnectionResult.{i}.
TotalBytesSent
UploadDiagnostics.PerConnectionResult.{i}.
TCPOpenRequestTime
UploadDiagnostics.PerConnectionResult.{i}.
TCPOpenResponseTime
UploadDiagnostics.IncrementalResult.{i}.
TestBytesSent
UploadDiagnostics.IncrementalResult.{i}.
StartTime
UploadDiagnostics.IncrementalResult.{i}.
EndTime
UDPEchoDiagnostics.
DiagnosticsState
UDPEchoDiagnostics.
Host
UDPEchoDiagnostics.
Port
UDPEchoDiagnostics.
NumberOfRepetitions
UDPEchoDiagnostics.
Timeout
UDPEchoDiagnostics.
DataBlockSize
UDPEchoDiagnostics.
DSCP
UDPEchoDiagnostics.
InterTransmissionTime
UDPEchoDiagnostics.
EnableIndividualPacketResults
UDPEchoDiagnostics.
UDPEchoDiagnosticsMaxResults
ServerSelectionDiagnostics.
DiagnosticsState
ServerSelectionDiagnostics.
FastestHost
ServerSelectionDiagnostics.
MinimumResponseTime
ServerSelectionDiagnostics.
AverageResponseTime
ServerSelectionDiagnostics.
MaximumResponseTime
Capabilities.PerformanceDiagnostic.
UDPEchoDiagnosticsMaxResults

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.

Download:1 Profile

This table defines the Download:1 profile for the TR-143:1 data model. The minimum REQUIRED version for this profile is TR-143:1.1.

Name Requirement
DownloadDiagnostics. P
DiagnosticsState W
Interface W
DownloadURL W
DownloadTransports R
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestBytesReceived R
TotalBytesReceived R
IPv4DownloadDiagnosticsSupported R
IPv6DownloadDiagnosticsSupported R

DownloadTCP:1 Profile

This table defines the DownloadTCP:1 profile for the TR-143:1 data model. The minimum REQUIRED version for this profile is TR-143:1.1.

Name Requirement
DownloadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

Upload:1 Profile

This table defines the Upload:1 profile for the TR-143:1 data model. The minimum REQUIRED version for this profile is TR-143:1.1.

Name Requirement
UploadDiagnostics. P
DiagnosticsState W
Interface W
UploadURL W
UploadTransports R
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestFileLength R
TotalBytesSent R
IPv4UploadDiagnosticsSupported R
IPv6UploadDiagnosticsSupported R

UploadTCP:1 Profile

This table defines the UploadTCP:1 profile for the TR-143:1 data model. The minimum REQUIRED version for this profile is TR-143:1.1.

Name Requirement
UploadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

UDPEchoDiag:1 Profile

This table defines the UDPEchoDiag:1 profile for the TR-143:1 data model. The minimum REQUIRED version for this profile is TR-143:1.1.

Name Requirement
UDPEchoDiagnostics. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
EnableIndividualPacketResults W
Timeout W
DataBlockSize W
DSCP W
InterTransmissionTime W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R
IndividualPacketResultNumberOfEntries R
UDPEchoDiagnostics.​IndividualPacketResult.​{i}. P
PacketSuccess R
PacketSendTime R
PacketReceiveTime R
TestGenSN R
TestRespSN R
TestRespRcvTimeStamp R
TestRespReplyTimeStamp R
TestRespReplyFailureCount R

ServerSelectionDiag:1 Profile

This table defines the ServerSelectionDiag:1 profile for the TR-143:1 data model. The minimum REQUIRED version for this profile is TR-143:1.1.

Name Requirement
ServerSelectionDiagnostics. P
DiagnosticsState W
Interface W
HostList W
NumberOfRepetitions W
Timeout W
FastestHost R
AverageResponseTime R


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 17:14:42 (INTERIM VERSION).
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --nomodels --automodel --report=html --outfile=tr-143-1-1-0.html tr-143-1-1-0.xml