Broadband Forum

USP Device:2.13 Root Object definition (changes)

tr-181-2-13-0-usp.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2019, Broadband Forum

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

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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

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

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separate 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 [SOAP1.1].
decimal -

Decimal number, with optional sign and optional fractional part.

For some decimal types, a value range is given using the form decimal(Min:Max) or decimal(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.0. Multiple comma-separated ranges can be specified, in which case the value will 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.

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.

Alias string(:64)

A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.
IPAddress string(:45)

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPv4Address IPAddress(:45)

IPv4 address (or subnet mask).

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

Possible patterns:

  • <Empty> (an empty string)
  • ((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])
IPv6Address IPAddress(:45)

IPv6 address.

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

IoTDeviceType string

Describes the type of Device that the object instance is representing. Enumeration of:

  • Alarm
  • AntiTheft
  • Bell
  • Clock
  • Door
  • Fan
  • GarageDoor
  • HVAC
  • Light
  • Lock
  • Meter
  • Motor
  • Oven
  • PowerStrip
  • Sensor
  • SensorStrip
  • Siren
  • Thermostat
IoTEnumControlType string

Describes the type of IoT Enum Controller that the object instance is representing. Enumeration of:

  • AlarmMode
  • DoorMode
  • FanMode
  • LockMode
  • OperatingMode
  • TemperatureMode
  • ThermostatMode
IoTEnumSensorType string

Describes the type of IoT Enum Sensor that the object instance is representing. Enumeration of:

  • AlarmState
  • DoorState
  • FanState
  • LockState
  • OperatingState
  • TemperatureState
  • ThermostatFanState
IoTLevelType string

Describes the type of IoT Level Controller or Sensor that the object instance is representing. Enumeration of:

  • Acceleration
  • Area
  • Battery
  • Brightness
  • Concentration
  • Conductivity
  • Distance
  • Energy
  • Flow
  • Humidity
  • Intensity
  • Luminance
  • Meter
  • Motion
  • Position
  • Power
  • Pressure
  • Radiation
  • Speed
  • Temperature
  • Volume (Amount of space that an object or substance occupies)
  • Weight
IoTUnitType string

Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI])
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])
PSDBreakPointIndexAndLevel unsignedInt[2:2]
  1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and
  2. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. Both values are represented as unsignedInt.
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.

UERComplex int[2:2] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
  1. Real UER component, a(i)
  2. Imaginary UER component, b(i) for values of i starting at i=0. Both values are represented as signed integers. The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2].
UUID string(36)

Universally Unique Identifier. See [RFC4122].

Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

References

[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2016] IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11ax] IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1Q-2011] IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011.
[BPF] BPF, Berkeley Packet Filter Syntax, FreeBSD.org, October 2016.
[DataElements-v1.0] Data Elements Specification, Data Elements Specification Version 1.0, January 2019.
[DSLite] RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion, IETF, 2011.
[DSLite-options] RFC 6334, Dynamic Host Configuation Protocol for IPv6 (DHCPv6) Option for Dual-Stack Lite, IETF, 2011.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[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.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[LIBPCAP] Libpcap, Libpcap File Format, Wireshark, 2015.
[MAPv1.0] Multi-AP Specification, Multi-AP Specification Version 1.0, June 2018.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT311] MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014.
[MQTT50] MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2616] RFC 2616, Hypertext Transfer Protocol - HTTP/1.1, IETF, 1999.
[RFC2697] RFC 2697, A Single Rate Three Color Marker, IETF.
[RFC2698] RFC 2698, A Two Rate Three Color Marker, IETF.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2898] RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3633] RFC 3633, IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP) version 6, IETF, 2003.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4180] RFC4180, Common Format and MIME Type for Comma-Separated Values (CSV) Files, IETF, October 2005.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4292] RFC 4292, IP Forwarding Table MIB, IETF, 2006.
[RFC4293] RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4302] RFC 4302, IP Authentication Header, IETF, December 2005.
[RFC4303] RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4861] RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007.
[RFC4862] RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007.
[RFC5139] RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008.
[RFC5491] RFC 5491, GEOPRIV Presence Information Data Format Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations, IETF, March 2009.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC5969] RFC 5969, IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol Specification, IETF, 2010.
[RFC5996] RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[RFC7468] RFC 7468, Textual Encoding of PKIX, PKCS, and CMS Structures, IETF, April 2015.
[RFC7597] RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015.
[RFC7598] RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015.
[RFC7599] RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[TR-369] TR-369 Issue 1 Amendment 2, User Services Platform, Broadband Forum, January 2022.
[UPA-PLC] Universal Powerline Association, UPA.
[UPnP-DM:1] UPnP Device Management:1, UPnP Device Management v1.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.
[Z-Wave] Z-Wave, Z-Wave website.
[ZigBee] ZigBee, ZigBee Alliance website.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

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

Device:2.13 Data Model

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

Changes in 2.13:

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device.

Changes in 2.13:

 - 2.0
Boot! event - Boot event indicating that the Device was rebooted. - 2.12
⇒ Cause string R

The cause of the boot.

Enumeration of:

  • LocalReboot (

A Device Event that was the result of a reboot triggered locally on the Device (NOT as a result of a Reboot() Command)

Changes in 2.13:

  • Added A Device Event that was the result of a reboot triggered locally on the Device (NOT as a result of a Reboot() Command) description

)

  • RemoteReboot (

A Device Event that was the result of a reboot triggered via the Reboot() Command

Changes in 2.13:

  • Added A Device Event that was the result of a reboot triggered via the Reboot() Command description

)

  • LocalFactoryReset (

A Device Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a FactoryReset() Command)

Changes in 2.13:

  • Added A Device Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a FactoryReset() Command) description

)

  • RemoteFactoryReset (

A Device Event that was the result of a factory reset triggered via the FactoryReset() Command

Changes in 2.13:

  • Added A Device Event that was the result of a factory reset triggered via the FactoryReset() Command description

)

 - 2.12
SelfTestDiagnostics() command - [ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
PacketCaptureDiagnostics() command - [ASYNC] This diagnostic command is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a table row. A reference to a (layer 2 or above) interface object that will be the target of this packet capture diagnostic. - 2.13
⇒ Format string W

This indicates whether the network trace will be recorded in libpcap [LIBPCAP] or pcapng format, and is dependent on the underlying method of performing a network trace.

Enumeration of:

  • libpcap (The packet data is recorded in libpcap [LIBPCAP] format)
  • pcapng (The packet data is recorded in pcapng format)
 - 2.13
⇒ Duration unsignedInt(1:) W The duration in seconds to copy packets to the file target. The diagnostic completes when either the Duration, PacketCount, or ByteCount conditions are met. - 2.13
⇒ PacketCount unsignedInt W The maximum number of packets to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when the Duration, ByteCount, or PacketCount conditions are met. - 2.13
⇒ ByteCount unsignedInt W The maximum number of bytes to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when Duration, PacketCount or ByteCount conditions are met. - 2.13
⇒ FileTarget string(:2048) W URL, as defined in [RFC3986], specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. - 2.13
⇒ FilterExpression string(:256) W A ([BPF]) formatted expression used to restrict the types of network packets that are recorded to FileTarget. - 2.13
⇒ Username string(:256) W Username to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required. - 2.13
⇒ Password string(:256) W

Password to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required. When read, this parameter returns an empty string, regardless of the actual value.

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

 - 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
⇐ PacketCaptureResult.{i}. object(0:) R

Results for individual packet capture diagnostics. Packet capture files whose FileLocation is local to the system SHOULD be deleted when the next diagnostic is run, or upon a system reboot.

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

 - 2.13
⇐ FileLocation string(:2048) R URL, as defined in [RFC3986], specifying the resulting file location of the packet capture record that triggered this result. This MAY be different than the location specified in FileTarget. - 2.13
⇐ StartTime dateTime R The local system time at which the capture was started. - 2.13
⇐ EndTime dateTime R The local system time at which the capture was completed. - 2.13
⇐ Count unsignedInt R The number of packets recorded to the file target. - 2.13
IoTCapabilityNumberOfEntries unsignedInt R The number of entries in the IoTCapability table. - 2.13
NodeNumberOfEntries unsignedInt R The number of entries in the Node table. - 2.13
Device.DeviceInfo. object R This object contains general device information. - 2.12
Device.DeviceInfo.VendorConfigFile.{i}. object(0:) R

Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. This table of Vendor Configuration Files is for information only and does not allow the ACSController to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table.

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

 - 2.0
Device.DeviceInfo.ProcessStatus. object R Status of the processes on the device. - 2.0
ProcessNumberOfEntries unsignedInt R {{numentries: not associated with a table}} Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in [Section 3.2.1/TR-069a2]. - 2.0
Device.DeviceInfo.TemperatureStatus. object R Status of the temperature of the device. - 2.0
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object(0:) R

This object represents information that the device has obtained via sampling an internal temperature sensor.

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

 - 2.0
ResetTime dateTime R The time at which this temperature sensor was reset. Reset can be caused by: * Status transition from Disabled to Enabled * {{param: non-existent Reset}} set to true. * An internal reset of the temperature sensor (including a reboot of the device). The Unknown Time value, as defined in {{bibref: non-existent TR-106}}, indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled. - 2.0
LastUpdate dateTime R

The time at which this temperature sensor’s last good reading was obtained. The Unknown Time value, as defined in {{bibref: non-existent TR-106}}, indicates a good reading has not been obtained since last reset.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
MinTime dateTime R The time at which this temperature sensor’s lowest value was read. The Unknown Time value, as defined in {{bibref: non-existent TR-106}}, indicates a good reading has not been obtained since last reset. - 2.0
MaxTime dateTime R The time at which this temperature sensor’s highest value was read. The Unknown Time value, as defined in {{bibref: non-existent TR-106}}, indicates a good reading has not been obtained since last reset. - 2.0
LowAlarmTime dateTime R Initial time at which this temperature sensor’s LowAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in {{bibref: non-existent TR-106}}, indicates that an alarm has not been encountered since the last reset. - 2.0
HighAlarmTime dateTime R Initial time at which this temperature sensor’s HighAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in {{bibref: non-existent TR-106}}, indicates that an alarm has not been encountered since the last reset. - 2.0
Device.DeviceInfo.Processor.{i}. object(0:) R

Each table entry represents a hardware or virtual processor that resides on this device.

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

 - 2.1
Architecture string R

The architecture of the processor on the underlying hardware. Enumeration of:

  • arm
  • i386
  • m68010
  • m68k
  • mipseb (big-endian)
  • mipsel (little-endian)
  • powerpc
  • sh3eb (big-endian)
  • sh3el (little-endian)
  • x86_64 For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref: non-existent TR-106}}.
 - 2.1
Device.DeviceInfo.VendorLogFile.{i}. object(0:) R

Each table entry represents a Vendor Log File. This table of log files is informational only and does not allow the ACSController to operate on these files in any way.

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

 - 2.1
Device.DeviceInfo.Location.{i}. object(0:) W

This object contains Location information.

At most one entry in this table can exist with the same values for both Source and ExternalSource. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for ExternalSource such that the new entry does not conflict with any existing entries.

 - 2.4
ExternalSource string R

URL, MAC address, or other identifier that identifies an “External” source of this location. Meaningful only if Source has a value of External, otherwise it MUST be an empty string. If ExternalProtocol has a value of CWMP, this is the URL or IP address of the ACS.Controller.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.4
ExternalProtocol string R

Protocol used to acquire a location from an “External” source. Enumeration of:

  • <Empty> (An empty string)
  • CWMP
  • USP
  • OMA-DM
  • SNMP
  • UPnP
  • HELD
  • DHCPv4
  • DHCPv6
  • LLDP-MED
  • MLP
  • Other Meaningful only if Source has a value of External, otherwise it MUST be an empty string.

Changes in 2.13:

  • Added string USP enumeration
 CWMP 2.4
DataObject string(:1200) W The currently valid location information. Writable only when ExternalProtocol has a value of CWMP or USP. If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491]. If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). If obtained by an external source this is the location information as received. If it’s an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. CWMP or USP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). Only zero or one Location object instance with value {{enum: non-existent CWMP{{inserted: unexpected argument ExternalProtocol after: []}}** or {{enum: parameter DataObject doesn’t define any values}}}}** MUST exist at any given time. - 2.4
Device.DSL. object R 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.BondingGroup.{i}. object(0:) R

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a DSL.Channel instance or a FAST.Line instance for each bonded channel in the group. Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured viaby [TR-069].a Controller. The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup.

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

 - 2.0
LowerLayers string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers is read-only for this object because bonding is expected to be configured by the CPE, not by the ACS.Controller. - 2.0
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. object(0:) R

DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one DSL.Channel instance or one FAST.Line instance. There MUST be an instance of BondedChannel for each DSL channel or FAST line that is bonded. When a DSL.Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded DSL.Channel or FAST.Line becomes disabled, the channel remains bonded and so the corresponding BondedChannel instance MUST NOT be deleted.

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

 - 2.0
Channel string(:256) R The value MUST be the Path Name of a row in the DSL.Channel. or FAST.Line. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.This is the channel that is being bonded. This is read-only because bonding is expected to be configured by the CPE, not by the ACS.Controller. - 2.0
Device.DSL.Diagnostics. object R The DSL Diagnostics object.

Changes in 2.13:

 - 2.0
ADSLLineTest() command - [ASYNC] This command is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
SELTUER() command - [ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER). This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the DSL.Line. table. This is the interface over which the test is to be performed. - 2.13
⇒ UERMaxMeasurementDuration unsignedInt(5:240) W This parameter is the SELT UER maximum measurement duration (MMD) measured in seconds. This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation [Clause A.2.1.1/G.996.2]. - 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL) If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
⇐ ExtendedBandwidthOperation boolean R This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false). If the option for extended bandwidth SELT is applied to UER, then UERGroupSize has three valid values: 1, 2 and 12. If the option for extended bandwidth SELT is not applied to UER, then UERGroupSize has two valid values: 1 and 2. UERGroupSize is reported if the option for extended bandwidth UER SELT is supported; otherwise, reporting of the group size is optional. - 2.13
⇐ UER int[2:2][1:4096] R The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], … Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of:. [UERComplex] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
  1. Real UER component, a(i)
  2. Imaginary UER component, b(i) for values of i starting at i=0. Both values are represented as signed integers. The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2]. The value of UER at frequency i*UERGroupSizeDf = (UERScaleFactor/(2^31))(a(i)+j*b(i))/(2^31) where Df = 4.3125 kHz. This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].
 - 2.13
⇐ UERScaleFactor unsignedInt R The Uncalibrated Echo Response (UER) scale factor. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2]. - 2.13
⇐ UERGroupSize unsignedInt(1:2,12) R The Uncalibrated Echo Response (UER) group size, UER_G. In units of subcarriers. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2]. - 2.13
⇐ UERVar int[0:4096] R Comma-separated list (0 to 4096 items) of integers. This parameter represents the variance of the UER. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*UERGroupSizeDf is VAR(iUERGroupSize*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz. This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in [Clause A.2.2.2/G.996.2]. - 2.13
SELTQLN() command - [ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN). This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the DSL.Line. table. This is the interface over which the test is to be performed. - 2.13
⇒ QLNMaxMeasurementDuration unsignedInt(1:240) W This parameter is the SELT QLN maximum measurement duration (MMD) measured in seconds. This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation [Clause A.2.1.2/G.996.2]. - 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL) If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
⇐ ExtendedBandwidthOperation boolean R This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false). If the option for extended bandwidth SELT is applied to QLN, then QLNGroupSize has three valid values: 1, 2 and 12. If the option for extended bandwidth SELT is not applied to QLN, then QLNGroupSize has two valid values: 1 and 2. QLNGroupSize is reported if the option for extended bandwidth QLN SELT is supported; otherwise, reporting of the group size is optional. - 2.13
⇐ QLN int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. List items represent SELT quiet line noise (QLN) per subcarrier group. Each list element is n(i), with i starting at 0. The value of QLN at frequency i*QLNGroupSizeDf with Df=4.3125 kHz is defined as QLN(iQLNGroupSize*Df) = -23 - (n(i)/2) dBm/Hz. This data format supports a QLN granularity of 0.5 dB and an dynamic range of -150 to -23 dBm/Hz. Interpretation of the SELT_QLN_R value is defined in [Clause A.2.2.3/G.996.2]. - 2.13
⇐ QLNGroupSize unsignedInt(1:2,12) R This parameter represents the Quiet Line Noise (QLN) group size. In units of subcarriers. This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation [Clause A.2.2.3/G.996.2]. - 2.13
SELTP() command - [ASYNC] This command performs a DSL Single-Ended Line Test - Processed (SELT-P). This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [G.996.2]. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the DSL.Line. table. This is the interface over which the test is to be performed. - 2.13
⇒ CapacityEstimateEnabling boolean W Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value false if xDSL performance estimation is not required, true otherwise. The capacity estimate calculation enabling parameter is defined in [Clause B.2.1.1/G.996.2]. - 2.13
⇒ CapacitySignalPSD unsignedInt[2:2][1:48] W The capacity estimate signal Power Spectral Density (PSD): Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of:. [PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and
  1. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. Both values are represented as unsignedInt. This capacity estimate signal PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.2/G.996.2].
 - 2.13
