Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:2.9 Root Object definition
tr-181-2-9-0.xml (changes)

License

Copyright (c) 2010-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

Table of Contents

Data Types

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

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

Data Type Base Type Description
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.

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

IPv6Address IPAddress(45)

IPv6 address.

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

MACAddress string(17)

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

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

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

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

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

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

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

base64 -

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

References

[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-181i2] TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.

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

Name Type Write Description Object Default Version
Device. object - The top-level object for a Device. - 2.0
Device.WiFi. object - The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
Device.WiFi.AccessPoint.{i}. object W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

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

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

- 2.0
MACAddressControlEnabled boolean W Indicates whether or not MAC Address Control is enabled on this WiFi. MAC Address Control limits client devices to those whose hardware addresses match the AllowedMACAddress list. - 2.9
AllowedMACAddress string W [MACAddress] Comma-separated list of MACAddresses. Hardware addresses of client devices that are allowed to associate with this WiFi if MACAddressControlEnabled is true. - 2.9
Device.IP. object - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Diagnostics. object - The IP Diagnostics object. - 2.0
IPv4DownloadDiagnosticsSupported boolean - Indicates that Download Diagnostics over IPv4 is supported. - 2.9
IPv6DownloadDiagnosticsSupported boolean - Indicates that Download Diagnostics over IPv6 is supported. - 2.9
IPv4UploadDiagnosticsSupported boolean - Indicates that Upload Diagnostics over IPv4 is supported. - 2.9
IPv6UploadDiagnosticsSupported boolean - Indicates that Upload Diagnostics over IPv6 is supported. - 2.9
IPv4UDPEchoDiagnosticsSupported boolean - Indicates that UDPEcho Diagnostics over IPv4 is supported. - 2.9
IPv6UDPEchoDiagnosticsSupported boolean - Indicates that UDPEcho Diagnostics over IPv6 is supported. - 2.9
IPv4ServerSelectionDiagnosticsSupported boolean - Indicates that ServerSelection Diagnostics over IPv4 is supported. - 2.9
IPv6ServerSelectionDiagnosticsSupported boolean - Indicates that ServerSelection Diagnostics over IPv6 is supported. - 2.9
Device.IP.Diagnostics.DownloadDiagnostics. object -

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.

- 2.0
DownloadDiagnosticMaxConnections unsignedInt­[1:] - Indicates the maximum number of connections that are supported by Download Diagnostics. - 2.9
DownloadDiagnosticsMaxIncrementalResult unsignedInt­[1:] - The maximum number of rows in IncrementalResult that the CPE will store. - 2.9
TimeBasedTestDuration 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. - 2.9
TimeBasedTestMeasurementInterval 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.

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

- 2.9
ProtocolVersion 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)
- 2.9
NumberOfConnections 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. - 2.9
IPAddressUsed string­(45) - [IPAddress] Indicates which IP address was used to send the request. - 2.9
TotalBytesSent 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. - 2.9
TestBytesReceivedUnderFullLoading 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. - 2.9
TotalBytesReceivedUnderFullLoading 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. - 2.9
TotalBytesSentUnderFullLoading 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. - 2.9
PeriodOfFullLoading unsignedInt - The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 2.9
PerConnectionResultNumberOfEntries unsignedInt - The number of entries in the PerConnectionResult table. - 2.9
EnablePerConnectionResults boolean W The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false. - 2.9
IncrementalResultNumberOfEntries unsignedInt - The number of entries in the IncrementalResult table. - 2.9
Device.IP.Diagnostics.DownloadDiagnostics.PerConnectionResult.{i}. object - 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. - 2.9
ROMTime 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.
- 2.9
BOMTime 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.
- 2.9
EOMTime 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.
- 2.9
TestBytesReceived unsignedInt - The number of bytes of the test file received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime. - 2.9
TotalBytesReceived 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. - 2.9
TotalBytesSent 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. - 2.9
TCPOpenRequestTime 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.
- 2.9
TCPOpenResponseTime 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.
- 2.9
Device.IP.Diagnostics.DownloadDiagnostics.IncrementalResult.{i}. object - 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. - 2.9
TestBytesReceived unsignedInt - Change in the value of TestBytesReceivedUnderFullLoading between StartTime and EndTime. - 2.9
TotalBytesReceived 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. - 2.9
TotalBytesSent 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. - 2.9
StartTime dateTime -

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

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

- 2.9
EndTime dateTime -

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

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

- 2.9
Device.IP.Diagnostics.UploadDiagnostics. object -

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.

- 2.0
UploadDiagnosticsMaxConnections unsignedInt­[1:] - Indicates the maximum number of connections that are supported by Upload Diagnostics. - 2.9
UploadDiagnosticsMaxIncrementalResult unsignedInt­[1:] - The maximum number of rows in IncrementalResult that the CPE will store. - 2.9
TimeBasedTestDuration 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. - 2.9
TimeBasedTestMeasurementInterval 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.

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

