Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:2.8 Root Object definition
tr-181-2-8-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
Alias string(64)

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
IPAddress string(45)

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

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

MACAddress string(17)

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

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

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

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

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

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

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

StatsCounter64 unsignedLong

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

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

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

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

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

[3GPP-HSPA] High Speed Packet data Access (HSPA), 3GPP.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.1AB-2009] IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009.
[802.3-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANAifType] IANAifType, IANAifType-MIB DEFINITIONS, IANA, 2009.
[ITU-E.118] ITU E.118, Overall Network Operation, Telephone Service, Service Operation and Human Factors, International Telecommunication Union, May 2006.
[ITU-E.164] ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[JJ-300.01] JJ-300.01, The List of Device Categories, TTC, 2011.
[MAP] ID-MAP, Mapping of Address and Port with Encapsulation (MAP), IETF, January 2014.
[MAP-DHCP] ID-MAP-DHCP, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, March 2014.
[MAP-T] ID-MAP-T, Mapping of Address and Port using Translation (MAP-T), IETF, February 2014.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] PCP Proxy Function, Port Control Protocol (PCP) Proxy Function, IETF, January 2014.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC6970] RFC 6970, Universal Plug and Play (UPnP) Internet Gateway Device (IGD) - Port Control Protocol (PCP) Interworking Function, IETF, 2013.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[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.
[TR-181i2a8] TR-181 Issue 2 Amendment 8, Device Data Model for TR-069, Broadband Forum, September 2014.

Device:2.8 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.8, then it will indicate support for version 2.8. 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.DeviceInfo. object - This object contains general device information. - 2.0
DeviceCategory string -

Comma-separated list of strings. Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.

Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

- 2.8
ModelNumber string­(64) -

The model number of the device (human readable string), or an empty string if no model number is provided by the device.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31.

- 2.8
Device.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 2.0
InformParameterNumberOfEntries unsignedInt - The number of entries in the InformParameter table. - 2.8
Device.ManagementServer.InformParameter.{i}. object W

This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the ParameterList argument of the Inform RPC whenever any Event within the EventList is being delivered.

This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.

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

- 2.8
Enable boolean W Enables or disables this InformParameter. false 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
ParameterName string­(256) W

A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE.

If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.

<Empty> 2.8
EventList string W

Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC.

All Inform Events (see [Section 3.7.1.5/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069].

An empty string means all events except "4 VALUE CHANGE".

<Empty> 2.8
Device.DSL. object - This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Line.{i}. object -

DSL Line table (a stackable interface object as described in [Section 4.2/TR-181i2]).

This table models physical DSL lines.

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

- 2.0
EnableDataGathering boolean W Enables or disables data gathering on the DSL line. - 2.8
XTSE hexBinary­(8:8) -

This configuration parameter defines the transmission system types to be allowed by the xTU on this Line instance. Each bit is 0 if not allowed or 1 if allowed, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1.

Note: This parameter is defined as xDSL Transmission system enabling (XTSE) in ITU-T G.997.1. For a full definition, see Clause 7.3.1.1.1 of ITU-T Recommendation [G.997.1].

- 2.8
XTSUsed hexBinary­(8:8) - This parameter indicates which DSL standard and recommendation are currently in use by the Line instance. Only one bit is set, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. - 2.8
UPBOKLER unsignedInt­[0:1280] -

This parameter contains the estimated electrical loop length estimated by the VTU-R expressed in 0.1 dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R in Clause 7.5.1.23.2 of ITU-T Recommendation [G.997.1].

- 2.8
UPBOKLEPb string -

Comma-separated list of unsigned integers (value 0 to 1280, or 2047). VTU-O estimated upstream power back-off electrical length per band.

This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported upstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).

Note: This parameter is defined as UPBOKLE-pb in Clause 7.5.1.23.3 of ITU-T Recommendation [G.997.1].

- 2.8
UPBOKLERPb string -

Comma-separated list of unsigned integers (value 0 to 1280, or 2047). VTU-R estimated upstream power back-off electrical length per band.

This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported downstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).

The value of each list element is coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R-pb in Clause 7.5.1.23.4 of ITU-T Recommendation [G.997.1].

- 2.8
RXTHRSHds int­[-640:0] -

UPBO downstream receiver signal level threshold.

This parameter reports the downstream received signal level threshold value used in the alternative electrical length estimation method (ELE-M1). This parameter represents an offset from -100 dBm/Hz, and ranges from -64 dB to 0 dB in steps of 0.1 dB.

The value is coded as a 16 bit number in the range -64 (coded as -640) to 0 dB (coded as 0) in steps of 0.1 dB.

Note: See ITU-T Recommendation [G.997.1].

- 2.8
ACTRAMODEds unsignedInt­[1:4] -

This parameter indicates the actual active rate adaptation mode in the downstream direction.

  • If ACTRAMODEds equals 1, the link is operating in RA-MODE 1 (MANUAL).
  • If ACTRAMODEds equals 2, the link is operating in RA-MODE 2 (AT_INIT).
  • If ACTRAMODEds equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
  • If ACTRAMODEds equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).

Note: This parameter is defined as ACT-RA-MODEds in Clause 7.5.1.33.1 of ITU-T Recommendation [G.997.1].

- 2.8
ACTRAMODEus unsignedInt­[1:4] -

This parameter indicates the actual active rate adaptation mode in the upstream direction.

  • If ACTRAMODEus equals 1, the link is operating in RA-MODE 1 (MANUAL).
  • If ACTRAMODEus equals 2, the link is operating in RA-MODE 2 (AT_INIT).
  • If ACTRAMODEus equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
  • If ACTRAMODEus equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).

Note: This parameter is defined as ACT-RA-MODEus in Clause 7.5.1.33.2 of ITU-T Recommendation [G.997.1].

- 2.8
ACTINPROCds unsignedInt -

This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the downstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP.

Note: This parameter is defined as ACTINP-ROC-ds in Clause 7.5.1.34.1 of ITU-T Recommendation [G.997.1].

- 2.8
ACTINPROCus unsignedInt -

This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the upstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP.

Note: This parameter is defined as ACTINP-ROC-us in Clause 7.5.1.34.2 ITU-T Recommendation [G.997.1].

- 2.8
SNRMROCds unsignedInt -

This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the downstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin DownstreamNoiseMargin.

Note: This parameter is defined as SNRM-ROC-ds in Clause 7.5.1.35.1 ITU-T Recommendation [G.997.1].

- 2.8
SNRMROCus unsignedInt -

This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the upstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin (UpstreamNoiseMargin).

Note: This parameter is defined as SNRM-ROC-us in Clause 7.5.1.35.2 ITU-T Recommendation [G.997.1].

- 2.8
Device.DSL.Line.{i}.DataGathering. object -

This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2.

Note: see ITU-T Recommendation [G.993.2].

- 2.8
LoggingDepthR unsignedInt -

This parameter is the maximum depth of the entire data gathering event buffer at the VTU-R, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2].

Note: This parameter is defined as LOGGING_DEPTH_R in Clause 7.5.3.2 of ITU-T Recommendation [G.997.1].

- 2.8
ActLoggingDepthReportingR unsignedInt -

This parameter is actual logging depth that is used for reporting the VTU-R event trace buffer over the eoc channel, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2].

Note: This parameter is defined as ACT_LOGGING_DEPTH_REPORTING_R in Clause 7.5.3.4 of ITU-T Recommendation [G.997.1].

- 2.8
EventTraceBufferR string­(256) -

The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the log file of the the data gathering event trace buffer containing the event records that originated at the VTU-R.

This indicates the table entry that represents a Vendor Log File that contains the data gathering buffer at the VTU-R in the DeviceInfo.VendorLogFile table.

This data gathering buffer MAY be retrieved wia an upload RPC of the identified Vendor Log File.

Note: This parameter is defined as EVENT_TRACE_BUFFER_R in Clause 7.5.3.6 of ITU-T Recommendation [G.997.1] and Clause 11.5 of ITU-T Recommendation [G.993.2].

- 2.8
Device.DSL.Channel.{i}. object -

DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]).

This table models DSL channel(s) on top of physical DSL lines.

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

- 2.0
ACTNDR unsignedInt -

Actual net data rate expressed in Kbps. Independent whether retransmission is used or not in a given transmit direction:

  • In L0 state, this parameter reports the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) at which the bearer channel is operating.
  • In L2 state, the parameter contains the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) in the previous L0 state.

Note: See ITU-T Recommendation [G.997.1].

- 2.8
ACTINPREIN unsignedInt­[0:255] -

Actual impulse noise protection against REIN, expressed in 0.1 DMT symbols.

If retransmission is used in a given transmit direction, this parameter reports the actual impulse noise protection (INP) against REIN (under specific conditions detailed in [ITU T G.998.4]) on the bearer channel in the L0 state. In the L2 state, the parameter contains the INP in the previous L0 state.

The value is coded in fractions of DMT symbols with a granularity of 0.1 symbols.

The range is from 0 to 25.4. A special value of 25.5 indicates an ACTINP_REIN of 25.5 or higher.

Note: This parameter is defined as ACTINP_REIN in Clause 7.5.2.9 of ITU-T Recommendation [G.997.1].

- 2.8
Device.Cellular. object - This object models cellular interfaces and access points. - 2.8
RoamingEnabled boolean W Enables or disables roaming. - 2.8
RoamingStatus string -

Current roaming status. Enumeration of:

- 2.8
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.8
AccessPointNumberOfEntries unsignedInt - The number of entries in the AccessPoint table. - 2.8
Device.Cellular.Interface.{i}. object -

Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and a single USIM.

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

- 2.8
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.8
Status string -

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

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

When Enable is changed to true then Status

  • SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.
  • 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)
  • SHOULD remain in the Error state if there is an error or other fault condition detected on the interface
  • 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.