⇒ CapacityNoisePSD unsignedInt[2:2][1:48] W The capacity estimate noise Power Spectral Density (PSD): Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of:. [PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and
  1. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. Both values are represented as unsignedInt. This capacity estimate noise PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.3/G.996.2].
 - 2.13
⇒ CapacityTargetMargin unsignedInt(0:310) W The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of 0.1 dB. This capacity estimate target noise margin parameter is defined in ITU-T Recommendation [Clause B.2.1.4/G.996.2]. - 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL) If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
⇐ LoopTermination string(:21) R Loop termination indicator, one of the following state indications: ‘Open’ ‘Short’ ‘Powered on DSLAM/DPU’ ‘Unknown’ This parameter is defined as LOOP-TERM in ITU-T Recommendation [Clause B.1.1.1/G.996.2]. - 2.13
⇐ LoopLength unsignedInt(0:16383) R This parameter is the loop length with units of meters. This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation [Clause B.1.1.2/G.996.2]. - 2.13
⇐ LoopTopology string[](:256) R Comma-separated list (maximum number of characters 256) of strings. List items represent paired parameters [LOOP_SEG_LEN, LOOP_SEG_BTAP] representing a concatenation of loop segment types, where LOOP_SEG_LEN represents the length of the segment in meters; and LOOP_SEG_BTAP is a string that identifies the segment type as either “in series” or “bridged tap”. The first loop segment in the list shall be the segment connected to the SELT-PMD block, subsequent loop segments in the list shall describe the loop in the direction toward the far-end loop termination. This Loop Topology parameter is defined in ITU-T Recommendation [Clause B.1.1.3/G.996.2]. - 2.13
⇐ AttenuationCharacteristics string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. List items represent paired frequency spacing index i and transfer function log value, i.e. [i,TFlog(i * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB. The Attenuation characteristics TFlog(f) parameter is defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2]. - 2.13
⇐ MissingFilter boolean R Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter. The missing micro-filter or splitter parameter is defined in [Clause B.1.1.4/G.996.2]. - 2.13
⇐ CapacityEstimate unsignedInt R Capacity Estimate: This parameter is an unsigned integer representing the capacity estimate in kbit/s, with units of kbit/s. The capacity estimate parameter is defined in [Clause B.1.1.7/G.996.2]. - 2.13
Device.Cellular. object R This object models cellular interfaces and access points. - 2.8
Device.Cellular.Interface.{i}. object(0:) R

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
Device.Cellular.Interface.{i}.USIM. object R USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.8
PIN string(:4) W

Allows the ACSController 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.ATM. object R Asynchronous Transfer Mode (ATM) object that contains the Link interface and {{object: referenced Diagnostics.F5Loopback() is command, not object}} diagnostics. - 2.0
Device.ATM.Diagnostics. object R The ATM Diagnostics object. - 2.0
F5Loopback() command - [ASYNC] This command provides access to an ATM-layer F5 OAM loopback test.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
Device.Ethernet. object R 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.

Changes in 2.13:

 - 2.0
WoLSupported boolean R Indicates that WoL (Wake on LAN) over Ethernet is supported. - 2.13
Device.Ethernet.WoL. object R This object provides access to the WoL (Wake on LAN) funtionality. - 2.13
SendMagicPacket() command - [ASYNC] This command sends a magic packet over the CPE active Ethernet interfaces. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ MACAddress string(:17) W [MACAddress] MAC address target of the magic packet. - 2.13
⇒ Password string W The SecureOn password. The parameter value can be empty or, if present, can contain either 4 bytes or 6 bytes. - 2.13
Device.USB. object R Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
Device.USB.USBHosts. object R This object models the CPE’s USB Host controllers. See {{bibref: non-existent TR-181i2}} for Theory of Operation. - 2.0
Device.HPNA. object R HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. - 2.0
Device.HPNA.Diagnostics. object R The HPNA Diagnostics object. - 2.0
PHYThroughput() command - [ASYNC] HPNA PHY throughput diagnostics configuration and results. When diagnostics are requested, all HPNA nodes for which the Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable parameter is set enter PHY diagnostics mode.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_FailToEnableCert
  • Error_CertCmdTimeout
  • Error_UnknownErr
  • Error_UnsupportedOpcode
  • Error_InvalidParam
  • Error_UnsupportedCmdSegment
  • Error_UnsupportedDataGen
  • Error_InvalidSequence
  • Error_InvalidFrame
  • Eror_InvalidOpcode If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
PerformanceMonitoring() command - [ASYNC] HPNA performance monitoring configuration and results. Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_SampleIntervalTooSmall If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
Device.Ghn. object R 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.Diagnostics. object R The G.hn Diagnostics object. - 2.8
PHYThroughput() command - [ASYNC] 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.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL) If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
PerformanceMonitoring() command - [ASYNC] 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.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL) If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
Device.UPA. object R Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
Device.UPA.Diagnostics. object R The UPA Diagnostics object. - 2.0
InterfaceMeasurement() command - [ASYNC] This command provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The Type parameter is used to select which type of test to perform. CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network).

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_InvalidPort If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
Device.WiFi. object R 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).

Changes in 2.13:

 - 2.7
NeighboringWiFiDiagnostic() command - [ASYNC] This command defines access to other WiFi SSIDs that this device is able to receive.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL) If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
⇐ Result.{i}. object(0:) R

Neighboring SSID table. This table models the other WiFi SSIDs that this device is able to receive.

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.7
⇐ SecurityModeEnabled string R

The type of encryption the neighboring WiFi SSID advertises.

Enumeration of:

  • None
  • WEP
  • WPA
  • WPA2
  • WPA-WPA2
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
  • WPA3-SAE
  • WPA2-PSK-WPA3-SAE
  • WPA3-Enterprise

Changes in 2.13:

  • Added string WPA3-SAE enumeration
  • Added string WPA2-PSK-WPA3-SAE enumeration
  • Added string WPA3-Enterprise enumeration
 - 2.7
⇐ EncryptionMode string[] R

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list.

Each list item is an enumeration of:

  • TKIP
  • AES
 - 2.7
⇐ SupportedStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Result instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

Changes in 2.13:

  • Added string ax enumeration
 - 2.7