- 2.9
ProtocolVersion 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)
- 2.9
NumberOfConnections 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. - 2.9
IPAddressUsed string­(45) - [IPAddress] Indicates which IP address was used to send the request. - 2.9
TestBytesSent 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. - 2.9
TotalBytesReceived 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. - 2.9
TestBytesSentUnderFullLoading 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. - 2.9
TotalBytesReceivedUnderFullLoading 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. - 2.9
TotalBytesSentUnderFullLoading 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. - 2.9
PeriodOfFullLoading unsignedInt - The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 2.9
PerConnectionResultNumberOfEntries unsignedInt - The number of entries in the PerConnectionResult table. - 2.9
EnablePerConnectionResults boolean W The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false. - 2.9
IncrementalResultNumberOfEntries unsignedInt - The number of entries in the IncrementalResult table. - 2.9
Device.IP.Diagnostics.UploadDiagnostics.PerConnectionResult.{i}. object - 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. - 2.9
ROMTime 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.
- 2.9
BOMTime 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.
- 2.9
EOMTime 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.
- 2.9
TestBytesSent unsignedInt - The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime. - 2.9
TotalBytesReceived 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. - 2.9
TotalBytesSent 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. - 2.9
TCPOpenRequestTime 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.
- 2.9
TCPOpenResponseTime 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.
- 2.9
Device.IP.Diagnostics.UploadDiagnostics.IncrementalResult.{i}. object - 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. - 2.9
TestBytesSent unsignedInt - Change in the value of TestBytesSent between StartTime and EndTime. - 2.9
TotalBytesReceived 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. - 2.9
TotalBytesSent 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. - 2.9
StartTime dateTime -

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

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

- 2.9
EndTime dateTime -

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

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

- 2.9
Device.IP.Diagnostics.UDPEchoDiagnostics. object - 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]. - 2.9
DiagnosticsState 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.

- 2.9
Interface string­(256) W

The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. If the referenced object is deleted, the parameter value MUST be set to 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.

- 2.9
Host string­(256) W Host name or address of the host to perform tests to. - 2.9
Port unsignedInt­[1:65535] W Port on the host to perform tests to. - 2.9
NumberOfRepetitions unsignedInt­[1:] W Number of repetitions of the test to perform before reporting the results. The default value SHOULD be 1. - 2.9
Timeout 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. - 2.9
DataBlockSize unsignedInt­[1:65535] W Size of the data block in bytes to be sent for each packet. The default value SHOULD be 24. - 2.9
DSCP unsignedInt­[0:63] W DiffServ codepoint to be used for the test packets. The default value SHOULD be zero. - 2.9
InterTransmissionTime unsignedInt­[1:65535] W The time in milliseconds between the NumberOfRepetitions of packets sent during a given test. The default value SHOULD be 1000. - 2.9
ProtocolVersion 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)
- 2.9
IPAddressUsed string­(45) - [IPAddress] Indicates which IP address was used to send the request. - 2.9
SuccessCount 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. - 2.9
FailureCount 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. - 2.9
AverageResponseTime 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. - 2.9
MinimumResponseTime 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. - 2.9
MaximumResponseTime 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. - 2.9
EnableIndividualPacketResults 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. - 2.9
IndividualPacketResultNumberOfEntries unsignedInt - The number of entries in the IndividualPacketResult table. - 2.9
UDPEchoDiagnosticsMaxResults 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. - 2.9
Device.IP.Diagnostics.UDPEchoDiagnostics.IndividualPacketResult.{i}. object - 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. - 2.9
PacketSuccess 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. - 2.9
PacketSendTime 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

- 2.9
PacketReceiveTime 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].

- 2.9
TestGenSN unsignedInt - The TestGenSN field in the UDPEcho Plus packet [Section A.1.4/TR-143a1] sent by the CPE client. - 2.9
TestRespSN 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. - 2.9
TestRespRcvTimeStamp 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. - 2.9
TestRespReplyTimeStamp 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.

- 2.9
TestRespReplyFailureCount 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. - 2.9
Device.IP.Diagnostics.ServerSelectionDiagnostics. object - 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. - 2.9
DiagnosticsState 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.

- 2.9
Interface string­(256) W

The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. If the referenced object is deleted, the parameter value MUST be set to 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.

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

- 2.9
Protocol string W

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

- 2.9
HostList string W Comma-separated list (up to 10 items) of strings (maximum item length 256). Each entry is a Host name or address of a host to ping. - 2.9
NumberOfRepetitions unsignedInt­[1:] W Number of repetitions of the ping test to perform for each HostList entry before reporting the results. - 2.9
Timeout 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. - 2.9
FastestHost string - Result parameter indicating the Host (one of the items within the HostList Parameter) with the smallest average response time. - 2.9
MinimumResponseTime 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. - 2.9
AverageResponseTime 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. - 2.9
MaximumResponseTime 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. - 2.9
IPAddressUsed string­(45) - [IPAddress] Indicates which IP address was used to send the request to the host identified in FastestHost. - 2.9
Device.IEEE1905. object - This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. - 2.9
Version string -

1905 profile version number of the AL as would be sent in a Higher Layer response message as defined in [Table 6-37: 1905 profile version TLV/IEEE1905.1a]. Enumeration of:

- 2.9
Device.IEEE1905.AL. object - This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. - 2.9
IEEE1905Id string­(17) - [MACAddress] 1905 AL MAC Address. - 2.9
Status string -