Because the interface includes layer 1 the LowerLayerDown value SHOULD never be used.

This parameter is based on ifOperStatus from [RFC2863].

- 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.8
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.8
LowerLayers string­(1024) W

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

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.8
Upstream boolean -

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.8
IMEI string­(15:15) -

International Mobile Station Equipment Identity number, represented as a 15 digit string (digits 0-9). Possible patterns:

- 2.8
SupportedAccessTechnologies string -

Comma-separated list of strings. Access technologies supported by the interface. Each list item is an enumeration of:

- 2.8
PreferredAccessTechnology string W

The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter, or else be Auto. Preferred access technology.

The factory default value MUST be Auto.

- 2.8
CurrentAccessTechnology string - The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter. Access technology that is currently in use. - 2.8
AvailableNetworks string - Comma-separated list of strings (maximum item length 64). List of available networks. - 2.8
NetworkRequested string­(64) W

Name of the network which will be used, or an empty string if the network is selected automatically.

The factory default value MUST be <Empty>.

- 2.8
NetworkInUse string­(64) - The value MUST be a member of the list reported by the AvailableNetworks parameter, or else be an empty string. The value is an empty string if no network is found, or if the network specified in NetworkRequested is not found. - 2.8
RSSI int -

The received signal strength in dBm. The allowed values depend on CurrentAccessTechnology:

  • For GPRS, EDGE the range is -111 dBm to -49 dBm
  • For UMTS, UMTSHSPA the range is -117 dBm to -54 dBm
  • For LTE the range is -117 dBm to -25 dBm

Note: An undetectable signal is indicated by the appropriate lower limit, e.g. -117 dBm for LTE.

- 2.8
UpstreamMaxBitRate unsignedInt - The current maximum attainable data rate upstream (expressed in Kbps). - 2.8
DownstreamMaxBitRate unsignedInt - The current maximum attainable data rate downstream (expressed in Kbps). - 2.8
Device.Cellular.Interface.{i}.USIM. object - USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.8
Status string -

The current status of the USIM card. Enumeration of:

  • None (No card available)
  • Available (Card is available but not verified)
  • Valid (Card can be used; either valid PIN was entered, or PIN check is deactivated)
  • Blocked (USIM is blocked because the maximum number of invalid PIN entries was exceeded)
  • Error (An error was detected with the card, OPTIONAL)
- 2.8
IMSI string­(14:15) -

International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN). Possible patterns:

- 2.8
ICCID string­(6:20) -

Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:

  • Major industry identifier (MII), 2 fixed digits, 89 for telecommunication purposes.
  • Country code, 1–3 digits, as defined by ITU-T recommendation [ITU-E.164].
  • identifier, 1–4 digits.
  • Individual account identification number. Its length is variable, but every number under one IIN will have the same length.
  • Single check digit calculated from the other digits using the Luhn algorithm.

For cards using an ICCID according to [ITU-E.118] the maximum length is 19 Digits, for GSM cards 20 digits. Possible patterns:

- 2.8
MSISDN string­(14:15) -

Mobile Subscriber Integrated Service Digital Network Number, a number uniquely identifying a subscription in a GSM, UMTS, or LTE mobile network. [ITU-E.164]

Possible patterns:

- 2.8
PINCheck string W

Controls the PIN verification of the USIM card. Enumeration of:

  • OnNetworkAccess (Check the PIN with each access to a new network)
  • Reboot (Check the PIN with first access after (re)boot)
  • Off (Disable the PIN check)
- 2.8
PIN string­(4) W

Allows the ACS to change the USIM PIN used for SIM card activation.

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