⇐ OperatingStandards string[] R Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this Result. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, {{enum: non-existent ac, ax}} are allowed. For example, a value of “g,b” (or “b,g” - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of “g” means that only the 802.11g standard can be used. - 2.7
Device.WiFi.MultiAP. object R This object describes a Wi-Fi network containing 1 or more Access Point devices. This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network. - 2.13
APDeviceNumberOfEntries unsignedInt R The number of entries in the APDevice table. - 2.13
Device.WiFi.MultiAP.SteeringSummaryStats. object R The summary of statistics related to Multi-AP Steering for the Wi-Fi network. The counters contained in SteeringSummaryStats are all reset on reboot. - 2.13
NoCandidateAPFailures unsignedLong R [StatsCounter64] Number of times Associated Devices should have been steered but weren’t because a better candidate AP couldn’t be found. - 2.13
BlacklistAttempts unsignedLong R [StatsCounter64] Number of times a Blacklist steer was attempted. - 2.13
BlacklistSuccesses unsignedLong R [StatsCounter64] Number of times an attempted Blacklist steer succeeded. - 2.13
BlacklistFailures unsignedLong R [StatsCounter64] Number of times an attempted Blacklist steer failed. - 2.13
BTMAttempts unsignedLong R [StatsCounter64] Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted. - 2.13
BTMSuccesses unsignedLong R [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded. - 2.13
BTMFailures unsignedLong R [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed. - 2.13
BTMQueryResponses unsignedLong R [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued. - 2.13
Device.WiFi.MultiAP.APDevice.{i}. object(0:) R

Each instance of this object represents an individual Access Point device in the Wi-Fi network.

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

 - 2.13
MACAddress string(:17) R [MACAddress] A unique identifier for this particular device within the Wi-Fi network. - 2.13
Manufacturer string R The manufacturer of the Access Point device (human readable string). - 2.13
ManufacturerOUI string(6) R

Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates.
 - 2.13
ProductClass string(:64) R Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 2.13
SerialNumber string(:64) R Identifier of the particular Access Point device that is unique for the indicated class of product and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 2.13
SoftwareVersion string(:64) R A string identifying the software version currently installed in the Access Point device (i.e. version of the overall firmware). To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build. - 2.13
LastContactTime dateTime R The last time that the Access Point device was contacted via the Multi-AP control protocol. - 2.13
AssocIEEE1905DeviceRef string R The value MUST be the Path Name of a row in the IEEE1905.AL.NetworkTopology.IEEE1905Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. AssocIEEE1905DeviceRef is a reference to the IEEE 1905.1 Network Topology Device. Since IEEE 1905.1 is a common protocol used by Multi-AP Controllers for communications, this parameter allows the MultiAP portion of the data model to reference the associated IEEE 1905.1 portion of the data model. - 2.13
BackhaulLinkType string R

The medium being used to backhaul this Access Point Device to the Multi-AP Controller. The None value is reserved for the APDevice instance that represents the Multi-AP Controller. Enumeration of:

  • None
  • Wi-Fi
  • MoCA
  • Ethernet
  • G.hn
  • HPNA
  • HomePlug
  • UPA
 - 2.13
BackhaulMACAddress string(:17) R [MACAddress] The MAC Address of the Device on the network that is providing a Backhaul Link for this Access Point Device. The an empty string value is reserved for the APDevice instance that represents the Multi-AP Controller. - 2.13
BackhaulBytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted across the backhaul medium (as identified by the value of the BackhaulLinkType parameter), including framing characters. - 2.13
BackhaulBytesReceived unsignedLong R [StatsCounter64] The total number of bytes received across the backhaul medium (as identified by the value of the BackhaulLinkType parameter), including framing characters. - 2.13
BackhaulLinkUtilization unsignedInt(:100) R Current utilization (expressed in %) of the medium (as identified by the value of the BackhaulLinkType parameter) being used to backhaul this Access Point device to the Multi-AP Controller. A value of 0 is used for the APDevice instance that represents the Access Point on the Multi-AP Controller. - 2.13
BackhaulSignalStrength unsignedInt(:255) R An indicator of radio signal strength of the backhaul link of the Access Point (AP) to the Multi-AP Controller, measured in dBm. RCPI threshold is encoded per Table 9-154 of [802.11-2016]. The value of this parameter is indeterminate if the value of the BackhaulLinkType parameter is anything other than Wi-Fi. - 2.13
RadioNumberOfEntries unsignedInt R The number of entries in the Radio table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}. object(0:) R

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

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

 - 2.13
MACAddress string(:17) R [MACAddress] A unique identifier for this particular Radio within the identified Access Point. - 2.13
OperatingFrequencyBand string R

Indicates the frequency band at which the radio is operating. Enumeration of:

  • 2.4GHz
  • 5GHz
 - 2.13
OperatingStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each list item is an enumeration of:

 - 2.13
Channel unsignedInt(1:255) R The current radio channel used by the connection. - 2.13
ExtensionChannel string R

The secondary extension channel position, applicable when operating in wide channel mode (i.e. when CurrentOperatingChannelBandwidth is 40MHz If not operating in wide channel mode (i.e. when CurrentOperatingChannelBandwidth is something other than 40MHz, then the value of ExtensionChannel is None. Enumeration of:

  • None
  • AboveControlChannel
  • BelowControlChannel
 - 2.13
CurrentOperatingChannelBandwidth string R

The channel bandwidth currently in use. Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
 - 2.13
MCS int(0:31,16:31) R The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ([802.11n-2009]). Values from 0 to 9 MUST be supported for [802.11ac-2013]. - 2.13
TransmitPower int(-1:100) R Indicates the current transmit power level as a percentage of full power. - 2.13
APNumberOfEntries unsignedInt R The number of entries in the AP table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}. object(0:) R

A single logical Access Point operating on this radio.

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

 - 2.13
BSSID string(:17) R [MACAddress] The MAC Address of the logical BSS (BSSID). - 2.13
SSID string R The SSID in use for this BSS. - 2.13
BlacklistAttempts unsignedLong R [StatsCounter64] Number of times a Blacklist steer was attempted for this Access Point. - 2.13
BTMAttempts unsignedLong R [StatsCounter64] Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted for this Access Point. - 2.13
BTMQueryResponses unsignedLong R [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued by this Access Point. - 2.13
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}. object(0:) R

Object describing a single Associated Device (STA).

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

 - 2.13
MACAddress string(:17) R [MACAddress] The MAC address of an associated device. - 2.13
OperatingStandard string R

The operating standard that this associated device is connected with. Enumeration of:

 - 2.13
Active boolean R Whether or not this associated device is currently present on the Wi-Fi Access Point device. The ability to list inactive nodes is OPTIONAL. If the Access Point devices includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. - 2.13
AssociationTime dateTime R Date and time in UTC when the device was associated. - 2.13
LastDataDownlinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the access point to the associated device. - 2.13
LastDataUplinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the associated device to the access point. - 2.13
SignalStrength unsignedInt(:255) R An indicator of radio signal strength of the uplink from the Associated Device (STA) to the Access Point (AP) measured in dBm. RCPI threshold is encoded per Table 9-154 of [802.11-2016]. - 2.13
Noise unsignedInt(:255) R An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP). Encoded as defined for ANPI in [Section 10.11.9.4/802.11-2016]. - 2.13
SteeringHistoryNumberOfEntries unsignedInt R The number of entries in the SteeringHistory table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.Stats. object R Object describing the Statistics for a single Associated Device (STA). - 2.13
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the Associated Device. - 2.13
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the Associated Device. - 2.13
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.13
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received from the Associated Device. - 2.13
ErrorsSent unsignedLong R [StatsCounter64] 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.13
ErrorsReceived unsignedLong R [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.13
RetransCount unsignedLong R [StatsCounter64] The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringSummaryStats. object R The summary of statistics related to Multi-AP Steering for an individual STA on the Wi-Fi network. The counters contained in SteeringSummaryStats are all reset on reboot. - 2.13
NoCandidateAPFailures unsignedLong R [StatsCounter64] Number of times this Associated Device should have been steered but wasn’t because a better candidate AP couldn’t be found. - 2.13
BlacklistAttempts unsignedLong R [StatsCounter64] Number of times a Blacklist steer was attempted on this Associated Device. - 2.13
BlacklistSuccesses unsignedLong R [StatsCounter64] Number of times an attempted Blacklist steer succeeded for this Associated Device. - 2.13
BlacklistFailures unsignedLong R [StatsCounter64] Number of times an attempted Blacklist steer failed for this Associated Device. - 2.13
BTMAttempts unsignedLong R [StatsCounter64] Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted on this Associated Device. - 2.13
BTMSuccesses unsignedLong R [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded for this Associated Device. - 2.13
BTMFailures unsignedLong R [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed for this Associated Device. - 2.13
BTMQueryResponses unsignedLong R [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued to this Associated Device. - 2.13
LastSteerTime unsignedInt R The number of seconds since this Associated Device was last attempted to be steered. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringHistory.{i}. object(0:) R

The history of Multi-AP Steering for an individual STA on the Wi-Fi network. The contents of this multi-instance object are reset on reboot.

At most one entry in this table can exist with the same values for all of Time, APOrigin and APDestination.

 - 2.13
Time dateTime R The date/time when steering was initiated for the Associated Device. - 2.13
APOrigin string R The BSSID of the Access Point that initiated the steering. - 2.13
TriggerEvent string R

The type of event that caused the steering to be initiaited. Enumeration of:

  • Unknown
  • Wi-Fi Channel Utilization
  • Wi-Fi Link Quality
  • Backhaul Link Utilization NOTE: This might be Unknown for BTM Query Response steers.
 - 2.13
SteeringApproach string R

The type of steering that was attempted. Enumeration of:

  • Blacklist
  • BTM Request
  • Async BTM Query
 - 2.13
APDestination string R The BSSID of the destination Access Point of a successful steer. A failed steering attempt will leave this parameter an empty string. - 2.13
SteeringDuration unsignedInt R The amount of time in seconds required for the steer to complete successfully. A failed steering attempt will leave this parameter 0. - 2.13
Device.WiFi.DataElements. object R This object represents the Wi-Fi Alliance Data Elements as defined in [DataElements-v1.0]. - 2.13
Device.WiFi.DataElements.Network. object R This object describes a Wi-Fi network containing 1 or more Access Point devices. - 2.13
ID string W A unique identifier for this particular Wi-Fi network. - 2.13
TimeStamp string R The time this group was collected. - 2.13
ControllerID string W A unique identifier for a Multi-AP controller. - 2.13
DeviceNumberOfEntries unsignedInt R The number of entries in the Device table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}. object(0:) R

Each instance of this object represents an individual Access Point device in the Wi-Fi network.

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

 - 2.13
ID string(:17) R [MACAddress] A unique identifier for this particular device within the Wi-Fi network as defined in [Section 3.1/DataElements-v1.0]. - 2.13
MultiAPCapabilities base64(1) R The Multi-AP capabilities supported by this device as defined by the APCapability TLV in [Section 17.2.6/MAPv1.0]. - 2.13
CollectionInterval unsignedInt R The interval between the collection of consecutive measurements of the most frequently updated Data Element from this device in milliseconds. - 2.13
RadioNumberOfEntries unsignedInt R The number of entries in the Radio table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. object(0:) R

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

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

 - 2.13
ID base64(6) R A unique identifier for this particular Radio within the identified Access Point as defined in [Section 3.1/DataElements-v1.0]. - 2.13
Enabled boolean R Indicates whether this radio is enabled or disabled. - 2.13
Noise unsignedInt(:255) R An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.11.9.4/802.11-2016]. - 2.13
Utilization unsignedInt(0:255) R (Total Channel Utililzation) The percentage of time (linearly scaled with 255 representing 100%) that the Access Point device sensed the medium was busy, as indicated by either the physical or virtual carier sense (CS) mechanism. This is essentially the amount of time spent transmiting (both successful and failed transmissions), receiving (both local and non-local transmissions), and processing noise. When more than one channel is in use for the BSS operating on the radio, the Utilization value is calculated only for the primary channel. - 2.13
Transmit unsignedInt(0:255) R (Transmit Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on sending individually or group addressed transmissions (successful and failed). When more than one channel is in use for the BSS operating on the radio, the Transmit value is calculated only for the primary channel. - 2.13
ReceiveSelf unsignedInt(:255) R (Receive Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed local transmissions (i.e. transmissions from any STA associated with any BSS operating on this radio). When more than one channel is in use for the BSS operating on the radio, the ReceiveSelf value is calculated only for the primary channel. - 2.13
ReceiveOther unsignedInt(0:255) R (Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatin gon this radio). When more than one channel is in use for the BSS operating on the radio, the ReceiveOther value is calculated only for the primary channel. - 2.13
CurrentOperatingClassProfileNumberOfEntries unsignedInt R The number of entries in the CurrentOperatingClassProfile table. - 2.13
UnassociatedSTANumberOfEntries unsignedInt R The number of entries in the UnassociatedSTA table. - 2.13
BSSNumberOfEntries unsignedInt R The number of entries in the BSS table. - 2.13
ScanResultNumberOfEntries unsignedInt R The number of entries in the ScanResult table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta. object R Contains the MACAddress of the STA on this radio providing Wi-Fi backhaul to this device. - 2.13
MACAddress string(:17) R [MACAddress] The MAC address of the logical STA sharing the radio for Wi-Fi backhaul. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities. object R This object represents the capabilities of the radio which may be different from the current operational configuration. - 2.13
HTCapabilities base64(1) R Describes the HT capabilities of the radio as defined by the HTCapabilities TLV [Section 17.2.8/MAPv1.0]. - 2.13
VHTCapabilities base64(2:6) R Describes the VHT capabilities of the radio as defined by the VHTCapabilities TLV [Section 17.2.9/MAPv1.0]. - 2.13
HECapabilities base64(4:14) R Describes the HE capabilities of the radio as defined by the HECapabilities TLV [Section 17.2.10/MAPv1.0]. - 2.13
CapableOperatingClassProfileNumberOfEntries unsignedInt R The number of entries in the CapableOperatingClassProfile table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}. object(0:) R

Describes one of the possible Operating Classes supported by this Radio.

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

 - 2.13
Class unsignedInt(:255) R The Operating Class per Table E-4 in [802.11-2016] that this radio is capable of operating on. - 2.13
MaxTxPower int(-127:127) R Maximum Transmit Power EIRP that this radio is capable of transmitting in the current regulatory domain for the Operating Class. Represented as 2’s complement signed integer in units of decibels relative to 1 mW (dBm). - 2.13
NonOperable unsignedInt(:255)[] R Comma-separated list of unsigned integers (up to 255). The channel numbers which are statically non-operable in the Operating Class (i.e. the Radio is never able to operate on these channels). Other channels from this Operating Class which are not listed here are supported for the Radio. - 2.13
NumberOfNonOperChan unsignedInt R The number of non-operable channels contained in NonOperable. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}. object(0:) R

Describes one of the current Operating Classes in use by this Radio. One Opeating Class is indicated for each current Operating Channel Bandwidth. The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel.

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

 - 2.13
Class unsignedInt(:255) R The Operating Class per Table E-4 in [802.11-2016] that this radio is currently operating on. - 2.13
Channel unsignedInt(:255) R This Channel number in the Operating Class that this Radio is currently operating on. - 2.13
TxPower int(-127:127) R Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class. Represented as 2’s complement signed integer in units of decibels relative to 1 mW (dBm). - 2.13
TimeStamp string R The time this group was collected. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. object(0:) R

A single logical BSS operating on this radio.

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

 - 2.13
BSSID string(:17) R [MACAddress] The MAC Address of the logical BSS (BSSID). - 2.13
SSID string R The SSID in use for this BSS. - 2.13
Enabled boolean R Whether the BSSID is currently enabled (beaconing frames are being sent) or disabled. - 2.13
LastChange unsignedInt R Time in seconds since the last change to the Enabled value. - 2.13
TimeStamp string R The time this group was collected. - 2.13
UnicastBytesSent unsignedLong R [StatsCounter64] Access Point (BSS) wide statistics for total unicast bytes transmitted. - 2.13
UnicastBytesReceived unsignedLong R [StatsCounter64] Access Point (BSS) wide statistics for total unicast bytes received. - 2.13
MulticastBytesSent unsignedLong R [StatsCounter64] Access Point (BSS) wide statistics for total multicast bytes transmitted. - 2.13
MulticastBytesReceived unsignedLong R [StatsCounter64] Access Point (BSS) wide statistics for total multicast bytes received. - 2.13
BroadcastBytesSent unsignedLong R [StatsCounter64] Access Point (BSS) wide statistics for total broadcast bytes transmitted. - 2.13
BroadcastBytesReceived unsignedLong R [StatsCounter64] Access Point (BSS) wide statistics for total broadcast bytes received. - 2.13
EstServiceParametersBE base64(0:3) R Estimated Service Parameters information field for AC=BE, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
EstServiceParametersBK base64(0:3) R Estimated Service Parameters information field for AC=BK, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
EstServiceParametersVI base64(0:3) R Estimated Service Parameters information field for AC=VI, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
EstServiceParametersVO base64(0:3) R Estimated Service Parameters information field for AC=VO, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
STANumberOfEntries unsignedInt R The number of entries in the STA table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. object(0:) R

Object describing a single Associated Device (STA).

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

 - 2.13
MACAddress string(:17) R [MACAddress] The MAC address of an associated device. - 2.13
TimeStamp string R The time this group was collected. - 2.13
HTCapabilities base64(1) R Describes the HT capabilities of the Associated Device (STA). - 2.13
VHTCapabilities base64(2:6) R Describes the VHT capabilities of the Associated Device (STA). - 2.13
HECapabilities base64(4:14) R Describes the HE capabilities of the Associated Device (STA). - 2.13
LastDataDownlinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the access point to the associated device. - 2.13
LastDataUplinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the associated device to the access point. - 2.13
UtilizationReceive unsignedLong R The amount of time in milliseconds that the Radio has spent on the Channel receiving data from this Associated Device (STA). - 2.13
UtilizationTransmit unsignedLong R The amount of time in milliseconds that the Radio has spent on the Channel transmitting data to this Associated Device (STA). - 2.13
EstMACDataRateDownlink unsignedInt R Estimate of the MAC layer throughput in Mbps achievable in the downlink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/MAPv1.0]. - 2.13
EstMACDataRateUplink unsignedInt R Estimate of the MAC layer throughput in Mbps achievable in the uplink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/MAPv1.0]. - 2.13
SignalStrength unsignedInt(:255) R An indicator of radio signal strength of the uplink from the associated STA to the access point - measured in dBm. RCPI threshold (encoded per Table 9-154 of [802.11-2016], and described in 10.3.1 of [MAPv1.0]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. - 2.13
LastConnectTime unsignedInt R The time in seconds since this Assocated Device (STA) was associated. - 2.13
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the Associated Device. - 2.13
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the Associated Device. - 2.13
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.13
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received from the Associated Device. - 2.13
ErrorsSent unsignedLong R [StatsCounter64] 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.13
ErrorsReceived unsignedLong R [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.13
RetransCount unsignedLong R [StatsCounter64] The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.13
MeasurementReport base64[] R Comma-separated list of Base64s. Measurement Report element(s) received from the Associated Device (STA) that constitute the latest Beacon report as defined in Figure 9-199 of [802.11-2016]. - 2.13
NumberOfMeasureReports unsignedInt R The number of measurement report elements contained in MeasurementReport. - 2.13
IPV4Address string(:45) R [IPv4Address] IPV4 Address assigned to the client. - 2.13
IPV6Address string(:45) R [IPv6Address] IPV6Address assigned to the client. - 2.13
Hostname string R Hostname assigned to the client. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. object(0:) R The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. - 2.13
TimeStamp string R The timestamp of the last scan. - 2.13
OpClassScanNumberOfEntries unsignedInt R The number of entries in the OpClassScan table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. object(0:) R

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

 - 2.13
OperatingClass unsignedInt(:255) R The Operating Class per Table E-4 in [802.11-2016] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. - 2.13
ChannelScanNumberOfEntries unsignedInt R The number of entries in the ChannelScan table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. object(0:) R

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

 - 2.13
Channel unsignedInt(:255) R The channel number of the Channel scanned by the Radio given the Operating Class. - 2.13
TimeStamp string R The timestamp of the last scan of the channel. - 2.13
Utilization unsignedInt(:255) R The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.28/802.11-2016]. - 2.13
Noise unsignedInt(:255) R An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.11.9.4/802.11-2016]. - 2.13
NeighborBSSNumberOfEntries unsignedInt R The number of entries in the NeighborBSS table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. object(0:) R

The neighboring BSS discovered by a Radio during a channel scan.

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

 - 2.13
BSSID string(:17) R [MACAddress] The BSSID indicated by the neighboring BSS. - 2.13
SSID string R The SSID indicated by the neighboring BSS. - 2.13
SignalStrength unsignedInt(:255) R An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per Table 9-154 of [802.11-2016]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. - 2.13
ChannelBandwidth string R Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. “20” or “40” or “80” or “80+80” or “160” MHz. - 2.13
ChannelUtilization unsignedInt(:255) R The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by Section 9.4.2.28 in [802.11-2016]. - 2.13
StationCount unsignedInt R The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.28/802.11-2016]. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}. object(0:) R

Each instance represents a Non-AP STA that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio.

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

 - 2.13
MACAddress string(:17) R [MACAddress] The MAC address of the Non-AP STA. - 2.13
SignalStrength unsignedInt(:255) R An indicator of radio signal strength (RCPI) of the uplink from the Non-AP STA - measured in dBm. (RCPI threshold is encoded per Table 9-154 of [802.11-2016], and described in 103.2 of [MAPv1.0]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. - 2.13
Device.WiFi.DataElements.AssociationEvent. object R This object contains the events generated when a STA associates to a BSS. - 2.13
AssociationEventDataNumberOfEntries unsignedInt R The number of entries in the AssociationEventData table. - 2.13
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}. object(0:) R The events generated when an Associated Device (STA) associates to a BSS. - 2.13
BSSID string(:17) R [MACAddress] The MAC Address of the logical BSS ( BSSID) which is reporting the Association Event. - 2.13
MACAddress string(:17) R [MACAddress] The MAC Address of the Associated Device (STA). - 2.13
StatusCode unsignedInt R The status code sent to the Associated Device (STA) in the Association Response frame as defined by Table 9-46 in [802.11-2016]. - 2.13
HTCapabilities base64(1) R Describes the HT capabilities of the Associated Device (STA). - 2.13
VHTCapabilities base64(2:6) R Describes the VHT capabilities of the Associated Device (STA). - 2.13
HECapabilities base64(4:14) R Describes the HE capabilities of the Associated Device (STA). - 2.13
TimeStamp string R The time this event was collected. - 2.13
Device.WiFi.DataElements.DisassociationEvent. object R This object contains the events generated when an Associated Device (STA) disassociates from a BSS. - 2.13
DisassociationEventDataNumberOfEntries unsignedInt R The number of entries in the DisassociationEventData table. - 2.13
Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}. object(0:) R The events generated when an Associated Device (STA) disassociates from a BSS. - 2.13
BSSID string(:17) R [MACAddress] The MAC Address of the logical BSS ( BSSID) which is reporting the Disassociation Event. - 2.13
MACAddress string(:17) R [MACAddress] The MAC address of the Associated Device (STA). - 2.13
ReasonCode unsignedInt R The Reason Code received by the AP from the Associated Device (STA) in the most recent Disassociation or Deauthentication frame or sent by the AP to the Associated Device (STA) in the most recent Disassociation or Deauthenticaiton frame as defined in Table 9-45 in [802.11-2016]. - 2.13
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the Associated Device (STA). - 2.13
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the Associated Device (STA). - 2.13
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted to the Associated Device (STA). - 2.13
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received from the Associated Device (STA). - 2.13
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound packets that could not be transmitted to the Associated Device (STA) because of errors. These might be due to the number of retransmissions exceeding the retry limit or from other causes. - 2.13
ErrorsReceived unsignedInt R [StatsCounter32] The total number of inbound packets from the Associated Device (STA) that contained errors preventing them from being delivered to a higher-layer protocol. - 2.13
RetransCount unsignedInt R [StatsCounter32] The total number of transmitted packets to the Associated Device (STA) which were retransmissions. N retransmissions of the same packet results in this counter incrementing by N. - 2.13
TimeStamp string R The time this event was collected. - 2.13
Device.WiFi.Radio.{i}. object(0:) R

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.

Changes in 2.13:

 - 2.0
SupportedStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Radio instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

Changes in 2.13:

  • Added string ax enumeration
 - 2.0
OperatingStandards string[] W Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, {{enum: non-existent ac, ax}} are allowed. For example, a value of “g,b” (or “b,g” - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of “g” means that only the 802.11g standard can be used. - 2.0
Channel unsignedInt(1:255) W The current radio channel used by the connection. To request automatic channel selection, set AutoChannelEnable to true. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. For channels in “wide mode” (802.11n where a 40MHz channel bandwidth is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through ExtensionChannel. Note: Valid Channel values depend on the OperatingFrequencyBand and RegulatoryDomain values specified. - 2.0
SupportedOperatingChannelBandwidths string[] R

Comma-separated list of strings. These are the valid writable values for OperatingChannelBandwidth.

Each list item is an enumeration of:

  • 20MHz
  • 40MHz (wide mode)
  • 80MHz (802.11ac and 802.11ax only)
  • 160MHz (802.11ac and 802.11ax only)
  • 80+80MHz (802.11ac and 802.11ax only)
  • Auto

Changes in 2.13:

  • Added string 80+80MHz enumeration
 - 2.12
OperatingChannelBandwidth string W The value MUST be a member of the list reported by the SupportedOperatingChannelBandwidths parameter. The preferred channel bandwidth to be used (applicable to 802.11n802.11n, 802.11ac, and 802.11ac802.11ax specifications only). - 2.0
CurrentOperatingChannelBandwidth string R

The channel bandwidth currently in use.

Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
  • 80+80MHz

Changes in 2.13:

  • Added string 80+80MHz enumeration
 - 2.11
ExtensionChannel string W

The secondary extension channel position,position (applicable to the 802.11n specification only), applicable when operating in wide channel mode (i.e. when OperatingChannelBandwidth is set to 40MHz or Auto).

Enumeration of:

  • AboveControlChannel
  • BelowControlChannel
  • Auto
 - 2.0
GuardInterval string W

The guard interval value between OFDM symbols (applicable to 802.11n and 802.11ac specifications only).symbols.

Enumeration of:

  • 400nsec (

applicable to 802.11n and 802.11ac specifications only

Changes in 2.13:

  • Added applicable to 802.11n and 802.11ac specifications only description

)

  • 800nsec (

applicable to 802.11n, 802.11ac, and 802.11ax specifications only

Changes in 2.13:

  • Added applicable to 802.11n, 802.11ac, and 802.11ax specifications only description

)

  • 1600nsec (applicable to 802.11ax specifications only)
  • 3200nsec (applicable to 802.11ax specifications only)
  • Auto

Changes in 2.13:

  • Added string 1600nsec enumeration
  • Added string 3200nsec enumeration
 - 2.0
CenterFrequencySegement0 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. - 2.13
CenterFrequencySegement1 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. - 2.13
Device.WiFi.Radio.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref: non-existent TR-181i2}} 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 {{bibref: non-existent TR-181i2}}. - 2.0
Device.WiFi.SSID.{i}. object(0:) W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object. WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.

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

 - 2.0
Device.WiFi.SSID.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref: non-existent TR-181i2}} 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 {{bibref: non-existent TR-181i2}}. - 2.0
Device.WiFi.AccessPoint.{i}. object(0:) 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 can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
MaxAssociatedDevices unsignedInt W The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. This parameter has been DEPRECATED in favor of MaxAllowedAssociations.

Changes in 2.13:

  • Added status = deprecated
 0 2.4
Device.WiFi.AccessPoint.{i}.Security. object R This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007].

Changes in 2.13:

 - 2.0