The current operational state of the 1905 Abstraction Layer. Enumeration of:

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 2.9
LastChange unsignedInt - This parameter is NOT RECOMMENDED to be used because IEEE1905 is not an interface. The accumulated time in seconds since the 1905 Abstraction Layer entered its current operational state. - 2.9
LowerLayers string­(1024) - This parameter is NOT RECOMMENDED to be used because IEEE1905 is not an interface. Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a row in the AL.Interface table. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.9
RegistrarFreqBand string­(1024) -

Comma-separated list (maximum list length 1024) of strings. See [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a]. Each list item is an enumeration of:

- 2.9
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.9
Device.IEEE1905.AL.Interface.{i}. object -

The 1905 interface table (described in [Sub-clause 5 Abstraction Layer Management/IEEE1905.1a]).

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

- 2.9
InterfaceId string­(17) - [MACAddress] MAC Address of this interface. This is the value of the intfAddress parameter defined in [Table 5-2: intfDescriptor elements/IEEE1905.1a] - 2.9
Status string -

This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:

It SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD normally be Down when the interface cannot transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.9
LastChange unsignedInt - This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. The accumulated time in seconds since the interface entered its current operational state. - 2.9
LowerLayers string­(1024) - This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.9
InterfaceStackReference string­(256) - Path name of an interface object described by this 1905 Interface. Referenced interface object MUST have a MACAddress and the InterfaceId MUST be the same as the interface object MACAddress. - 2.9
MediaType string -

Media type of this Interface. This is derived from the value of the intfType parameter defined in [Tables 5.2: intfDescriptor elements/IEEE1905.1a]. Enumeration of:

- 2.9
GenericPhyOUI string­(6:6) -

OUI of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. Possible patterns:

- 2.9
GenericPhyVariant hexBinary­(1:1) - Variant Index of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. - 2.9
GenericPhyURL string­(1024) - URL to Generic Phy XML Description of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
SetIntfPowerStateEnabled boolean W Enables or disables the Abstraction Layer's ability to set the power state for the interface. Boolean can be true for "enabled" and false for "disabled". - 2.9
PowerState string W

The Power State of this Interface. This is derived from the value of the powerState parameter as defined in [Tables 5.3: ALME-SET-INTF-PWR-STATE.request parameters and Table 5.7: ALME-GET-INTF-PWR-STATE.response parameters/IEEE1905.1a]. Enumeration of:

- 2.9
VendorPropertiesNumberOfEntries unsignedInt - The number of entries in the VendorProperties table. - 2.9
LinkNumberOfEntries unsignedInt - The number of entries in the Link table. - 2.9
Device.IEEE1905.AL.Interface.{i}.VendorProperties.{i}. object - This object defines the vendor specific properties (vendorSpecificInfo field) of this Interface as defined in [Table 5-2: intfDescriptor elements/IEEE1905.1a]. - 2.9
OUI string­(6:6) -

Organizationally unique identifier of a manufacturer of this Interface. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros according to [Table 5-20: VendorSpecificInfo information element/IEEE1905.1a]. Possible patterns:

- 2.9
Information hexBinary­(65535) - A hexbinary string used to to provide vendor specific information about this Interface. This is the value of the vendorSpecificInfo parameter defined in [Table 5-20: VendorSpecificInfo information element/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.Interface.{i}.Link.{i}. object -

This object defines the 1905 neighbors and link properties.

At most one entry in this table can exist with the same values for InterfaceId and IEEE1905Id.

- 2.9
InterfaceId string­(17) - [MACAddress] MAC Address of the interface of the Neighbor for this Link. This value comes from the neighbor’s Topology discovery message as defined in [Table 6-9: MAC address typeTLV/IEEE1905.1a]. - 2.9
IEEE1905Id string­(17) - [MACAddress] MAC Address of the 1905 AL entity of the Neighbor device on this Link. This value comes from the neighbor’s Topology discovery message as defined in [Table 6-8: AL MAC address type TLV/IEEE1905.1a]. - 2.9
MediaType string -

Media type of this Link. This value is derived from the neighbor’s Topology response message 1905 device information type TLV Media Type field as defined in [Table 6-12: Media type/IEEE1905.1a]. Enumeration of:

- 2.9
GenericPhyOUI string­(6:6) -

OUI of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message field as defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. Possible patterns:

- 2.9
GenericPhyVariant hexBinary­(1:1) - Variant Index of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message variant index field as defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. - 2.9
GenericPhyURL string­(1024) - URL to Generic Phy XML Description of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message URL to Generic Phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.Interface.{i}.Link.{i}.Metric. object - This object represents the metrics for this Link as defined in [Tables 6-18: 1905 transmitter link metrics and Table 6-20: 1905 receiver link metrics/IEEE1905.1a]. - 2.9
IEEE802dot1Bridge boolean - Indicates whether or not the 1905 link includes one or more IEEE 802.1 bridges. If false, the 1905 link does not include an IEEE 802.1 bridge. If true, the 1905 link does include one or more IEEE 802.1 bridges. - 2.9
PacketErrors unsignedInt - [StatsCounter32] Estimated number of lost Packets on the transmit side of the link [Table 6-18: 1905 transmitter link metrics/IEEE1905.1a] during a measurement period. - 2.9
PacketErrorsReceived unsignedInt - [StatsCounter32] Estimated number of lost Packets on the receive side of the link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] during a measurement period. - 2.9
TransmittedPackets unsignedInt - [StatsCounter32] Estimated number of Packets sent to the Neighbor on this Link, in the same measurement period used to estimate PacketErrors. - 2.9
PacketsReceived unsignedInt - [StatsCounter32] Estimated number of Packets received from this Neighbor on this Link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a], in the same measurement period used to estimate PacketErrors. - 2.9
MACThroughputCapacity unsignedInt - The maximum MAC throughput in Mb/s between this Interface and the Neighbor on this Link that is estimated at this Interface. - 2.9
LinkAvailability unsignedInt­[0:100] - The estimated average percent of time that the Link is available for data transmissions. - 2.9
PHYRate unsignedInt - The Physical Layer (PHY) rate in Mb/s between this Interface and the Neighbor on this Link that is estimated at this Interface. - 2.9
RSSI unsignedInt­[0:255] - The estimated Received Signal Strength Indicator (RSSI) ratio in dB between this Interface and the Neighbor on this Link that is estimated at the receive side of this Interface. - 2.9
Device.IEEE1905.AL.ForwardingTable. object - This object represents the rules to forward PDUs between interfaces within the 1905 Abstraction Layer. - 2.9
SetForwardingEnabled boolean W Abstraction Layer ability to set, modify, and remove ForwardingRule entries for interfaces. Boolean can be true for "enabled" and false for "disabled". - 2.9
ForwardingRuleNumberOfEntries unsignedInt - The number of entries in the ForwardingRule table. - 2.9
Device.IEEE1905.AL.ForwardingTable.ForwardingRule.{i}. object W The 1905 fowarding rule for the ALME-SET-FWD-RULE.request and ALME-GET-FWD-RULES.response with classification criteria as defined in [Table 5-9: ClassificationSet elements/IEEE1905.1a]. - 2.9
InterfaceList string W The list of interfaces to which a frame satisfying the following classification criteria should be forwarded (intfAddressList parameter as defined in [Table 5-8: ALME-SET-FWD-RULE.request parameters and Table 5-12: fwdRuleList elements/IEEE1905.1a]). Comma-separated list of strings (maximum item length 256). Each list item MUST be the path name of an object, which MUST be a row of an Interface object. If the referenced item is deleted, the corresponding item MUST be removed from the list. <Empty> 2.9
MACDestinationAddress string­(17) W

[MACAddress] Classification criterion.

The destination MAC address.

- 2.9
MACDestinationAddressFlag boolean W If false, the classification criterion MACDestinationAddress is ignored. If true, the classification criterion MACDestinationAddress is used. false 2.9
MACSourceAddress string­(17) W

[MACAddress] Classification criterion.

The source MAC address.

- 2.9
MACSourceAddressFlag boolean W If false, the classification criterion MACSourceAddress is ignored. If true, the classification criterion MACSourceAddress is used. false 2.9
EtherType unsignedInt W

Classification criterion.

Ether Type Field in a frame.

- 2.9
EtherTypeFlag boolean W If false, the classification criterion EtherType is ignored. If true, the classification EtherType is used. false 2.9
Vid unsignedInt­[0:4095] W

Classification criterion.

IEEE 802.1Q VLAN ID in a frame.

- 2.9
VidFlag boolean W If false, the classification criterion Vid is ignored. If true, the classification Vid is used. false 2.9
PCP unsignedInt­[0:7] W

Classification criterion.

IEEE 802.1Q Priority Code Point field.

- 2.9
PCPFlag boolean W If false, the classification criterion PCP is ignored. If true, the classification PCP is used. false 2.9
Device.IEEE1905.AL.NetworkTopology. object - This object represents the 1905 Network Topology capabilities of this device. - 2.9
Enable boolean W Enables or disables the 1905 Network Topology reporting (via TR-069). When true, the device clears and (re)populates the IEEE1905Device and ChangeLog tables. When false, the contents of the IEEE1905Device and ChangeLog tables have no meaning. - 2.9
Status string -

When Enable is set to true, this parameter indicates the transient phase of the discovery of the NetworkTopology.

  • Incomplete (Indicates that the device is populating the topology object during the transient phase)
  • Available (Indicates that the transient phase is over and the device is maintaining and updating the topology object as changes occur)
  • Error_Misconfigured (NOT RECOMMENDED for use; if used, indicates that a necessary configuration value is undefined or invalid)
- 2.9
MaxChangeLogEntries unsignedInt­[1:] W The maximum number of entries allowed in the ChangeLog table. - 2.9
LastChange string­(256) - The value MUST be the Path Name of a row in the ChangeLog table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the ChangeLog is modified the parameter is modified to reflect the last entry added to the ChangeLog. - 2.9
IEEE1905DeviceNumberOfEntries unsignedInt - The number of entries in the IEEE1905Device table. - 2.9
ChangeLogNumberOfEntries unsignedInt - The number of entries in the ChangeLog table. - 2.9
Device.IEEE1905.AL.NetworkTopology.ChangeLog.{i}. object - This object represents log entries for changes in the 1905 Network Topology. The Change Log is a First In First Out queue where the oldest entries (defined by values of the TimeStamp parameter) are deleted once the log is full. - 2.9
TimeStamp dateTime - Date and Time at which the entry was added to the ChangeLog table. - 2.9
EventType string -