- 2.8
Device.Cellular.Interface.{i}.Stats. object -

Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted out of the interface. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received on the interface. - 2.8
ErrorsSent unsignedLong - [StatsCounter64] The total number of outbound packets that could not be transmitted because of errors. - 2.8
ErrorsReceived unsignedLong - [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
UnicastPacketsSent unsignedLong - [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.8
UnicastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.8
DiscardPacketsSent unsignedLong - [StatsCounter64] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
DiscardPacketsReceived unsignedLong - [StatsCounter64] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
MulticastPacketsSent unsignedLong - [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.8
MulticastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.8
BroadcastPacketsSent unsignedLong - [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.8
BroadcastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.8
UnknownProtoPacketsReceived unsignedLong - [StatsCounter64] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.8
Device.Cellular.AccessPoint.{i}. object W

Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network.

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 APN, or with a given value for Interface.

- 2.8
Enable boolean W Enables or disables the Access Point. - 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
APN string­(64) W Access Point Name. - 2.8
Username string­(256) W Username used to authenticate the CPE when making a connection to the Access Point. - 2.8
Password string­(256) W

Password used to authenticate the CPE when making a connection to the Access Point.

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

- 2.8
Proxy string­(45) W [IPAddress] Proxy server IP address. - 2.8
ProxyPort unsignedInt­[1:65535] W Proxy server port. - 2.8
Interface string W The value MUST be the Path Name of a row in the Cellular.Interface table. Reference to the interface with which the access point is associated. - 2.8
Device.Ethernet. object - Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An "outer" VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
Device.Ethernet.Interface.{i}. object -

Ethernet interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical Ethernet ports, but in terms of the interface stack it also models the PHY and MAC level Ethernet interface.

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

- 2.0
EEECapability boolean - Indicates whether this physical ethernet port supports Energy Efficient Ethernet as specified in [Section 78/802.3-2012_section6]. - 2.8
EEEEnable boolean W Whether Energy Efficient Ethernet [Section 78/802.3-2012_section6] support is currently enabled. When enabled, this ethernet port will be capable of entering or exiting Low Power Idle (LPI) mode. - 2.8
Device.Ghn. object - G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Device.Ghn.Interface.{i}. object -

G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface.

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

- 2.4
MaxTransmitRate unsignedInt - The maximum PHY data rate that the interface is capable of transmitting (expressed in Mbps). - 2.8
DMRequested boolean W Indicates a request to force the role of the G.hn interface to Domain Master (DM) for the G.hn domain it is connected to. The selection of the Domain Master follows the procedures described in [Clause 8.6.6/G.9961]. - 2.8
IsDM boolean - Indicates whether this G.hn interface is currently the Domain Master (DM) for the G.hn domain it is connected to, as described in [Clause 8.6/G.9961]. - 2.8
SCRequested boolean W Indicates a request to force the role of the G.hn interface to Security Controller (SC) for the G.hn domain it is connected to. The selection of the Security Controller follows the procedures described in [Clause 9.2/G.9961]. - 2.8
IsSC boolean - Indicates whether this G.hn interface is currently the Security Controller (SC) for the G.hn domain it is connected to, as described in [Clause 9.2/G.9961]. - 2.8
StandardVersions string -

Comma-separated list of strings. The standard versions that the interface supports. The list MUST have an even number of items. The first item of each pair represents an ITU-T G.hn Recommendation while the second element of each pair represents the amendment version of the indicated Recommendation that this interface supports (the value 0 corresponds to the base Recommendation).

For example, to indicate support for the G.9960 base document and G.9961 amendment 1, the corresponding list would be "G9960,0,G9961,1".

- 2.8
MaxBandPlan unsignedInt - The largest bandplan that the interface can support, as defined in [Clause 8.8.5.5/G.9961]. - 2.8
MediumType string -

The medium type that the interface currently operates on. Refer to [Table 7-5/G.9962]. Enumeration of:

- 2.8
TAIFG unsignedInt - The Acknowledgement InterFrame Gap, or TAIFG, as defined in [Clause 8.4/G.9961]. It is represented as multiples of 1.28 microseconds. - 2.8
NotchedAmateurRadioBands hexBinary­(2) W

A bit map representing usage of international amateur bands (0 = masked, 1 = unmasked). The LSB represents the lowest band (1.8-2.0 MHz), the second LSB represents the second lowest band (3.5-4.0 MHz), and so on. The maximum value for this parameter is 0x03FF, i.e. it is a 10-bit quantity represented in 16 bits and the top 6 bits are always zero.

International Radio amateur bands are described in [Table D-1/G.9964] and conveyed by the Domain Master in the Amateur radio band descriptor (see [Table 8-77/G.9961]).

- 2.8
PHYThroughputDiagnosticsEnable string W Comma-separated list of DeviceIDs of nodes that need to enable their PHY throughput diagnostics mode. All devices that are enabled will participate in the G.hn network PHY throughput diagnostics process. - 2.8
PerformanceMonitoringDiagnosticsEnable string W Comma-separated list of DeviceIDs of nodes that need to enable their Performance Monitoring diagnostics mode on this node. All devices that are enabled will participate in the G.hn network Performance Monitoring diagnostics process. - 2.8
SMMaskedBandNumberOfEntries unsignedInt - The number of entries in the SMMaskedBand table. - 2.8
Device.Ghn.Interface.{i}.Stats. object -

Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961].

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.4
MgmtBytesSent unsignedLong - [StatsCounter64] The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
MgmtBytesReceived unsignedLong - [StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
MgmtPacketsSent unsignedLong - [StatsCounter64] The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium. - 2.8
MgmtPacketsReceived unsignedLong - [StatsCounter64] The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium. - 2.8
BlocksSent unsignedLong - [StatsCounter64] The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs. - 2.8
BlocksReceived unsignedLong - [StatsCounter64] The total number of LPDUs that were received by the node through a physical medium, with or without errors. - 2.8
BlocksResent unsignedInt - [StatsCounter32] The total number of LPDUs that were retransmitted. - 2.8
BlocksErrorsReceived unsignedInt -

[StatsCounter32] The total number of received LPDUs that contained errors.

Note the following relationships hold:

  • PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
  • PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
  • Retransmission rate = BlocksResent / BlocksSent.
  • Block error rate = BlocksErrorReceived / BlocksReceived.
- 2.8
Device.Ghn.Interface.{i}.DMInfo. object - This object specifies management parameters pertaining to the domain functionality (Domain Master function; see [Clause 8.6/G.9961]). The object exists only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true. - 2.8
DomainName hexBinary­(32) W This is the domain name to which the interface is currently registered. An empty string indicates that the interface is currently not registered. - 2.8
DomainNameIdentifier hexBinary­(2) - The Domain Name Identifier, a shortened version of DomainName, denoted as DNI in [Section 8.6.11.2.1/G.9961]. - 2.8
DomainId unsignedInt - The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.8
MACCycleDuration unsignedInt­[0, 10:200] W The MAC cycle duration, as specified in [Clause 8.4/G.9961]. It is represented as multiples of 0.5 msec. In the case of power line, writing to this parameter has no effect and it reads back as 0, which is a special value indicating that the MAC cycle is synchronized with 2 AC cycles as defined in [Clause 8.6.3.1/G.9961]. - 2.8
SCDeviceId unsignedInt W The DEVICE_ID of the Security Controller selected by the Domain Master. - 2.8
SCMACAddress string­(17) W [MACAddress] The REGID of the Security Controller selected by the Domain Master. - 2.8
ReregistrationTimePeriod unsignedInt­[5:63] W The time interval for periodic re-registration, as specified in [Clause 8.8.5.8/G.9961]. It is represented as multiples of 2 seconds. - 2.8
TopologyPeriodicInterval unsignedInt­[0:255] W The time interval that a node sends out the periodic topology update using TM_NodeTopologyChange.ind message, as specified in [Clause 8.8.5.8.1/G.9961]. It is represented as multiples of 0.1 sec. The special value 0 represents an infinite interval (i.e., no periodic topology update). - 2.8
MinSupportedBandplan unsignedInt W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.8
MaxSupportedBandplan unsignedInt W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.8
Device.Ghn.Interface.{i}.SCInfo. object - This object specifies management parameters pertaining to the Security Controller functionality (Security Controller function; see [Clause 9.2/G.9961]). The object exists only on G.hn interfaces that are currently the Security Controller, i.e. for which parameter IsSC is true. - 2.8
ModesSupported string -

Comma-separated list of strings. The security modes that the Security Controller can support. Refer to [Clause 9.2/G.9961]. Each list item is an enumeration of:

  • NN (Node-to-Node)
  • NMK (Network Membership Key)
- 2.8
ModeEnabled string W The value MUST be a member of the list reported by the ModesSupported parameter, or else be Disabled. The security mode in which the Security Controller is operating. - 2.8
MICSize string W

The selected MIC size used in the domain. Enumeration of:

- 2.8
Location boolean - Indicates whether the Security Controller is above the L1 reference point. It is set to true if the Security Controller is above the L1 reference point, and set to false otherwise. - 2.8
Device.Ghn.Interface.{i}.SMMaskedBand.{i}. object W

Specifies the list of masked bands to be applied to the G.hn interface. This information is conveyed by the Domain Master in the SM descriptor as specified in [Table 8-77/G.9961].

Instances of this object are expected to exist only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true.

This table MUST contain at least 0 and at most 32 entries.

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

- 2.8
Enable boolean W Enables or disables the SMMaskedBand. - 2.8
BandNumber unsignedInt W The masked band number. - 2.8
StartSubCarrier unsignedInt W Index of the lowest frequency sub-carrier in the band to be masked as specified in [Table 8-79/G.9961]. This parameter is writable only on the interface which acts as the Domain Master. - 2.8
StopSubCarrier unsignedInt W Index of the highest frequency sub-carrier in the band to be masked as specified in Table 8-79 in [G.9961]. This parameter is writable only on the interface which acts as the Domain Master. - 2.8
Device.Ghn.Diagnostics. object - The G.hn Diagnostics object. - 2.8
Device.Ghn.Diagnostics.PHYThroughput. object -

G.hn PHY throughput diagnostics configuration and results.

When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PHYThroughputDiagnosticsEnable parameter is set enter PHY diagnostics mode.

- 2.8
DiagnosticsState string W

Indicates availability of diagnostic data for PHYThroughput measurements 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 the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in the Diagnostics 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.

- 2.8
Interface string W The value MUST be the Path Name of a row in the Ghn.Interface table. The interface over which the test is to be performed. - 2.8
DiagnoseMACAddress string­(17) W

[MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed.

Note: This MAC address might belong to another node of the domain.

- 2.8
PHYThroughputResultNumberOfEntries unsignedInt - The number of entries in the Result table. - 2.8
Device.Ghn.Diagnostics.PHYThroughput.Result.{i}. object -

PHY throughput diagnostics results.

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

- 2.8
DestinationMACAddress string­(17) - [MACAddress] MAC address of the destination node of the link being measured. - 2.8
LinkState string -

Indicates the state of the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. Enumeration of:

- 2.8
TxPhyRate unsignedInt - PHY data rate in transmit direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. - 2.8
RxPhyRate unsignedInt - PHY data rate in receive direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. - 2.8
Device.Ghn.Diagnostics.PerformanceMonitoring. object -

G.hn Performance Monitoring diagnostics configuration and results.

When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PerformanceMonitoringDiagnosticsEnable parameter is set enter PHY diagnostics mode.

- 2.8
DiagnosticsState string W

Indicates availability of diagnostic data for Performance Monitoring. 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 the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in the Diagnostics object) MUST be retained by the node 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.

- 2.8
Interface string W The value MUST be the Path Name of a row in the Ghn.Interface table. The interface over which the test is to be performed. - 2.8
DiagnoseMACAddress string­(17) W

[MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed.

Note: This MAC address might belong to another node of the domain.

- 2.8
SampleInterval unsignedInt W

Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data.

The node MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error.

If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the device MAY choose to align sample intervals with time of day, but is not required to do so.

- 2.8
SNRGroupLength unsignedInt­[1, 2, 4, 8, 16, 32, 64, 128, 256] W The number of sub-carriers in a group to be used for averaging SNR values when providing SNR information for a channel. - 2.8
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes. object -

Per-node G.hn performance monitoring results.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the "current" interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any.

When automatic collection is disabled, i.e. SampleInterval is zero, the "current" interval is defined by the three most recent manual samples.

Note: Packets in statistics counters are Ethernet packets.

- 2.8
CurrentStart dateTime -

Start time for the current interval.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample.

When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago.

- 2.8
CurrentEnd dateTime -

End time for the current interval.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty.

When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample.

- 2.8
NodeNumberOfEntries unsignedInt - The number of entries in the Node table. This is the number of G.hn nodes for which performance monitoring results were collected during the current sample interval. - 2.8
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}. object -

Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses DiagnoseMACAddress) and DestinationMACAddress).

Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

This table MUST contain at least 1 entry.

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

- 2.8
DestinationMACAddress string­(17) - [MACAddress] MAC address of the destination node of the link being measured. - 2.8
BytesSent unsignedLong -

[StatsCounter64] The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets).

Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

- 2.8
BytesReceived unsignedLong -

[StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors.

Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

- 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). This parameter represents the total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium) but could not be transmitted because of errors (e.g., APDUs containing CRC errors). - 2.8
ErrorsReceived unsignedInt - [StatsCounter32] The total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet. - 2.8
UnicastPacketsSent unsignedLong - [StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent. - 2.8
UnicastPacketsReceived unsignedLong - [StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. - 2.8
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow). - 2.8
DiscardPacketsReceived unsignedInt - [StatsCounter32] The total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered. - 2.8
MulticastPacketsSent unsignedLong - [StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent. - 2.8
MulticastPacketsReceived unsignedLong - [StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. - 2.8
BroadcastPacketsSent unsignedLong - [StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent. - 2.8
BroadcastPacketsReceived unsignedLong - [StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. - 2.8
UnknownProtoPacketsReceived unsignedInt - [StatsCounter32] The total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol. - 2.8
MgmtBytesSent unsignedLong - [StatsCounter64] The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
MgmtBytesReceived unsignedLong - [StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
MgmtPacketsSent unsignedLong - [StatsCounter64] The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium. - 2.8
MgmtPacketsReceived unsignedLong - [StatsCounter64] The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium. - 2.8
BlocksSent unsignedLong - [StatsCounter64] The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs. - 2.8
BlocksReceived unsignedLong - [StatsCounter64] The total number of LPDUs that were received by the node through a physical medium, with or without errors. - 2.8
BlocksResent unsignedInt - [StatsCounter32] The total number of LPDUs that were retransmitted. - 2.8
BlocksErrorsReceived unsignedInt -

[StatsCounter32] The total number of received LPDUs that contained errors.

Note the following relationships hold:

  • PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
  • PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
  • Retransmission rate = BlocksResent / BlocksSent.
  • Block error rate = BlocksErrorReceived / BlocksReceived.
- 2.8
Device.Ghn.Diagnostics.PerformanceMonitoring.Channels. object -

Per-channel G.hn performance monitoring results.

Note: channels are unidirectional.

- 2.8
TimeStamp dateTime - Time at which channel data was last collected. - 2.8
ChannelNumberOfEntries unsignedInt - The number of entries in the Channel table. - 2.8
Device.Ghn.Diagnostics.PerformanceMonitoring.Channels.Channel.{i}. object -

Per-channel G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected from the channel between a G.hn interface (as indicated by DiagnoseMACAddress) and a G.hn interface indicated by DestinationMACAddress)

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

- 2.8
DestinationMACAddress string­(17) - [MACAddress] MAC address of the destination node of the link being measured. - 2.8
SNR string - Comma-separated list of unsigned integers. The result of an SNR test performed over the channel. It is formatted as a comma-separated list of N/M unsigned integers that represents the result of Signal-to-Noise-Ratio measurement averaging in groups of M subcarriers. The number N depends on the bandplan used by the node and corresponds to the OFDM control parameter N of each medium as defined in [G.9964]. The number M corresponds to the parameter SNRGroupLength. - 2.8
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.Radio.{i}. object -

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]).

If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information.

Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

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

- 2.0
RetryLimit unsignedInt­[0:7] W The maximum number of retransmissions of a short packet i.e. a packet that is no longer than the RTSThreshold. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit [802.11-2012]. - 2.8
CCARequest hexBinary­(11:11) W A request for the clear channel assessment (CCA) report in the format specified in [Clause 8.4.2.23.3/802.11-2012]. - 2.8
CCAReport hexBinary­(12:12) -

The clear channel assessment (CCA) report in the format specified in [Clause 8.4.2.24.3/802.11-2012].

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

If this parameter is read before a CCARequest has been issued, then its value is an empty string.

- 2.8
RPIHistogramRequest hexBinary­(11:11) W A request for a received power indicator (RPI) histogram in the format specified in [Clause 8.4.2.23.4/802.11-2012]. - 2.8
RPIHistogramReport hexBinary­(19:19) - Received power indicator (RPI) histogram report in the format specified in [Clause 8.4.2.24.4/802.11-2012]. - 2.8
FragmentationThreshold unsignedInt W This specifies the current maximum size, in octets, of the MPDU that can be delivered to the PHY. This parameter is based on dot11FragmentationThreshold from [802.11-2012]. - 2.8
RTSThreshold unsignedInt W This indicates the number of octets in an MPDU, below which an RTS/CTS handshake is not performed. This parameter is based on dot11RTSThreshold from [802.11-2012]. - 2.8
LongRetryLimit unsignedInt W This indicates the maximum number of transmission attempts of a frame, the length of which is greater than RTSThreshold, that will be made before a failure condition is indicated. This parameter is based on dot11LongRetryLimit from [802.11-2012]. - 2.8
BeaconPeriod unsignedInt W Time interval between transmitting beacons (expressed in milliseconds). This parameter is based on dot11BeaconPeriod from [802.11-2012]. - 2.8
DTIMPeriod unsignedInt W This specifies the number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM Count field is 0. This parameter is based on dot11DTIMPeriod from [802.11-2012]. - 2.8
PacketAggregationEnable boolean W This determines whether or not packet aggregation (commonly called "frame aggregation") is enabled. This applies only to 802.11n. - 2.8
PreambleType string W

The type of preamble. Longer preambles (more overhead) are needed by 802.11g to coexist with legacy systems 802.11 and 802.11b. Enumeration of:

- 2.8
BasicDataTransmitRates string W Comma-separated list of strings. The set of data rates, in Mbps, that have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed in BasicDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in BasicDataTransmitRates. - 2.8
OperationalDataTransmitRates string W Comma-separated list of strings. Maximum access point data transmit rates in Mbps for unicast frames (a superset of BasicDataTransmitRates). Given the value of BasicDataTransmitRates from the example above, OperationalDataTransmitRates might be "1,2,5.5,11", indicating that unicast frames can additionally be transmitted at 5.5 Mbps and 11 Mbps. - 2.8
SupportedDataTransmitRates string - Comma-separated list of strings. Data transmit rates in Mbps for unicast frames at which the access point will permit a station to connect (a subset of OperationalDataTransmitRates). Given the values of BasicDataTransmitRates and OperationalDataTransmitRates from the examples above, SupportedDataTransmitRates might be "1,2,5.5", indicating that the AP will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps, even though it could theoretically accept connections at 11 Mbps. - 2.8
Device.WiFi.Radio.{i}.Stats. object - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2a5] for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2a5]. - 2.0
Noise int - An indicator of average noise strength received at this radio, measured in dBm. This measurement of non-IEEE 802.11 noise power is made by sampling the channel when virtual carrier sense indicates idle and this radio is neither transmitting nor receiving a frame. - 2.8
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
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object -

A table of the devices currently associated with the access point.

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

- 2.0
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats. object -

These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames.

The CPE MUST reset these Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Status of the parent AccessPoint object transitions from Disabled to Enabled, or when it transitions from Enabled to Disabled.

- 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted to the Associated Device, including framing characters. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received from the Associated Device, including framing characters. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received from the Associated Device. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.8
RetransCount unsignedInt - [StatsCounter32] The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.8
FailedRetransCount unsignedInt - [StatsCounter32] The number of packets that were not transmitted successfully due to the number of retransmission attempts exceeding an 802.11 retry limit. This parameter is based on dot11FailedCount from [802.11-2012]. - 2.8
RetryCount unsignedInt - [StatsCounter32] The number of packets that were successfully transmitted after one or more retransmissions. This parameter is based on dot11RetryCount from [802.11-2012]. - 2.8
MultipleRetryCount unsignedInt - [StatsCounter32] The number of packets that were successfully transmitted after more than one retransmission. This parameter is based on dot11MultipleRetryCount from [802.11-2012]. - 2.8
Device.WiFi.AccessPoint.{i}.AC.{i}. object -

This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:

  • BE (Best Effort)
  • BK (Background)
  • VI (Video)
  • VO (Voice)

This table MUST contain exactly 4 entries.

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

- 2.8
AccessCategory string -

This identifies the access category. Enumeration of:

- 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
AIFSN unsignedInt­[2:15] W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 2.8
ECWMin unsignedInt­[0:15] W Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255, (expressed in microseconds). - 2.8
ECWMax unsignedInt­[0:15] W Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255, (expressed in microseconds). - 2.8
TxOpMax unsignedInt­[0:255] W Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU). - 2.8
AckPolicy boolean W Ack Policy, where False="Do Not Acknowledge" and True="Acknowledge" - 2.8
OutQLenHistogramIntervals string W Comma-separated list of strings. Definition of the histogram intervals for counting the transmit queue length in packets. Each value indicates the maximum value of the interval. For example, "0,1,4,8," defines the five intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no Stats.OutQLenHistogram stats will be collected. - 2.8
OutQLenHistogramSampleInterval unsignedInt W The time between recording samples of the current transmit queue in seconds. - 2.8
Device.WiFi.AccessPoint.{i}.AC.{i}.Stats. object -