ModesSupported string[] R

Comma-separated list of strings. Indicates which security modes this AccessPoint instance is capable of supporting.

Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA3-Personal
  • WPA-WPA2-Personal
  • WPA3-Personal-Transition
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA3-Enterprise
  • WPA-WPA2-Enterprise

Changes in 2.13:

  • Added string WPA3-Personal enumeration
  • Added string WPA3-Personal-Transition enumeration
  • Added string WPA3-Enterprise enumeration
 - 2.0
PreSharedKey hexBinary(:32) W

A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACSController SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined).

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

 - 2.0
KeyPassphrase string(8:63) W

A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey for WPA2 is immediately generated. The ACSController SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 ([RFC2898]).

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

 - 2.0
SAEPassphrase string W

A passphrase for WPA3-Personal or WPA3-Personal-Transition security modes. NOTE: this parameter is for WPA3. WPA2 PreSharedKey is generated from KeyPassphrase.

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

 - 2.13
RadiusServerIPAddr string(:45) W [IPAddress] The IP Address of the RADIUS server used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). - 2.0
SecondaryRadiusServerIPAddr string(:45) W [IPAddress] The IP Address of a secondary RADIUS server used for WLAN security. *SecondaryRadiusServerIPAddr * is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion [RFC2865]. - 2.5
RadiusServerPort unsignedInt W The port number of the RADIUS server used for WLAN security. RadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). 1812 2.0
SecondaryRadiusServerPort unsignedInt W The port number of the secondary RADIUS server used for WLAN security. SecondaryRadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server. 1812 2.5
MFPConfig string W

Management Frame Protection configuration applicable when ModeEnabled is set to WPA2-Personal or, WPA2-Enterprise, WPA3-Personal, or WPA3-Enterprise. When in WPA3 modes, MFPConfig MUST be set to Required.

Enumeration of:

  • Disabled
  • Optional
  • Required
 Disabled 2.11
Reset() command - Reset this Security instance’s WiFi security settings to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey , KeyPassphrase, SAEPassphrase, and WPS.PIN (if applicable). If the command cannot be executed, the agent MUST reject the command. Possible failure reasons include a lack of default values or if ModeEnabled is an Enterprise type, i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise. - 2.12
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object(0:) R

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
OperatingStandard string R

The operating standard that this associated device is connected with.

Enumeration of:

Changes in 2.13:

  • Added string ax enumeration
 - 2.10
Device.WiFi.AccessPoint.{i}.AC.{i}. object(4:4) R

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
Device.WiFi.AccessPoint.{i}.AC.{i}.Stats. object R 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 DiasbledDisabled 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].[Section 4.2.2/TR-181i2]. - 2.8
Device.WiFi.EndPoint.{i}. object(0:) 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 can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Device.WiFi.EndPoint.{i}.Security. object R This object contains security related parameters that apply to a WiFi end point [802.11-2007]. - 2.0
ModesSupported string[] R

Comma-separated list of strings. Indicates which security modes this EndPoint instance is capable of supporting.

Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA3-Personal
  • WPA-WPA2-Personal
  • WPA3-Personal-Transition
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA3-Enterprise
  • WPA-WPA2-Enterprise

Changes in 2.13:

  • Added string WPA3-Personal enumeration
  • Added string WPA3-Personal-Transition enumeration
  • Added string WPA3-Enterprise enumeration
 - 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}. object(0:) W

EndPoint Profile table.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of SSID, Location and Priority. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, SSID and Location such that the new entry does not conflict with any existing entries.

 - 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. object R This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007].

Changes in 2.13:

 - 2.0
PreSharedKey hexBinary(:32) W

A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACSController SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined).

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

 - 2.0
KeyPassphrase string(8:63) W

A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACSController SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 [RFC2898].

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

 - 2.0
SAEPassphrase string W

A passphrase for WPA3-Personal or WPA3-Personal-Transition security modes. NOTE: this parameter is for WPA3. WPA2 PreSharedKey is generated from KeyPassphrase.

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

 - 2.13
MFPConfig string W

Management Frame Protection configuration applicable when ModeEnabled is set to WPA2-Personal or, WPA2-Enterprise, WPA3-Personal, or WPA3-Enterprise. When in WPA3 modes, MFPConfig MUST be set to Required.

Enumeration of:

  • Disabled
  • Optional
  • Required
 Disabled 2.11
Device.WiFi.EndPoint.{i}.AC.{i}. object(4:4) R

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
Device.WiFi.EndPoint.{i}.AC.{i}.Stats. object R 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 DiasbledDisabled 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].[Section 4.2.2/TR-181i2]. - 2.8
Device.ZigBee. object R Top level object for ZigBee capabilities based on the [ZigBee2007] specification. - 2.7
Device.ZigBee.Discovery. object R This object is used for managing the discovery of ZigBee devices within a ZigBee Area Network. ZigBee Devices are discovered via the ZDO instance associated with the ZigBee Coordinator of an Area Network. - 2.7
Device.ZigBee.Discovery.AreaNetwork.{i}. object(0:) W

This object specifies the ZigBee devices that are discovered by the Coordinator. As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the AreaNetwork object is provisioned and not discovered.

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

 - 2.7
Coordinator string(:256) W

The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee Coordinator. The coordinator MAY be located within the CPE. In this scenario the ACSController or CPE MAY use the value of “localhost”.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.7
Device.Bridging. object R Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. - 2.0
Device.Bridging.Bridge.{i}. object(0:) W

Bridge table.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Device.Bridging.Bridge.{i}.Port.{i}. object(0:) W

Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. When ManagementPort is set to true the CPE MUST set LowerLayers to reference all non-management bridge ports that are within the same Bridge instance (and update LowerLayers when subsequent non-management bridge ports are added or deleted on that Bridge). The ACSController SHOULD NOT set LowerLayers in this case. <Empty> 2.0
Device.Bridging.ProviderBridge.{i}. object(0:) W

Provider Bridge table. A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects. When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags). When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.7
Alias string(:64) W

A non-volatile handle used to reference this instance. This parameter 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.

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Changes in 2.13:

  • Removed string(:64) syntax
  • Added Alias
 - 2.7
Device.IP. object R IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Interface.{i}. object(0:) W

IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface. Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface’s IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables. Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the ACSController to create) Interface instances of type Loopback. When the ACSController administratively disables the interface, i.e. sets Enable to false, the interface’s automatically-assigned IP addresses and prefixes MAY be retained. When the ACSController administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It’s up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. Any Tunneled IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces. Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Device.IP.Interface.{i}.IPv4Address.{i}. object(0:) W

IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the ACS.Controller.

At most one entry in this table can exist with a given value for Alias, or with the same values for both IPAddress and SubnetMask. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and IPAddress such that the new entry does not conflict with any existing entries.

 - 2.0
Device.IP.Interface.{i}.IPv6Address.{i}. object(0:) W

This table contains the IP interface’s IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses. There are several ways in which entries can be added to and deleted from this table, including: * Automatically via SLAAC [RFC4862], which covers generation of link-local addresses (for all types of device) and global addresses (for non-router devices). * Automatically via DHCPv6 [RFC3315], which covers generation of any type of address (subject to the configured DHCP server policy). * Manually via a GUI or some other local management interface. * Manually via factory default configuration. * By the ACS.Controller. This table MUST NOT include entries for the Subnet-Router anycast address [Section 2.6.1/RFC4291]. Such entries would be identical to others but with a zero interface identifier, and would add no value. A loopback interface will always have address ::1 [Section 2.5.3/RFC4291] and MAY also have link-local address fe80::1. This object is based on ipAddressTable from [RFC4293].

At most one entry in this table can exist with a given value for Alias, or with a given value for IPAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Origin string R

Mechanism via which the IP address was assigned. Enumeration of:

  • AutoConfigured (Automatically generated. For example, a link-local address as specified by SLAAC [Section 5.3/RFC4862], a global address as specified by SLAAC [Section 5.5/RFC4862], or generated via CPE logic (e.g. from delegated prefix as specified by [RFC3633]), or from ULA /48 prefix as specified by [RFC4193])
  • DHCPv6 (Assigned by DHCPv6 [RFC3315])
  • IKEv2 (Assigned by IKEv2 [RFC5996])
  • MAP (Assigned by MAP [RFC7597], i.e. is this interface’s MAP IPv6 address)
  • WellKnown (Specified by a standards organization, e.g. the ::1 loopback address, which is defined in [RFC4291])
  • Static (For example, present in the factory default configuration (but not WellKnown), created by the Controller, or created by some other management entity (e.g. via a GUI)) This parameter is based on ipOrigin from [RFC4293].
 Static 2.2
Device.IP.Interface.{i}.IPv6Prefix.{i}. object(0:) W

This table contains the interface’s IPv6 prefixes. There MUST be an entry for each such prefix, not only for prefixes learned from router advertisements. There are several ways in which entries can be added to and deleted from this table, including: * Automatically via [RFC4861] Router Advertisements. See also RouterAdvertisement. * Automatically via DHCPv6 [RFC3315] prefix delegation [RFC3633]. See also DHCPv6.Client. * Automatically via internal CPE logic, e.g. creation of child prefixes derived from a parent prefix. * Manually via a GUI or some other local management interface. * Manually via factory default configuration. * By the ACS.Controller. The CPE MAY choose not to create IPv6Prefix entries for WellKnown prefixes or for the ULA /48 prefix [RFC4193]. If an IPv6Prefix entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has Upstream = false). This object is based on ipAddressPrefixTable from [RFC4293].

At most one entry in this table can exist with a given value for Alias, or with a given value for Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Origin string R

Mechanism via which the prefix was assigned or most recently updated.

Enumeration of:

  • AutoConfigured (Generated via internal CPE logic (e.g. the ULA /48 prefix) or derived from an internal prefix that is not modeled in any IPv6Prefix table)
  • PrefixDelegation (Delegated via DHCPv6 [RFC3633] or some other protocol, e.g. IPv6rd [RFC5969]. Also see StaticType)
  • RouterAdvertisement (Discovered via router advertisement [RFC4861] Prefix Information Option)
  • WellKnown (Specified by a standards organization, e.g. fe80::/10 for link-local addresses, or ::1/128 for the loopback address, both of which are defined in [RFC4291])
  • Static (Created by the Controller, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not WellKnown). Unrelated to any shorter length prefix that might exist on the CPE. Also see StaticType. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD))
  • Child (Derived from an associated AutoConfigured or PrefixDelegation parent prefix. Also see StaticType, ParentPrefix and ChildPrefixBits. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD)) Note that:
  • PrefixDelegation and RouterAdvertisement prefixes can exist only on upstream interfaces (i.e. interfaces for which the physical layer interface object has Upstream = true),
  • AutoConfigured and WellKnown prefixes can exist on any interface, and
  • Static and Child prefixes can exist only on downstream interfaces (i.e. interfaces for which the physical layer interface object has Upstream = false). Also note that a Child prefix’s ParentPrefix will always be an AutoConfigured, PrefixDelegation, or RouterAdvertisement prefix. This parameter is based on ipAddressOrigin from [RFC4293].
 Static 2.2
StaticType string W

Static prefix sub-type. For a Static prefix, this can be set to PrefixDelegation or Child, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the ACSController to pre-create “prefix slots” with known path names that can be referenced from elsewhere in the data model before they have been populated.

Enumeration of:

  • Static (Prefix is a “normal” Static prefix)
  • Inapplicable (Prefix is not Static, so this parameter does not apply, READONLY)
  • PrefixDelegation (Prefix will be populated when a PrefixDelegation prefix needs to be created)
  • Child (Prefix will be populated when a Child prefix needs to be created. In this case, the Controller needs also to set ParentPrefix and might want to set ChildPrefixBits (if parent prefix is not set, or goes away, then the child prefix will become operationally disabled)) This mechanism works as follows: * When this parameter is set to PrefixDelegation or Child, the instance becomes a “prefix slot” of the specified type. * Such an instance can be administratively enabled (Enable = true) but will remain operationally disabled (Status = Disabled) until it has been populated. * When a new prefix of of type T is needed, the CPE will look for a matching unpopulated instance, i.e. an instance with (Origin,StaticType,Prefix) = (Static,T,““). If the CPE finds at least one such instance it will choose one and populate it. If already administratively enabled it will immediately become operationally enabled. If the CPE finds no such instances, it will create and populate a new instance with (Origin,StaticType) = (T,T). If the CPE finds more than one such instance, the algorithm via which it chooses which instance to populate is implementation-specific. * When a prefix that was populated via this mechanism becomes invalid, the CPE will reset Prefix to an empty string. This does not affect the value of the Enable parameter. The prefix StaticType can only be modified if Origin is Static.
 Static 2.2
Device.IP.Diagnostics. object R The IP Diagnostics object. - 2.0
IPPing() command - [ASYNC] This command provides access to an IP-layer ping test.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_CannotResolveHostName
  • Error_NoRouteToHost (The CPE can not reach the requested Ping host address)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
TraceRoute() command - [ASYNC] This command defines access to an IP-layer trace-route test for the specified IP interface.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.0
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_CannotResolveHostName
  • Error_NoRouteToHost (The CPE can not reach the requested TraceRoute host address)
  • Error_MaxHopCountExceeded
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
DownloadDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ DownloadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL. * When using FTP transport, FTP binary transfer MUST be used. * When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used. * When using HTTP transport the HTTP Authentication MUST NOT be used. Note: For time based tests (TimeBasedTestDuration > 0) the ACSController MAY add a hint to duration of the test to the URL. See {{bibref: non-existent TR-143}} for more details. - 2.0
⇒ TimeBasedTestDuration unsignedInt(0:999) W Controls time based testing {{bibref: non-existent TR-143}}. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. - 2.9
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_CannotResolveHostName
  • Error_NoRouteToHost
  • Error_InitConnectionFailed
  • Error_NoResponse
  • Error_TransferFailed
  • Error_PasswordRequestFailed
  • Error_LoginFailed
  • Error_NoTransferMode
  • Error_NoPASV
  • Error_IncorrectSize
  • Error_Timeout
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
UploadDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ TimeBasedTestDuration unsignedInt(0:999) W Controls time based testing {{bibref: non-existent TR-143}}. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. - 2.9
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_CannotResolveHostName
  • Error_NoRouteToHost
  • Error_InitConnectionFailed
  • Error_NoResponse
  • Error_PasswordRequestFailed
  • Error_LoginFailed
  • Error_NoTransferMode
  • Error_NoPASV
  • Error_NoCWD
  • Error_NoSTOR
  • Error_NoTransferComplete
  • Error_Timeout
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
UDPEchoDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a UDP Echo test {{bibref: non-existent TR-143}} defined in [RFC862] or a UDP Echo Plus test defined in {{bibref: non-existent TR-143}}.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_CannotResolveHostName
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
⇐ IndividualPacketResult.{i}. object(0:) R

This object provides the results from individual UDPEchoPlus test packets collected during a test if EnableIndividualPacketResults is set to true. It should contain NumberOfRepetitions objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet.

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

 - 2.9
⇐ PacketReceiveTime dateTime R Time the client receives the response packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z If this response is never received, PacketReceiveTime SHOULD be set to the Unknown Time value as specified in {{bibref: non-existent TR-106}}. - 2.9
⇐ TestGenSN unsignedInt R The TestGenSN field in the UDPEcho Plus packet {{bibref: non-existent TR-143}} sent by the CPE client. - 2.9
⇐ TestRespSN unsignedInt R The TestRespSN field in the response packet {{bibref: non-existent TR-143}} from the UDP Echo Plus server (i.e. Host) for this Echo Plus packet sent by the CPE client. If PacketSuccess is false, TestRespSN SHOULD be 0. - 2.9
⇐ TestRespRcvTimeStamp unsignedInt R The TestRespRcvTimeStamp field in the response packet {{bibref: non-existent TR-143}} from the UDP Echo Plus server (i.e. Host) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If PacketSuccess is false, TestRespRcvTimeStamp SHOULD be 0. - 2.9
⇐ TestRespReplyTimeStamp unsignedInt R The TestRespReplyTimeStamp field in the response packet {{bibref: non-existent TR-143}} from the UDP Echo Plus server (i.e. Host) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If PacketSuccess is false, TestRespReplyTimeStamp SHOULD be 0. - 2.9
ServerSelectionDiagnostics() command - [ASYNC] This command provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_CannotResolveHostName
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
Device.IPsec. object R IPsec [RFC4301] object that supports the configuration of Encapsulating Security Payload (ESP) [RFC4303] and Authentication Header (AH) [RFC4302] in tunnel mode [Section 3.2/RFC4301]. Use of IKEv2 [RFC5996] is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). See the IPsec Theory of Operation {{bibref: non-existent TR-181i2}} for a description of the working of this IPsec data model. - 2.5
Device.MAP. object R The Mapping of Address and Port (MAP) object [RFC7597] [RFC7599] [RFC7598]. 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 {{bibref: non-existent TR-181i2}} for a description of the working of this MAP data model. - 2.8
Device.MAP.Domain.{i}. object(0:) W