Type of event for this entry. Enumeration of:

- 2.9
ReporterDeviceId string­(17) - [MACAddress] 1905 AL MAC Address of device which reported the change. - 2.9
ReporterInterfaceId string­(17) - [MACAddress] MAC Address of the interface of the reporting device on which the change has been detected. - 2.9
NeighborType string -

Type of Neighbor for this event. Enumeration of:

- 2.9
NeighborId string­(17) -

[MACAddress] MAC Address of the Neighbor of this event. If the value of the EventType parameter is NewNeighbor, then the value of this parameter represents the MAC Address of the new Neighbor that joined the network; if the value of the EventType parameter is LostNeighbor, then the value of this parameter represents the MAC Address of the Neighbor that left the network.

If value of the NeighborType parameter is IEEE1905, then the value of this parameter is the 1905 AL MAC Address of the Neighbor.

- 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. object -

This object represents an instance of discovered 1905 Devices in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]).

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

- 2.9
IEEE1905Id string­(17) - [MACAddress] 1905 AL MAC Address. - 2.9
Version string -

1905 profile version number in Higher Layer Response message as defined in [Table 6-37: 1905 profile version TLV/IEEE1905.1a]. Enumeration of:

- 2.9
RegistrarFreqBand string­(1024) -

Comma-separated list (maximum list length 1024) of strings. of frequency bands identified as supported for a registrar role in an AP-autoconfiguration response message as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] Each list item is an enumeration of:

- 2.9
FriendlyName string­(128) - Friendly Name String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. - 2.9
ManufacturerName string­(128) - Manufacturer Name String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. - 2.9
ManufacturerModel string­(128) - Manufacturer Model String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. - 2.9
ControlURL string­(1024) - Control URL received in Higher Layer response message as defined in defined in [Table 6-31: Control URL Type TLV/IEEE1905.1a]. - 2.9
VendorPropertiesNumberOfEntries unsignedInt - The number of entries in the VendorProperties table. - 2.9
IPv4AddressNumberOfEntries unsignedInt - The number of entries in the IPv4Address table. - 2.9
IPv6AddressNumberOfEntries unsignedInt - The number of entries in the IPv6Address table. - 2.9
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.9
NonIEEE1905NeighborNumberOfEntries unsignedInt - The number of entries in the NonIEEE1905Neighbor table. - 2.9
IEEE1905NeighborNumberOfEntries unsignedInt - The number of entries in the IEEE1905Neighbor table. - 2.9
L2NeighborNumberOfEntries unsignedInt - The number of entries in the L2Neighbor table. - 2.9
BridgingTupleNumberOfEntries unsignedInt - The number of entries in the BridgingTuple table. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv4Address.{i}. object -

This object represents represents all IPv4 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-32: IPv4 type TLV/IEEE1905.1a].

At most one entry in this table can exist with the same values for MACAddress and IPv4Address.

- 2.9
MACAddress string­(17) - [MACAddress] MAC Address. - 2.9
IPv4Address string­(15) - [IPv4Address] IPv4 Address. - 2.9
IPv4AddressType string -

The IPv4 Address Type of this IPv4Address. Enumeration of:

- 2.9
DHCPServer string­(45) - [IPAddress] Either IPv4 address of DHCPv4 server or IPv6 address of DHCPv6 server. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv6Address.{i}. object -

This object represents represents all IPv6 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-34: IPv6 type TLV/IEEE1905.1a].

At most one entry in this table can exist with the same values for MACAddress and IPv6Address.

- 2.9
MACAddress string­(17) - [MACAddress] MAC Address. - 2.9
IPv6Address string­(45) - [IPv6Address] IPv6 Address. - 2.9
IPv6AddressType string -

The IPv6 Address Type of this IPv6Address. Enumeration of:

- 2.9
IPv6AddressOrigin string­(45) - [IPv6Address] "::" or the IPv6 address of the origin of this IPv6 address. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.VendorProperties.{i}. object - This object represents vendor specific information received in a message with a Vendor specific TLV (as defined in in [Table 6-7: Vendor specific TLV/IEEE1905.1a]). - 2.9
MessageType hexBinary­(1:1) - The Message type of a message received from this IEEE1905Device that contained a Vendor specific TLV, as defined in [Table 6-4: Message type/IEEE1905.1a]. - 2.9
OUI string­(6:6) -

This is the value of the Vendor specific OUI defined in [Table 6-7: Vendor specific TLV/IEEE1905.1a]. Possible patterns:

- 2.9
Information hexBinary­(65535) - A hexbinary string used to provide vendor specific information. This is the value of the Vendor specific information parameter defined in [Table 6-7: Vendor specific TLV/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.Interface.{i}. object -

This object represents an instance of an interface for the IEEE1905Device.

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

- 2.9
InterfaceId string­(17) - [MACAddress] MAC Address of the interface. This comes from the Topology response message as defined in [Table 6-10: 1905 device information type TLV/IEEE1905.1a]. - 2.9
MediaType string -

Media type of this Interface. This comes from the Topology response message as defined in [Table 6-10: 1905 device information type TLV/IEEE1905.1a]. Enumeration of:

- 2.9
PowerState string -

The Power State of this Interface. "Off" is used for interfaces identified in a Power Off Interface TLV as defined in [Table 6-38/IEEE1905.1a]. "On" is used for all other interfaces. "Power_Save" and "Unsupported" are not used at this time. Updated as a result of a received Interface Power Change response with “request completed” or “alternate change made” Interface Power Change status as defined in [Table 6-40: Interface Power Change status TLV/IEEE1905.1a]. Enumeration of:

- 2.9
GenericPhyOUI string­(6:6) -

GenericPhyOUI of this Interface. Possible patterns:

- 2.9
GenericPhyVariant hexBinary­(1:1) - Variant Index of the Generic Phy networking technology of this Interface. This value is from a Generic Phy response message variant index field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
GenericPhyURL string­(1024) - URL to Generic Phy XML Description of the Generic Phy networking technology of this Interface. This value is from a Generic Phy response message URL to generic phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
NetworkMembership string­(17) - [MACAddress] MACAddress Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a]. - 2.9
Role string -

Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a]. Enumeration of:

- 2.9
APChannelBand hexBinary­(1:1) - Hexadecimal digit. Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] - 2.9
FrequencyIndex1 hexBinary­(1:1) - Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] - 2.9
FrequencyIndex2 hexBinary­(1:1) - Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.NonIEEE1905Neighbor.{i}. object -

This object represents an instance of a Non-IEEE1905 Neighbor for the IEEE1905Device. These fields come from a Topology response message as defined in [Table 6-14: Non-1905 neighbor device TLV/IEEE1905.1a].

At most one entry in this table can exist with the same values for LocalInterface and NeighborInterfaceId.

- 2.9
LocalInterface string­(256) - The value MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.9
NeighborInterfaceId string­(17) - [MACAddress] MAC Address of the interface for the NonIEEE1905Neighbor. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.L2Neighbor.{i}. object -

This object represents an instance of an L2 Neighbor for the IEEE1905Device. These fields come from a Topology response message as defined in [Table 6-41: L2 neighbor device TLV/IEEE1905.1a].

At most one entry in this table can exist with the same values for LocalInterface and NeighborInterfaceId.

- 2.9
LocalInterface string­(256) - The value MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.9
NeighborInterfaceId string­(17) - [MACAddress] MAC Address of the L2Neighbor. - 2.9
BehindInterfaceIds string­(1024) - [MACAddress] Comma-separated list (maximum list length 1024) of MACAddresses. Behind MAC Addresses of the L2Neighbor. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. object -

This object represents an instance of an IEEE1905Neighbor for the IEEE1905Device. These values are from the Topology response message as defined in [Table 6-15: 1905 neighbor device TLV/IEEE1905.1a].

At most one entry in this table can exist with the same values for LocalInterface and NeighborDeviceId.

- 2.9
LocalInterface string­(256) - The value MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.9
NeighborDeviceId string­(17) - [MACAddress] 1905 AL MAC Address of the Neighbor. - 2.9
MetricNumberOfEntries unsignedInt - The number of entries in the Metric table. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}.Metric.{i}. object -

This object represents the metrics included in a Link metric response from the IEEE1905Device where LocalInterface is the MAC address of an interface in the receiving 1905 AL as defined in [Table 6-17: 1905 transmitter link metric TLV/IEEE1905.1a].

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

- 2.9
NeighborMACAddress string­(17) - [MACAddress] The MAC address of an interface in a neighbor 1905 device as defined in [Table 6-17: 1905 transmitter link metric TLV or Table 6-19: 1905 receiver link metric TLV/IEEE1905.1a]. - 2.9
IEEE802dot1Bridge boolean - Indicates whether or not the 1905 link includes one or more IEEE 802.1 bridges. If false, the 1905 link does not include an IEEE 802.1 bridge. If true, the 1905 link does include one or more IEEE 802.1 bridges. - 2.9
PacketErrors unsignedInt - [StatsCounter32] Estimated number of lost Packets on the transmit side of the link [Table 6-18: 1905 transmitter link metrics/IEEE1905.1a] during a measurement period. - 2.9
PacketErrorsReceived unsignedInt - [StatsCounter32] Estimated number of lost Packets on the receive side of the link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] during a measurement period. - 2.9
TransmittedPackets unsignedInt - [StatsCounter32] Estimated number of Packets sent to the Neighbor on this link, in the same measurement period used to estimate PacketErrors. - 2.9
PacketsReceived unsignedInt - [StatsCounter32] Estimated number of Packets received from this Neighbor [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] on this link, in the same measurement period used to estimate PacketErrors. - 2.9
MACThroughputCapacity unsignedInt - The maximum MAC throughput in Mb/s between this Interface and the Neighbor on this link that is estimated at this Interface. - 2.9
LinkAvailability unsignedInt­[0:100] - The estimated average percent of time that this link is idle. - 2.9
PHYRate unsignedInt - The Physical Layer (PHY) rate in Mb/s between this Interface and the Neighbor on this link that is estimated at this Interface. - 2.9
RSSI unsignedInt­[0:255] - The estimated Received Signal Strength Indicator (RSSI) ratio in dB between this Interface and the Neighbor on this link that is estimated at the receive side of this Interface. Note: This parameter is valid only for IEEE 802.11 Neighbors. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.BridgingTuple.{i}. object - This object represents an instance of an BridgingTuple for the IEEE1905Device. These values come from the 1905 Device’s Topology response message as defined in [Table 6-11: Device bridging capability TLV/IEEE1905.1a]. - 2.9
InterfaceList string - Comma-separated list of strings (maximum item length 256). Each list item MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface table. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.9
Device.IEEE1905.AL.Security. object - This object represents the Security configuration for the 1905 device as defined in [Section 9.2 Security Setup Methods/IEEE1905.1a]. - 2.9
SetupMethod string­(1024) W