This object contains statistics for different 802.11e access categories (priorities).

Packet counters here count 802.11 WiFi frames.

If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE).

The CPE MUST reset the Access Point's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point's Status parameter transitions to a Diasbled state) or when the Access Point becomes administratively up (i.e. the Access Point's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2].

- 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted in this access category, including framing characters. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received in this access category, including framing characters. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted in this access category. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received in this access category. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound packets in this access category that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.8
ErrorsReceived unsignedInt - [StatsCounter32] The total number of inbound packets in this access category that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of outbound packets in this access category which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
DiscardPacketsReceived unsignedInt - [StatsCounter32] The total number of inbound packets in this access category which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
RetransCount unsignedInt - [StatsCounter32] The total number of transmitted packets in this access category which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.8
OutQLenHistogram string - Comma-separated list of strings. Histogram of the total length of the transmit queue of this access category in packets (1 packet, 2 packets, etc.) according to the intervals defined by OutQLenHistogramIntervals, with samples taken each OutQLenHistogramSampleInterval. Example: "12,5,1,0,2,0,0,1". - 2.8
Device.WiFi.EndPoint.{i}. object W

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.

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

Note: The EndPoint 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 EndPoint 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 EndPoint 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
Device.WiFi.EndPoint.{i}.AC.{i}. object -

This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:

  • BE (Best Effort)
  • BK (Background)
  • VI (Video)
  • VO (Voice)

This table MUST contain exactly 4 entries.

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

- 2.8
AccessCategory string -

This identifies the access category. Enumeration of:

- 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
AIFSN unsignedInt­[2:15] W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 2.8
ECWMin unsignedInt­[0:15] W Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255, (expressed in microseconds). - 2.8
ECWMax unsignedInt­[0:15] W Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255, (expressed in microseconds). - 2.8
TxOpMax unsignedInt­[0:255] W Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU). - 2.8
AckPolicy boolean W Ack Policy, where False="Do Not Acknowledge" and True="Acknowledge" - 2.8
OutQLenHistogramIntervals string W Comma-separated list of strings. Definition of the histogram intervals for counting the transmit queue length in packets. Each value indicates the maximum value of the interval. For example, "0,1,4,8," defines the five intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no Stats.OutQLenHistogram stats will be collected. - 2.8
OutQLenHistogramSampleInterval unsignedInt W The time between recording samples of the current transmit queue seconds. - 2.8
Device.WiFi.EndPoint.{i}.AC.{i}.Stats. object -

This object contains statistics for different 802.11e access categories (priorities).

Packet counters here count 802.11 WiFi frames.

If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE).

The CPE MUST reset the EndPoint's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the EndPoint becomes operationally down due to a previous administrative down (i.e. the EndPoint's Status parameter transitions to a Diasbled state) or when the EndPoint becomes administratively up (i.e. the EndPoint's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2].

- 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted in this access category, including framing characters. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received in this access category, including framing characters. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted in this access category. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received in this access category. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound packets in this access category that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.8
ErrorsReceived unsignedInt - [StatsCounter32] The total number of inbound packets in this access category that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of outbound packets in this access category which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
DiscardPacketsReceived unsignedInt - [StatsCounter32] The total number of inbound packets in this access category which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
RetransCount unsignedInt - [StatsCounter32] The total number of transmitted packets in this access category which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.8
OutQLenHistogram string - Comma-separated list of strings. Histogram of the total length of the transmit queue of this access category in packets (1 packet, 2 packets, etc.) according to the intervals defined by OutQLenHistogramIntervals, with samples taken each OutQLenHistogramSampleInterval. Example: "12,5,1,0,2,0,0,1" - 2.8
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
IPv4PingSupported boolean - Indicates that Ping over IPv4 is supported. - 2.8
IPv6PingSupported boolean - Indicates that Ping over IPv6 is supported. - 2.8
IPv4TraceRouteSupported boolean - Indicates that TraceRoute over IPv4 is supported. - 2.8
IPv6TraceRouteSupported boolean - Indicates that TraceRoute over IPv6 is supported. - 2.8
Device.IP.Diagnostics.IPPing. object - This object provides access to an IP-layer ping test. - 2.0
ProtocolVersion string W

Indicates the IP protocol to be used. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the Ping requests)
  • IPv6 (Use IPv6 for the Ping requests)