MAP domain settings [RFC7597] [RFC7599]. Each instance models a MAP domain. MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):

  • MAP-E (TransportMode = Encapsulation) uses an IPv4-in-IPv6 tunnel.
  • MAP-T (TransportMode = Translation) uses stateless NAT64. 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 can exist with a given value for Alias, or with the same values for both WANInterface and IPv6Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, WANInterface and IPv6Prefix such that the new entry does not conflict with any existing entries.

 - 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 ACSController configures this prefix directly, the CPE MUST use the ACS-configuredController-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.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with WANInterface) doesn’t conflict with any existing entries.

 - 2.8
Device.MAP.Domain.{i}.Rule.{i}. object(0:) W

The MAP domain’s Mapping Rules [RFC7597]. 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 can exist with a given value for Alias, or with a given value for IPv6Prefix, or with a given value for IPv4Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.8
Origin string R

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 [RFC7598] S46_RULE option)
  • Static (Present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI))
 Static 2.8
Device.Routing. object R Routing object that contains the Router table and RIP protocol object. - 2.0
Device.Routing.Router.{i}. object(0:) W

This object allows the handling of the routing and forwarding configuration of the device.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Device.Routing.Router.{i}.IPv4Forwarding.{i}. object(0:) W

Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination address/mask are considered, and the matching entry with the longest prefix is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero. For enabled table entries, if Interface is not a valid reference to an IPv4-capable interface (that is attached to the IPv4 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The IPv4Forwarding 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 IPv4Forwarding row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending IPv4Forwarding row.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Origin string R

Protocol via which the IPv4 forwarding rule was learned. Enumeration of:

  • DHCPv4
  • OSPF
  • IPCP
  • RIP
  • Static (For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI))
 Static 2.2
Device.Routing.Router.{i}.IPv6Forwarding.{i}. object(0:) W

Layer 3 IPv6 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, and RA. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination prefix are considered, and the matching entry with the longest prefix length is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. This object is based on inetCidrRouteTable from [RFC4292].

At most one entry in this table can exist with a given value for Alias, or with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Origin string R

Protocol via which the IPv6 forwarding rule was learned. Enumeration of:

  • DHCPv6
  • OSPF
  • RA (Router Advertisement Route Information Option [RFC4191])
  • RIPng (RIPng for IPv6 [RFC2080])
  • Static (For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI))
 Static 2.2
Device.NeighborDiscovery. object R The Neighbor Discovery Protocol (NDP) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. - 2.2
Device.NeighborDiscovery.InterfaceSetting.{i}. object(0:) W

Per-interface Neighbor Discovery Protocol (NDP) configuration [RFC4861]. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting 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 InterfaceSetting 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 InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.2
DADTransmits unsignedInt W The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see[Section 5.1/RFC4862]). A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions. If the value is greater than 1, RetransTimer defines the delay between consecutive messages. 1 2.13
RetransTimer unsignedInt(1:) W Retransmission interval in milliseconds, as defined in [RFC4861]. For auto-configuration purposes, RetransTimer specifies the delay between consecutive Neighbor Solicitation transmissions performed during Duplicate Address Detection (DAD) [Section 5.4/RFC4862], as well as the time a node waits after sending the last Neighbor Solicitation before ending the DAD process.

Changes in 2.13:

  • Added unsignedInt 1: range
 1000 2.2
RtrSolicitationInterval unsignedInt(4000:) W Retransmission interval in milliseconds, as defined in {{bibref: non-existent RFC4861{{inserted: unexpected argument 6.3.7 after: []}}}}. For auto-configuration purposes, RtrSolicitationInterval specifies the delay between consecutive Router Solicitation transmissions.

Changes in 2.13:

  • Added unsignedInt 4000: range
  • Changed default value = 4 ⇒ 4000
 4000 2.2
Device.IPv6rd. object R Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in [RFC5969]. The 6rd mechanism is intended to be implemented only on what [RFC5969] refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. See the 6rd Theory of Operation {{bibref: non-existent TR-181i2}} for a description of the working of this 6rd data model. - 2.2
Device.IPv6rd.InterfaceSetting.{i}. object(0:) R

6rd [RFC5969] settings. A 6rd delegated prefix is expected to be of maximum length 64 bits, and is the concatenation of the following two items:

  • Service provider IPv6 prefix: specified via the SPIPv6Prefix parameter
  • IPv4 address suffix: the IPv4 address with the first IPv4MaskLength bits removed This object definition is derived from [RFC5969] with some minor nomenclature changes.

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

 - 2.2
AllTrafficToBorderRelay boolean W If true, the destination address for all 6rd traffic will be set (IPv4 destination address) to one of the BorderRelayIPv4Addresses. If false, traffic whose destination address begins with the same prefix as SPIPv6Prefix will be sent directly to the destination IPv4 address of the endpoint, which is in the same 6rd domain. See 6rd Theory of Operation for further explanation {{bibref: non-existent TR-181i2}}. - 2.2
Device.DSLite. object R Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in [DSLite]. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. See the Dual-Stack Lite Theory of Operation {{bibref: non-existent TR-181i2}} for a description of the working of this DS-Lite data model. - 2.2
Device.DSLite.InterfaceSetting.{i}. object(0:) R

DSLite [DSLite] settings.

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

 - 2.2
EndpointName string(:256) W The Fully Qualified Domain Name (FQDN) of the tunnel concentrator (remote endpoint). This parameter is based on OPTION_DS_LITE_NAME from [Section 4/DSLite-options] and can be assigned statically (e.g. present in the factory default configuration or set by the ACS)Controller) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then EndpointAssignmentPrecedence indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to EndpointName. Note: EndpointName is only writable when EndpointAssignmentPrecedence is Static; otherwise, EndpointName is automatically configured via the DHCPv6 received option. - 2.2
EndpointAddress string(:45) W [IPv6Address] The address of the tunnel concentrator (remote endpoint). This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the ACS).Controller). - 2.2
Origin string R

Method used to assign EndpointAddressInUse.

Enumeration of:

  • DHCPv6 (Assigned by DHCPv6 [RFC3315])
  • Static (For example, present in the factory default configuration, set by the Controller, or set by some other management entity (e.g. via a GUI))
 - 2.2
Device.QoS. object R Queue management configuration object. - 2.0
DefaultEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref: non-existent TR-181i2}}. - 2.0
Device.QoS.App.{i}. object(0:) W

Application table.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
DefaultEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref: non-existent TR-181i2}}. -1 2.0
Device.QoS.Flow.{i}. object(0:) W

Flow table.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
EthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref: non-existent TR-181i2}}. -1 2.0
Device.QoS.Policer.{i}. object(0:) W

Policer table.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
MeterType string W

The value MUST be a member of the list reported by the PossibleMeterTypes parameter. Identifies the method of traffic measurement to be used for this policer.[ Each list item is an enumeration of:

 SimpleTokenBucket 2.0
Device.QoS.QueueStats.{i}. object(0:) W

Queue statistics table. This table is managed by the ACS,Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The QueueStats 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 QueueStats row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending QueueStats row.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Queue and Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Device.Hosts. object R This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. - 2.0
Device.Hosts.Host.{i}. object(0:) R

Host table.

At most one entry in this table can exist with a given value for {{param: reference to deprecated parameter Device.Hosts.Host.{i}.Alias}}, or with a given value for PhysAddress.

Changes in 2.13:

 - 2.0
AssociatedDevice string(:256) R The value MUST the path name of the AssociatedDevice (or equivalent) table row that models the host, or an empty string if either there is no such table.table or the host isn’t directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point). For example: Device.WiFi.AccessPoint.1.AssociatedDevice.2 - 2.2
Layer1Interface string(:256) R The value MUST be the path name of a row in a layer 1 interface table. If either the layer 1 interface isn’t known or the host isn’t directly connected to this device isn’t(e.g. known,the host is connected to a Wi-Fi Access Point), then Layer1Interface will be an empty string. For example: Device.Ethernet.Interface.2 - 2.0
Layer3Interface string(:256) R 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. If either the entrylayer represents3 interface isn’t known or the host isn’t directly connected to this device (e.g. the host is connected to a non-IPWi-Fi device,Access Point), then Layer3Interface will be an empty stringan empty string. - 2.0
InterfaceType string R

Type of physical interface through which this host is connected.

Enumeration of:

  • Ethernet
  • G.hn
  • HPNA
  • HomePlug
  • MoCA
  • UPA
  • Wi-Fi
  • Other
 - 2.13
Device.DNS. object R Properties for Domain Name Service (DNS). - 2.0
Device.DNS.Client. object R Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. - 2.0
Device.DNS.Client.Server.{i}. object(0:) W

This table contains the DNS Server IP address to be used by the DHCP Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS.Controller.

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

 - 2.0
Device.DNS.Relay. object R DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. - 2.0
Device.DNS.Relay.Forwarding.{i}. object(0:) W

DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS.Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.

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

 - 2.0
Device.DNS.Diagnostics. object R The DNS Diagnostics object containing the {{object: referenced NSLookupDiagnostics() is command, not object}} test. - 2.0
NSLookupDiagnostics() command - [ASYNC] This command defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated.

Changes in 2.13:

  • Added Output. output Status parameter
 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a table row. ThisThe parameterlayer specifies2 theor IP-layerlayer 3 interface over which the test is to be performedperformed. (i.e.Example: theDevice.IP.Interface.1, source IP address to use when performing the test).Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding(Forwarding table entries), if necessary,entries) to determine the appropriate interface. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_DNSServerNotResolved (Unable to resolve DNSServer Name)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
 - 2.13
Device.NAT. object R Properties for Network Address Translation (NAT). The entire NAT object only applies to IPv4. - 2.0
Device.NAT.InterfaceSetting.{i}. object(0:) W

NAT settings for an associated IP Interface on which NAT is enabled. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting 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 InterfaceSetting 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 InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.0
TCPTranslationTimeout int(-1:) W Determines the timeout, in seconds, of NAT translations for TCP sessions. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. 300 2.13
UDPTranslationTimeout int(-1:) W Determines the timeout, in seconds, of NAT translations for UDP bindings. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. 30 2.13
Device.NAT.PortMapping.{i}. object(0:) W

Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string, or 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 can exist with a given value for Alias, or with the same values for all of RemoteHost, ExternalPort and Protocol. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, ExternalPort and Protocol such that the new entry does not conflict with any existing entries.

 - 2.0
InternalClient string(:256) W The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACSController can learn the host name associated with a given LAN device via the Hosts.Host. table. Read access to this parameter MUST always return the exact value that was last set by the ACS.Controller. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. <Empty> 2.0
Device.PCP. object R Properties for Port Control Protocol (PCP) [RFC6887]. See the PCP Theory of Operation {{bibref: non-existent TR-181i2}} for a description of the working of this PCP data model. - 2.8
Device.PCP.Client.{i}. object(0:) 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 can exist with a given value for Alias, or with a given value for WANInterface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and WANInterface such that the new entry does not conflict with any existing entries.

 - 2.8
Device.PCP.Client.{i}.Server.{i}. object(0:) 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 can exist with a given value for Alias, or with a given value for ServerNameOrAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and ServerNameOrAddress such that the new entry does not conflict with any existing entries.

 - 2.8
Origin string R

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 Controller, 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
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. object(0:) 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 ACSController MAY modify the {{param: empty ref only valid in parameter descriptions}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of InternalPort, ProtocolNumber and ThirdPartyAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, InternalPort, ProtocolNumber and ThirdPartyAddress such that the new entry does not conflict with any existing entries.

 - 2.8
Origin string R

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 Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)
 - 2.8
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. object(0:) 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 ACSController MAY modify the {{param: empty ref only valid in parameter descriptions}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort such that the new entry does not conflict with any existing entries.

 - 2.8
Origin string R

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 Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)
 - 2.8
Device.DHCPv4. object R The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
Device.DHCPv4.Server. object R DHCP server configuration. - 2.0
Device.DHCPv4.Server.Pool.{i}. object(0:) W

DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.0
AllowedDevices string W

Pool association criterion. Determines which devices are allowed, Enumeration of:

 - 2.13
StaticAddressNumberOfEntries unsignedInt R {{numentries: not associated with a table}}

Changes in 2.13:

  • Removed unsignedInt syntax 0 default
 - 2.0
OptionNumberOfEntries unsignedInt R {{numentries: not associated with a table}}

Changes in 2.13:

  • Removed unsignedInt syntax 0 default
 - 2.0
Device.DHCPv6. object R The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC3315]. This entire object applies to IPv6 only. It contains the Client and Server objects. - 2.2
Device.DHCPv6.Server. object R DHCPv6 server configuration. - 2.2
Device.DHCPv6.Server.Pool.{i}. object(0:) W

DHCPv6 server pool table. Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.2
ClientNumberOfEntries unsignedInt R {{numentries: not associated with a table}}

Changes in 2.13:

  • Removed unsignedInt syntax 0 default
 - 2.2
OptionNumberOfEntries unsignedInt R {{numentries: not associated with a table}}

Changes in 2.13:

  • Removed unsignedInt syntax 0 default
 - 2.2
Device.SmartCardReaders. object R SmartCardReaders object that contains the SmartCardReader table. - 2.0
Device.SmartCardReaders.SmartCardReader.{i}. object(0:) R

This object describes the characteristics of the smart card reader.

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

 - 2.0
Device.SmartCardReaders.SmartCardReader.{i}.SmartCard. object R Status of currently associated smart card. - 2.0
Type string R

Smart Card Type. Enumeration of:

  • CA
  • DRM
  • UICC Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref: non-existent TR-106}} MUST be adhered to.
 - 2.0
Application string[] R

Comma-separated list of strings. Indicates Smart Card Application(s). Application is only relevant when Type has a value of UICC, otherwise it is an empty string. Each list item is an enumeration of:

  • SIM
  • USIM
  • ISIM Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref: non-existent TR-106}} MUST be adhered to.
 - 2.0
Device.Firewall. object R Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. See {{bibref: non-existent TR-181i2}} for an example Advanced configuration. - 2.0
Config string W

How this firewall is configured. Enumeration of:

  • High (The firewall implements the “Traffic Denied Inbound” and “Minimally Permit Common Services Outbound” components of the ICSA residential certification’s Required Services Security Policy [ICSA-Residential]. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Low (All Outbound traffic and pinhole-defined Inbound traffic is allowed. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Off (All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings (if supported and enabled). If DoS and vulnerability protections are implemented [ICSA-Baseline], these are disabled. This value is DEPRECATED because it is the same as setting Enable to false, DEPRECATED)
  • Advanced (Advanced firewall configuration applies, as specified by AdvancedLevel, OPTIONAL) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref: non-existent TR-106}} MUST be adhered to.
 - 2.0
Device.PeriodicStatistics. object R This object configures collection of periodic statistics for the device. Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACSController as a comma-separated list of the most recent samples. This object provides a single set of global settings that affect the entire device unless overridden locally. - 2.0
Device.PeriodicStatistics.SampleSet.{i}. object(0:) W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Status string R

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the Controller SHOULD now fetch the collected data) The Trigger value is only used for triggering the ACSController to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples]. The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.
 Disabled 2.0
TimeReference dateTime W An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval. TimeReference is used only to set the “phase” of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future. This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval). If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. The Unknown Time value defined in {{bibref: non-existent TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight. Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start. 0001-01-01T00:00:00Z 2.0
FetchSamples unsignedInt W The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled. If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur. For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACSController could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param: non-existent ForceSample}}). To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples. 0 2.0
ParameterNumberOfEntries unsignedInt R The number of entries in the Parameter table.

Changes in 2.13:

  • Removed unsignedInt syntax 0 default
 - 2.0
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object(0:) W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled. Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a “sneak preview” of the current sample), or (c) at the end of the sample interval.

At most one entry in this table can exist with a given value for Reference, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Failures unsignedInt R Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the “in range” state to the “out of range” state, or between the “out of range (low)” and “out of range (high)” states. The states are defined as follows: * “in range” : current value is greater than LowThreshold and less than HighThreshold. * “out of range” : current value is less than or equal to LowThreshold, or greater than or equal to HighThreshold. * “out of range (low)” : current value is less than or equal to LowThreshold. * “out of range (high)” : current value is greater than or equal to HighThreshold. Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment. This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACSController of such changes, as described in [Section 3.2.1/TR-069a2].changes. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. 0 2.0
Device.FaultMgmt. object R This object contains parameters relating to Fault/Alarm Management. - 2.4
Device.FaultMgmt.CurrentAlarm.{i}. object(0:) R