Comma-separated list (maximum list length 1024) of strings. Supported security setup method(s) for the network. Each list item is an enumeration of:

  • UCPK (User Configured Passphrase or Key)
  • PBC (Push Button Configuration)
  • NFCNK (Near-field Communication Network Key)
- 2.9
Password string W

1905 network passphrase for generating security keys.

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

- 2.9
Device.IEEE1905.AL.NetworkingRegistrar. object - This object represents the detected Network Registrars detection function for the IEEE 1905 network. They are determined by received AP-autoconfiguration response messages with Registrar role, with supported band as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] - 2.9
Registrar2dot4 string­(1024) - [MACAddress] Comma-separated list (maximum list length 1024) of MACAddresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 2.4 GHz. - 2.9
Registrar5 string­(1024) - [MACAddress] Comma-separated list (maximum list length 1024) of MACAddresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 5 GHz. - 2.9
Registrar60 string­(1024) - [MACAddress] Comma-separated list (maximum list length 1024) of MACAddresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 60 GHz. - 2.9

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.IP.Diagnostics.DownloadDiagnostics.
IPAddressUsed
EnablePerConnectionResults
Device.IP.Diagnostics.DownloadDiagnostics.PerConnectionResult.{i}.
ROMTime
BOMTime
EOMTime
TestBytesReceived
TotalBytesReceived
TotalBytesSent
TCPOpenRequestTime
TCPOpenResponseTime
Device.IP.Diagnostics.DownloadDiagnostics.IncrementalResult.{i}.
TestBytesReceived
StartTime
EndTime
Device.IP.Diagnostics.UploadDiagnostics.
EnablePerConnectionResults
Device.IP.Diagnostics.UploadDiagnostics.PerConnectionResult.{i}.
ROMTime
BOMTime
EOMTime
TestBytesSent
TotalBytesReceived
TotalBytesSent
TCPOpenRequestTime
TCPOpenResponseTime
Device.IP.Diagnostics.UploadDiagnostics.IncrementalResult.{i}.
TestBytesSent
StartTime
EndTime
Device.IP.Diagnostics.UDPEchoDiagnostics.
DiagnosticsState
Host
Port
NumberOfRepetitions
Timeout
DataBlockSize
DSCP
InterTransmissionTime
EnableIndividualPacketResults
UDPEchoDiagnosticsMaxResults
Device.IP.Diagnostics.ServerSelectionDiagnostics.
DiagnosticsState
FastestHost
MinimumResponseTime
AverageResponseTime
MaximumResponseTime
Device.IEEE1905.AL.
LastChange
Device.IEEE1905.AL.Interface.{i}.
LastChange
InterfaceStackReference
Device.IEEE1905.AL.Interface.{i}.Link.{i}.Metric.
PacketErrors
PacketErrorsReceived
TransmittedPackets
PacketsReceived
MACThroughputCapacity
LinkAvailability
PHYRate
RSSI

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.

UDPEchoDiag:1 Profile

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

Name Requirement
Device.­IP.­Diagnostics.­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
Device.­IP.­Diagnostics.­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 Device:2 data model. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IP.­Diagnostics.­ServerSelectionDiagnostics. P
DiagnosticsState W
Interface W
HostList W
NumberOfRepetitions W
Timeout W
FastestHost R
AverageResponseTime R

IEEE1905Device:1 Profile

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

Name Requirement
Device.­IEEE1905. P
Version R
Device.­IEEE1905.AL. P
IEEE1905Id R
Status R
InterfaceNumberOfEntries R
Device.­IEEE1905.AL.­Interface.­{i}. P
InterfaceId R
MediaType R
GenericPhyOUI R
GenericPhyVariant R
GenericPhyURL R
Device.­IEEE1905.AL.­Security. P
SetupMethod W
Password W

IEEE1905NetworkTopology:1 Profile