- 2.8
IPAddressUsed string­(45) - [IPAddress] Indicates which IP address was used to send the Ping request. The parameter is only valid if the DiagnosticsState is Complete. - 2.8
Device.IP.Diagnostics.TraceRoute. object - This object defines access to an IP-layer trace-route test for the specified IP interface. - 2.0
ProtocolVersion string W

Indicates the IP protocol to be used. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the TraceRoute)
  • IPv6 (Use IPv6 for the TraceRoute)
- 2.8
IPAddressUsed string­(45) - [IPAddress] Indicates which IP address was used for TraceRoute. The parameter is only valid if the DiagnosticsState is Complete. - 2.8
Device.LLDP. object - This object contains Link Layer Discovery Protocol (LLDP) [802.1AB-2009] related objects and parameters. - 2.8
Device.LLDP.Discovery. object -

This object is used for managing the discovery of LLDP devices.

The CPE MAY, but need not, retain some or all of the information in this object across reboot.

- 2.8
DeviceNumberOfEntries unsignedInt - The number of entries in the Device table. - 2.8
Device.LLDP.Discovery.Device.{i}. object -

This table contains information about discovered LLDP devices.

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

- 2.8
Interface string - The value MUST be the Path Name of the interface via which the LLDP device was discovered. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.8
ChassisIDSubtype unsignedInt­[:255] -

The chassis identifier subtype, which is included in the value of the LLDPDU's Chassis ID TLV (TLV Type = 1). The following subtype values are defined:

  • 0 (Reserved)
  • 1 (Chassis component)
  • 2 (Interface alias)
  • 3 (Port component)
  • 4 (MAC address)
  • 5 (Network address)
  • 6 (Interface name)
  • 7 (Locally assigned)
  • 8-255 (Reserved)

Note: It is assumed that this integer might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the Chassis ID is set to the representative MAC address (chassis ID subtype = 4) for HTIP-Ethernet Bridge.

- 2.8
ChassisID string­(1:255) -

The chassis identifier, which is included in the value of the LLDPDU's Chassis ID TLV (TLV Type = 1).

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the Chassis ID is set to the representative MAC address. If LLDPDUs are sent and received from two or more LLDP agents of the same HTIP-Ethernet Bridge, this value is same in all LLDPDUs.

- 2.8
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings (maximum item length 256). Each list item MUST be the Path Name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this device.

When the entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 2.8
PortNumberOfEntries unsignedInt - The number of entries in the Port table. - 2.8
Device.LLDP.Discovery.Device.{i}.Port.{i}. object -

This table contains information about ports on discovered LLDP devices.

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

- 2.8
PortIDSubtype unsignedInt­[:255] -

The port identifier subtype, which is included in the value of the LLDPDU's Port ID TLV (TLV Type = 2). The following subtype values are defined:

  • 0 (Reserved)
  • 1 (Interface alias)
  • 2 (Port component)
  • 3 (MAC address)
  • 4 (Network address)
  • 5 (Interface name)
  • 6 (Agent circuit ID)
  • 7 (Locally assigned)
  • 8-255 (Reserved)
- 2.8
PortID string­(1:255) - The port identifier, which is included in the value of the LLDPDU's Port ID TLV (TLV Type = 2). - 2.8
TTL unsignedInt­[:65535] -

The LLDPDU lifetime (in seconds), which is the value of the latest TimeToLive TLV (TLV Type = 3).

If this value is 0, it means that the LLDP agent or the MAC service function of the port is stopped.

- 2.8
PortDescription string­(255) -

The port description, which is the value of the latest Port Description TLV (TLV Type = 4), or an empty string if no Port Description TLV has been received.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the parameter value is likely to be one of the names defined in [Appendix A (List of Interface Standard Names)/JJ-300.00].

- 2.8
MACAddressList string -

[MACAddress] Comma-separated list (up to 255 items) of MACAddresses. The device's MAC addresses, which are included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or an empty string if no list of MAC addresses has been received.

The parameter is relevant when there is a LLDP device which has a MAC copy function and has two or more MAC addresses.

Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 3 (MAC Address List).

- 2.8
LastUpdate dateTime - The date and time at which the last LLDPDU was received for this (Device,Port). - 2.8
Device.LLDP.Discovery.Device.{i}.Port.{i}.LinkInformation. object -

The port's link information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127).

Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 2 (Link Information).

- 2.8
InterfaceType unsignedInt -

The port's interface type, or 0 if no interface type has been received.

Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, it's an IANA interface type [IANAifType].

For example, IANAifType defines the following interface types for wired line (UTP cable), wireless line, power line, and coaxial cable:

  • 6 (Wired line)
  • 71 (Wireless)
  • 174 (PLC)
  • 236 (Coaxial cable)
- 2.8
MACForwardingTable string - [MACAddress] Comma-separated list (up to 255 items) of MACAddresses. The port's MAC forwarding table, or the value is an empty string if no forwarding table was supplied. - 2.8
Device.LLDP.Discovery.Device.{i}.DeviceInformation. object -

The device information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127).

Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 1 (Device Information).

- 2.8
DeviceCategory string -

Comma-separated list of strings. Each list item indicates a device category (e.g."AV_TV" and "AV_Recorder"), or the value is an empty string if no device categories were provided.

Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

- 2.8
ManufacturerOUI string­(6) -

The manufacturer OUI, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or an empty string if no manufacturer OUI was provided.

- 2.8
ModelName string­(31) -

The model name, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or an empty string if no model name was provided.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973].

- 2.8
ModelNumber string­(31) -

The model number, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or an empty string if no model number was provided.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973].

- 2.8
VendorSpecificNumberOfEntries unsignedInt - The number of entries in the VendorSpecific table. - 2.8
Device.LLDP.Discovery.Device.{i}.DeviceInformation.VendorSpecific.{i}. object -

The vendor-specific device information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127).

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

Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the [OUI] in the third octet is E0271A (TTC-OUI), the organizationally defined subtype in the sixth octet is 1 (Device Information), and the device information ID in the seventh octet is 255 (Vendor-specific extension field).

- 2.8
OrganizationCode string­(6:6) -

The vendor-specific organization code, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). Possible patterns:

- 2.8
InformationType unsignedInt­[:255] - The vendor-specific device information type, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). - 2.8
Information string­(248) - The vendor-specific device information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). - 2.8
Device.GRE. object - This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. - 2.8
TunnelNumberOfEntries unsignedInt - The number of entries in the Tunnel table. - 2.8
FilterNumberOfEntries unsignedInt - The number of entries in the Filter table. - 2.8
Device.GRE.Tunnel.{i}. object W

GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

At most one entry in this table 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.

- 2.8
Enable boolean W Enables or disables the tunnel. - 2.8
Status string -

The current operational state of the tunnel. Enumeration of:

- 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
RemoteEndpoints string W Comma-separated list (up to 4 items) of strings (maximum item length 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote GRE tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.8
KeepAlivePolicy string W

The mechanism used to keep the tunnel from timing out at the ConnectedRemoteEndpoint. Enumeration of:

"None" 2.8
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.8
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.8
DeliveryHeaderProtocol string W

The protocol used for the delivery header. Enumeration of:

- 2.8
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.8
ConnectedRemoteEndpoint string­(256) - The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote GRE tunnel endpoint. - 2.8
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.8
Device.GRE.Tunnel.{i}.Stats. object -

Statistics for this GRE tunnel, i.e. all traffic that has passed through the tunnel.

The device MUST reset the tunnel's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true).

- 2.8
KeepAliveSent unsignedInt - [StatsCounter32] The total number of KeepAlive messages sent out the tunnel. - 2.8
KeepAliveReceived unsignedInt - [StatsCounter32] The total number of KeepAlive messages received by the tunnel. - 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes sent by the tunnel. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received by the tunnel. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets sent by the tunnel. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received by the tunnel. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.8
ErrorsReceived unsignedInt - [StatsCounter32] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
Device.GRE.Tunnel.{i}.Interface.{i}. object W

GRE Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the GRE Header as defined in [RFC2784] and extensions to the GRE Header as defined in [RFC2890]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of [RFC2890] is supported there is only one instance of this Interface object per tunnel.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

- 2.8
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.8
Status string -

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

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

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to 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.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.8
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.8
LowerLayers string­(1024) W 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.8
ProtocolIdOverride unsignedInt W The Protocol ID assigned to this Interface. The Protocol Id is the EtherType value used to identify the encapsulated payload. When set to 0 the CPE determines the Protocol Id. 0 2.8
UseChecksum boolean W When true, includes the "Checksum" field in the GRE header as defined in [RFC2784]. false 2.8
KeyIdentifierGenerationPolicy string W

The method used to generate the Key Identifier extension as defined in.[RFC2890]. Enumeration of:

"Disabled" 2.8
KeyIdentifier unsignedInt W When the value of KeyIdentifierGenerationPolicy is Provisioned this KeyIdentifier parameter is used to identify an individual traffic flow within a GRE tunnel, as defined in [RFC2890]. 0 2.8
UseSequenceNumber boolean W When true, includes the "SequenceNumber" field in the GRE header as defined in [RFC2890] false 2.8
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. object -

Statistics for this GRE tunnel interface, i.e. all traffic that has passed through the interface.

The device MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e., the interface's Status parameter transitions to a down state after the interface has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true).

- 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes sent by this interface. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received by this interface. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets sent by this interface. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received by this interface. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of packets discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.8
ErrorsReceived unsignedInt - [StatsCounter32] The total number of packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
DiscardChecksumReceived unsignedInt - [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Checksum errors. - 2.8
DiscardSequenceNumberReceived unsignedInt - [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors. - 2.8
Device.GRE.Filter.{i}. object W

GRE Filter table. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions:

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

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.

- 2.8
Enable boolean W Enables or disables this filter. false 2.8
Status string -

The status of this filter. 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.

"Disabled" 2.8
Order unsignedInt­[1:] W

Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

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

- 2.8
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.8
Interface string­(256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel or Tunnel.{i}.Interface tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.8
AllInterfaces boolean W Filter criterion. This specifies that all ingress GRE tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress GRE tunnel interfaces are indicated. false 2.8
VLANIDCheck int­[-1:] W

Filter criterion.

Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering.

-1 2.8
VLANIDExclude boolean W

If false, the filter includes only those packets that match the VLANIDCheck entry, if specified.

If true, the filter includes all packets except those that match the VLANIDCheck entry, if specified.

false 2.8
DSCPMarkPolicy int­[-2:63] W

DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion.

Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.

  • A value of -1 indicates copy from the upstream packet.
  • A value of -2 indicates automatic marking of DSCP.
- 2.8
Device.MAP. object -

The Mapping of Address and Port (MAP) object [MAP] [MAP-T] [MAP-DHCP]. This object applies only to gateway devices that support IPv4 on the LAN side, include a NAT, and typically have only IPv6 connectivity on the WAN side.

See the MAP Theory of Operation [Appendix XV/TR-181i2a8] for a description of the working of this MAP data model.

- 2.8
Enable boolean W Enables or disables MAP. - 2.8
DomainNumberOfEntries unsignedInt - The number of entries in the Domain table. - 2.8
Device.MAP.Domain.{i}. object W

MAP domain settings [MAP]. Each instance models a MAP domain.

MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):

Note: There is an n:1 relationship between a MAP domain and the associated WANInterface, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own End-user IPv6 prefix and MAP IPv6 address).

Note: The Domain table includes unique key parameters that are strong references. 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 Domain 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 Domain 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 the same values for WANInterface and IPv6Prefix.

- 2.8
Enable boolean W Enables or disables the MAP domain. false 2.8
Status string -

The current operational state of the MAP domain.

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

- 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
TransportMode string W

The transport mode to use.

Corresponds to the [MAP-DHCP] S46_CONT_MAPE and S46_CONT_MAPT container options. Enumeration of:

"Translation" 2.8
WANInterface string W

The value MUST be the Path Name of a row in the IP.Interface table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP interface with which this MAP domain is associated. This will always be a NAT-ted upstream (WAN) interface.

The End-user IPv6 prefix IPv6Prefix is one of this IP interface's prefixes.

The MAP IPv6 address is derived from the End-user IPv6 prefix and is one of this IP interface's IP addresses, with an IP.Interface.{i}.IPv6Address.{i}.Origin of MAP.

- 2.8
IPv6Prefix string W

The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The MAP domain's End-user IPv6 prefix. This MUST reference one of WANInterface's prefixes.

If the ACS configures this prefix directly, the CPE MUST use the ACS-configured prefix. Otherwise, the CPE MUST select one of WANInterface's prefixes; the selected prefix will typically have IP.Interface.{i}.IPv6Prefix.{i}.Origin = PrefixDelegation.

- 2.8
BRIPv6Prefix string­(49) W

[IPv6Prefix] The MAP Border Relay (BR) address or prefix.

  • For MAP-E this is the BR address and therefore MUST be a /128 [MAP].
  • For MAP-T this is the BR prefix [MAP-T].

Corresponds to the [MAP-DHCP] S46_DMR (Default Mapping Rule) option.

Note: There will be a corresponding Routing.Router.{i}.IPv4Forwarding default rule.

- 2.8
DSCPMarkPolicy int­[-2:63] W

DSCP with which to mark the outer IP header for traffic that is associated with this MAP domain.

Downstream packets are never re-marked.

Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.

  • A value of -1 indicates copy from the incoming packet.
  • A value of -2 indicates automatic marking of DSCP.
- 2.8
PSIDOffset unsignedInt­[0:16] W

Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset.

Corresponds to the [MAP-DHCP] S46_PORTPARAMS (Port Parameters) option's offset field.

4 2.8
PSIDLength unsignedInt­[0:16] W

The length in bits of the Port-set id (PSID) configured in the PSID parameter.

Corresponds to the [MAP-DHCP] S46_PORTPARAMS (Port Parameters) option's PSID-len field.

0 2.8
PSID unsignedInt­[0:65535] W

Port-set ID (PSID) to use in preference to the value extracted from the Embedded Address (EA) bits.

Only the high order PSIDLength bits of the PSID value are used, so the parameter is ignored when PSIDLength is zero.

Corresponds to the [MAP-DHCP] S46_PORTPARAMS (Port Parameters) option's PSID field.

0 2.8
IncludeSystemPorts boolean W

Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range [0:2^(16-PSIDOffset)-1] are excluded, e.g. for the default PSIDOffset value of 4, ports [0:4095] are not included in the Port-sets.

As specified in [MAP], this parameter is relevant only when PSIDOffset is 0.

false 2.8
RuleNumberOfEntries unsignedInt - The number of entries in the Rule table. - 2.8
Device.MAP.Domain.{i}.Rule.{i}. object W

The MAP domain's Mapping Rules [MAP]. The rule with the longest match between its IPv6Prefix and the end-user IPv6Prefix is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule.

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 IPv6Prefix, or with a given value for IPv4Prefix.

- 2.8
Enable boolean W Enable or disable this Rule instance. false 2.8
Status string -

The status of this Rule instance. Enumeration of:

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

"Disabled" 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Origin string -

The mechanism via which the Rule was created.

If the CPE supports MAP configuration via both DHCPv6 and CWMP, it is up to the implementation to determine how the two mechanisms will interact. Enumeration of:

  • DHCPv6 (Created via a [MAP-DHCP] S46_RULE option)
  • Static (Present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
"Static" 2.8
IPv6Prefix string­(49) W

[IPv6Prefix] The Rule IPv6 prefix.

The Rule IPv6 prefix is a leading part of the end-user IPv6Prefix, i.e. its length MUST be less than or equal to the length of the end-user IPv6Prefix, and it MUST match the end-user IPv6Prefix.

Corresponds to the [MAP-DHCP] S46_RULE option's ipv6-prefix field.

"/0" 2.8
IPv4Prefix string­(18) W

[IPv4Prefix] The Rule IPv4 prefix.

Corresponds to the [MAP-DHCP] S46_RULE option's ipv4-prefix field.

"/0" 2.8
EABitsLength unsignedInt­[0:48] W

The length in bits of the Embedded Address (EA) bits in the end-user IPv6Prefix.

Corresponds to the [MAP-DHCP] S46_RULE option's ea-len field.

0 2.8
IsFMR boolean W

Indicates whether this rule is a Forwarding Mapping Rule (FMR), i.e. can be used for forwarding.

Corresponds to the [MAP-DHCP] S46_RULE option's flags field's F-Flag.

false 2.8
Device.MAP.Domain.{i}.Interface. object - MAP interface (a stackable interface object as described in [Section 4.2/TR-181i2]). This models the LAN side MAP domain interface. - 2.8
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.8
Status string -

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

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

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to 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.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.8
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.8
LowerLayers string­(1024) W

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

Note: Since this interface object is a MAP domain interface, it is expected that LowerLayers will not be used.

- 2.8
Device.MAP.Domain.{i}.Interface.Stats. object -

Throughput statistics for this MAP domain interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.8
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.8
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.8
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted out of the interface. - 2.8
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received on the interface. - 2.8
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. - 2.8
ErrorsReceived unsignedInt - [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
UnicastPacketsSent unsignedLong - [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.8
UnicastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.8
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
DiscardPacketsReceived unsignedInt - [StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
MulticastPacketsSent unsignedLong - [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.8
MulticastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.8
BroadcastPacketsSent unsignedLong -

[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent.

Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.

- 2.8
BroadcastPacketsReceived unsignedLong -

[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.

Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.

- 2.8
UnknownProtoPacketsReceived unsignedInt - [StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.8
Device.PCP. object -

Properties for Port Control Protocol (PCP) [RFC6887].

See the PCP Theory of Operation [Appendix XIV/TR-181i2a8] for a description of the working of this PCP data model.

- 2.8
SupportedVersions string -

Comma-separated list of unsigned integers (value 0 to 65535). Each list item denotes a PCP version supported by the PCP Client. Currently known versions are 0, 1 and 2.

This parameter is based on Version from [RFC6887].

- 2.8
PreferredVersion unsignedInt­[0:65535] W

This is the version to be used in the first exchange with a new PCP Server.

The factory default MUST be the highest supported version, as described in [Section 9/RFC6887].

- 2.8
OptionList string - Comma-separated list of unsigned integers (value 0 to 254). The list of the PCP Options supported by the PCP Client. - 2.8
ClientNumberOfEntries unsignedInt - The number of entries in the Client table. - 2.8
Device.PCP.Client.{i}. object W

Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in [RFC6887] for internal device applications or LAN device applications via Interworking functions.

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

- 2.8
Enable boolean W Enables or disables the PCP Client. - 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
WANInterface string - The value MUST be the Path Name of the interface stack instance representing the WAN interface this client operates on. If the referenced object is deleted, the parameter value MUST be set to an empty string. See InterfaceStack. - 2.8
Status string -

The status of the PCP Client. Enumeration of:

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

- 2.8
MAPEnable boolean W Enables or disables the MAP OpCode. - 2.8
PEEREnable boolean W Enables or disables the PEER OpCode. - 2.8
ANNOUNCEEnable boolean W

Enables or disables the ANNOUNCE OpCode.

When false the PCP Client does not support unsolicited ANNOUNCE messages.

- 2.8
THIRDPARTYEnable boolean W Enables or disables the THIRD_PARTY Option. - 2.8
THIRDPARTYStatus string -

Indicates whether THIRD_PARTY Option is enabled or not. Enumeration of:

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

- 2.8
FILTEREnable boolean W Enables or disables the FILTER option. - 2.8
ServerNumberOfEntries unsignedInt - The number of entries in the Server table. - 2.8
Device.PCP.Client.{i}.PCPProxy. object - Properties for the Port Control Protocol (PCP) Proxy, as specified in [PCPProxy]. - 2.8
Enable boolean W Enables or disables the PCP Proxy for this PCP Client. - 2.8
HighestVersion unsignedInt­[0:65535] -

A string identifying the highest version of PCP that the proxy supports.

This parameter is based on Version from [RFC6887].

- 2.8
Status string -

The status of the PCP Proxy for this PCP Client. Enumeration of:

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

- 2.8
Device.PCP.Client.{i}.UPnPIWF. object - Properties for the interworking function between UPnP IGD (Internet Gateway Device) and PCP, as specified in [RFC6970]. - 2.8
Enable boolean W Enables or disables the UPnP IGD-PCP Interworking Function for this PCP Client. - 2.8
Status string -

The status of the UPnP IGD-PCP Interworking Function for this PCP Client. Enumeration of:

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

- 2.8
Device.PCP.Client.{i}.Server.{i}. object W

This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per [RFC7291].

Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a Server instance. If an option returns multiple addresses then that Server instance has multiple addresses.

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

- 2.8
Enable boolean W Enables or disables this PCP Server. true 2.8
Status string -

The status of the PCP Server. Enumeration of:

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

"Disabled" 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Origin string -

Method used to assign ServerNameOrAddress and create this table entry. Enumeration of:

  • DHCPv4 (ServerNameOrAddress is an IPv4 address that was received via OPTION_V4_PCP_SERVER)
  • DHCPv6 (ServerNameOrAddress is an IPv6 address that was received via OPTION_V6_PCP_SERVER)
  • Static (ServerNameOrAddress is an FQDN, IPv4 address or IPv6 address that was created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)

Note: In the DHCPv4 and DHCPv6 cases, if more than one IP address is received ServerNameOrAddress will be the first address and AdditionalServerAddresses will be the remaining addresses.

"Static" 2.8
ServerNameOrAddress string­(256) W The FQDN or IP address of the PCP Server, assigned as described under Origin. - 2.8
ServerAddressInUse string­(45) -

[IPAddress] The IP address currently in use for the PCP Server, derived from the value of ServerNameOrAddress.

An empty string indicates that no PCP Server address is currently known.

- 2.8
AdditionalServerAddresses string - [IPAddress] Comma-separated list of IPAddresses. PCP Server addresses in addition to ServerNameOrAddress. This can be non-empty only if Origin is DHCPv4 or DHCPv6 and if more than one PCP Server address was received. - 2.8
ExternalIPAddress string­(45) - [IPAddress] The external IP address of the PCP-controlled device hosting this server. - 2.8
CurrentVersion unsignedInt­[0:65535] -

This is the version of PCP resulting from client-server Version Negotiation.

This parameter is based on Version from [RFC6887].

- 2.8
MaximumFilters unsignedInt W Indicates the maximum number of inbound filters allowed to be associated with a mapping entry on this server. - 2.8
PortQuota unsignedInt­[:65535] W

Indicates the maximum number of ports allocated to this PCP Client on this server.

A value of 0 means that there is no limitation.

0 2.8
PreferredLifetime unsignedInt W Indicates the preferred lifetime (in seconds) to be used for mappings with this server when no preference is selected by an application/user. - 2.8
Capabilities string -

Comma-separated list of strings. Indicates the capabilities supported by the PCP Server. Each list item is an enumeration of:

- 2.8
InboundMappingNumberOfEntries unsignedInt - The number of entries in the InboundMapping table. - 2.8
OutboundMappingNumberOfEntries unsignedInt - The number of entries in the OutboundMapping table. - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. object W

Inbound Mapping table.

This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in [Section 11/RFC6887].

These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping.

For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the ACS MAY modify the parameter parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

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

At most one enabled entry in this table can exist with all the same values for InternalPort, ProtocolNumber and ThirdPartyAddress.

- 2.8
Enable boolean W Enables or disables this InboundMapping instance. false 2.8
Status string -

The status of this entry. Enumeration of:

The Error_PCPErrorCodeReceived value indicates that the PCP Client received an error code from the PCP Server.

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

"Disabled" 2.8
ErrorCode unsignedInt­[1:255] - Provides the PCP error code when Status is Error_PCPErrorCodeReceived. Error code values are defined in [Section 7.4/RFC6887]. - 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Origin string -

Mechanism via which the mapping was requested. Enumeration of:

  • Internal (Requested via internal device application)
  • UPnP_IWF (Requested via UPnP IGD interworking function)
  • PCP_Proxy (Requested via PCP proxy)
  • Static (Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)
- 2.8
Lifetime unsignedInt W

Determines the time to live, in seconds, of this Inbound Mapping lease, i.e. the remaining time before this port mapping expires.

A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]).

When a dynamic Inbound Mapping lease expires, the CPE MUST automatically delete the corresponding InboundMapping table entry.

- 2.8
SuggestedExternalIPAddress string­(45) W

[IPAddress] The external IPv4 or IPv6 Address that the PCP-controlled device will listen on for incoming packets to be forwarded to the PCP Client.

This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP client does not know the external address, or does not have a preference, it MUST use an empty string.

<Empty> 2.8
SuggestedExternalPort unsignedInt­[0:65535] W

The external port (or the first port of a range of external ports) that the PCP-controlled device will listen on for incoming packets. Those inbound packets will be forwarded to InternalPort. If the PCP client does not know the external port, or does not have a preference, it MUST use 0.

This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0.

0 2.8
SuggestedExternalPortEndRange unsignedInt­[0:65535] W

Indicates the last port of the external port range that starts with SuggestedExternalPort.

If an external port range is specified, then the behavior described for SuggestedExternalPort applies to all ports within the range.

A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of SuggestedExternalPort.

If SuggestedExternalPort is zero (wildcard), the value of SuggestedExternalPortEndRange MUST be ignored.

If specified, the value of this parameter MUST be zero or be greater than or equal to the value of SuggestedExternalPort.

0 2.8
InternalPort unsignedInt­[1:65535] W The port on this PCP Client's WANInterface that the PCP-controlled device forwards incoming packets to. - 2.8
ProtocolNumber int­[-1:255] W

The protocol number of the InboundMapping. Values are taken from [IANA-protocolnumbers].

The value -1 means all protocols.

- 2.8
ThirdPartyAddress string­(45) W

[IPAddress] Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in [Section 7.3/RFC6887]. In that case, ThirdPartyAddress is the IP address of the device for which the PCP operation is requested.

For non-third-party mappings, ThirdPartyAddress SHOULD be an empty string.

- 2.8
Description string­(256) W User-readable description of this InboundMapping. <Empty> 2.8
AssignedExternalIPAddress string­(45) - [IPAddress] The external IPAddress returned by the PCP Server. The IP address that the PCP-controlled device is listening on for incoming packets to a corresponding PCP Client. <Empty> 2.8
AssignedExternalPort unsignedInt­[0:65535] - The external port returned by the PCP Server. The external port (or the first port of a range of external ports) that the PCP-controlled device is listening on for incoming packets to a corresponding InternalPort. Inbound packets to this external port on the External interface of the PCP-controlled device is forwarded to the on the InternalPort. - 2.8
AssignedExternalPortEndRange unsignedInt­[0:65535] -

Indicates the last port of the external port range that starts with AssignedExternalPort.

If an external port range is specified, then the behavior described for AssignedExternalPort applies to all ports within the range.

A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of AssignedExternalPort.

0 2.8
FilterNumberOfEntries unsignedInt - The number of entries in the Filter table. - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.Filter.{i}. object W

Filter table.

This table contains all Filters restricting this Inbound Mapping, as defined in [RFC6887].

At most one entry in this table 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.

- 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
RemoteHostIPAddress string­(45) W [IPAddress] Permitted remote peer IP address for this filter. <Empty> 2.8
PrefixLength unsignedInt­[1:128] W Indicates how many bits of RemoteHostIPAddress are relevant for this filter. 128 2.8
RemotePort unsignedInt­[0:65535] W

Permitted remote peer port number for this filter.

The value 0 indicates all ports.

- 2.8
RemotePortEndRange unsignedInt­[0:65535] -

Indicates the last port of the remote port range that starts with RemotePort.

If an external port range is specified, then the behavior described for RemotePort applies to all ports within the range.

A value of zero (0) indicates that no remote port range is specified, i.e. that the range consists only of RemotePort.

0 2.8
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. object W

Outbound Mapping table.

This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in [Section 12/RFC6887].

These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping.

For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the ACS MAY modify the parameter parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

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

At most one enabled entry in this table can exist with all the same values for InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort.

- 2.8
Enable boolean W Enables or disables this OutboundMapping instance. false 2.8
Status string -

The status of this entry. Enumeration of:

The Error_PCPErrorCodeReceived value indicates that the PCP Client received an error code from the PCP Server.

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

"Disabled" 2.8
ErrorCode unsignedInt­[1:255] - Provides the PCP Error code when Status is Error_PCPErrorCodeReceived. Error code values are defined in [Section 7.4/RFC6887]. - 2.8
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8
Origin string -

Mechanism via which the mapping was requested. Enumeration of:

  • Internal (Requested via internal device application)
  • UPnP_IWF (Requested via UPnP IGD interworking function)
  • PCP_Proxy (Requested via PCP proxy)
  • Static (Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)
- 2.8
Lifetime unsignedInt W

Determines the time to live, in seconds, of this Outbound Mapping lease, i.e. the remaining time before this port mapping expires.

A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]).

When a dynamic Outbound Mapping lease expires, the CPE MUST automatically delete the corresponding OutboundMapping table entry.

- 2.8
SuggestedExternalIPAddress string­(45) W

[IPAddress] The external IPv4 or IPv6 Address that the PCP-controlled device will use to send outgoing packets covered by this mapping.

This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external address, or does not have a preference, it MUST use an empty string.

<Empty> 2.8
SuggestedExternalPort unsignedInt­[0:65535] W

The external port that the PCP-controlled device will use to send outgoing packets covered by this mapping.

This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0.

0 2.8
RemoteHostIPAddress string­(45) W [IPAddress] The remote peer's IP address, as seen from the PCP Client, for this Outbound Mapping. - 2.8
InternalPort unsignedInt­[1:65535] W The port on PCP Client WAN Interface that the PCP-controlled device SHOULD listen to for this mapping. - 2.8
RemotePort unsignedInt­[1:65535] W The remote peer's port, as seen from the PCP Client, for this Outbound Mapping. - 2.8
ProtocolNumber int­[-1:255] W

The protocol number of the OutboundMapping. Values are taken from the [IANA-protocolnumbers].

The value -1 means all protocols.

- 2.8
ThirdPartyAddress string­(45) W

[IPAddress] Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in [Section 7.3/RFC6887]. In that case, ThirdPartyAddress is the IP address of the device for which the PCP operation is requested.

For non-third-party mappings, ThirdPartyAddress SHOULD be an empty string.

- 2.8
Description string­(256) W User-readable description of this OutboundMapping. <Empty> 2.8
AssignedExternalIPAddress string­(45) - [IPAddress] The external IP address returned by the PCP Server. The IP address that the PCP-controlled device uses to send outgoing packets corresponding to this mapping. <Empty> 2.8
AssignedExternalPort unsignedInt­[0:65535] - The external port returned by the PCP Server. The port that the PCP-controlled device uses to send outgoing packets corresponding to this mapping. - 2.8
Device.UPnP. object - This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 2.0
Device.UPnP.Description. object - This object contains information from the Description Document discovered from the UPnP Devices and Services. - 2.6
Device.UPnP.Description.DeviceInstance.{i}. object -

This table contains the information from Device Description Document retrieved for a discovered UPnP root or embedded device.

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

- 2.6
DeviceCategory string -

Comma-separated list of strings. Each list item is the value of an element in the Device Description Document for this DeviceInstance that indicates a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.

Note: It is assumed that the htip:X_DeviceCategory Device Description Document element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

Note: DeviceCategory is different from DeviceType and is included here for the purpose of HTIP usage.

- 2.8
ManufacturerOUI string­(6) -

The value of an element in the Device Description Document for this DeviceInstance that indicates the manufacturer OUI if this value is provided by the device; or an empty string if this value is not provided by the device.

Note: It is assumed that the htip:X_ManufacturerOUI element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973].

- 2.8

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.Cellular.Interface.{i}.
Status
LastChange
AvailableNetworks
RSSI
Device.Cellular.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Ghn.Interface.{i}.Stats.
MgmtBytesSent
MgmtBytesReceived
MgmtPacketsSent
MgmtPacketsReceived
BlocksSent
BlocksReceived
BlocksResent
BlocksErrorsReceived
Device.Ghn.Diagnostics.PHYThroughput.Result.{i}.
TxPhyRate
RxPhyRate
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
MgmtBytesSent
MgmtBytesReceived
MgmtPacketsSent
MgmtPacketsReceived
BlocksSent
BlocksReceived
BlocksResent
BlocksErrorsReceived
Device.GRE.Tunnel.{i}.
Alias
Device.GRE.Tunnel.{i}.Interface.{i}.
Alias
LastChange
Device.MAP.Domain.{i}.
Alias
Device.MAP.Domain.{i}.Rule.{i}.
Alias
Device.MAP.Domain.{i}.Interface.
Alias
LastChange
Device.MAP.Domain.{i}.Interface.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
UnknownProtoPacketsReceived
Device.PCP.Client.{i}.
Alias
Device.PCP.Client.{i}.Server.{i}.
Alias
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.
Alias
Lifetime
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.Filter.{i}.
Alias
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}.
Alias

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.

InformParameters:1 Profile

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

Name Requirement
Device.­ManagementServer. P
InformParameterNumberOfEntries R
Device.­ManagementServer.­InformParameter.­{i}. C
Enable W
ParameterName W
EventList W

ADSL2:2 Profile

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

Name Requirement
Device.­DSL.­Line.­{i}. P
XTSE R
XTSUsed R
Device.­DSL.­Channel.­{i}. P
ACTNDR R

VDSL2:2 Profile

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

Name Requirement
Device.­DSL.­Line.­{i}. P
XTSE R
XTSUsed R
UPBOKLEPb R
UPBOKLERPb R
ACTRAMODEds R
ACTRAMODEus R
ACTINPROCds R
ACTINPROCus R
SNRMROCds R
SNRMROCus R
Device.­DSL.­Channel.­{i}. P
ACTNDR R

CellularInterfaceBase:1 Profile

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

Name Requirement
Device.­Cellular. P
InterfaceNumberOfEntries R
AccessPointNumberOfEntries R
Device.­Cellular.­Interface.­{i}. P
Enable W
Status R
NetworkInUse R
CurrentAccessTechnology R
Device.­Cellular.­Interface.­{i}.­USIM. P
Status R
MSISDN R
Device.­Cellular.­AccessPoint.­{i}. C
Enable W
Interface W
APN W

CellularInterfaceExtended:1 Profile

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

Name Requirement
Device.­Cellular. P
RoamingEnabled W
RoamingStatus R
Device.­Cellular.­Interface.­{i}. P
Alias W
Name R
LastChange R
IMEI R
SupportedAccessTechnologies R
PreferredAccessTechnology W
NetworkRequested R
AvailableNetworks R
Device.­Cellular.­Interface.­{i}.­USIM. P
IMSI R
ICCID R

CellularInterfaceStats:1 Profile

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

Name Requirement
Device.­Cellular.­Interface.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

LLDPBaseline:1 Profile

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

Name Requirement
Device.­LLDP. P
Device.­LLDP.­Discovery. P
DeviceNumberOfEntries R
Device.­LLDP.­Discovery.­Device.­{i}. P
Interface R
ChassisIDSubtype R
ChassisID R
Host R
PortNumberOfEntries R
Device.­LLDP.­Discovery.­Device.­{i}.­Port.­{i}. P
PortIDSubtype R
PortID R
TTL R
PortDescription R
LastUpdate R
MACAddressList R

LLDPRemOrgDefInfo:1 Profile

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

Name Requirement
Device.­LLDP.­Discovery.­Device.­{i}.­Port.­{i}.­LinkInformation. P
InterfaceType R
MACForwardingTable R
Device.­LLDP.­Discovery.­Device.­{i}.­DeviceInformation. P
DeviceCategory R
ManufacturerOUI R
ModelName R
ModelNumber R
VendorSpecificNumberOfEntries R
Device.­LLDP.­Discovery.­Device.­{i}.­DeviceInformation.­VendorSpecific.­{i}. P
OrganizationCode R
InformationType R
Information R

GREBasic:1 Profile

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

Name Requirement
Device.­GRE. P
TunnelNumberOfEntries R
Device.­GRE.­Tunnel.­{i}. C
Enable W
Status R
RemoteEndpoints W
KeepAlivePolicy W
KeepAliveTimeout W
KeepAliveThreshold W
DeliveryHeaderProtocol W
ConnectedRemoteEndpoint R
InterfaceNumberOfEntries R
Device.­GRE.­Tunnel.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.­GRE.­Tunnel.­{i}.­Interface.­{i}. C
Enable W
Status R
Name R
LastChange R
LowerLayers R
ProtocolIdOverride W
UseChecksum W
Device.­GRE.­Tunnel.­{i}.­Interface.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

GREAdv:1 Profile

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

Name Requirement
Device.­GRE. P
FilterNumberOfEntries R
Device.­GRE.­Tunnel.­{i}.­Stats. P
KeepAliveSent R
KeepAliveReceived R
Device.­GRE.­Tunnel.­{i}.­Interface.­{i}. C
KeyIdentifierGenerationPolicy W
KeyIdentifier W
UseSequenceNumber W
Device.­GRE.­Tunnel.­{i}.­Interface.­{i}.­Stats. P
DiscardChecksumReceived R
DiscardSequenceNumberReceived R
Device.­GRE.­Filter.­{i}. C
Enable W
Status R
Order W
Interface W
AllInterfaces W
VLANIDCheck W
VLANIDExclude W
DSCPMarkPolicy W

MAPBasic:1 Profile

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

Name Requirement
Device.­MAP. P
Enable W
DomainNumberOfEntries R
Device.­MAP.­Domain.­{i}. P
Enable W
Status R
TransportMode R
WANInterface R
IPv6Prefix W
BRIPv6Prefix W
RuleNumberOfEntries R
Device.­MAP.­Domain.­{i}.­Rule.­{i}. C
Enable W
Status R
IPv6Prefix W
IPv4Prefix W
IsFMR W
Device.­MAP.­Domain.­{i}.­Interface. P

MAPAdv:1 Profile

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

Name Requirement
Device.­MAP.­Domain.­{i}. P
PSIDOffset W
PSIDLength W
PSID W
IncludeSystemPorts W
Device.­MAP.­Domain.­{i}.­Rule.­{i}. C
EABitsLength W


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