Contains all currently active alarms (whose FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity is not Cleared). Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table. If maximum entries as indicated by FaultMgmt.MaxCurrentAlarmEntries is reached, the next event overrides the object with the oldest AlarmChangedTime. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACSController (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier, or with the same values for all of EventType, ProbableCause and SpecificProblem.

 - 2.4
Device.FaultMgmt.ExpeditedEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 0 Expedited. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.ExpeditedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in {{bibref: non-existent TR-106}}. If maximum instance number FaultMgmt.ExpeditedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACSController (even if their new values are identical to those of the prior alarm).

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

 - 2.4
EventTime dateTime R Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in {{bibref: non-existent TR-106}}. - 2.4
Device.FaultMgmt.QueuedEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 1 Queued. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.QueuedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in {{bibref: non-existent TR-106}}. If maximum instance number FaultMgmt.QueuedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACSController (even if their new values are identical to those of the prior alarm).

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

 - 2.4
EventTime dateTime R Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in {{bibref: non-existent TR-106}}. - 2.4
Device.FAP. object R This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 2.4
Device.FAP.GPS. object R This object contains the parameters relating to the GPS scan. - 2.4
PeriodicTime dateTime W An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the PeriodicInterval. PeriodicTime is used only to set the “phase” of the GPS scan. The actual value of PeriodicTime can be arbitrarily far into the past or future. For example, if PeriodicInterval is 86400 (a day) and if PeriodicTime is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicTime refers to a day in the future. The Unknown Time value defined in {{bibref: non-existent TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval. If absolute time is not available to the CPE, its periodic GPS scan behavior MUST be the same as if PeriodicTime parameter was set to the Unknown Time value. - 2.4
LastSuccessfulScanTime dateTime R

Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboot and is only reset after another scan completes successfully or {{param: non-existent GPSReset}} is set to true. The values for LockedLatitude, LockedLongitude and NumberOfSatellites correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in {{bibref: non-existent TR-106}}.

Value Change Notification requests for this parameter MAY be denied.

 - 2.4
Device.FAP.GPS.ContinuousGPSStatus. object R When ContinuousGPS is true, the parameters in this object contain the GPS status as it is continuously monitored. When ContinuousGPS is false, the parameters in this object are not being updated and their values are not accurate. - 2.4
LastFixTime dateTime R

Represents the date and time when the last GPS Fix was acquired. The Unknown Time value defined in {{bibref: non-existent TR-106}} is used when GotFix is false. This applies too after a reboot of the device until a valid location is determined and GotFix transsitions to true.

Value Change Notification requests for this parameter MAY be denied.

 - 2.4
Device.FAP.PerfMgmt. object R This object contains parameters relating to Performance Management in a Femto-related environment. - 2.4
Device.FAP.PerfMgmt.Config.{i}. object(0:) W

This object contains parameters relating to File Management configuration for uploading of Performance Files to a designated File Server. Each table entry can be referenced by zero or more radio-specific objects contained in the FAPService instances. The periodic upload will upload data for all of the radio-specific objects that reference it.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of URL, PeriodicUploadInterval and PeriodicUploadTime. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, URL, PeriodicUploadInterval and PeriodicUploadTime such that the new entry does not conflict with any existing entries.

 - 2.4
PeriodicUploadTime dateTime W

An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the PeriodicUploadInterval. PeriodicUploadTime is used only to set the “phase” of the periodic uploads. The actual value of PeriodicUploadTime can be arbitrarily far into the past or future. For example, if PeriodicUploadInterval is 86400 (a day) and if PeriodicUploadTime is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicUploadTime refers to a day in the future. The Unknown Time value as defined in {{bibref: non-existent TR-106}} indicates that no particular time reference is specified. That is, the device MAY locally choose the time reference, and is REQUIRED only to adhere to the specified PeriodicUploadInterval. If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the PeriodicUploadTime parameter was set to the Unknown Time value.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with URL, PeriodicUploadInterval) doesn’t conflict with any existing entries.

 - 2.4
Device.FAP.ApplicationPlatform. object R This object defines the data model for the following Femtozone APIs.
  • Femto Awareness
  • SMS
  • MMS
  • Terminal Location Femto Awareness, SMS, MMS, and Terminal Location APIs are defined in the Release 1 API Specifications of the Service SIG in the Femto Forum (non public document). [Appendix I/TR-262] provides the “Theory of Operation” for the usage of this object.
 - 2.4
Device.FAP.ApplicationPlatform.Control. object R This object contains parameters related to the operation of the Femtozone APIs. - 2.4
TunnelInst string(:256) W This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic. If InternetGatewayDevice:1 [TR-098] or Device:1 [TR-181i1]) is used as root data model theThe TunnelInst MUST point to a row in the .FAP.Tunnel.IKESA.{i}. table. If the root data model used is Device:2 [TR-181i2] than the TunnelInst MUST point to an tunnel instance defined in thisthe data model. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.4
Device.BulkData. object R This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in [TR-232]. The HTTP solution is based on transfer mechanisms described in {{bibref: non-existent TR-369}}. The USPEventNotif solution is based on sending a Device.BulkData.Profile.{i}.Push! Event Notification via USP [TR-369]. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. - 2.5
Protocols string[] R

Comma-separated list of strings. Represents the IPDR and transport protocols that this device is capable of supporting.

Each list item is an enumeration of:

  • Streaming (IPDR Streaming Protocol [IPDR-SP])
  • File (IPDR File Transfer Protocol [IPDR-FTP])
  • HTTP (Hypertext Transfer Protocol [RFC2616])
  • USPEventNotif (User Services Platform (USP - [Annex A/TR-369]) Event Notiification)

Changes in 2.13:

  • Added string USPEventNotif enumeration
 - 2.5
EncodingTypes string[] R

Comma-separated list of strings. Represents the Encoding Types for the protocols that this device is capable of supporting.

Each list item is an enumeration of:

  • XML (Used with the IPDR Streaming and File Protocols. [IPDR-XML])
  • XDR (Used with the IPDR Streaming and File Protocols. [IPDR-XDR])
  • CSV (Comma Separated Values. Used with the HTTP and USPEventNotif Protocols. [RFC4180])
  • JSON (JavaScript Object Notation. Used with the HTTP and USPEventNotif Protocols. [RFC7159])
 - 2.5
MaxNumberOfProfiles int(-1:) R The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the ACSController can create. If the value of this parameter is -1, then it means that the CPE doesn’t have a limit to the number of profiles that can exist. - 2.5
Device.BulkData.Profile.{i}. object(0:) W

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

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.5
TimeReference dateTime W An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations. TimeReference is used only to set the “phase” of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future. If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately. The Unknown Time value as defined in {{bibref: non-existent TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a “ITPush” mode) its report at midnight every 24 hours. Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start. 0001-01-01T00:00:00Z 2.5
StreamingSessionID unsignedInt(48:57,65:90) W This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). AnA ACSController MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single ‘char’, but we are restricting the range even further (ASCII values of ‘0’ - ‘9’ and ‘A’ - ‘Z’. - 2.5
Push! event - Bulk Data Push event for delivering a bulk data report within a USP Notification message. - 2.13
⇒ Data string R The contents of the bulk data report in the configured CSV or JSON Encoding Type. - 2.13
Device.BulkData.Profile.{i}.Parameter.{i}. object(0:) W Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported. - 2.5
Name string(:64) W Name of the parameter in the report body. If the value of this parameter is an empty string, then the value of the Reference parameter is used as the name. When the value Reference parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in {{bibref: non-existent TR-369}}. - 2.10
Device.BulkData.Profile.{i}.CSVEncoding. object R This object defines the properties to be used when the Profile object’s EncodingType parameter value is CSV. - 2.10
ReportFormat string W

This parameter describes the formatting used for reports defined by this profile as described in {{bibref: non-existent TR-369}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616].

Enumeration of:

  • ParameterPerRow (Reports are formatted with each parameter formatted as a row entry)
  • ParameterPerColumn (Reports are formatted with each parameter formatted as a column entry)
 ParameterPerColumn 2.10
RowTimestamp string W

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

Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format.)
  • None (Timestamp is not inserted in the row)
 Unix-Epoch 2.10
Device.BulkData.Profile.{i}.JSONEncoding. object R This object defines the properties to be used when the Profile object’s EncodingType parameter value is JSON. - 2.10
ReportFormat string W

This parameter describes the formatting used for the report as described in {{bibref: non-existent TR-369}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616].

Enumeration of:

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

The format of timestamp to use for the JSON Object named “CollectionTime” as described in {{bibref: non-existent {{replaced: unexpected argument Annex A.2.6.1 after: TR-157a10, TR-369}}}}.

Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format. .)
  • None (Timestamp is not inserted)
 Unix-Epoch 2.10
Device.BulkData.Profile.{i}.HTTP. object R This object defines the properties to be used when transporting bulk data using the HTTP/HTTPS protocol. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the CPE MUST support HTTP Basic and Digest Access Authentication as defined in [RFC2616]. - 2.10
RetryMinimumWaitInterval unsignedInt(1:65535) W Configures the data transfer retry wait interval, in seconds, as specified in {{bibref: non-existent TR-369}}. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 5 2.10
RetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in {{bibref: non-existent TR-369}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 2000 2.10
Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. object(0:) W This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by {{bibref: non-existent TR-369}}. - 2.10
Device.XMPP. object R The XMPP represents the XMPP capabilities of the device as described in [Appendix III/TR-069a5].. - 2.7
Device.XMPP.Connection.{i}. object(0:) W

The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of Username, Domain and Resource. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Username, Domain and Resource such that the new entry does not conflict with any existing entries.

 - 2.7
Password string(:256) W

Password used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If ana ACSController modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

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

 - 2.7
ServerRetryInitialInterval unsignedInt(1:65535) W The maximum first reconnection wait interval, in seconds, as specified in [Annex K XMPP Connection Request/TR-069a5].. The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval. NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 60 2.7
ServerRetryIntervalMultiplier unsignedInt(1000:65535) W The reconnection interval multiplier as specified in [Annex K XMPP Connection Request/TR-069a5].. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1). NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 2000 2.7
UseTLS boolean W This parameter allows ana ACSController to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS “mandatory-to-negotiate”. If the value of UseTLS is true then the CPE will initiate TLS negotiation if not required to by the XMPP Server. If the value of UseTLS is false then the CPE will not initiate TLS negotiation if not required to by the XMPP Server. false 2.7
Device.IEEE1905. object R This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. - 2.9
Device.IEEE1905.AL. object R This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.NetworkTopology. object R This object represents the 1905 Network Topology capabilities of this device. - 2.9
Enable boolean W Enables or disables the 1905 Network Topology reporting (via TR-069).a Controller). When true, the device clears and (re)populates the IEEE1905Device and ChangeLog tables. When false, the contents of the IEEE1905Device and ChangeLog tables have no meaning. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. object(0:) R

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

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

Changes in 2.13:

 - 2.9
AssocWiFiNetworkDeviceRef string R The value MUST be the Path Name of a row in the WiFi.MultiAP.APDevice. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. AssocWiFiNetworkDeviceRef is a reference to the Wi-Fi Network “APDevice”. Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance’s EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. - 2.13
Device.MQTT. object R MQTT Base object describing all MQTT related parameters and objects [MQTT31],objects. - 2.10
Device.MQTT.Capabilities. object R Indicates the MQTT capabilities of the device. - 2.10
ProtocolVersionsSupported string[] R

Comma-separated list of strings. Indicates the supported protocol versions. Each list item is an enumeration of:

  • 3.1 (Protocol according to [MQTT31])
  • 3.1.1 (Protocol according to {{bibref: non-existent MQTT31}})
  • 5.0 (Protocol according to [MQTT50])

Changes in 2.13:

  • Added string 5.0 enumeration
 - 2.10
Device.MQTT.Client.{i}. object(0:) W