The IEEE1905NetworkTopology:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­NetworkTopology. P
Enable W
Status R
MaxChangeLogEntries W
LastChange R
IEEE1905DeviceNumberOfEntries R
ChangeLogNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­ChangeLog.­{i}. P
TimeStamp R
EventType R
ReporterDeviceId R
ReporterInterfaceId R
NeighborType R
NeighborId R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}. P
IEEE1905Id R
Version R
InterfaceNumberOfEntries R
NonIEEE1905NeighborNumberOfEntries R
IEEE1905NeighborNumberOfEntries R
BridgingTupleNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­BridgingTuple.­{i}. P
InterfaceList R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­IEEE1905Neighbor.­{i}. P
LocalInterface R
NeighborDeviceId R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­Interface.­{i}. P
InterfaceId R
MediaType R
PowerState R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­NonIEEE1905Neighbor.­{i}. P
LocalInterface R
NeighborInterfaceId R

IEEE1905LinkMetric:1 Profile

The IEEE1905LinkMetric:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­Interface.­{i}. P
SetIntfPowerStateEnabled W
PowerState W
LinkNumberOfEntries R
VendorPropertiesNumberOfEntries R
Device.­IEEE1905.AL.­Interface.­{i}.­VendorProperties.­{i}. P
OUI R
Information R
Device.­IEEE1905.AL.­Interface.­{i}.­Link.­{i}. P
InterfaceId R
IEEE1905Id R
MediaType R
Device.­IEEE1905.AL.­Interface.­{i}.­Link.­{i}.­Metric. P
PacketErrors R
PacketErrorsReceived R
TransmittedPackets R
PacketsReceived R
MACThroughputCapacity R
LinkAvailability R
PHYRate R
RSSI R

IEEE1905InterfaceSelection:1 Profile

The IEEE1905InterfaceSelection:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­Interface.­{i}. P
SetIntfPowerStateEnabled W
PowerState W
VendorPropertiesNumberOfEntries R
Device.­IEEE1905.AL.­Interface.­{i}.­VendorProperties.­{i}. P
OUI R
Information R
Device.­IEEE1905.AL.­ForwardingTable. P
SetForwardingEnabled R
ForwardingRuleNumberOfEntries R
Device.­IEEE1905.AL.­ForwardingTable.­ForwardingRule.­{i}. C
InterfaceList W
MACDestinationAddress W
MACDestinationAddressFlag W
MACSourceAddress W
MACSourceAddressFlag W
EtherType W
EtherTypeFlag W
Vid W
VidFlag W
PCP W
PCPFlag W

IEEE1905Power:1 Profile

The IEEE1905Power:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­Interface.­{i}. P
SetIntfPowerStateEnabled W
PowerState W
VendorPropertiesNumberOfEntries R
Device.­IEEE1905.AL.­Interface.­{i}.­VendorProperties.­{i}. P
OUI R
Information R

IEEE1905TopologyHigherLayer:1 Profile

The IEEE1905TopologyHigherLayer:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­NetworkTopology. P
Enable W
Status R
IEEE1905DeviceNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}. P
IEEE1905Id R
Version R
FriendlyName R
ManufacturerName R
ManufacturerModel R
ControlURL R
IPv4AddressNumberOfEntries R
IPv6AddressNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­IPv4Address.­{i}. P
MACAddress R
IPv4Address R
IPv4AddressType R
DHCPServer R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­IPv6Address.­{i}. P
MACAddress R
IPv6Address R
IPv6AddressType R
IPv6AddressOrigin R

IEEE1905TopologyNeighbor:1 Profile

The IEEE1905TopologyNeighbor:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­NetworkTopology. P
Enable W
Status R
IEEE1905DeviceNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}. P
IEEE1905Id R
Version R
InterfaceNumberOfEntries R
NonIEEE1905NeighborNumberOfEntries R
IEEE1905NeighborNumberOfEntries R
L2NeighborNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­IEEE1905Neighbor.­{i}. P
LocalInterface R
NeighborDeviceId R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­Interface.­{i}. P
InterfaceId R
MediaType R
PowerState R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­NonIEEE1905Neighbor.­{i}. P
LocalInterface R
NeighborInterfaceId R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­L2Neighbor.­{i}. P
LocalInterface R
NeighborInterfaceId R
BehindInterfaceIds R

IEEE1905TopologyMetric:1 Profile

The IEEE1905TopologyMetric:1 profile for the Device:2 data model is defined as the union of the IEEE1905Device:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­IEEE1905.AL.­NetworkTopology. P
Enable W
Status R
IEEE1905DeviceNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}. P
IEEE1905Id R
InterfaceNumberOfEntries R
IEEE1905NeighborNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­IEEE1905Neighbor.­{i}. P
LocalInterface R
NeighborDeviceId R
MetricNumberOfEntries R
Device.­IEEE1905.AL.­NetworkTopology.­IEEE1905Device.­{i}.­IEEE1905Neighbor.­{i}.­Metric.­{i}. P
NeighborMACAddress R
IEEE802dot1Bridge R
PacketErrors R
PacketErrorsReceived R
TransmittedPackets R
PacketsReceived R
MACThroughputCapacity R
LinkAvailability R
PHYRate R
RSSI R

WiFiAccessPoint:2 Profile

The WiFiAccessPoint:2 profile for the Device:2 data model is defined as the union of the WiFiAccessPoint:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.­WiFi.­AccessPoint.­{i}. P
MACAddressControlEnabled W
AllowedMACAddress W


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:23:45.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-9-0-diffs.html tr-181-2-9-0.xml