MQTT client table. Contains a list of configured MQTT clients.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.10
Enable boolean W Allows to enable or disable the MQTT client. If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the Subscription. table. In case theIf the ProtocolVersion is set to 3.1 or 3.1.1 and CleanSession is set to false a subscription MUST only be sent for topics which haven’t been subscribed before (see **{{bibref: non-existent **{{replaced: unexpected argument section after: MQTT311|, MQTT31}}3.1.2.4}}). If the ProtocolVersion is set to 5.0 and CleanStart is set to false a subscription MUST only be sent for topics which haven’t been subscribed before (see [Section 3.1.2.4/MQTT50]). If a connected MQTT client gets disabled (Status is either Connecting or Connected) then the MQTT client has to send a MQTT DISCONNECT messagepacket to disconnect from the MQTT broker ([section 3.14/MQTT31],[Section 3.14/MQTT31]) or **{{bibref: non-existent **{{replaced: unexpected argument section after: MQTT311|, MQTT50}}3.14}}), before setting the Status to Disabled. - 2.10
CleanSession boolean W The value of the MQTT clean session flag in the MQTT CONNECT messagepacket (see [section 3.1/MQTT31] and {{bibref: non-existent MQTT31}}). If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. AA change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. change of thisThis parameter only applies if ProtocolVersion is only effective after the next MQTT CONNECT messageset to the3.1 MQTTor broker. If the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.3.1.1. true 2.10
CleanStart boolean W The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50]. If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.. This parameter only applies if ProtocolVersion is set to 5.0. true 2.13
WillEnable boolean W Enables or disables the will handling (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}})..) Changingor this[Section/MQTT50] parameter while the MQTT client is connected will cause the client to disconnect and reconnect.3.1.2.5). If the connection gets enabled and this parameter is set to true and either the parameter WillTopic or WillValue are an empty string, the CPE MUST set the Status to Error_Misconfigured. (see [Section 3.1.2.5/MQTT311]).A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.. - 2.10
WillQoS unsignedInt(0:2) W The MQTT QoS level assigned with the will message (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well. 
A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.

 - 2.10
WillRetain boolean W Indicate to the MQTT broker to retain the Will over a Disconnect (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well. 
A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.

 - 2.10
KeepAliveTime unsignedInt(:65535) W Keep Alive Time in seconds defines the maximum wait time after which a messagepacket has to be sent to the MQTT broker (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). If no regular messagespacket can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive messagepackets are sent and the MQTT client is not disconnected by the server. A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. 60 2.10
SessionExpiryInterval unsignedInt W Session expiry interval in seconds defines the wait time before a session expires after the connection has been closed by the MQTT client [Section 3.1.2.11.2/MQTT50]). This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
ReceiveMaximum unsignedInt W The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see [Section 3.1.2.11.3/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
MaximumPacketSize unsignedInt W The maximum packet size in byte the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet [Section 3.1.2.11.4/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
TopicAliasMaximum unsignedInt(:65535) W This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see [Section 3.1.2.11.5/MQTT50]). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection. A value of 0 indicates that Topic Alias is not supported. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
RequestResponseInfo boolean W The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see [Section 3.1.2.11.6/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
RequestProblemInfo boolean W This value indicates whether the Reason String or User Properties are sent in the case of failures.(see [Section 3.1.2.11.7/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
AuthenticationMethod string(0:256) W This value defines the extended authentication method to be used (see [Section 3.1.2.11.9/MQTT50]). If the parameter is empty, no extended authentication is performed. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
ClientID string(0:65535) W The MQTT client identifier used in the MQTT CONNECT messagepacket (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). ThisIf ProtocolVersion is set to 3.1 or 3.1.1, this parameter MUST NOT be an empty string,an theempty CPEstring. hasIf ProtocolVersion is set to provide5.0, aan defaultempty value for the parameter, which can be changed by the ACS. A change of this parameterstring is onlyallowed. communicated to the MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.

Changes in 2.13:

  • Changed 0:65535 size minLength = 1 ⇒ 0
  • Changed 0:65535 size maxLength = 23 ⇒ 65535
 - 2.10
WillDelayInterval unsignedInt W The delay in seconds after the session is disconnected, before sending the Will message [Section 3.1.3.2.2/MQTT50]). A value of 0 indicates that there is no delay. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. 5 2.13
WillMessageExpiryInterval unsignedInt W The lifetime in seconds of a Will Message (see [Section 3.1.3.2.4/MQTT50]). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
WillContentType string(:256) W Describes the type of the WillValue [Section 3.1.3.2.5/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
WillResponseTopic string(:65535) W Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request [Section 3.1.3.2.6/MQTT50]). If the WillResponseTopic is an empty string the will response topic will not be sent in a MQTT CONNECT packet. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
WillTopic string(:65535) W

The Topic sent in the Will Message (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.

Changes in 2.13:

  • Added string :65535 size
 - 2.10
WillValue string(:65535) W

The value sent in the Will Message (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.

Changes in 2.13:

  • Added string :65535 size
 - 2.10
Username string(:256) W Username used to authenticate the CPEMQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see [[section 3.1, [Section 3.1.3.4/MQTT31] or [Section 3.1.3.5/MQTT50]). For MQTT 3.1 [Section /MQTT31]3.1/MQTT31](#R.MQTT31)] recommends that the usernameuser name has 12 characters or fewer, but this is not required. If this parameter is an empty string no authentication parameters are sent in the MQTT CONNECT message.packet. - 2.10
Password string(:256) W

Password used to authenticate the CPEMQTT client when making a connection to the MQTT brokerbroker. The value is sent in the MQTT CONNECT packet (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). This password is only sent in the MQTT CONNECT messagepacket if Username is not an empty string.

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

 - 2.10
PublishMessageExpiryInterval unsignedInt W The lifetime in seconds of a PUBLISH Message (see [Section 3.3.2.3.3/MQTT50]). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. This parameter only applies if ProtocolVersion is set to 5.0. - 2.13
MessageRetryTime unsignedInt(1:) W Message retry time in seconds defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see [section 4.2/MQTT31]). andThis {{replaced: unexpected argument [replaced(4.4}})., #.Capabilities.ProtocolVersionsSupported), ‘.’] after: {{bibref|MQTT311, [’parameter only applies if ’, param(ProtocolVersion), ’ is set to ’, enum(3.1)]}} 5 2.10
ConnectRetryTime unsignedInt(1:) W Connect retry time in seconds defines the wait time before a failed MQTT broker connection is retried. A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK messagepacket on a MQTT CONNECT messagepacket sent. If the parameter ConnectRetryIntervalMultiplier is defined, the MQTT client MUST use a random value between ConnectRetryTime*(ConnectRetryIntervalMultiplier/1000)(n-1) and ConnectRetryTime*(ConnectRetryIntervalMultiplier/1000)n for the connect retry time, with n equals the current retry number. The max number of n is 10, starting with the 11th retry always the value n = 10 is used. If the parameters ConnectRetryIntervalMultiplier and ConnectRetryMaxInterval are defined, the MQTT client MUST use the value of ConnectRetryMaxInterval if the calculated random value exceeds the value of ConnectRetryMaxInterval.

Changes in 2.13:

  • Changed default value = 30 ⇒ 5
 5 2.10
ConnectRetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. 2000 2.13
ConnectRetryMaxInterval unsignedInt(1:) W The maximum reconnection wait interval, in seconds. 30720 2.13
ResponseInformation string(:65535) R The value of the CONNACK Response Information property supplied by a MQTT 5.0 server. This value is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If the value of ResponseInformation is not a subset (wildcarded or precise match) of any of the Subscription.{i}.Topic values the MQTT client MUST subscribe to this Topic. - 2.13
UserPropertyNumberOfEntries unsignedInt R The number of entries in the UserProperty table. - 2.13
Device.MQTT.Client.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled by the MQTT client. The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter Enable is set to true, when it establishes a new connection to the MQTT broker. Disabled subscription instances with Enable set to false will be ignored during connection establishment.

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

 - 2.10
Enable boolean W Setting Enable to true means the topic is subscribed at the MQTT broker withWhen a MQTT SUBSCRIBEclient message, setting itconnects to false will unsubscribe the topic from the MQTT broker with a MQTT UNSUBSCRIBEserver, message.it MUST send a SUBSCRIBE message including all instances with Enable set to true. If the MQTT client is already connected with the BrokerMQTT server (Status is Connected), thea MQTT SUBSCRIBE or UNSUBSCRIBE message isMUST be sent directly,directly otherwisewhen itEnable is sentchanged afterto thetrue nextor successfulfalse, connect.respectively. The actual status of the subscription is indicated with Status. - 2.10
Status string R

Indicates the status of this subscription. Enumeration of:

  • Unsubscribed
  • Subscribed
  • Subscribing (OPTIONAL)
  • Unsubscribing (OPTIONAL)
  • Error The Subscribed value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server. The Subscribing value MAY be used by the CPE to indicate that the a SUBSCRIBE message for this topic was sent, and the CPE is waiting for a SUBACK message. The Unsubscribed value indicates that the topic is not reqisteredregistered with the MQTT broker. The Unsubscribing value MAY be used by the CPE to indicate that the an UNSUBSCRIBE message for this topic was sent, and the CPE is waiting for an UNSUBACK message. If the Enable is set to false the status MUST be either Unsubscribed or if the unsubscription failed Error.
 - 2.10
Topic string(:65535) W

Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in [section Appendix A/MQTT31] and, {{bibref: non-existent {{replaced: unexpected argument section 4.7 after: MQTT311, MQTT31}} or [MQTT50]}}.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.10
QoS unsignedInt(0:2) W The MQTT QoS level assigned with the subscription (see [section 4.1/MQTT31] and, {{bibref: non-existent {{replaced: unexpected argument section 4.3 after: MQTT311, MQTT31}}) or [MQTT50]}}).. - 2.10
Device.MQTT.Client.{i}.UserProperty.{i}. object(0:) W

List of user properties used by the MQTT client. This table only applies if ProtocolVersion is set to 5.0.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.13
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

 - 2.13
Enable boolean W Setting Enable to true means the user property is used in the indicated control packet(s). The user property will be applied to all control packets of the same control packet type (e.g PUBLISH). - 2.13
Name string(:65535) W

Name of the user property

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.13
Value string(:65535) W Value of the user property - 2.13
PacketType string[] W

Comma-separated list of strings. Each entry defines the control packet type(s) in which the user property is included.

Each list item is an enumeration of:

 - 2.13
Device.MQTT.Broker.{i}. object(0:) W

MQTT broker table. Contains a list of configured MQTT brokers.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.10
Username string(:256) W UsernameUser name used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is an empty string no authentication is used. - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object(0:) W

Configures MQTT bridges, which are used to communicate with other MQTT brokers.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.10
CleanSession boolean W The value of the MQTT clean session flag in the MQTT bridgeCONNECT connectionpacket (see [section 3.1/MQTT31] and {{bibref: non-existent MQTT31}}).) to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. AA change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. change of thisThis parameter only applies if ProtocolVersion is only effective after the next MQTT CONNECT messageset to the3.1 remoteor MQTT broker. If the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.3.1.1. true 2.10
CleanStart boolean W The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50] to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.. This parameter only applies if ProtocolVersion is set to 5.0. true 2.13
KeepAliveTime unsignedInt(:65535) W Keep Alive Time in seconds defines the maximum wait time after which a messagepacket has to be sent to the remote MQTT broker (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). If no regular messagespacket can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive messagepackets are sent and the bridge is not disconnected by the server. A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed. 60 2.10
ClientID string(0:65535) W The MQTT client identifier used in the CONNECT messagepacket (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). ThisIf ProtocolVersion is set to 3.1 or 3.1.1, this parameter MUST NOT be an empty string,an theempty CPEstring. hasIf ProtocolVersion is set to provide5.0, aan defaultempty value for the parameter, which may be changed by the ACS. A change of this parameterstring is onlyallowed. communicated to the remote MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command {{param: non-existent ForceReconnect}} has to be executed.

Changes in 2.13:

  • Changed 0:65535 size minLength = 1 ⇒ 0
  • Changed 0:65535 size maxLength = 23 ⇒ 65535
 - 2.10
Username string(:256) W UsernameUser name used to authenticate the MQTT broker when making a connection over the MQTT bridgebridge. The value is sent in the MQTT CONNECT packet (see [section 3.1/MQTT31] and [Section 3.1.3.4/MQTT311])., [[section 3.1.3.4 or [Section 3.1.3.5/MQTT50]). For MQTT 3.1 [Section /MQTT31]3.1/MQTT31](#R.MQTT31)] recommends that the usernameuser name has 12 characters or fewer, but this is not required. If this parameter is an empty string no authentication parameters are sent in the MQTT CONNECT message.packet. - 2.10
Password string(:256) W

Password used to authenticate the MQTT broker when making a connection over the MQTT bridgebridge. The value is sent in the MQTT CONNECT packet (see [section 3.1/MQTT31] and, {{bibref: non-existent MQTT31}}). TheThis password is only sent in the MQTT CONNECT packet if Username is not an empty string.

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

 - 2.10
MessageRetryTime unsignedInt(1:) W Message retry time in seconds defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see [section 4.2/MQTT31]. andThis {{replaced: unexpected argument [replaced(4.4}})., ##.Capabilities.ProtocolVersionsSupported), ‘.’] after: {{bibref|MQTT311, [’parameter only applies if ’, param(ProtocolVersion), ’ is set to ’, enum(3.1)]}} 5 2.10
ConnectRetryTime unsignedInt(1:) W Connect retry time in seconds defines the wait time before a failed bridge connection is retried. A failure can either be on the connection level (e.g. the TCP/IP or TLS conectionconnection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK messagepacket on a MQTT CONNECT messagepacket sent. 30 2.10
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled over the bridge.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Topic and Direction. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Topic and Direction such that the new entry does not conflict with any existing entries.

 - 2.10
Status string R

Indicates the status of this subscription. Enumeration of:

  • Enabled
  • Disabled
  • Error The Enabled value indicates that the this subscription is active. In case of incoming directions (Direction is either in or both) the topic was successfully subscribed with the remote MQTT broker. The Disabled value indicates that this subscription is not used. The Error value indicates that an error occuredoccurred (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use.
 - 2.10
Topic string(:65535) W

Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in [section Appendix A/MQTT31] and, {{bibref: non-existent {{replaced: unexpected argument section 4.7 after: MQTT311, MQTT31}} or [MQTT50]}}.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Direction) doesn’t conflict with any existing entries.

 - 2.10
QoS unsignedInt(0:2) W The MQTT QoS level assigned with the subscription (see [section 4.1/MQTT31] and, {{bibref: non-existent {{replaced: unexpected argument section 4.3 after: MQTT311, MQTT31}}) or [MQTT50]}}).. - 2.10
LocalPrefix string(:256) W

The local prefix is used for remapping received topics to the local topics of the MQTT broker and to select the topics to be sent over bridge to the remote MQTT broker.

For remote topics received over the bridge the MQTT broker adds the LocalPrefix in front of the received topic, before processing it.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, Direction is “in”
MQTT broker receives message with topic “/bus/tr181” over bridge => MQTT broker uses topic “/local/bus/tr181” for internal processing
For selection of the topics to be sent over the bridge the MQTT broker uses the combination of LocalPrefix and Topic to match the topics to be sent over bridge, and removes the LocalPrefix from the selected topic before sending it over the bridge.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, Direction is “out”
MQTT broker receives message with topic “/local/bus/tr181” from a MQTT client => MQTT broker sends topic “/bus/tr181” to remote MQTT broker

Changes in 2.13:

  • Added string :256 size
 - 2.10
RemotePrefix string(:256) W

The remote prefix is used for remapping topics to the remote MQTT broker topic lists.

For remote topics received over the bridge the MQTT broker removes the remote prefix topic from the received topic (before handling the LocalPrefix), before processing it.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, RemotePrefix is “/remote”, Direction is “in”
MQTT broker receives message with topic “/remote/bus/tr181” over bridge => MQTT broker uses topic “/local/bus/tr181” for internal processing
During activation of the bridge, the MQTT broker prepends the Topic with RemotePrefix topic and subscribes to the remote MQTT broker with it, in order to receive all applicable remote topics.
Example:
Topic is “/bus/+”, RemotePrefix is “/remote”, Direction is “in”
MQTT broker sends a subscription to the remote MQTT broker with the topic “/remote/bus/+”.
For all topics to be sent over the bridge (Direction is either out or both), the RemotePrefix will be prepended to the topic after the LocalPrefix has been processed and before sending the message over the bridge.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, RemotePrefix is “/remote” Direction is “out”
MQTT broker receives message with topic “/local/bus/tr181” from a MQTT client => MQTT broker sends topic “/remote/bus/tr181” to remote MQTT broker

Changes in 2.13:

  • Added string :256 size
 - 2.10
Device.LocalAgent. object R This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the DeviceInfo object. NOTE: The Vendor Log File table (DeviceInfo.VendorLogFile) details are located on the DeviceInfo object.

Changes in 2.13:

 - 2.12
AddCertificate() command - This command is issued to allow a Controller (with the proper permissions) to add a new certificate to Certificate.{i}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in Controller.{i}.Credential or ControllerTrust.Credential.{i}.Credential that references the new Certificate.{i} entry. The Agent will use the Serial Number and Issuer fields from the input Certificate to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Certificate string(:65535) W [MANDATORY] The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) [RFC7468] format. - 2.12
SupportedProtocols string[1:] R

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

Each list item is an enumeration of:

Changes in 2.13:

  • Added string MQTT enumeration
 - 2.12
SupportedThresholdOperator string[] R

Comma-separated list of strings, each entry is a threshold operation for Threshold.{i}.ThresholdOperator supported by the Agent.

Each list item is an enumeration of:

 - 2.13
ThresholdNumberOfEntries unsignedInt R The number of entries in the Threshold table. - 2.13
Device.LocalAgent.MTP.{i}. object(0:) W

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

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.12
Device.LocalAgent.MTP.{i}.MQTT. object R If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how the Agent communicates with the MQTT broker. - 2.13
Reference string W The value MUST be the Path Name of a row in the MQTT.Client. table. A reference to the MQTT Client used by this Agent when communicating via the MQTT MTP. <Empty> 2.13
ResponseTopicConfigured string(:65535) W The Agent’s configured “reply to” topic. When MQTT 5.0 is being used, this value is put in the PUBLISH Response Topic property for all PUBLISH packets with a USP Record, if no Response Information (value recorded in ResponseTopicDiscovered) is included in the CONNACK. When MQTT 3.1.1 is being used, this value is put at the end of the PUBLISH Topic Name property (as specified in [Section “MQTT Binding”/TR-369]. If the value of ResponseTopicConfigured is not a subset (wildcarded or precise match) of any of the Reference MQTT.Client.{i}.Subscription.{i}.Topic values the Agent MUST subscribe to this Topic. The value MUST NOT contain any wild card characters (“+”, “#”). - 2.13
ResponseTopicDiscovered string(:65535) R Duplicate of Reference MQTT.Client.{i}.ResponseInformation. This is the value of the CONNACK Response Information property supplied by a MQTT 5.0 server and is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If a value is received from the MQTT 5.0 server, it will be used instead of any value configured in ResponseTopicConfigured. - 2.13
PublishQoS unsignedInt(0:2) W The Agent MUST use this QoS value when sending a USP Record on this MTP. If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server. - 2.13
Device.LocalAgent.Threshold.{i}. object(0:) W

Each instance of this table represents a Threshold Event that is triggered by a threshold test.

For example:

ReferencePath: Device.Ethernet.[Enable==1].Stats. ThresholdParam: BytesSent ThresholdOperator: Rise ThresholdValue: 100000

Would trigger a Triggered! Event whenever a value of a parameter matching Device.Ethernet.[Enable==1].Stats.BytesSent rises from below to above 100000.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.13
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.13
Enable boolean W Enable/Disable this Threshold instance. If the Threshold instance is disabled, the Triggered! Event will not be invoked, even if there is a LocalAgent.Subscription.{i}. instance that references it false 2.13
OperatingMode string W

Determines whether to disable this Threshold instance after the Triggered! Event has been invoked.

Enumeration of:

  • Normal (The Threshold will generate events as long as the Enable is true)
  • Single (After invoking the Triggered! Event, the Enable parameter will be automatically set to false)
 Normal 2.13
ReferencePath string W The combination of ReferencePath and ThresholdParam create the reference to the parameter being checked for the threshold test. ReferencePath can be either an Object Path or a Search Path. - 2.13
ThresholdParam string W The combination of ReferencePath and ThresholdParam create the reference to the parameter being checked for the threshold test. ThresholdParam is the name of the Parameter in the context of ReferencePath. - 2.13
ThresholdOperator string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedThresholdOperator parameter. The operator used for the threshold test. Rise 2.13
ThresholdValue string W The Value used for the threshold test. - 2.13
Triggered! event - Triggered event requested via a Threshold object. When any of the Threshold.{i}.ThresholdParams that are in the Threshold.{i}.ReferencePath change and the threshold test conditation changes from false to true, the Triggered Event will be invoked. The Triggered Event will only be eligible for retriggering if the test condition is fulfilled again. - 2.13
⇒ ParamPath string R The parameter (LocalAgent.Threshold.{i}.ReferencePath and LocalAgent.Threshold.{i}.ThresholdParam) for which the threshold has been triggered. - 2.13
⇒ ParamValue string R The new (LocalAgent.Threshold.{i}.ReferencePath and LocalAgent.Threshold.{i}.ThresholdParam) Value. - 2.13
Device.LocalAgent.Controller.{i}. object(0:) W

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

At most one entry in this table can exist with a given value for EndpointID, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enable/Disable this Controller instance. If the Controller instance is to be disabled, the USP Endpoint MUST terminate the MTP connection. When false, messages (notifications) are not sent to the remote endpoint represented by this Controller instance.instance, and any MTP session establishment are refused. false 2.12
PeriodicNotifTime dateTime W If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the PeriodicNotifInterval. PeriodicNotifTime is used only to set the phase of the Periodic Event Notifications. The actual value of PeriodicNotifTime can be arbitrarily far into the past or future. For example, if PeriodicNotifInterval is 86400 (a day) and if PeriodicNotifTime is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicNotifTime refers to a day in the future. The Unknown Time value defined in {{bibref: non-existent TR-106}} indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified PeriodicNotifInterval. If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the PeriodicNotifTime parameter was set to the Unknown Time value. - 2.12
AddMyCertificate() command - This command is issued to allow a Controller to add a new certificate for itself. This can be useful when the current certificate is expiring or has become compromised. This command creates a new entry in Certificate and adds a reference to the new entry to the Controller’s Controller.{i}.Credential. The Agent will use the Serial Number and Issuer fields from the input Certificate to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Certificate string(:65535) W [MANDATORY] The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) [RFC7468] format. - 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}. object(0:) W

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

At most one entry in this table can exist with a given value for Alias, or with a given value for Protocol. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.13:

 - 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.MQTT. object R If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker. - 2.13
Reference string W The value MUST be the Path Name of a row in the MQTT.Client. table. A reference to the MQTT Client used by this Controller when communicating via the MQTT MTP. <Empty> 2.13
Topic string(:65535) W The topic name the USP Controller has subscribed to, to be used for Notify messages send by the USP Agent. - 2.13
Device.LocalAgent.Subscription.{i}. object(0:) W

A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Recipient and ID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Recipient such that the new entry does not conflict with any existing entries.

 - 2.12
ReferenceList string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each entry in the list is a parameter pathPath Name, Search Path, Command reference, or Event reference that determines the elementelement(s) of the data model that the Subscription is applicable to. Different values of the NotifType parameter will cause the Subscription to interact with ReferenceList differently. For example, an instance of Subscription with ValueChange will utilize the value of this parameter differently than an instance with Event. Expressions areOnce the value of the ReferenceList is written, the value cannot be changed as the Subscription instance is considered to be immutable. If the value of a non-empty ReferenceList parameter needs to change, the Subscription instance MUST be deleted and a new Subscription instance created. The following bullet points describe what is allowed as a value of ReferenceList based on the different values of the NotifType parameter: * ValueChange: may be either a Path Name or Search Path; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported parameters in the list items, butall objects below this point will be relevant for the subscription. * ObjectCreation: may be either a Path Name or Search Path as long as it only refers to a Multi-Instance Object; only the referenced Multi-Instance Objects will be relevant for the subscription. * ObjectDeletion: may be either a Path Name or Search Path as long as it only refers to instances of a Multi-Instance Object; only the referenced instances (wildcard references all instances over time) of the Multi-Instance Objects will be relevant for the subscription. * OperationComplete: may be either a Path Name, Search Path, or Command reference; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported data model commands in some cases could cause a dynamic set of instances to be monitoredall objects below this point will be relevant for the subscription. * Event: may be either a Path Name, Search Path, or Event reference; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported Events in order to fulfill the Subscription’s requirements. Once the value of the ReferenceList is written, the value cannot be changed as the Subscription instance is considered to be immutable. If the value of a non-empty ReferenceList parameter needs to change, the Subscription instance MUST be deleted and a new Subscription instance created.all objects below this point will be relevant for the subscription. - 2.13
Device.LocalAgent.ControllerTrust. object R This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.12
Device.LocalAgent.ControllerTrust.Role.{i}. object(0:) W

Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model. If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.

At most one entry in this table 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.12
Device.LocalAgent.ControllerTrust.Role.{i}.Permission.{i}. object(0:) W

Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role. If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others.

At most one entry in this table can exist with a given value for Alias, or with a given value for Order. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
InstantiatedObj string(4) W The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (“r” for Read, “w” for Write, “x” for Execute“, and “n” for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a “-” character (e.g., r–n). The following describes the meaning of the permissions for Instantiated Object type of Targets: 1. Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances.GetInstances and read the value of Parameters related to the Instantiated Object via a Get containing a search expression or wildcard in place of the instance identifier. 1. Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.). 1. Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions. 1. Notify: Grants the capability to use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription. ---- 2.12
Device.STOMP. object R The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.12
Device.STOMP.Connection.{i}. object(0:) W

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

At most one entry in this table can exist with the same values for all of Host, Username and VirtualHost, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Host, Username and Alias such that the new entry does not conflict with any existing entries.

 - 2.12
ServerRetryIntervalMultiplier unsignedInt(1000:65535) W The reconnection interval multiplier as specified in [TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1). The server retry mechanism reaches its upper limit at 10 reconnection attempts. Meaning, that if the number of reconnection attempts exceeds 10, then the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (10 - 1). 2000 2.12
Device.SoftwareModules. object R Top level object for dynamically managed software applications. - 2.1
InstallDU() command - [ASYNC] Install one or more Deployment Units (DUs) to the associated SoftwareModules. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ UUID string(36) W [UUID] The UUID (see [RFC4122]) of the DU to be installed. If this parameter is an empty string the device MUST generate the UUID based on the rules defined in [RFC4122] and {{bibref: non-existent TR-181i2}}. - 2.12
Device.SoftwareModules.DeploymentUnit.{i}. object(0:) R

This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit. A new instance of this table gets created during the installation of a Software Module.

At most one entry in this table can exist with the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias.

 - 2.1
UUID string(:36) R A Universally Unique Identifier either provided by the Controller, or generated by the device, at the time of Deployment Unit Installation. The format of this value is defined by [RFC4122] Version 5 (Name-Based) and {{bibref: non-existent TR-181i2}}. This value MUST NOT be altered when the DeploymentUnit is updated. - 2.1
Name string(:64) R Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit. The value of this parameter is used in the generation of the UUID based on the rules defined in {{bibref: non-existent TR-181i2}}. - 2.1
Vendor string(:128) R The author of this DeploymentUnit formatted as a domain name. The value of this parameter is used in the generation of the UUID based on the rules defined in {{bibref: non-existent TR-181i2}}. - 2.1
Device.SoftwareModules.ExecutionUnit.{i}. object(0:) R

This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

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

 - 2.1
ExecutionFaultCode string R

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter embodies the problem. The value of NoFault MUST be used when everything is working as intended. Enumeration of:

  • NoFault
  • FailureOnStart
  • FailureOnAutoStart
  • FailureOnStop
  • FailureWhileActive
  • DependencyFailure
  • UnStartable For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref: non-existent TR-106}}.
 - 2.1
SetRequestedState() command - Set the state transition that the Controller is requesting for this instance of the ExecutionUnit object. {{enum: empty param arg only valid in parameter descriptions}} If this instance of the ExecutionUnit object is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a error message MUST be generated. - 2.1
Device.ProxiedDevice.{i}. object(0:) R

Each entry in the table is a ProxiedDevice object that is a mount point. Each ProxiedDevice represents distinct hardware Devices. ProxiedDevice objects are virtual and abstracted representation of functionality, that exists on hardware other than that which the Agent is running.

This object is a mount point, under which mountable objects can be mounted.

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

Changes in 2.13:

 - 2.12
Type string R

[IoTDeviceType] Describes the type of Device that the ProxiedDevice instance is representing. Enumeration of:

  • Alarm
  • AntiTheft
  • Bell
  • Clock
  • Door
  • Fan
  • GarageDoor
  • HVAC
  • Light
  • Lock
  • Meter
  • Motor
  • Oven
  • PowerStrip
  • Sensor
  • SensorStrip
  • Siren
  • Thermostat
 - 2.13
Description string(:256) R Human-readable description of the ProxiedDevice. e.g. a more detailed description of Type. - 2.13
Name string(:64) W A textual name of the instance, which can be assigned by the user. ProxiedDevice. - 2.13
Online boolean R This parameter provides the state of the ProxiedDevice on the underlying (proxied) connected network. - 2.13
LastTimeContacted dateTime R The date time of the last successful contact. - 2.13
InterfaceReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol.. - 2.13
ProxyProtocol string R

The protocol being used to communicate between the Agent and this Proxied Device. Enumeration of:

  • Z-Wave (see [Z-Wave])
  • ZigBee (see [ZigBee])
  • UPnP-DM (see [UPnP-DM:1]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.
 - 2.13
NodeNumberOfEntries unsignedInt R The number of entries in the Node table. - 2.13
Device.ProxiedDevice.{i}.Node.{i}. object(0:) R

Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality.

This object is a mount point, under which mountable objects can be mounted.

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

 - 2.13
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.13
Type string R

[IoTDeviceType] Describes the type of Device that the Node instance is representing. Enumeration of:

  • Alarm
  • AntiTheft
  • Bell
  • Clock
  • Door
  • Fan
  • GarageDoor
  • HVAC
  • Light
  • Lock
  • Meter
  • Motor
  • Oven
  • PowerStrip
  • Sensor
  • SensorStrip
  • Siren
  • Thermostat
 - 2.13
Description string(:256) R Human-readable description of the Node. e.g. a more detailed description of Type. - 2.13
Device.IoTCapability.{i}. object(0:) R

This list of IoT capability objects.

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

 - 2.13
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.13
Name string(:64) W

A textual name of the instance, which can be assigned by the user.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.13
Class string R

Describes the type of functionality that IoTCapability is representing. Depending on the functionality the corresponding sub-object is instantiated. Note: Only one of the defined sub-objects can exist in an IoTCapability instance.

Enumeration of:

  • BinaryControl
  • LevelControl
  • EnumControl
  • BinarySensor
  • LevelSensor
  • MultiLevelSensor
  • EnumSensor
 - 2.13
Device.IoTCapability.{i}.BinaryControl. object R This capability provides a boolean function that is mapped to the type of function it represents. E.g. If the instance represents a door lock (Type is Locked), a Value of true says the door lock is locked. - 2.13
Type string R

Describes the type of functionality that BinaryControl is representing.

Enumeration of:

  • Switch
  • Locked
 - 2.13
Description string(:256) R Human-readable description of the BinaryControl. e.g. a more detailed description of Type. - 2.13
Value boolean W Value of true or false that reflects the functionality. - 2.13
Toggle() command - [ASYNC] Toggle the Value. - 2.13
Device.IoTCapability.{i}.LevelControl. object R LevelController is used to model a control with a range of continuous states. These values are configurable via Value and measured in Unit and are restricted between a Min and Max values. Intensity profile - Value of intensity and ability to update that level through {{param: non-existent StepUp}} and {{param: non-existent StepDown}} commands with a configurable StepValue. - 2.13
Type string R

[IoTLevelType] Describes the type of IoT Level Controller or Sensor that the LevelControl instance is representing. Enumeration of:

  • Acceleration
  • Area
  • Battery
  • Brightness
  • Concentration
  • Conductivity
  • Distance
  • Energy
  • Flow
  • Humidity
  • Intensity
  • Luminance
  • Meter
  • Motion
  • Position
  • Power
  • Pressure
  • Radiation
  • Speed
  • Temperature
  • Volume (Amount of space that an object or substance occupies)
  • Weight
 - 2.13
Description string(:256) R Human-readable description of the LevelControl. e.g. a more detailed description of Type. - 2.13
Value decimal W The desired run value that this LevelControl will be between MinValue and MaxValue. - 2.13
Unit string R

Units in which Value, Value, MinValue, MaxValue and StepValue are expressed. [IoTUnitType] Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI]) .
 - 2.13
MinValue decimal R Minimum allowed value for Value. - 2.13
MaxValue decimal R Maximum allowed value for Value. - 2.13
StepValue decimal W Number of Unit changes of each {{param: non-existent StepUp}} and {{param: non-existent StepDown}} command. - 2.13
StepUp() command - [ASYNC] Step Up the Value. - 2.13
StepDown() command - [ASYNC] Step Down the Value. - 2.13
Device.IoTCapability.{i}.EnumControl. object R The EnumControl reflects the Enumerated level Control functionality. The enumeration is defined by the ValidValues parameter. This will provide a comma-separated list of values that are available for configuring via the Value parameter. - 2.13
Type string R

[IoTEnumControlType] Describes the type of IoT Enum Controller that the EnumControl instance is representing. Enumeration of:

  • AlarmMode
  • DoorMode
  • FanMode
  • LockMode
  • OperatingMode
  • TemperatureMode
  • ThermostatMode
 - 2.13
Description string(:256) R Human-readable description of the EnumControl. e.g. a more detailed description of Type. - 2.13
Value string W Current value representing the EnumControl; MUST be an element of ValidValues. - 2.13
ValidValues string(:64)[] R Comma-separated list of strings (maximum number of characters per item 64). List of valid values from the control represented by the EnumControl. - 2.13
StepUp() command - [ASYNC] Step up the Value to the next allowed value in the enum. - 2.13
StepDown() command - [ASYNC] Step down the Value to the previous allowed value in the enum. - 2.13
Device.IoTCapability.{i}.BinarySensor. object R BinarySensor is used to reflect the functionality of a sensor that reports a Value. The Sensitivity configures the degree of sensitivity that the sensor uses for detection. Timed BinarySensor profile - To provide the ability to add time based control over the Value attribute. How long the Value remains true is controlled by the HoldTime. RestTime controls how soon, after being activated, the sensor will respond to continuous events. - 2.13
Type string R

Describes the type of functionality that BinarySensor is representing.

Enumeration of:

  • CarbonDioxideDetected
  • CarbonMonoxideDetected
  • DoorOpen
  • MotionDetected
  • SmokeDetected
  • WindowOpen
  • WaterDetected
 - 2.13
Description string(:256) R Human-readable description of the BinarySensor. e.g. a more detailed description of Type. - 2.13
Value boolean R If the BinarySensor has been recently activated, the value would be true. For how long the state attribute remain true after being activated depends on the underlying sensor reports. - 2.13
LastChange dateTime R The date and time in UTC when Value has been changed to the current value. - 2.13
Sensitivity unsignedInt(:100) W A 0 to 100 value indicating how reactive to changes the BinarySensor should be, 0 being not sensible / disabled and 100 max sensitivity. - 2.13
HoldTime unsignedInt W After activation has been detected and the sensing attribute set to true, how soon, in milliseconds should the Value be reset to false. - 2.13
RestTime unsignedInt W After activation has been detected and the Value set to true, how soon, in milliseconds should affected again per subsequent event. - 2.13
Device.IoTCapability.{i}.LevelSensor. object R LevelSensor is used to reflect the functionality of a sensor that reports a Value in Unit. - 2.13
Type string R

[IoTLevelType] Describes the type of IoT Level Controller or Sensor that the LevelSensor instance is representing. Enumeration of:

  • Acceleration
  • Area
  • Battery
  • Brightness
  • Concentration
  • Conductivity
  • Distance
  • Energy
  • Flow
  • Humidity
  • Intensity
  • Luminance
  • Meter
  • Motion
  • Position
  • Power
  • Pressure
  • Radiation
  • Speed
  • Temperature
  • Volume (Amount of space that an object or substance occupies)
  • Weight
 - 2.13
Description string(:256) R Human-readable description of the LevelSensor. e.g. a more detailed description of Type. - 2.13
Value decimal R The current value reading of this LevelSensor in units defined in Unit. - 2.13
LastChange dateTime R The date and time in UTC when Value has been changed to the current value. - 2.13
Unit string R

[IoTUnitType] Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI]) Unit in which Value is expressed.
 - 2.13
LowLevel boolean R Low level indicator. Is set to true if Value is equal or less than the value defined in LowLevelThreshold. - 2.13
LowLevelThreshold decimal W The threshold value in for LowLevel expressed in the same units like Value. - 2.13
HighLevel boolean R High level indicator. Is set to true if Value is equal or higher than the value defined in HighLevelThreshold. - 2.13
HighLevelThreshold decimal W The threshold value in for HighLevel expressed in the same units like Value. - 2.13
Device.IoTCapability.{i}.MultiLevelSensor. object R MultiLevelSensor is used to reflect the functionality of a sensor that reports multiple Values with the same Unit. - 2.13
Type string R

Describes the type of functionality that MultiLevelSensor is representing.

Enumeration of:

  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • Location (The sensor reports a location with the values of Longitude, Latitude, Altitude as decimal values in km)
 - 2.13
Description string(:256) R Human-readable description of the MultiLevelSensor. e.g. a more detailed description of Type. - 2.13
Values decimal[2:]() R Comma-separated list (at least 2 items) (length ) of decimals. The current value reading of this MultiLevelSensor in units defined in Unit. - 2.13
ValueNames string[2:]() R Comma-separated list (at least 2 items) (length ) of strings. The names of the values expressed in Values. - 2.13
LastChange dateTime R The date and time when Values has been changed to the current values. - 2.13
Unit string R

[IoTUnitType] Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI]) Unit in which Values are expressed.
 - 2.13
Device.IoTCapability.{i}.EnumSensor. object R EnumSensor is used to reflect the functionality of a sensor that reports explicit non-continuous values. - 2.13
Type string R

[IoTEnumSensorType] Describes the type of IoT Enum Sensor that the EnumSensor instance is representing. Enumeration of:

  • AlarmState
  • DoorState
  • FanState
  • LockState
  • OperatingState
  • TemperatureState
  • ThermostatFanState
 - 2.13
Description string(:256) R Human-readable description of the EnumSensor. e.g. a more detailed description of Type. - 2.13
Value string R The actual reading value; MUST be a member of the enumeration defined in ValidValues. - 2.13
LastChange dateTime R The date and time when Value has been changed to the current value. - 2.13
ValidValues string(:64)[] R Comma-separated list of strings (maximum number of characters per item 64). List of valid values reported from the sensor represented by this EnumSensor. - 2.13
Device.Node.{i}. object(0:) R

Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality.

This object is a mount point, under which mountable objects can be mounted.

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

 - 2.13
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.13
Type string R

[IoTDeviceType] Describes the type of Device that the Node instance is representing. Enumeration of:

  • Alarm
  • AntiTheft
  • Bell
  • Clock
  • Door
  • Fan
  • GarageDoor
  • HVAC
  • Light
  • Lock
  • Meter
  • Motor
  • Oven
  • PowerStrip
  • Sensor
  • SensorStrip
  • Siren
  • Thermostat
 - 2.13
Description string(:256) R Human-readable description of the Node. e.g. a more detailed description of Type. - 2.13

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 09:57:14 UTC.
report.py –include ../../install/cwmp –output –transform diff –format markdown tr-181-2-12-0-usp.xml tr-181-2-13-0-usp.xml

Table of Contents