Broadband Forum

    DATA MODEL DEFINITION


USP Device:2.12 Root Object definition
tr-181-2-12-0-usp.xml (changes)

License

Copyright (c) 2010-2018, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
Copyright (c) 2017-2018 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.

Summary

Table of Contents

Data Types

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

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

Data Type Base Type Description
Alias string(64)

A non-volatile 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.

The value MUST NOT change once it's been assigned.

Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

The IEEE EUI 64-bit identifier as defined in [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

  • The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
  • The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.

Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){7}([0-9A-Fa-f][0-9A-Fa-f])
IPAddress string(45)

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

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

IPv6Address IPAddress(45)

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

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

MACAddress string(17)

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

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

Comma-separated list (2 items) of unsigned integers.

  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz.

Both values are represented as unsignedInt.

[Clause 5.2/G.9964] defines limits on PSM breakpoint levels.

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.

UUID string(36: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}
ZigBeeNetworkAddress string(4)

The ZigBee 16-bit network address (NWK) as defined in [ZigBee2007]. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f]){4}
base64 -

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

References

[3GPP-HSPA] High Speed Packet data Access (HSPA), 3GPP.
[3GPP-TS.25.171] 3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4.
[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[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, IEEE.
[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.11h-2003] IEEE Std 802.11h-2003, Spectrum and Transmit Power Management Extensions, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1AB-2009] IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1AX-2014] IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks -- Link Aggregation, IEEE, 2014.
[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.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[802.3-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[BLUE] Blue, A New Class of Active Queue Management Algorithms.
[DLNA-NDIG] DLNA Networked Device Interoperability Guidelines, DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles., DLNA, October 2006.
[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[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.
[ETSIBRAN] ETSI EN 301 893, Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN; Harmonized EN covering the essential requirements of article 3.2 of the RTTE Directive, ETSI.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[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.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug AV Specification, Version 1.1, HomePlug, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANAifType] IANAifType, IANAifType-MIB DEFINITIONS, IANA, 2009.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[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.
[IKEv2-params] IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IETF.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[IPDR-XDR] IPDR XDR Encoding Format, IPDR/XDR Encoding Format, TM Forum.
[IPDR-XML] IPDR XML File Encoding Format, IPDR/XML File Encoding Format, TM Forum.
[ISO3166-1] ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006.
[ISO639-1] ISO 639-1, Codes for the representation of names of Languages - Part 1: Alpha-2 code, ISO, 2002.
[ISO646-1991] ISO/IEC 646-1991, Information Technology - ISO 7-bit coded character set for information interchange, ISO, 1991.
[ITU-E.118] ITU E.118, Overall Network Operation, Telephone Service, Service Operation and Human Factors, International Telecommunication Union, May 2006.
[ITU-E.164] ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010.
[ITU-X.733] ITU X.733, Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function, International Telecommunication Union, February 1992.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[JJ-300.01] JJ-300.01, The List of Device Categories, TTC, 2011.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[LMAPREG] draft-ietf-ippm-metric-registry-12, Registry for Performance Metrics, IETF, June 30, 2017.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MoCAv1.0] MoCA v1.0, MoCA MAC/PHY Specification v1.0, MoCA Alliance, 2009.
[MoCAv1.1] MoCA v1.1, MoCA MAC/PHY Specification v1.1 Extensions, MoCA Alliance, 2009.
[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.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] PCP Proxy Function, Port Control Protocol (PCP) Proxy Function, IETF, January 2014.
[RED] References on RED (Random Early Detection) Queue Management.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1378] RFC 1378, The PPP AppleTalk Control Protocol (ATCP), IETF, 1992.
[RFC1552] RFC 1552, The PPP Internetwork Packet Exchange Control Protocol (IPXCP), IETF, 1993.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC1974] RFC 1974, PPP Stac LZS Compression Protocol, IETF, 1996.
[RFC2080] RFC 2080, RIPng for IPv6, IETF, 1997.
[RFC2097] RFC 2097, The PPP NetBIOS Frames Control Protocol (NBFCP), IETF, 1997.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2225] RFC 2225, Classical IP and ARP over ATM, IETF.
[RFC2364] RFC 2364, PPP Over AAL5, IETF, 1998.
[RFC2474] RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.
[RFC2581] RFC 2581, TCP Congestion Control, IETF, April 1999.
[RFC2582] RFC 2582, The NewReno Modification to TCP's Fast Recovery Algorithm, IETF, April 1999.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2684] RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, IETF.
[RFC2697] RFC 2697, A Single Rate Three Color Marker, IETF.
[RFC2698] RFC 2698, A Two Rate Three Color Marker, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2819] RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2866] RFC 2866, RADIUS Accounting, IETF, 2000.
[RFC2869] RFC 2869, RADIUS Extensions, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC2898] RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3232] RFC 3232, "Assigned Numbers: RFC 1700 is Replaced by an On-line Database", IETF, 2002.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3339] RFC 3339, Date and Time on the Internet: Timestamps, IETF, July, 2002.
[RFC3596] RFC 3596, DDNS Extensions to Support IP Version 6, IETF, 2003.
[RFC3633] RFC 3633, IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP) version 6, IETF, 2003.
[RFC3646] RFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3775] RFC 3775, Mobility Support in IPv6, IETF, 2004.
[RFC3925] RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF.
[RFC3927] RFC 3927, Dynamic Configuration of IPv4 Link-Local Addresses, IETF, 2005.
[RFC3931] RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), IETF, March 2005.
[RFC3948] RFC 3948, UDP Encapsulation of IPsec ESP Packets, IETF, January 2005.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, 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.
[RFC4191] RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4242] RFC 4242, Information Refresh Time Option for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), 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.
[RFC4389] RFC 4389, Neighbor Discovery Proxies (ND Proxy), IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4719] RFC 4719, Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3 (L2TPv3), IETF, November 2006.
[RFC4835] RFC 4835, Cryptographic Algorithm Implementation Requirements for Encapsulating Security Payload (ESP) and Authentication Header (AH), IETF, 2007.
[RFC4861] RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007.
[RFC4862] RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007.
[RFC5072] RFC 5072, IP Version 6 over PPP, IETF, 2007.
[RFC5139] RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008.
[RFC5280] RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 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.
[RFC6106] RFC 6106, IPv6 Router Advertisement Option for DNS Configuration, IETF, 2010.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC6970] RFC 6970, Universal Plug and Play (UPnP) Internet Gateway Device (IGD) - Port Control Protocol (PCP) Interworking Function, IETF, 2013.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[RFC7348] RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014.
[RFC7395] RFC 7395, An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for WebSocket, IETF, October 2014.
[RFC7398] RFC 7398, A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance, IETF, February 2015.
[RFC7594] RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 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.
[TR-064] TR-064, LAN-Side DSL CPE Configuration Specification, Broadband Forum, 2004.
[TR-069] TR-069, CPE WAN Management Protocol, Broadband Forum, 2004.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, 2007.
[TR-069a5] TR-069 Amendment 5, CPE WAN Management Protocol, Broadband Forum, December 2013.
[TR-098] TR-098, Internet Gateway Device Data Model for TR-069, Broadband Forum, 2005.
[TR-106] TR-106, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2005.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2008.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2010.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.
[TR-143] TR-143, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, 2008.
[TR-143a1] TR-143 Amendment 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, December 2014.
[TR-157] TR-157, Component Object for CWMP, Broadband Forum, March 2009.
[TR-157a10] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, 2015.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, 2008.
[TR-181i1] TR-181 Issue 1, Device Data Model for TR-069, Broadband Forum, 2010.
[TR-181i2] TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, 2011.
[TR-304] TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, March 2015.
[TR-390] WT-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, November 2016.
[TR-181i2a2] TR-181 Issue 2 Amendment 2, Device Data Model for TR-069, Broadband Forum, 2011.
[TR-181i2a5] TR-181 Issue 2 Amendment 5, Device Data Model for TR-069, Broadband Forum, 2012.
[TR-181i2a8] TR-181 Issue 2 Amendment 8, Device Data Model for TR-069, Broadband Forum, September 2014.
[UPA-PLC] Universal Powerline Association, UPA.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[UPnP-DAv11] UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 2008.
[UPnP-IGD:1] UPnP InternetGatewayDevice:1, InternetGatewayDevice:1 Device Template Version 1.01, UPnP, 2001.
[UPnP-IGD:2] UPnP InternetGatewayDevice:2, InternetGatewayDevice:2 Device Template Version 1.01, UPnP, 2010.
[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.
[WPS 2.0] WSC 2.0, Wi-Fi Simple Configuration Technical Specification Version 2.0.x , Wi-Fi Alliance.
[WPSv1.0] Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Device:2.12 Data Model (changes)

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

Name Type Write Description Object Default Version
Device. object - The top-level object for a Device. - 2.0
ProxiedDeviceNumberOfEntries unsignedInt - The number of entries in the ProxiedDevice table. - 2.12
Reboot() command - Reboot the entity associated with the containing Device. - 2.12
Boot! event - Boot event indicating that the Device was rebooted. - 2.12
⇒ CommandKey string - The command_key supplied when requesting the boot, or an empty string if the boot was not requested via a USP operation. - 2.12
⇒ Cause string -

The cause of the boot. Enumeration of:

- 2.12
⇒ FirmwareUpdated boolean - true if the firmware was updated as a result of the boot that caused this Event Notification; otherwise false. - 2.12
⇒ ParameterMap string -

Boot parameters configured via the recipient Controller's LocalAgent.Controller.{i}.BootParameter table.

Formatted as a A JSON Object as defined in [Section 4/RFC7159].

- 2.12
FactoryReset() command - Factory reset the entity associated with the containing Device. - 2.12
SelfTestDiagnostics() command - [ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 2.12
Device.DeviceInfo. object - This object contains general device information. - 2.0
CID string­(6:6) -

Company identifier assigned and registered by the IEEE Registration Authority to the entity responsible for this Agent. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

- 2.12
PEN string­(10) -

Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assinged number.

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

- 2.12
FriendlyName string­(32) W

The friendly name of the device.

In [TR-369] the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of [TR-369].

- 2.12
ActiveFirmwareImage string - A full path reference to the row in the FirmwareImage table representing the currently running firmware image. - 2.12
BootFirmwareImage string W

A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots.

This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to 'true'). Out of the factory, this parameter should be set to point to the firmware image the CPE will attempt to boot when first powered on.

The firmware image instance referenced by this parameter must also have an Available parameter value of 'true'. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPE responding with a CWMP fault (9007).

In situations where the CPE cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPE MUST NOT modify this value to point to the alternate firmware image that is currently active.

- 2.12
FirmwareImageNumberOfEntries unsignedInt - The number of entries in the FirmwareImage table. - 2.12
Device.DeviceInfo.VendorConfigFile.{i}. object -

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 ACS 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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Backup() command -

[ASYNC] This command is issued to upload the configuration file specified by this VendorConfigFile instance.

All results of the actual upload will be contained within the Device.LocalAgent.TransferComplete! event.

- 2.12
Restore() command -

[ASYNC] This command is issued to download a configuration file into this VendorConfigFile instance.

All results of the actual download will be contained within the Device.LocalAgent.TransferComplete! event.

- 2.12
Device.DeviceInfo.TemperatureStatus. object - Status of the temperature of the device. - 2.0
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object -

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Reset() command - Resets the temperature sensor. - 2.12
Device.DeviceInfo.VendorLogFile.{i}. object -

Each table entry represents a Vendor Log File.

This table of log files is informational only and does not allow the ACS 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. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.1
Upload() command -

[ASYNC] This command is issued to upload the log file specified by this Vendor Log File instance.

All results of the actual upload will be contained within the Device.LocalAgent.TransferComplete! event.

- 2.12
Device.DeviceInfo.FirmwareImage.{i}. object -

Top-level object for mapping firmware images.

This is a static table – the number of object instances in this table is defined by the firmware that is currently running.

At most one entry in this table can exist with a given value for Alias. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(64) -

Firmware/software image name. Descriptive text of the image or filename.

The value of Name is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed.

- 2.12
Version string­(64) -

A string identifying the version of the firmware image represented by this FirmwareImage. Whenever this firmware image is active (ie, the device has booted this firmware image), the value of the DeviceInfo.SoftwareVersion parameter MUST be the same as the value contained in this parameter.

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.

The value of Version is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed.

- 2.12
Available boolean W

Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true.

This value MUST be set to true whenever a new firmware image is installed.

This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter.

Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it.

- 2.12
Status string -

Status of the firmware image, as determined by the Agent. Enumeration of:

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Downloading (This Firmware Image instance is being downloaded)
  • Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
  • Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
  • DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
  • ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
  • InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
  • ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)
- 2.12
BootFailureLog string -

If the Agent is unable to boot into this firmware image, when specified, the Agent can use this parameter to record some information as to why the boot failed.

If the Agent successfully boots into this firmware, the value of this parameter SHOULD be an empty string. When a new firmware image is installed into this object instance, this parameter MUST be cleared.

The length of this string is defined as implementation-specific by the Agent.

- 2.12
Download() command -

[ASYNC] This command is issued to download a firmware into this Firmware Image instance.

All results of the actual download will be contained within the Device.LocalAgent.TransferComplete! event.

- 2.12
Activate() command -

[ASYNC] This command is issued to activate this FirmwareImage instance.

A FirmwareImage instance can also be activated by setting the Device.DeviceInfo.BootFirmwareImage parameter and causing the Agent to reboot.

A successful activation will result in a reboot of the device with this FirmwareImage as the currently running firmware image. Furthermore, this FirmwareImage will be referenced by the Device.DeviceInfo.ActiveFirmwareImage parameter.

A failed activation will result in this FirmwareImage instance's BootFailureLog being updated.

- 2.12
Device.UserInterface. object - This object contains parameters relating to the user interface of the CPE. - 2.0
PasswordReset() command -

Present only if the Agent provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.

Reset LANConfigSecurity.ConfigPassword to its factory value.

- 2.12
Device.DSL. object - This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Diagnostics. object - The DSL Diagnostics object. - 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. - 2.12
Device.ATM. object - Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback() diagnostics. - 2.0
Device.ATM.Diagnostics. object - The ATM Diagnostics object. - 2.0
F5Loopback() command - [ASYNC] This command provides access to an ATM-layer F5 OAM loopback test. - 2.12
Device.Ethernet. object - Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An "outer" VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
LAGNumberOfEntries unsignedInt - The number of entries in the LAG table. - 2.12
Device.Ethernet.LAG.{i}. object W

Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Link Aggregation Sub-Layer as defined in [802.3-2015] and [802.1AX-2014]. It is expected that a LAG interface can only be stacked above Ethernet.Interface interfaces. The CPE can reject creation of additional LAG instances if this would exceed its capabilities.

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 MACAddress. On creation of a new table entry, the Agent MUST choose initial values for Alias, Name and MACAddress such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.12
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Status string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(64) - The textual name of the LAG interface as assigned by the CPE. - 2.12
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.12
LowerLayers string­(1024) W

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. . See [Section 4.2.1/TR-181i2].

LowerLayers must reference to Device.Ethernet.Interface instances where Link Aggregation Group is configured by the CPE.

For example, "Device.Ethernet.Interface.1, Device.Ethernet.Interface.2"

- 2.12
MACAddress string­(17) W [MACAddress] MAC address of the Link Aggregation Interface. - 2.12
Device.Ethernet.LAG.{i}.Stats. object -

Throughput statistics for this interface.

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

- 2.12
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.12
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.12
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted out of the interface. - 2.12
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received on the interface. - 2.12
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. - 2.12
ErrorsReceived unsignedInt - [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
UnicastPacketsSent unsignedLong - [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.12
UnicastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.12
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.12
DiscardPacketsReceived unsignedInt - [StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.12
MulticastPacketsSent unsignedLong - [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.12
MulticastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.12
BroadcastPacketsSent unsignedLong - [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.12
BroadcastPacketsReceived unsignedLong - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.12
UnknownProtoPacketsReceived unsignedInt - [StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.12
Device.USB. object - Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
Device.USB.USBHosts. object -

This object models the CPE's USB Host controllers.

See [Appendix I/TR-157] for Theory of Operation.

- 2.0
Device.USB.USBHosts.Host.{i}. object -

Table of CPE USB Host controllers.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Reset() command - Reset the Host Controller and apply the reset signaling (see [Chapter 7.1.7.5/USB2.0]) to all of the Host Controller Hub downstream ports. - 2.12
Device.HPNA. object - 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 - 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.

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

- 2.12
Device.Ghn. object - G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Device.Ghn.Interface.{i}. object -

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

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.4
PSM string W

Specifies the list of PSD shaping mask (PSM) breakpoints to be applied to the G.hn interface.

Comma-separated list (2 to 32 items) of PSMBreakPointIndexAndLevels, with each list item consisting of:.

  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz.

Both values are represented as unsignedInt.

[Clause 5.2/G.9964] defines limits on PSM breakpoint levels.

The PSM level is 0.1*(the value of the level of the PSM) - 140 dBm/Hz.

For example, a PSM defined by two breakpoints (subcarrier 450, PSM level -80 dBm/Hz) and (subcarrier 1050, PSM level -90 dBm/Hz) is represented by PSM [450,600],[1050,500] .

- 2.12
Device.Ghn.Diagnostics. object - 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.

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

- 2.12
Device.UPA. object - Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
Device.UPA.Diagnostics. object - 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).

- 2.12
Device.WiFi. object - The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
ResetCounter unsignedInt - [StatsCounter32] This parameter counts the number of WiFi host or driver resets since the last device reset. This parameter is reset to zero after the device resets, and increments with each successive WiFi host or driver reset. - 2.12
NeighboringWiFiDiagnostic() command - [ASYNC] This command defines access to other WiFi SSIDs that this device is able to receive. - 2.12
Reset() command - This parameter represents a request to reset or reboot the WiFi sub-system without resetting or rebooting the device. - 2.12
Device.WiFi.Radio.{i}. object -

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

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

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

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.0
ChannelLastChange unsignedInt - The accumulated time in seconds since the current Channel came into use. - 2.12
ChannelLastSelectionReason string -

The cause of the last channel selection. Enumeration of:

  • Manual (Manual selection of the Channel)
  • Auto_Startup (Automatic channel selection procedure launched at radio startup)
  • Auto_User (Automatic channel selection procedure triggered by the user (e.g. via a GUI))
  • Auto_Refresh (Automatic channel selection procedure triggered by the AutoChannelRefreshPeriod timer)
  • Auto_Dynamic (Automatic channel selection procedure dynamically triggered to adjust to environmental interference)
  • Auto_DFS (Automatic channel selection procedure triggered by Dynamic Frequency Selection (DFS) [ETSIBRAN])
  • Unknown
- 2.12
MaxSupportedSSIDs unsignedInt­[1:] - Maximum number of SSIDs supported on this radio. - 2.12
MaxSupportedAssociations unsignedInt­[1:] - Maximum number of associated devices supported. - 2.12
FirmwareVersion string­(64) - This radio's WiFi firmware version. - 2.12
SupportedOperatingChannelBandwidths string -

Comma-separated list of strings. These are the valid writable values for OperatingChannelBandwidth. Each list item is an enumeration of:

- 2.12
Device.WiFi.Radio.{i}.Stats. object - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2a5] for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2a5]. - 2.0
TotalChannelChangeCount unsignedInt - The total number of times that the Channel has changed since the WiFi.Radio entered its current operating state. - 2.12
ManualChannelChangeCount unsignedInt - The number of times that the Channel has changed due to manual channel selection since the WiFi.Radio entered its current operating state. - 2.12
AutoStartupChannelChangeCount unsignedInt - The number of times that the Channel has changed due to automatic channel selection procedure launched at radio startup since the WiFi.Radio entered its current operating state. - 2.12
AutoUserChannelChangeCount unsignedInt - The number of times that the Channel has changed due to automatic channel selection procedure triggered by the user (e.g. via a GUI) since the WiFi.Radio entered its current operating state. - 2.12
AutoRefreshChannelChangeCount unsignedInt - The number of times that the Channel has changed due to automatic channel selection procedure triggered by the AutoChannelRefreshPeriod timer since the WiFi.Radio entered its current operating state. - 2.12
AutoDynamicChannelChangeCount unsignedInt - The number of times that the Channel has changed due to automatic channel selection procedure dynamically triggered to adjust to environmental interference since the WiFi.Radio entered its current operating state. - 2.12
AutoDFSChannelChangeCount unsignedInt - The number of times that the Channel has changed due to automatic channel selection procedure triggered by DFS [ETSIBRAN] since the WiFi.Radio entered its current operating state. - 2.12
Device.WiFi.SSID.{i}. object 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 choose initial values for Alias, Name and BSSID such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.0
Upstream boolean -

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

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.

This parameter supersedes the deprecated Radio.{i}.Upstream parameter. If both exist, the parameter Radio.{i}.Upstream is ignored.

- 2.12
Device.WiFi.AccessPoint.{i}. object W

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

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

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

At most one entry in this table 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
MaxAllowedAssociations unsignedInt W

Maximum number of associated devices allowed for this SSID. If the number is reached new device connections to this access point will be rejected.

If the number is changed to a value less than the actual number of associated devices, new device connections will be rejected until the number of devices is below this number. It is not expected that any connections are dropped.

If the parameter Radio.{i}.MaxSupportedAssociations exists, the value MUST be less than or equal to the maximum number specified in Radio.{i}.MaxSupportedAssociations.

- 2.12
Device.WiFi.AccessPoint.{i}.Security. object - This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. - 2.0
Reset() command -

Reset this AccessPoint instance's WiFi security settings to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey , KeyPassphrase 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 or WPA-WPA2-Enterprise.

- 2.12
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object -

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

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

- 2.0
AssociationTime dateTime - Date and time in UTC when the device was associated - 2.12
Noise int­[-200:0] - An indicator of radio noise on the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device (see ANPI definition in [Clause 10.11.9.4/802.11-2012]) - 2.12
Device.PPP. object - Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Device.PPP.Interface.{i}. object W

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

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.0
Reset() command -

On a reset the device MUST tear down the existing PPP connection represented by this object and establish a new one.

The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.

Reset on a disabled interface is a no-op (not an error).

- 2.12
Device.IP. object - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Interface.{i}. object 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 ACS to create) Interface instances of type Loopback.

When the ACS administratively disables the interface, i.e. sets Enable to false, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the ACS 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 choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.0
TWAMPReflectorNumberOfEntries unsignedInt - The number of entries in the TWAMPReflector table. - 2.12
Reset() command -

On a reset device MUST tear down the existing IP connection represented by this object and establish a new one.

The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.

Reset on a disabled interface is a no-op (not an error).

- 2.12
Device.IP.Interface.{i}.TWAMPReflector.{i}. object W

This object contains parameters associated with the configuration that permits this interface to be used as Two-Way Active Measurement Protocol (TWAMP) reflector as defined in [TR-390].

At most one entry in this table can exist with a given value for Alias, or with a given value for Port. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enables or disables the TWAMP reflector. - 2.12
Status string -

The current operational state of the TWAMP reflector. Enumeration of:

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Port unsignedInt­[:65535] W The port used to listen for the TWAMP test packets. 862 2.12
MaximumTTL unsignedInt­[1:255] W The maximum TTL of a received packet that this TWAMP reflector will reflect to the TWAMP controller. 1 2.12
IPAllowedList string­(255) W

Comma-separated list (maximum list length 255) of strings. List items represent source IP addresses and subnets from which test packets MUST always be received. An empty string list will allow test packets to be received from any source IP address.

Each entry in the list MUST be either an IP address, or an IP prefix specified using Classless Inter-Domain Routing (CIDR) notation [RFC4632].

An IP prefix is specified as an IP address followed (with no intervening white space) by "/n", where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the prefix.

IPv4 example:

  • 1.2.3.4 specifies a single IPv4 address, and 1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0.
  • 1.2.0.0/22 represents the 1024 IPv4 addresses from 1.2.0.0 to 1.2.3.255.

IPv6 example:

  • fec0::220:edff:fe6a:f76 specifies a single IPv6 address.
  • 2001:edff:fe6a:f76::/64 represents the IPv6 addresses from 2001:edff:fe6a:f76:0:0:0:0 to 2001:edff:fe6a:f76:ffff:ffff:ffff:ffff.
- 2.12
PortAllowedList string­(255) W

Comma-separated list (maximum list length 255) of strings. List items represent source port ranges from which test packets MUST always be received. An empty string list will allow test packets to be received from any source port.

Each entry in the list MUST be either a port number or a range of port numbers separated by a hypen (-).

For example, an entry with the value: '2-40' accepts test packets from any allowed source IP addresses with a source port between 2 and 40 inclusive. An entry of '3' accepts test packets from allow source IP addresses with a port of 3.

- 2.12
Device.IP.Diagnostics. object - The IP Diagnostics object. - 2.0
IPPing() command - [ASYNC] This command provides access to an IP-layer ping test. - 2.12
TraceRoute() command - [ASYNC] This command defines access to an IP-layer trace-route test for the specified IP interface. - 2.12
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.

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

- 2.12
UDPEchoDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143a1] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143a1]. - 2.12
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. - 2.12
Device.L2TPv3. object -

This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Layer Two Tunneling Protocol version 3 (L2TPv3) ([RFC3931]).

This object also provides a means to treat packets that are encapsulated within a L2TPv3 Tunnel by using a set of Filter objects to determine the treatment of the packet.

- 2.12
TunnelNumberOfEntries unsignedInt - The number of entries in the Tunnel table. - 2.12
FilterNumberOfEntries unsignedInt - The number of entries in the Filter table. - 2.12
Device.L2TPv3.Tunnel.{i}. object W

L2TPv3 Tunnel table, models the L2TPv3 Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface.

A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

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

The current operational state of the tunnel. Enumeration of:

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
RemoteEndpoints string W

Comma-separated list (up to 4 items) of strings (maximum item length 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote L2TPv3 tunnel endpoint.

If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence.

- 2.12
KeepAlivePolicy string W

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

  • ICMP (The version of the ICMP packet used for this KeepAlivePolicy is based on the value of the DeliveryHeaderProtocol parameter (Either ICMP for IPv4 or ICMPv6 for IPv6))
  • None
"None" 2.12
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.12
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.12
DeliveryHeaderProtocol string W

The protocol used for the delivery header. Enumeration of:

- 2.12
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.12
TunnelEncapsulation string W

The protocol that this Tunnel will be encapsulated

Enumeration of:

"IP" 2.12
ConnectedRemoteEndpoint string­(256) - The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote L2TPv3 tunnel endpoint. - 2.12
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.12
Device.L2TPv3.Tunnel.{i}.UDP. object - This UDP provides the parameters when the value of the Tunnel.{i}.TunnelEncapsulation parameter is UDP. - 2.12
SourcePort unsignedInt­[:65535] W The source (local) port used to transmit PDUs. A value of 0 indicates that the port selection is performed by the device. 1701 2.12
RemotePort unsignedInt­[:65535] W The remote port used to by the remote endpoint to transmit PDUs. 1701 2.12
EnableChecksum boolean W Enables or disables checksum processing. false 2.12
Device.L2TPv3.Tunnel.{i}.Stats. object -

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

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

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

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

The Interface object models the L2TPv3 Header as defined in [RFC3931] and the transport of L2 frames across over L2TPv3 as defined in [RFC4719].

The Interface object provides a way to discriminate how sessions or flows are encapsulated within the L2TPv3 Tunnel.

In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.12
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Status string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.12
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.12
LowerLayers string­(1024) W Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.12
SessionID int­[-1, 1:65535] W

The unique Session ID to be used in the L2TPv3 header of the tunnel.

A Session ID with a value of -1 indicates that he CPE is to generate the session ids for this Interface instance.

1 2.12
CookiePolicy string W

The policy that defines how the Cookie is handled in this Interface instance. Enumeration of:

  • Disabled (The device does not perform Cooking processing)
  • Configured (The value of the Cookie parameter is transmitted in the L2TPv3 header)
  • Generated (The device generates the value of the Cookie transmitted in the L2TPv3 header)
"Configured" 2.12
Cookie unsignedLong W The Cookie transmitted in the L2TPv3 header. The default is to set the Cookie to the device's MAC address that is encoded in the low order 6 bytes. - 2.12
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. object -

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

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

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

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

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

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

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

The status of this filter. Enumeration of:

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

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

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

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

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

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

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Interface string­(256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel or Tunnel.{i}.Interface tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.12
AllInterfaces boolean W Filter criterion. This specifies that all ingress L2TPv3 tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress L2TPv3 tunnel interfaces are indicated. false 2.12
VLANIDCheck int­[-1:] W

Filter criterion.

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

-1 2.12
VLANIDExclude boolean W

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

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

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

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

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

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

This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Virtual eXtensible Local Area Network (VXLAN) ([RFC7348]).

This object also provides a means to treat packets that are encapsulated within a VXLAN Tunnel by using a set of Filter objects to determine the treatment of the packet.

- 2.12
TunnelNumberOfEntries unsignedInt - The number of entries in the Tunnel table. - 2.12
FilterNumberOfEntries unsignedInt - The number of entries in the Filter table. - 2.12
Device.VXLAN.Tunnel.{i}. object W

VXLAN Tunnel table, models the VXLAN Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface.

A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

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

The current operational state of the tunnel. Enumeration of:

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
RemoteEndpoints string W

Comma-separated list (up to 4 items) of strings (maximum item length 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote VXLAN tunnel endpoint.

If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence.

- 2.12
KeepAlivePolicy string W

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

  • ICMP (The version of the ICMP packet used for this KeepAlivePolicy is based on the value of the DeliveryHeaderProtocol parameter (Either ICMP for IPv4 or ICMPv6 for IPv6))
  • None
"None" 2.12
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.12
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.12
DeliveryHeaderProtocol string W

The protocol used for the delivery header. Enumeration of:

- 2.12
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.12
ConnectedRemoteEndpoint string­(256) - The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote VXLAN tunnel endpoint. - 2.12
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.12
SourcePort unsignedInt­[:65535] W The source (local) port used to transmit PDUs. A value of 0 indicates that the port selection is performed by the device. In such case, it is recommended that the UDP source port number be calculated using a hash of fields from the inner packet and that it is in the dynamic/private port range 49152-65535. 0 2.12
RemotePort unsignedInt­[:65535] W The remote port used to by the remote endpoint to transmit PDUs. The well-known port allocated by IANA is 4789, but it should be configurable. 4789 2.12
Device.VXLAN.Tunnel.{i}.Stats. object -

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

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

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

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

The Interface object models the VXLAN Header as defined in [RFC7348] for the transport of L2 frames across over VXLAN.

The Interface object provides a way to discriminate how multiple LAN segments are encapsulated within the VXLAN Tunnel.

In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.12
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Status string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.12
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.12
LowerLayers string­(1024) W Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.12
VNI int­[-1, 0:16777215] W

The unique Virtual Network Identifier (VNI) to be used in the VXLAN header of the tunnel.

A VNI with a value of -1 indicates that the CPE is to generate the VNI for this Interface instance.

1 2.12
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. object -

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

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

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

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

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

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

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

The status of this filter. Enumeration of:

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

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

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

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

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

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

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Interface string­(256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel or Tunnel.{i}.Interface tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.12
AllInterfaces boolean W Filter criterion. This specifies that all ingress VXLAN tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress VXLAN tunnel interfaces are indicated. false 2.12
VLANIDCheck int­[-1:] W

Filter criterion.

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

-1 2.12
VLANIDExclude boolean W

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

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

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

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

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

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

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 [Appendix XV/TR-181i2a8] for a description of the working of this MAP data model.

- 2.8
Device.MAP.Domain.{i}. object 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 WANInterface and IPv6Prefix. On creation of a new table entry, the Agent MUST choose initial values for Alias, WANInterface and IPv6Prefix such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.8
Device.MAP.Domain.{i}.Rule.{i}. object 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.8
PSIDOffset unsignedInt­[0:15] W

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

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

6 2.12
PSIDLength unsignedInt­[0:16] W

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

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

0 2.12
PSID unsignedInt­[0:65535] W

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

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

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

0 2.12
Device.Hosts. object - 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 -

Host table.

At most one entry in this table can exist with a given value for Alias, or with a given value for PhysAddress. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Device.Hosts.Host.{i}.WANStats. object - These count bytes or packets at the IP layer sent to the WAN, or received from the WAN. - 2.12
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted to the WAN from the Host device at the IP layer. - 2.12
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received from the WAN and sent to the Host device at the IP layer. - 2.12
PacketsSent unsignedLong - [StatsCounter64] The total number of IP packets transmitted to the WAN from the Host device. - 2.12
PacketsReceived unsignedLong - [StatsCounter64] The total number of IP packets received from the WAN and sent to the Host device. - 2.12
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound IP packets to the WAN from the Host device that could not be transmitted because of errors. These may be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.12
RetransCount unsignedInt - [StatsCounter32] The total number of transmitted IP packets to the WAN from the Host device which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.12
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of outbound IP packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.12
Device.DNS. object - Properties for Domain Name Service (DNS). - 2.0
Device.DNS.Diagnostics. object - The DNS Diagnostics object containing the NSLookupDiagnostics() 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.

- 2.12
Device.DNS.SD. object -

This object contains the DNS Service Discovery [DNS-SD] object and parameters necessary to discover services and their associated devices.

Upon reboot the the contents of the service table are repopulated. When the DNS.SD service is disabled, the contents of the service table is implementation specific.

- 2.6
AdvertisedInterfaces string W

Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance from which DNS-SD services are advertised. If the referenced object is deleted, the corresponding item MUST be removed from the list.

If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces.

- 2.12
Device.DHCPv4. object - 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.Client.{i}. object W

This object contains DHCP client settings for an associated IP Interface indicated by Interface.

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

This table MUST contain at least 1 entry.

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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Renew() command - The DHCP client will renew its DHCP lease. - 2.12
Device.DHCPv6. object - 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.Client.{i}. object W

This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface.

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

This table MUST contain at least 1 entry.

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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.2
Renew() command - The Client will renew its DHCPv6-supplied information (i.e. the Agent will do a renew or information request as needed, updating both stateful and stateless parameter values discovered by this Client instance). - 2.12
Device.IEEE8021x. object - IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. - 2.0
Device.IEEE8021x.Supplicant.{i}. object W

802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance).

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

This table MUST contain at least 1 entry.

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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Reset() command -

On a reset the device MUST reset the session by performing an initial authentication attempt as defined in [Section 9.6.1.3/802.1x-2004], Initialize Port by sending out the EAP start message.

The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call.

- 2.12
Disconnect() command -

On a reset the device MUST disconnect (forced unauthentication) the resource.

The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call.

- 2.12
Device.SmartCardReaders. object - SmartCardReaders object that contains the SmartCardReader table. - 2.0
Device.SmartCardReaders.SmartCardReader.{i}. object -

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Reset() command - Reset the SmartCard Reader and the associated SmartCard. - 2.12
Device.PeriodicStatistics. object -

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 ACS as a comma-separated list of the most recent <n> 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 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
ForceSample() command -

Force statistics for the current sample to be calculated and updated in the data model.

If this is the first time that this command is called during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly.

If this is not the first time that this command is during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly.

Note that ForceSample() just provides a "sneak preview" of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.

At the end of each sample interval, if this command was executed during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when the command was executed will be updated one last time at the end of the sample interval.

- 2.12
Device.FAP. object - 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 - This object contains the parameters relating to the GPS scan. - 2.4
GPSReset() command - Reset the GPS Hardware. - 2.12
Device.BulkData. object -

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 [Annex A/TR-157a10].

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
Device.BulkData.Profile.{i}. object 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 ACS 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.5
Controller string -

The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created or last updated this Profile. If the referenced object is deleted, the parameter value MUST be set to an empty string.

The value of this parameter is automatically populated by the USP Agent upon Profile creation using the reference to the USP Controller that created the instance.

The value of this parameter is automatically updated by the USP Agent upon Profile alteration using the reference to the USP Controller that changed the instance.

- 2.12
Device.BulkData.Profile.{i}.HTTP. object - 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
PersistAcrossReboot boolean W

Determines whether or not data transfers that have failed are required to be persisted across reboots.

If PersistAcrossReboot is true, then failed data transfers MUST be persisted across reboots.

If PersistAcrossReboot is false, then failed data transfers are not required to be persisted across reboots.

false 2.12
Device.MQTT. object - MQTT Base object describing all MQTT related parameters and objects [MQTT31], - 2.10
Device.MQTT.Client.{i}. object 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 choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.10
ForceReconnect() command -

Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter Status is Connected).

If the MQTT client is in a different state, the command has no effect.

This command may be used to immediately apply changes in the MQTT connection settings.

- 2.12
Device.MQTT.Broker.{i}. object 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 choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object 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 choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.10
ForceReconnect() command -

Disconnects the MQTT bridge to the remote MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT bridge is currently connected to the remote MQTT broker (Parameter Status is Connected).

If the MQTT bridge is in a different state, the command has no effect.

This command may be used to immediately apply changes in the MQTT connection settings.

- 2.12
Device.BASAPM. object - This object represents the objects necessary to manage and control the functionality for tests that utilize the Broadband Access Service Attributes and Performance Metrics measurement test framework as defined in by [TR-304]. - 2.12
MeasurementEndpointNumberOfEntries unsignedInt - The number of entries in the MeasurementEndpoint table. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}. object W

This object represents the measurement endpoint that provides additional contextual information regarding the measurement agent.

At most one entry in this table can exist with a given value for Alias, or with a given value for MeasurementAgent. On creation of a new table entry, the Agent MUST choose initial values for Alias and MeasurementAgent such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this MeasurementEndpoint instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
MeasurementAgent string W The value MUST be the Path Name of a LMAP.MeasurementAgent object that is associated with this measurement endpoint.. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
DeviceOwnership string W

This parameter describes the ownership of the device that hosts the measurement endpoint.

  • ISP (ISP Owned Device)
  • Customer (Customer Owned Device)
- 2.12
OperationalDomain string­(256) W This parameter describes the operational domain for this measurement endpoint - 2.12
InternetDomain string­(64) W The top level Internet domain used to identify this measurement endpoint. - 2.12
UseMeasurementEndpointInReports boolean W If the value of this parameter is false then the Measurement Endpoint MUST not be included in measurement reports. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}.ISPDevice. object - This object represents the information necessary to utilize an ISP owned device within the measurement endpoint. - 2.12
ReferencePoint string W

This parameter describes the measurement reference point of the measurement endpoint.

  • STP (Internet Source Test Point)
  • IDTP (Internet Drain Test Point)
  • RNTP (Regional Network Test Point)
  • IRTP (Internal Regional Test Point)
  • MTP (Metro Test Point)
  • IATP (Internal Access Test Point)
  • UNITP (User Network Interface Test Point)
  • CEDTP (Customer End Device Test Point)
- 2.12
GeographicalLocation string W The value MUST be the Path Name of a DeviceInfo.Location object that describes the geographic location of the measurement endpoint. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}.CustomerDevice. object - This object represents the information necessary to utilize customer owned device within the measurement endpoint. - 2.12
EquipmentIdentifier string­(64) W This parameter describes the customer equipment identifier of the measurement endpoint. - 2.12
CustomerIdentifier string­(256) W The unique customer identifier within the operational domain for this measurement endpoint. - 2.12
Device.LMAP. object - This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. - 2.12
MeasurementAgentNumberOfEntries unsignedInt - The number of entries in the MeasurementAgent table. - 2.12
ReportNumberOfEntries unsignedInt - The number of entries in the Report table. - 2.12
EventNumberOfEntries unsignedInt - The number of entries in the Event table. - 2.12
Device.LMAP.MeasurementAgent.{i}. object W

This object represents the measurement agent that performs measurement tasks and reporting functions defined in [RFC7594].

At most one entry in this table can exist with a given value for Alias, or with a given value for Identifier. On creation of a new table entry, the Agent MUST choose initial values for Alias and Identifier such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this MeasurementAgent instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Version string - Version of the measurement agent. - 2.12
LastStarted dateTime - Date and time, based on [RFC3339], in UTC that the measurement agent was successfully started. - 2.12
CapabilityTags string - Comma-separated list of strings. Capabilities of the measurement agent that cannot be expressed elsewhere in the data model. - 2.12
Identifier string­(36:36) W [UUID] Identifier of the MeasurementAgent instance. - 2.12
GroupIdentifier string­(256) W Identifier of the measurement group of interest to which the measurement agent belongs. - 2.12
MeasurementPoint string­(256) W Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [bibref|RFC7398}}. - 2.12
UseAgentIdentifierInReports boolean W If the value of the Identifier parameter is not an empty string and the value of this parameter is false then the value of the Identifier parameter MUST not be included in measurement reports. true 2.12
UseGroupIdentifierInReports boolean W If the value of the GroupIdentifier parameter is not an empty string and the value of this parameter is false then the value of the GroupIdentifier parameter MUST not be included in measurement reports. false 2.12
UseMeasurementPointInReports boolean W If the value of the MeasurementPoint parameter is not an empty string and the value of this parameter is false then the value of the MeasurementPoint parameter MUST not be included in measurement reports. false 2.12
PublicCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to identify this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
PrivateCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to contain the private keys for this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
EventLog string - The value MUST be the Path Name of a DeviceInfo.VendorLogFile object that is used to record events for this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
TaskCapabilityNumberOfEntries unsignedInt - The number of entries in the TaskCapability table. - 2.12
ScheduleNumberOfEntries unsignedInt - The number of entries in the Schedule table. - 2.12
TaskNumberOfEntries unsignedInt - The number of entries in the Task table. - 2.12
CommunicationChannelNumberOfEntries unsignedInt - The number of entries in the CommunicationChannel table. - 2.12
InstructionNumberOfEntries unsignedInt - The number of entries in the Instruction table. - 2.12
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}. object -

This object represents a capabilities, in the context of a task, that are supported by the measurement agent. Types of capabilities include: Report tasks, Configuration Tasks and Instruction Tasks.

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

- 2.12
Name string­(256) - Name of the supported task. - 2.12
Version string­(256) - Version of the task. - 2.12
TaskCapabilityRegistryNumberOfEntries unsignedInt - The number of entries in the Registry table. - 2.12
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}.Registry.{i}. object -

This object represents a registry function and an associated list of roles supported by this measurement agent

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

- 2.12
RegistryEntry string - A URI ([RFC3986]) that is the value of the task registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.12
Roles string - Comma-separated list of strings (maximum item length 256), representing the roles of the function. - 2.12
Device.LMAP.MeasurementAgent.{i}.Controller. object - This objects represents the measurement controller that is assigned to a measurement agent. - 2.12
ControllerTimeout int­[0:] W

The timer, in seconds, that is started after each successful contact with a measurement controller.

When the timer reaches the timeout en event is raised indicating that connectivity to the controller has been lost.

- 2.12
ControlSchedules string W

Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object. If the referenced object is deleted, the corresponding item MUST be removed from the list.

This parameter lists the available control schedules for invoking control tasks by the measurement agent.

- 2.12
ControlTasks string W

Comma-separated list of strings. Each list item MUST be the Path Name of a Task object. If the referenced object is deleted, the corresponding item MUST be removed from the list.

This parameter lists the available control tasks that can be invoked by the measurement agent.

- 2.12
ControlChannels string W

Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list.

The measurement agent to measurement controller channel is used for conveying results of communication sessions with the configuration, instruction status and logging information elements defined in defined in [LMAPIFM].

- 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. object W

This object represents a schedule that is associated with a set of scheduled actions to be performed by a measurement agent.

Note: Actions of an occurrence of this Schedule are gracefully terminated by the defining either the End or Duration parameters. Only one of these parameters may be defined at a time.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Schedule instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(256) W Name of the schedule. - 2.12
State string -

The current operational state of the Schedule. Only one instance of the schedule is active. An active schedule is defined where the State parameter has a value of Running.

- 2.12
Start string W The value MUST be the Path Name of a Event object that is used define the event to start an occurrence of this Schedule. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
End string W The value MUST be the Path Name of a Event object that is used define the event to gracefully terminate all actions associated with an occurrence of this Schedule. If the referenced object is deleted, the parameter value MUST be set to an empty string. . <Empty> 2.12
Duration unsignedInt W When the Duration value is not 0, this parameter is used define the duration, in seconds, where after this duration all actions associated with an occurrence of this Schedule are gracefully terminated. 0 2.12
Tags string W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.12
SuppressionTags string W Comma-separated list of strings, representing the suppression tags to be matched. - 2.12
ExecutionMode string W

This parameter describes the execution method to apply to this schedule for the associated Actions.

  • Sequential (Actions are executed in sequence as defined by the value of the Action.{i}.Order parameter. The first Scheduled Action of the DestinationOutput is provided the input)
  • Parallel (Actions are executed in parallel. The all Scheduled Actions of the DestinationOutput are provided the input)
  • Pipelined (Actions are executed in sequence where the output of one Action is used as the input of subsequent Action. The first Scheduled Action of the DestinationOutput is provided the input)
"Pipelined" 2.12
LastInvocation dateTime - Date and time, based on [RFC3339], in UTC that the Schedule was invoked by the measurement agent. - 2.12
Storage unsignedLong -

The amount of secondary storage, in bytes, allocated to an instance of this Schedule.

The value of this parameter reflects the amount of allocated physical storage and not the storage used by logical data records.

For example the secondary storage can be the storage allocated in a file system holding temporary data.

- 2.12
ActionNumberOfEntries unsignedInt - The number of entries in the Action table. - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats. object - This object represents the statistics associated with this object. - 2.12
Invocations unsignedLong - Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule. - 2.12
Suppressions unsignedLong - Number of suppressed executions of this schedule. - 2.12
Overlaps unsignedLong - Number of executions prevented due to overlaps with a previous invocation of this schedule. - 2.12
Failures unsignedLong - Number of failed executions of this schedule. A failed execution is an execution where at least one action failed. - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. object W

This object represents an action that is associated with the this Schedule object.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Schedule.{i}.Action object.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
State string -

The current operational state of the Action. Enumeration of:

- 2.12
Order unsignedInt W The order of the scheduled action. - 2.12
Task string W The value MUST be the Path Name of a Task object used in this scheduled action. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
OutputDestination string W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object used to receive the output(s) of this scheduled action. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.12
SuppressionTags string W Comma-separated list of strings, representing the suppression tags to be matched. - 2.12
Tags string W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.12
Storage unsignedLong -

The amount of secondary storage, in bytes, allocated to an instance of this Action.

The value of this parameter reflects the amount of allocated physical storage and not the storage used by logical data records.

For example the secondary storage can be the storage allocated in a file system holding temporary data.

- 2.12
LastInvocation dateTime - Date and time, based on [RFC3339], in UTC that the Action was invoked by the measurement agent. - 2.12
LastSuccessfulCompletion dateTime - Date and time, based on [RFC3339], in UTC of a successful completion of the Action. - 2.12
LastSuccessfulStatusCode int - The status code returned by successful execution of the Action. A value of 0 indicates successful completion. - 2.12
LastSuccessfulMessage string - The message associated with the successful completion of the Action. - 2.12
LastFailedCompletion dateTime - Date and time, based on [RFC3339], in UTC of a failure to complete the Action. - 2.12
LastFailedStatusCode int - The status code returned by failed execution of the Action. A value of 0 indicates successful completion. - 2.12
LastFailedMessage string - The message associated with the failure to complete the task. - 2.12
OptionNumberOfEntries unsignedInt - The number of entries in the Option table. - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Stats. object - This object represents the statistics associated with this object. - 2.12
Invocations unsignedLong - Number of invocations of this action. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule. - 2.12
Suppressions unsignedLong - Number of suppressed executions of this action. - 2.12
Overlaps unsignedLong - Number of executions prevented due to overlaps with a previous invocation of this action. - 2.12
Failures unsignedLong - Number of failed executions of this action. A failed execution is an execution where at least one action failed. - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}. object W

This object represents an option associated with the Scheduled Action. When an option with the same Name exists between the Seheduled Action's Option and The Task's option, the option of the Scheduled Action takes precedence over the option associated with the Task.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Option instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Order unsignedInt W The order of the Option. - 2.12
Name int W

The name of the option.

When the value of this parameter is equal to "channel", the option value specifies the Communication Channel used for this scheduled task.

- 2.12
Value string W The value associated with the Option. - 2.12
Device.LMAP.MeasurementAgent.{i}.Task.{i}. object W

The Task object defines the configuration for a task that can be performed by MeasurementAgent objects.

Tasks are performed by MeasurementAgent objects when a Schedule object invokes the Task.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Task instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(256) W Name of the task. - 2.12
Tags string W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.12
OptionNumberOfEntries unsignedInt - The number of entries in the Option table. - 2.12
RegistryNumberOfEntries unsignedInt - The number of entries in the Registry table. - 2.12
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}. object W

This object represents a registry function and an associated list of roles for this task

At most one entry in this table can exist with a given value for RegistryEntry, or with a given value for Alias. On creation of a new table entry, the Agent MUST choose initial values for RegistryEntry and Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Registry instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
RegistryEntry string W A URI ([RFC3986]) that is the value of the task registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.12
Roles string W Comma-separated list of strings (maximum item length 256), representing the roles of the function. - 2.12
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}. object W

This object represents an option associated with the task.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Option instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Order unsignedInt W The order of the Option. - 2.12
Name int W

The name of the option.

When the value of this parameter is equal to "channel", the option value specifies the Communication Channel used for this task.

- 2.12
Value string W The value associated with the Option. - 2.12
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}. object W

This object represents the properties communication channel used to establish communication between a measurement agent and other elements of the LMAP framework (e.g., measurement controller, measurement collector). The value of the Name parameter used for conveying information is defined as an option in the Task's or scheduled Task's option parameter.

When this object uses the BulkData capability, a BulkData.Profile.{i} object instance referred to by this object.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this CommunicationChannel instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(256) W Name of the channel. - 2.12
UseBulkDataProfile boolean W Enables or disables the ability to use a bulk data profile for this communication channel - 2.12
BulkDataProfile string W The value MUST be the Path Name of a BulkData.Profile object that is used to represent communication channel. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
Target string­(256) W The URL of the LMAP component that is the target of this communication channel. - 2.12
TargetPublicCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to identify the target of this channel. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
Interface string W The value MUST be the Path Name of an interface object used to restrict the data transmitted or received using this channel to a specific interface. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the value of this parameter is an empty string the data that is transmitted or received using this channel is able to use any available interface. - 2.12
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}. object W

The Instruction object defines the instruction to the measurement agent by the measurement controller. At most one Instruction object for the MeasurementAgent instance is enabled at a time. .

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Instruction instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
LastChange dateTime - Date and time, based on [RFC3339], in UTC that the Instruction object or its sub-object's configuration was changed by a measurement agent's controller. - 2.12
InstructionSchedules string W

Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object. If the referenced object is deleted, the corresponding item MUST be removed from the list.

This parameter lists the available instruction schedules for invoking control tasks by the measurement agent.

- 2.12
InstructionTasks string W

Comma-separated list of strings. Each list item MUST be the Path Name of a Task object. If the referenced object is deleted, the corresponding item MUST be removed from the list.

This parameter lists the available instruction tasks that can be invoked by the measurement agent.

- 2.12
ReportChannels string W

Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list.

This parameter defines the corresponding report channels to be used when reporting results of tasks to a measurement collector.

- 2.12
MeasurementSuppressionNumberOfEntries unsignedInt - The number of entries in the MeasurementSuppression table. - 2.12
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}. object W

This object defines the schedules and actions that are suppressed based on criteria defined in the SuppressionMatch parameter.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this MeasurementSuppression instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(256) W Name of the suppression object. - 2.12
State string -

The current operational state of the MeasurementSuppression. Enumeration of:

- 2.12
StopRunning boolean W When true, the measurement agent is instructed to stop running schedules or actions that have been matched by this object. false 2.12
Start string W The value MUST be the Path Name of a Event object that is used define the event that to start an occurrence of this MeasurementSuppression. If the referenced object is deleted, the parameter value MUST be set to an empty string. When an empty string the default behavior is to perform the suspension event immediately. <Empty> 2.12
End string W The value MUST be the Path Name of a Event object that is used define the event to gracefully suspend all actions associated with an occurrence of this MeasurementSuppression. If the referenced object is deleted, the parameter value MUST be set to an empty string. When an empty string the default behavior is for the suspension period to be indefinite. <Empty> 2.12
SuppressionMatch string W Comma-separated list of strings, representing the match patterns to be used for applying suppression to Schedule.{i} (and their actions) and all Schedule.{i}.Action.{i} object instances that have a matched using their SuppressionTags parameters. The match pattern syntax is defined in [LMAPIFM]. - 2.12
Device.LMAP.Report.{i}. object -

This Report object instance represents a report that is generated by a reporting task where the reporting task is defined as a MeasurementAgent.{i}.Task.{i} and executed as a scheduled action (MeasurementAgent.{i}.Schedule.{i}.Action.{i}).

The Report replicates the MeasurementAgent.{i} object instance's data at the time of the action exection.

When a BulkData.Profile.{i} object instance is used to communicate a Report instance, the CPE adds a BulkData.Profile.{i}.Parameter.{i} object instance referring to this Report object instance.

- 2.12
ReportDate dateTime - The report date and time, based on [RFC3339], that the report was sent to the collector. - 2.12
AgentIdentifier string­(36:36) - [UUID] Identifier of the measurement agent at the time the measurement was run. - 2.12
GroupIdentifier string - Identifier of the measurement group of interest to which the MA belongs. - 2.12
MeasurementPoint string­(256) - Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [RFC7398]. - 2.12
ResultNumberOfEntries unsignedInt - The number of entries in the Result table. - 2.12
Device.LMAP.Report.{i}.Result.{i}. object -

The Result object provides the meta-data of the result report of a single executed action that produced the result.

At most one entry in this table can exist with all the same values for ScheduleName, ActionName and StartTime.

- 2.12
TaskName string­(256) - Name of the task that produced the result. - 2.12
ScheduleName string­(256) - Name of the schedule that produced the result. - 2.12
ActionName string­(256) - Name of the action that produced the result. - 2.12
EventTime dateTime - The date and time, based on [RFC3339], that the event that triggered the schedule of the action that produced the reported result values in UTC. - 2.12
StartTime dateTime - The date and time, based on [RFC3339], that the action started in UTC. - 2.12
EndTime dateTime - The date and time, based on [RFC3339], that the action was completed in UTC. - 2.12
CycleNumber string -

The cycle number derived from the EventTime.

The cycle number is the time, in UTC, closest to the EventTime that is a multiple of the cycle interval of the event that triggered the execution of the schedule.

The value is valid if the event that triggered the execution of the schedule has a defined cycle interval. An an empty string value represent an invalid CycleNumber.

- 2.12
Status int - The status code returned by the execution of the action. - 2.12
Tags string - Comma-separated list of strings, each entry represents tags defined for the schedule, task and action objects that produced this result. - 2.12
OptionNumberOfEntries unsignedInt - The number of entries in the Option table. - 2.12
ResultConflictNumberOfEntries unsignedInt - The number of entries in the Conflict table. - 2.12
ResultReportTableNumberOfEntries unsignedInt - The number of entries in the ReportTable table. - 2.12
Device.LMAP.Report.{i}.Result.{i}.Option.{i}. object -

This object represents an option associated with the task or action object that produced the result.

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

- 2.12
Order unsignedInt - The order of the Option. - 2.12
Name int -

The name of the Option.

When the value of this parameter is equal to "channel", the option value specifies the Communication Channel used for this task.

- 2.12
Value string - The value associated with the Option. - 2.12
Device.LMAP.Report.{i}.Result.{i}.Conflict.{i}. object -

This object represents actions that might have impacted the results being reported.

At most one entry in this table can exist with all the same values for ScheduleName, ActionName and TaskName.

- 2.12
TaskName string­(256) - Name of the task. - 2.12
ScheduleName string­(256) - Name of the schedule. - 2.12
ActionName string­(256) - Name of the action. - 2.12
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}. object - This ReportTable object instances represents a row of results. - 2.12
ColumnLabels string -

Comma-separated list of strings. This parameter contains the column labels used for the result.

The column labels are ordered with the corresponding entries in the ResultRow table.

- 2.12
ResultReportRowNumberOfEntries unsignedInt - The number of entries in the ResultRow table. - 2.12
RegistryNumberOfEntries unsignedInt - The number of entries in the Registry table. - 2.12
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.ResultRow.{i}. object - This ResultRow object instances represents a row of results for the report. - 2.12
Values string - Comma-separated list of strings. This parameter contains an ordered set of values that align to the columns defined in the ColumnLabels parameter. - 2.12
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.Registry.{i}. object -

This object represents a registry function and an associated list of roles for this result report.

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

- 2.12
RegistryEntry string - A URI ([RFC3986]) that is the value of the registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.12
Roles string - Comma-separated list of strings (maximum item length 256), representing the roles of the function. - 2.12
Device.LMAP.Event.{i}. object W

This object defines the information associated with an event used within the measurement agent. Event instances may be referenced by various objects within the LMAP model.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Event instance.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(256) W Name of the Event. - 2.12
Type string W

This parameter describes the type of Event for this object instance. The timing of the event occurrence is adjusted based on the value of the RandomnessSpread parameter.

  • PeriodicTiming (Periodic Timing Event. When selected one or more event occurrences are emitted based on the parameters defined in the PeriodicTimer object)
  • CalendarTiming (Calendar Timing Event. When selected one or more event occurrences are emitted based on the parameters defined in the CalendarTimer object)
  • OneOffTiming (One-off Timing Event. When selected a single event occurrence is emitted based on the parameters defined in the OneOff object)
  • Immediate (Immediate Timing Event. When selected a single event occurrence is emitted as soon as possible)
  • Startup (Startup Timing Event. When selected a single event occurrence is emitted when the corresponding measurement agent starts up)
  • ControllerLost (Controller Lost Event. When selected a single event occurrence is emitted when the connectivity to the controller is lost)
  • ControllerConnected (Controller Connected Event. When selected a single event occurrence is emitted when the connectivity to the controller is established)
"Immediate" 2.12
RandomnessSpread int W The spread, in seconds, of the Uniform Discrete random distribution algorithm. A value of 0 means that the random algorithm is not applied. - 2.12
CycleInterval int W The duration of the time interval, in seconds, that used to calculate cycle numbers. - 2.12
Device.LMAP.Event.{i}.PeriodicTimer. object - This object defines a periodic timer instance. The periodic timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the interval to use. - 2.12
StartTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to begin operation. - 2.12
EndTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to end operation. - 2.12
Interval unsignedInt W The tolerable duration, in seconds, of the interval for this PeriodicTimer instance. - 2.12
Device.LMAP.Event.{i}.CalendarTimer. object -

This object defines a calendar timer instance.

The calendar timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the schedule of the recurrence.

The algrorithm that defines how the schedule elements are evaluated is defined in [LMAPIFM].

If the value of any of the ScheduleMonths, ScheduleDaysOfMonth, ScheduleDaysOfWeek, ScheduleHoursOfDay, ScheduleMinutesOfHour or ScheduleSecondsOfMinute is an empty string then any actions that use this object will not be invoked.

- 2.12
StartTime dateTime W Date and time that the CalendarTimer instance is to begin this operation. - 2.12
EndTime dateTime W Date and time that the CalendarTimer instance is to end this operation. - 2.12
ScheduleMonths string W

This parameter represents either a list of the months of year that are applied to the schedule or an asterisk (*) that represents all the elements of the list.

Each entry in the months of the year list can be a numeric value or the name of the month (january (1), february (2), march (3), april (4), may (5), june (6), july (7), august (8), september (9), october (10), november (11), december (12)).

- 2.12
ScheduleDaysOfMonth string W This parameter represents either a list of the days of the month (1-31) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.12
ScheduleDaysOfWeek string W

This parameter represents either a list of the days of the week that are applied to the schedule or an asterisk (*) that represents all the elements of the list.

Each entry in the days of the week list can be a numeric value or the name of the day (sunday (1), monday (2), tuesday (3), wednesday (4), thursday (5), friday (6), saturday (7)).

- 2.12
ScheduleHoursOfDay string W This parameter represents either a list of the hours of the day (0-23) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.12
ScheduleMinutesOfHour string W This parameter represents either a list of the minutes of the hour (0-59) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.12
ScheduleSecondsOfMinute string W This parameter represents either a list of the minutes of the hour (0-59) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.12
EnableScheduleTimezoneOffset boolean W

When true, the value of the ScheduleTimezoneOffset parameter is applied to the schedule elements.

When false, the device's system timezone offset is applied to the schedule elements.

- 2.12
ScheduleTimezoneOffset int­[-23:23] W The timezone offset, in hours, to be applied to the schedule elements. - 2.12
Device.LMAP.Event.{i}.OneOff. object - This object defines a one off timer instance. - 2.12
StartTime dateTime W Date and time, based on [RFC3339], that the OneOff instance is to begin operation. - 2.12
Device.LocalAgent. object -

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.

- 2.12
EndpointID string - The unique USP identifier for this USP Agent. - 2.12
SoftwareVersion string­(64) -

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

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

- 2.12
UpTime unsignedInt - Time in seconds since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device). - 2.12
Periodic! event - Periodic event configured via the recipient Controller's Controller.{i}.PeriodicNotifInterval and Controller.{i}.PeriodicNotifTime parameters. - 2.12
WakeUp! event - Wake-up event. - 2.12
TransferComplete! event -

Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case FaultCode will be zero), or else has failed (in which case FaultCode will be non-zero and FaultString will give further details).

The file transfer can be requested via a USP operation or via some other mechanism. If it's requested via a USP operation Command, CommandKey and Requestor give further details.

- 2.12
⇒ Command string - The Path Name of the command that requested the transfer, or an empty string if the transfer was not requested via a USP operation. - 2.12
⇒ CommandKey string - The command_key supplied when requesting the transfer, or an empty string if the transfer was not requested via a USP operation. <Empty> 2.12
⇒ Requestor string - The Endpoint ID of the Controller that requested the transfer, or an empty string if no Controller requested it. <Empty> 2.12
⇒ TransferType string -

The type (direction) of the transfer. Enumeration of:

  • Download (Downstream transfer; to the Agent)
  • Upload (Upstream transfer; from the Agent)
"Download" 2.12
⇒ Affected string - The Path Name of the Object or Object Instance that was affected by the transfer, or an empty string if no data model object was affected by the transfer. <Empty> 2.12
⇒ TransferURL string­(1024) - The URL from or to which this transfer was performed, or an empty string if no such URL is available. <Empty> 2.12
⇒ StartTime dateTime - The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value. 0001-01-01T00:00:00Z 2.12
⇒ CompleteTime dateTime - The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value. 0001-01-01T00:00:00Z 2.12
⇒ FaultCode unsignedInt - The numerical fault code as defined in [TR-369]. A value of 0 (zero) indicates no fault. 0 2.12
⇒ FaultString string­(256) - A human-readable text description of the fault. This field SHOULD be an empty string if the FaultCode equals 0 (zero). <Empty> 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
SupportedProtocols string -

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

- 2.12
SupportedFingerprintAlgorithms string -

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

Each list item is an enumeration of:

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

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

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

- 2.12
MTPNumberOfEntries unsignedInt - The number of entries in the MTP table. - 2.12
ControllerNumberOfEntries unsignedInt - The number of entries in the Controller table. - 2.12
SubscriptionNumberOfEntries unsignedInt - The number of entries in the Subscription table. - 2.12
RequestNumberOfEntries unsignedInt - The number of entries in the Request table. - 2.12
CertificateNumberOfEntries unsignedInt - The number of entries in the Certificate table. - 2.12
Device.LocalAgent.MTP.{i}. object 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enable/Disable this MTP instance.

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

false 2.12
Status string -

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

  • Up
  • Down (Value when this MTP instance cannot establish communication)
  • Error (Value when this MTP instance is misconfigured, OPTIONAL)
- 2.12
Protocol string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. "Co­AP" 2.12
EnableMDNS boolean W

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

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

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

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

true 2.12
Device.LocalAgent.MTP.{i}.CoAP. object - If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - 2.12
Interfaces string W

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

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

- 2.12
Port unsignedInt­[1:65535] W The port number used by the CoAP Server to receive USP messages. 5683 2.12
Path string W The path that is used by the CoAP Server in order to receive USP messages. - 2.12
IsEncrypted boolean - This parameter represents whether or not communications that utilize this CoAP object instance are encrypted. - 2.12
EnableEncryption boolean W When true, encryption is used for this MTP instance. true 2.12
Device.LocalAgent.MTP.{i}.STOMP. object - If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server. - 2.12
Reference string W The value MUST be the Path Name of a row in the STOMP.Connection table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP. <Empty> 2.12
Destination string W The STOMP destination where the Agent will be listening to incoming USP messages. <Empty> 2.12
DestinationFromServer string -

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

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

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

<Empty> 2.12
Device.LocalAgent.MTP.{i}.WebSocket. object - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. - 2.12
Interfaces string W

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

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

- 2.12
Port unsignedInt­[1:65535] W The port number used by the WebSocket Server to receive USP messages. 5683 2.12
Path string W The path that is used by the WebSocket Server in order to receive USP messages. - 2.12
Device.LocalAgent.Controller.{i}. object 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
EndpointID string W The unique USP identifier for this USP Controller. <Empty> 2.12
ControllerCode string­(128) W

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

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

<Empty> 2.12
ProvisioningCode string­(64) W Identifying information which MAY be used by the Controller instance to determine Controller instance specific customization and provisioning parameters. <Empty> 2.12
Enable boolean W

Enable/Disable this Controller instance.

When false, messages (notifications) are not sent to the remote endpoint represented by this Controller instance.

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

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

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

- 2.12
PeriodicNotifInterval unsignedInt­[1:] W If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is the duration in seconds of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller. - 2.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 [Section 3.2/TR-106a2] 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
USPNotifRetryMinimumWaitInterval unsignedInt­[1:65535] W

This parameter is related to the retry mechanism for Notifications.

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

A value of 5 corresponds to the default behavior.

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

5 2.12
USPNotifRetryIntervalMultiplier unsignedInt­[1000:65535] W

This parameter is related to the retry mechanism for Notifications.

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

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

A value of 2000 corresponds to the default behavior.

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

2000 2.12
ScheduleTimer() command - Schedule a Timer! event on the associated Controller. - 2.12
Timer! event - Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message. - 2.12
⇒ CommandKey string - The command_key supplied when requesting the timer event. - 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
SendOnBoardRequest() command - Requests the Agent to send an OnBoardRequest notification to this Controller. - 2.12
BootParameterNumberOfEntries unsignedInt - The number of entries in the BootParameter table. - 2.12
MTPNumberOfEntries unsignedInt - The number of entries in the MTP table. - 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}. object 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enable/Disable this MTP instance.

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

false 2.12
Protocol string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. "Co­AP" 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.CoAP. object - If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - 2.12
Host string­(256) W The hostname or IP Address of the Controller's CoAP server. - 2.12
Port unsignedInt­[1:65535] W The port number used by the Controller's CoAP Server to receive USP messages. - 2.12
Path string W The path that is used by the Controller's CoAP Server in order to receive USP messages. - 2.12
EnableEncryption boolean W When true, encryption is used as specified in [Section "MTP Message Encryption"/TR-369]. true 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.STOMP. object - If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server. - 2.12
Reference string W The value MUST be the Path Name of a row in the STOMP.Connection table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP. <Empty> 2.12
Destination string W The STOMP destination where the Controller will be listening to incoming USP messages. <Empty> 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket. object - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. - 2.12
Host string­(256) W The hostname or IP Address of the Controller's WebSocket server. - 2.12
Port unsignedInt­[1:65535] W The port number used by the Controller's WebSocket server to receive USP messages. - 2.12
Path string W The path that is used by the Controller's WebSocket server in order to receive USP messages. - 2.12
IsEncrypted boolean - This parameter represents whether or not communications that utilize this WebSocket object instance are encrypted. - 2.12
KeepAliveInterval unsignedInt­[1:] W The the duration in seconds between when WebSocket ping control frames are transmitted by the Agent to the WebSocket server for the USP Controller. - 2.12
CurrentRetryCount unsignedInt - The current retry count of the session. When zero (0), the session is not in a retry state. - 2.12
SessionRetryMinimumWaitInterval unsignedInt­[1:65535] W

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

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

5 2.12
SessionRetryIntervalMultiplier unsignedInt­[1000:65535] W

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

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

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

2000 2.12
Reset() command - [ASYNC] If enabled, this command will either request to start or restart an WebSocket session with the Controller. - 2.12
Device.LocalAgent.Controller.{i}.TransferCompletePolicy. object - The policy defined in this object determines the conditions under which the USP Agent notifies a USP Controller, that has an appropriate Subscription, of the completion of file transfers. - 2.12
ResultTypeFilter string W

Indicates the transfer results that MUST be included when the USP Agent notifies a USP Controller of file transfers. Transfer results omitted from this list MUST NOT be included when the USP Agent notifies a USP Controller. Enumeration of:

- 2.12
Device.LocalAgent.Controller.{i}.BootParameter.{i}. object W

This table provides the Controller with the ability to dictate the Parameters that are delivered via Boot! events.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the param_map element of the Boot! event.

At most one entry in this table can exist with a given value for ParameterName, or with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enables or disables this BootParameter. false 2.12
ParameterName string­(256) W

A pattern that describes the Parameter(s) to be included in the param_map element of a Boot! event. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed.

If the pattern does not match any existing Parameters at the time that the Agent is creating the Boot! event, then this BootParameter instance is not included in the param_map of the Boot! event.

<Empty> 2.12
Device.LocalAgent.Controller.{i}.E2ESession. object - The E2ESession object represents the End to End (E2E) Session Context functionality for this Controller.{i} object instance. - 2.12
Enable boolean W

Enable/Disable this E2ESession instance.

When true, Session Context is used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance.

When false, Session Context is not used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance.

false 2.12
Status string -

The current status of the Session Context. Enumeration of:

  • Up
  • Negotiating (A new Session Context is being negotiated (i.e., a USP Record with sequence_id of 0 and session_id not previously used with this remote endpoint was sent and response has not yet been received), OPTIONAL)
  • Down
- 2.12
SessionExpiration unsignedInt­[0:] W

The duration in seconds in which the current Session Context will expire since the last session-related activity (e.g., Message sent or received, Session Context start or restart).

A value of 0 means session expiration is disabled.

0 2.12
SessionRetryMinimumWaitInterval unsignedInt­[1:65535] W

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

A value of 5 corresponds to the default behavior that is described in [TR-369].

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

5 2.12
SessionRetryIntervalMultiplier unsignedInt­[1000:65535] W

Configures the retry interval multiplier as specified in [Section "Failure Handling in the Session Context"/TR-369].

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

A value of 2000 corresponds to the default behavior that is described in [TR-369].

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

2000 2.12
CurrentRetryCount unsignedInt - The current retry count of the Session Context. When zero (0), the Session Context is not in a retry state. - 2.12
SegmentedPayloadChunkSize unsignedInt­[0, 512:] W

The maximum size, in bytes, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes.

A value of 0 means that the segmentation function is effectively disabled.

0 2.12
MaxRetransmitTries int­[-1:10] W

The maximum times that a USP Endpoint attempts to retransmit the requested USP Record to the remote endpoint.

If the maximum tries is met for any requested USP Record, the USP Endpoint will restart the E2E Session.

A value of -1 means that the USP Endpoint will always attempt to retransmit the requested USP Record.

A value of 0 means that the USP Endpoint will not attempt to retransmit the requested USP Record and will restart the E2E Session.

0 2.12
PayloadSecurity string W

The security mechanism to use when exchanging the payload of the Record with the remote endpoint. Enumeration of:

  • Plaintext
  • TLS (The payload is encrypted at the originating endpoint and decrypted at the receiving endpoint using TLS. The procedures for using TLS in a Session Context is defined in [TR-369])
"TLS" 2.12
Reset() command -

[ASYNC] If the E2ESession is enabled then this command will either request to start or restart a Session Context with the remote endpoint.

If the E2ESession is not enabled and there is an active Session Context then this command will terminate that Session Context with the remote endpoint.

If the E2ESession is not enabled and there is no active Session Context then this command does nothing.

- 2.12
Device.LocalAgent.Subscription.{i}. object 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 Recipient and ID. On creation of a new table entry, the Agent MUST choose initial values for Alias and Recipient such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias, Recipient and ID are immutable and therefore MUST NOT change once they've been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enables/disables this Subscription. A disabled entry MUST NOT be processed by the USP Agent. false 2.12
Recipient string -

The value MUST be the Path Name of the Controller instance that will receive the Notification associated with this Subscription. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string).

The value of this parameter is automatically populated by the USP Agent upon Subscription creation using the reference to the USP Controller that created the instance.

- 2.12
ID string­(64) W

Unique identifier of the Subscription itself, which is specific to the USP Controller that creates the instance of the Subscription.

This value is also populated in the subscription_id element of every Notification message sent from a USP Agent to a USP Controller.

<Empty> 2.12
CreationDate dateTime -

The date and time when this instance of Subscription was created. This is internally used by the TimeToLive parameter to determine the expiration of this Subscription instance.

The value of this parameter is automatically populated by the USP Agent upon Subscription creation.

- 2.12
NotifType string W

Type of Notification message that will be sent to the USP Controller specified by Recipient when this Subscription is triggered. Enumeration of:

- 2.12
ReferenceList string W

Comma-separated list of strings (maximum item length 256). Each entry in the list is a parameter path that determines the element 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 are allowed in the list items, but in some cases could cause a dynamic set of instances to be monitored 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.

- 2.12
Persistent boolean W

Determines whether or not this Subscription remains after the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).

If true, this Subscription stays in existence until either a Delete message removes it or the TimeToLive parameter expires.

If false, this Subscription is automatically removed by the USP Agent whenever it is restarted.

false 2.12
TimeToLive unsignedInt W

Specifies the duration of time (in seconds) that this Subscription remains in existence. After TimeToLive has expired, this Subscription instance is automatically removed by the USP Agent.

If the value of TimeToLive is 0, then this parameter is ignored and this Subscription stays in existence until either a Delete message removes it or the Persistent parameter determines that it needs to be removed.

If the value of TimeToLive is greater than 0, then this parameter determines the length of time (from Subscription creation) until it will be automatically removed by the USP Agent (unless the Persistent parameter is false and the USP Agent is restarted, in which case it will be removed before the TimeToLive expiration). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to.

If the USP Agent is incapable of maintaining absolute time then TimeToLive will automatically expire if the USP Agent is restarted (either via a reset of the software or reboot of the underlying device) before TimeToLive expiration.

0 2.12
NotifRetry boolean W

Specifies whether or not the USP Agent attempts to re-deliver the Notification in the event that it could not be delivered to the USP Controller.

When NotifRetry is true, the USP Agent MUST retry the delivery of the Notification. This implies that the Notification MUST be generated with the "send_resp" flag set to true such that the USP Agent knows when the Notification has been successfully delivered. The retry attempt(s) are performed using the retry algorithm defined in [Section "Responses to Notifications and Notification Retry"/TR-369].

When NotifRetry is false, the USP Agent MUST NOT retry the delivery of the Notification, and SHOULD generate the notification with "send_resp" flag set to false.

false 2.12
NotifExpiration unsignedInt W

Specifies the duration of time (in seconds) that the Notification associated with this Subscription will continue to be retried. After NotifExpiration has expired, if the Notification has still not been successfully delivered then the USP Agent MUST stop attempting to re-deliver the Notification.

If NotifRetry is set to false then this parameter is ignored.

If NotifRetry is set to true and the value of NotifExpiration is 0, then the USP Agent will attempt to re-deliver the Notification until it has been successfully delivered or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).

If NotifRetry is set to true and the value of NotifExpiration is greater than 0, then the USP Agent will attempt to re-deliver the Notification until either it has been successfully delivered, until the length of time (from the time tha the Notification was initially attempted to be delivered) specified in this parameter expires, or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).

NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to.

0 2.12
Device.LocalAgent.Request.{i}. object -

Request instances are created using USP Operate messages. Only Operate messages with async=true will create a Request instance in the data model.

When the command of the Operate completes, then this Request instance is removed from this table.

At most one entry in this table can exist with all the same values for Originator, Command and CommandKey, or with a given value for Alias. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Originator string - The USP Endpoint Identifier that originated the command. - 2.12
Command string -

The command to be executed. This parameter is a Path Name that addresses a Command in an Object or Object Instance.

The command is a result of the evaluation of the command argument of an Operate message.

- 2.12
CommandKey string - The command_key from the USP Operate message. - 2.12
Status string -

The operational status of the request to execute the command. Enumeration of:

  • Requested (The command has been requested but is currently not executing)
  • Active (The command is currently executing)
  • Canceling (The command has been requested to be canceled)
  • Canceled (The command has successfully been canceled)
  • Success (The command has successfully been completed its execution)
  • Error (The command has unsuccessfully completed its execution or has unsuccessfully been canceled)
- 2.12
Cancel() command -

Request cancelation of this Request's command.

This command completes immediately. If successful, Status will immediately change to Canceling and will change to Canceled when the cancelation is complete.

- 2.12
Device.LocalAgent.Certificate.{i}. object -

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

At most one entry in this table can exist with the same values for SerialNumber and Issuer, or with a given value for Alias. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enable/Disable this Certificate instance. - 2.12
SerialNumber string­(64) - The Serial Number field in an X.509 certificate, see [RFC5280]. - 2.12
Issuer string­(256) - The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 2.12
Delete() command - This command is issued to allow a Controller (with the proper permissions) to delete an entry from the Certificate.{i}. It also removes references to the Certificate in LocalAgent.Controller.{i}.Credential or LocalAgent.ControllerTrust.Credential.{i}.Credential and removes any X.509 certificate data the Agent had stored related to the entry. - 2.12
GetFingerprint() command - This command is issued to allow a Controller to request the value of a fingerprint calculated for the specified table entry using the input FingerprintAlgorithm. - 2.12
Device.LocalAgent.ControllerTrust. object - This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.12
UntrustedRole string W

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

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

- 2.12
BannedRole string W

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

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

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

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

Inactivity timer in seconds.

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

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

- 2.12
RequestChallenge() command -

This command is issued to retrieve the instruction for the referenced challenge.

There is at most one (1) outstanding RequestChallenge for a requesting Controller.

As such, any new challenges with a different value of the ChallengeRef parameter are denied until a successful response to the outstanding challenge is received by the Agent or the current RequestChallenge expires.

When the value of the ChallengeRef parameter defined in the RequestChallenge does not exist, the Agent returns an "Invalid Value" error.

- 2.12
ChallengeResponse() command - This command is issued to return the response of challenge. - 2.12
RoleNumberOfEntries unsignedInt - The number of entries in the Role table. - 2.12
CredentialNumberOfEntries unsignedInt - The number of entries in the Credential table. - 2.12
ChallengeNumberOfEntries unsignedInt - The number of entries in the Challenge table. - 2.12
Device.LocalAgent.ControllerTrust.Role.{i}. object 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 choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enable/Disable this Role instance. false 2.12
Name string W The Role assigned to this Role instance. - 2.12
PermissionNumberOfEntries unsignedInt - The number of entries in the Permission table. - 2.12
Device.LocalAgent.ControllerTrust.Role.{i}.Permission.{i}. object 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enable/Disable this Permission instance. false 2.12
Order unsignedInt W

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

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

0 2.12
Targets string W

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

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

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

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

<Empty> 2.12
Param string­(4:4) W

The permissions of a Role for the specified Targets.

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

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

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

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

The permissions of a Role for the specified Targets.

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

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

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

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

The permissions of a Role for the specified Targets.

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

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

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

  1. Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances.
  2. Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.).
  3. Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription.
–– 2.12
CommandEvent string­(4:4) W

The permissions of a Role for the specified Targets.

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

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

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

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

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

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

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

At most one entry in this table can exist with a given value for Alias, or with a given value for Credential. On creation of a new table entry, the Agent MUST choose initial values for Alias and Credential such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W Enable/Disable this Credential instance. false 2.12
Role string W

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

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

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

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

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

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

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

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

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

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

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

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

This could include (but is not limited to):

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

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Description string W The description of this Challenge instance. - 2.12
Role string W

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

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

- 2.12
Enable boolean W Enable/Disable this Challenge instance. false 2.12
Type string W

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

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

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

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

- 2.12
ValueType string W

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

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

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

- 2.12
Retries unsignedInt W The number of times a challenge is retried before the challenge procedure is terminated. - 2.12
LockoutPeriod int­[0:] W

The time, in seconds that a Controller that has failed the challenge is locked out (based on the value of the Retries parameter) prior to being provided the challenge again.

A value of zero means that a LockoutPeriod doesn't apply and the challenge can be provided indefinitely.

30 2.12
Device.STOMP. object - The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.12
ConnectionNumberOfEntries unsignedInt - The number of entries in the Connection table. - 2.12
Device.STOMP.Connection.{i}. object W

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

At most one entry in this table can exist with all the same values for Host, Username and VirtualHost, or with a given value for Alias. On creation of a new table entry, the Agent MUST choose initial values for Host, Username and Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Enable boolean W

Enables or disables this Connection.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.12
Status string -

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

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

When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

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

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

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

- 2.12
VirtualHost string­(256) W

The Virtual Host to use when establishing the connection.

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

<Empty> 2.12
EnableHeartbeats boolean W

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

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

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

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

false 2.12
OutgoingHeartbeat unsignedInt W

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

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

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

0 2.12
IncomingHeartbeat unsignedInt W

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

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

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

0 2.12
ServerRetryInitialInterval unsignedInt­[1:65535] W

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

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

60 2.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).

2000 2.12
ServerRetryMaxInterval unsignedInt­[1:] W

The maximum reconnection wait interval, in seconds.

If the nth reconnection wait interval calculated from ServerRetryInitialInterval and ServerRetryIntervalMultiplier exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval.

30720 2.12
IsEncrypted boolean - This parameter represents whether or not communications that utilize this Connection object instance are encrypted. - 2.12
Device.Standby. object - Capabilities of a Device as it pertains to entering a standby state. - 2.12
NetworkAware boolean - Indicates that the device is capable of maintaining a network connection and responding to communications via the network connection while in a standby state. - 2.12
TimerAware boolean - Indicates that the device is capable of maintaining and responding to timers while in a standby state. - 2.12
Device.SoftwareModules. object - Top level object for dynamically managed software applications. - 2.12
InstallDU() command - [ASYNC] Install one or more Deployment Units (DUs) to the associated SoftwareModules. - 2.12
DUStateChange! event -

This event informs a Controller of the completion (successful or unsuccessful) of a DU state change.

When used, this event MUST be issued after the device has completed any file transfers and carried out all operations related to the DU State Change.

This event MAY contain the results from multiple DU state changes; it is implementation specific how the device chooses to aggregate the DU state changes, although the device MUST notify the Controller of any DU state changes within 24 hours of the time the operations were completed by the device.

The device SHOULD make every attempt to aggregate, as much as possible, the DU State Change notifications to the Controller in the interest of scalability.

- 2.12
⇒ UUID string­(36:36) - [UUID] The UUID as defined in [RFC4122] of the DU that affected by the state change. - 2.12
⇒ DeploymentUnitRef string - The value MUST be the Path Name of a row in the SoftwareModules.DeploymentUnit table. A reference to the DU that was affected by the state change. - 2.12
⇒ Version string­(32) -

In the case of an Install, this will be the version of the DU created. In the case of an Update, it will be the updated version of the DU. In the case of an Uninstall, it will be the version of the uninstalled DU.

This MUST match the SoftwareModules.DeploymentUnit.{i}.Version Parameter contained within the instance of the DeploymentUnit that is contained within the DeploymentUnitRef argument.

- 2.12
⇒ CurrentState string -

The current state of the created DU. Enumeration of:

  • Installed (The DU is in an Installed state due to one of the following: successful Install, successful Update, failed Update, or failed Uninstall. In the case of a failed Update or failed Uninstall the Fault argument will contain an explanation of the failure)
  • UnInstalled (The DU was successfully uninstalled from the device)
  • Failed (The DU could not be installed in which case a DU instance MUST NOT be created in the Data Model)
- 2.12
⇒ Resolved boolean -

Whether or not the DU operation resolved all of its dependencies.

In the case of a successful Uninstall, this value is meaningless and should be true.

- 2.12
⇒ ExecutionUnitRefList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the SoftwareModules.ExecutionUnit table. The Execution Units affected by this operation.

In the case of an Install, this will be the list of EUs that were created as a result of the DU’s installation.

In the case an Update, this will be the list of all EUs currently associated with the updated DU, including those that were created through the initial DU installation and any updates that had already occurred but not including any EUs that no longer exist on the device because of this or previous updates.

In the case of an Uninstall, this will be the list of the EUs removed from the device due to the DU being removed.

- 2.12
⇒ StartTime dateTime - The date and time transfer was started in UTC. The device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value. - 2.12
⇒ CompleteTime dateTime - The date and time the transfer was fully completed and applied in UTC. This need only be filled in if the transfer has been fully completed and applied. The device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value. - 2.12
⇒ OperationPerformed string -

The operation that was performed against the DU causing the DU state change. Enumeration of:

  • Install (The operation attempted was the Installation of a DU)
  • Update (The operation attempted was the Update of an existing DU)
  • Uninstall (The operation attempted was the Un-Installation of an existing DU)
- 2.12
⇒ Fault. object - Fault Structure. If the operation was successful, the FaultCode MUST be zero. Otherwise a non-zero FaultCode is specified along with a FaultString indicating the failure reason. - 2.12
⇒ FaultCode unsignedInt -

The numerical fault code. Valid values are:

  • If the operation was successful, the fault code is 0.
  • If the device cannot complete the operation for some unknown reason, it SHOULD reject the operation with a 9001 (Request Denied) fault code.
  • If the device detects the presence of the "userinfo" component in the file source URL, it SHOULD reject the operation with a 9003 (Invalid Arguments) fault code.
  • If the device cannot find the Execution Environment specified in the Install or Update command, it SHOULD reject the operation with a 9023 (Unknown Execution Environment) fault code.
  • If the device determines that the Deployment Unit being installed does not match either the Execution Environment specified or any Execution Environment on the device, it SHOULD reject the operation with a 9025 (Deployment Unit to Execution Environment Mismatch) fault code
  • If the device detects that the Deployment Unit being installed already has the same version as one already installed on the same Execution Environment, it SHOULD reject the operation with a 9026 (Duplicate Deployment Unit) fault code.
  • If the device detects that that there are no more system resources (disk space, memory, etc.) to perform the Install or Update of a Deployment Unit, it SHOULD reject the operation with a 9027 (System Resources Exceeded) fault code.
  • If a requested operation attempts to alter the State of a Deployment Unit in a manner that conflicts with the Deployment Unit State Machine Diagram [Appendix I "Software Module Management"/TR-369], it SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code.
  • If a requested operation attempts to Uninstall a DU that caused an EE to come into existence, where that EE has at least 1 installed DU or at least 1 child EE, then the device SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code.
- 2.12
⇒ FaultString string­(256) - A human-readable text description of the fault. This field SHOULD be empty if the FaultCode equals 0 (zero). - 2.12
ExecEnvNumberOfEntries unsignedInt - The number of entries in the ExecEnv table. - 2.12
DeploymentUnitNumberOfEntries unsignedInt - The number of entries in the DeploymentUnit table. - 2.12
ExecutionUnitNumberOfEntries unsignedInt - The number of entries in the ExecutionUnit table. - 2.12
Device.SoftwareModules.ExecEnv.{i}. object -

The Execution Environments that are available on the device, along with their properties and configurable settings.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.12
Enable boolean W

Indicates whether or not this ExecEnv is enabled.

Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it.

When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to Idle.

If an Update or Uninstall operation is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that operation fails and the associated event will contain a FaultStruct for that operation.

Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and a Controller disabled it, the Agent might be terminated leaving the device unmanageable.

- 2.12
Status string -

Indicates the status of this ExecEnv. Enumeration of:

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(32) - A Name provided by the device that adequately distinguishes this ExecEnv from all other ExecEnv instances. - 2.12
Type string­(64) - Indicates the complete type and specification version of this ExecEnv. - 2.12
InitialRunLevel unsignedInt­[:65535] W

The run level that this ExecEnv will be in upon startup (whether that is caused by a device Boot or the Execution Environment starting).

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this ExecEnv.

- 2.12
CurrentRunLevel int­[-1:65535] -

The run level that this ExecEnv is currently operating in. This value is altered by executing the SetRunLevel() command.

Upon startup (whether that is caused by a device Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or executing the command SetRunLevel() will not impact the Run Level of this ExecEnv.

- 2.12
InitialExecutionUnitRunLevel int­[-1:65535] W

Indicates the initial value on creation for ExecutionUnit.{i}.RunLevel for all Execution Unit instances associated with this ExecEnv.

If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit.

- 2.12
Vendor string­(128) - The vendor that produced this ExecEnv. - 2.12
Version string­(32) - The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification. - 2.12
ParentExecEnv string -

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

If this value is an empty string then this is the Primary Execution Environment.

- 2.12
AllocatedDiskSpace int­[-1:] - The amount of disk space measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12
AvailableDiskSpace int­[-1:] - The amount of disk space measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes disk space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12
AllocatedMemory int­[-1:] - The amount of physical RAM measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12
AvailableMemory int­[-1:] - The amount of physical RAM measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv are started/stopped and consume the physical RAM. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12
ActiveExecutionUnits string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances currently running on this ExecEnv. This parameter only contains ExecutionUnit instances that currently have a ExecutionUnit.{i}.Status of Active. - 2.12
ProcessorRefList string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it. - 2.12
SetRunLevel() command -

Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this comand will change the value of the CurrentRunLevel.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

- 2.12
Reset() command -

This command causes this ExecEnv to revert back to the state it was in when the device last issued a Boot event with a cause of a local or remote factory reset.

The following requirements dictate what MUST happen for the reset to be complete:

  1. All Deployment Units that were installed after the last Boot (with cause of a factory reset) event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last Boot (with cause of a factory reset) event event was issued
  4. Any Deployment Unit that was present when the last Boot (with cause of a factory reset) eventevent was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last "0 BOOTSTRAP" Inform event was issued
  5. The Execution Environment MUST be restored to the version and configuration present when the last Boot (with cause of a factory reset) eventevent was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met
- 2.12
Device.SoftwareModules.DeploymentUnit.{i}. object -

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 all the same values for UUID, Version and ExecutionEnvRef, or with a given value for Alias. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
UUID string­(36) -

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 [Appendix TBD/TR-181i2a12].

This value MUST NOT be altered when the DeploymentUnit is updated.

- 2.12
DUID string­(64) - Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific. - 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(64) -

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 [Annex H/TR-069].

- 2.12
Status string -

Indicates the status of this DeploymentUnit. Enumeration of:

  • Installing (This instance is in the process of being Installed and SHOULD transition to the Installed state)
  • Installed (This instance has been successfully Installed. The Resolved flag SHOULD also be referenced for dependency resolution)
  • Updating (This instance is in the process of being Updated and SHOULD transition to the Installed state)
  • Uninstalling (This instance is in the process of being Uninstalled and SHOULD transition to the Uninstalled state)
  • Uninstalled (This instance has been successfully Uninstalled. This status will typically not be seen within a DeploymentUnit instance)
- 2.12
Resolved boolean - Indicates whether or not this DeploymentUnit has resolved all of its dependencies. - 2.12
URL string­(1024) - Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit. - 2.12
Description string­(256) - Textual description of this DeploymentUnit. The format of this value is Execution Environment specific. - 2.12
Vendor string­(128) -

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 [Annex H/TR-069a3].

- 2.12
Version string­(32) - Version of this DeploymentUnit. The format of this value is Execution Environment specific. - 2.12
VendorLogList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this DeploymentUnit.

This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the device.

Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 2.12
VendorConfigList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this DeploymentUnit.

This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the device.

Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 2.12
ExecutionUnitList string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances that are associated with this DeploymentUnit instance. - 2.12
ExecutionEnvRef string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv instance where this DeploymentUnit instance is installed. - 2.12
Update() command - [ASYNC] Update the associated DeploymentUnit. - 2.12
Uninstall() command - [ASYNC] Uninstall the associated DeploymentUnit. - 2.12
Device.SoftwareModules.ExecutionUnit.{i}. object -

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
EUID string­(64) -

Execution Unit Identifier chosen by the ExecEnv during installation of the associated DeploymentUnit.

The format of this value is Execution Environment specific, but it MUST be unique across ExecEnv instances. Thus, it is recommended that this be a combination of the ExecEnv.{i}.Name and an Execution Environment local unique value.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12
Name string­(32) - The name of this ExecutionUnit as it pertains to its associated DeploymentUnit, which SHOULD be unique across all ExecutionUnit instances contained within its associated DeploymentUnit. - 2.12
ExecEnvLabel string­(64) - The name of this ExecutionUnit as provided by the ExecEnv, which SHOULD be unique across all ExecutionUnit instances contained within a specific ExecEnv. - 2.12
Status string -

Indicates the status of this ExecutionUnit. Enumeration of:

  • Idle (This instance is in an Idle state and not running)
  • Starting (This instance is in the process of Starting and SHOULD transition to the Active state)
  • Active (This instance is currently running)
  • Stopping (This instance is in the process of Stopping and SHOULD transition to the Idle state)
- 2.12
ExecutionFaultCode string -

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:

For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].

- 2.12
ExecutionFaultMessage string­(256) -

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem.

If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the Controller.

- 2.12
AutoStart boolean W

If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted.

If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the Controller or another Execution Unit.

- 2.12
RunLevel unsignedInt­[:65535] W

Determines when this ExecutionUnit will be started.

If AutoStart is true and ExecEnv.{i}.CurrentRunLevel is greater than or equal to RunLevel, then this ExecutionUnit will be started.

If the value of ExecEnv.{i}.CurrentRunLevel is -1, then the associated ExecEnv. doesn't support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this ExecutionUnit.

- 2.12
Vendor string­(128) - Vendor of this ExecutionUnit. - 2.12
Version string­(32) - Version of the ExecutionUnit. The format of this value is Execution Environment specific. - 2.12
Description string­(256) - Textual description of this ExecutionUnit. The format of this value is Execution Environment specific. - 2.12
DiskSpaceInUse int­[-1:] - The amount of disk space measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 2.12
MemoryInUse int­[-1:] - The amount of physical RAM measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 2.12
References string -

Comma-separated list of strings. Each list item MUST be the Path Name of a table row. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit.

NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the GetSupportedDM and GetInstances USP messages.

- 2.12
AssociatedProcessList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.ProcessStatus.Process table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the system processes that are active in the system because of this ExecutionUnit.

If Status is not Active it is expected that this list will be an empty string. Some ExecutionUnit instances MIGHT NOT have any system processes irrespective of the value of Status.

- 2.12
VendorLogList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the device.

Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 2.12
VendorConfigList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the device.

Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 2.12
ExecutionEnvRef string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv that this ExecutionUnit is associated with. - 2.12
SetRequestedState() command -

Set the state transition that the Controller is requesting for this instance of the ExecutionUnit object. Enumeration of:

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.12
Device.SoftwareModules.ExecutionUnit.{i}.Extensions. object -

This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit.

It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of References and use of GetSupportDM and GetInstances USP messages will be used to determine their locations.

- 2.12
Device.ProxiedDevice.{i}. object -

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Alias string­(64) W

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.

The value MUST NOT change once it's been assigned.

- 2.12

Notification Requirements

Parameters for which Value Change Notification MAY be Denied

Parameter
Device.Ethernet.LAG.{i}.
LastChange
Device.Ethernet.LAG.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.WiFi.Radio.{i}.
ChannelLastChange
Device.IP.Interface.{i}.TWAMPReflector.{i}.
Alias
Device.L2TPv3.Tunnel.{i}.
Alias
Device.L2TPv3.Tunnel.{i}.Interface.{i}.
Alias
LastChange
Device.VXLAN.Tunnel.{i}.
Alias
Device.VXLAN.Tunnel.{i}.Interface.{i}.
Alias
LastChange
Device.Hosts.Host.{i}.WANStats.
DiscardPacketsSent
Device.BASAPM.MeasurementEndpoint.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.
Alias
Storage
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats.
Invocations
Suppressions
Overlaps
Failures
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.
Alias
Storage
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Stats.
Invocations
Suppressions
Overlaps
Failures
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Task.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}.
Alias
Device.LMAP.Event.{i}.
Alias
Device.LocalAgent.
UpTime

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

VDSL2:3 Profile

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

Name Requirement
Device.­DSL.­Line.­{i}. P

L2TPv3Basic:1 Profile

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

Name Requirement
Device.­L2TPv3. P
TunnelNumberOfEntries R
Device.­L2TPv3.Tunnel.­{i}. C
Enable W
Status R
RemoteEndpoints W
KeepAlivePolicy W
KeepAliveTimeout W
KeepAliveThreshold W
DeliveryHeaderProtocol W
TunnelEncapsulation W
ConnectedRemoteEndpoint R
InterfaceNumberOfEntries R
Device.­L2TPv3.Tunnel.­{i}.­UDP. P
SourcePort W
RemotePort W
EnableChecksum W
Device.­L2TPv3.Tunnel.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.­L2TPv3.Tunnel.­{i}.­Interface.­{i}. C
Enable W
Status R
Name R
LastChange R
LowerLayers R
SessionID W
CookiePolicy W
Cookie W
Device.­L2TPv3.Tunnel.­{i}.­Interface.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

L2TPv3Adv:1 Profile

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

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

VXLANBasic:1 Profile

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

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

VXLANAdv:1 Profile

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

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

LMAPPreconfiguration:1 Profile

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

Name Requirement
Device.­LMAP. P
MeasurementAgentNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}. C
Alias W
Enable W
Version R
CapabilityTags R
Identifier W
PublicCredential W
PrivateCredential W
EventLog R
TaskCapabilityNumberOfEntries R
ScheduleNumberOfEntries R
TaskNumberOfEntries R
CommunicationChannelNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}.­Controller. P
ControllerTimeout W
ControlSchedules W
ControlTasks W
ControlChannels W
Device.­LMAP.­MeasurementAgent.­{i}.­TaskCapability.­{i}. P
Name R
Version R
TaskCapabilityRegistryNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}.­TaskCapability.­{i}.­Registry.­{i}. P
RegistryEntry R
Roles R
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}. C
Alias W
Enable W
Name W
Start W
End W
Duration W
Tags W
SuppressionTags W
ExecutionMode W
ActionNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}.­Action.­{i}. C
Alias W
Enable W
Order W
Task W
SuppressionTags W
Tags W
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}.­Action.­{i}.­Option.­{i}. C
Alias W
Enable W
Order W
Name W
Value R
Device.­LMAP.­MeasurementAgent.­{i}.­Task.­{i}. C
Alias W
Enable W
Name W
Tags W
OptionNumberOfEntries R
RegistryNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}.­Task.­{i}.­Registry.­{i}. C
Alias W
Enable W
RegistryEntry W
Roles W
Device.­LMAP.­MeasurementAgent.­{i}.­Task.­{i}.­Option.­{i}. C
Alias W
Enable W
Order W
Name W
Value R
Device.­LMAP.­MeasurementAgent.­{i}.­CommunicationChannel.­{i}. C
Alias W
Enable W
Name W
UseBulkDataProfile W
Target W
TargetPublicCredential W
Interface W
Device.­LMAP.­Event.­{i}. C
Alias W
Enable W
Name W
Type W
RandomnessSpread W
Device.­LMAP.­Event.­{i}.­PeriodicTimer. P
StartTime W
EndTime W
Interval W
Device.­LMAP.­Event.­{i}.­CalendarTimer. P
StartTime W
EndTime W
ScheduleMonths W
ScheduleDaysOfMonth W
ScheduleDaysOfWeek W
ScheduleHoursOfDay W
ScheduleMinutesOfHour W
ScheduleSecondsOfMinute W
EnableScheduleTimezoneOffset W
ScheduleTimezoneOffset W
Device.­LMAP.­Event.­{i}.­OneOff. P
StartTime W

LMAPController:1 Profile

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

Name Requirement
Device.­LMAP.­MeasurementAgent.­{i}. C
LastStarted R
GroupIdentifier W
MeasurementPoint W
UseAgentIdentifierInReports W
UseGroupIdentifierInReports W
UseMeasurementPointInReports W
InstructionNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}.­Controller. P
ControllerTimeout W
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}. C
State R
LastInvocation R
Storage R
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}.­Stats. P
Invocations R
Suppressions R
Overlaps R
Failures R
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}.­Action.­{i}. C
State R
LastInvocation R
Storage R
LastSuccessfulCompletion R
LastSuccessfulStatusCode R
LastSuccessfulMessage R
LastFailedCompletion R
LastFailedStatusCode R
LastFailedMessage R
Device.­LMAP.­MeasurementAgent.­{i}.­Schedule.­{i}.­Action.­{i}.­Stats. P
Invocations R
Suppressions R
Overlaps R
Failures R
Device.­LMAP.­MeasurementAgent.­{i}.­Instruction.­{i}. C
Alias W
Enable W
LastChange R
InstructionSchedules W
InstructionTasks W
ReportChannels W
MeasurementSuppressionNumberOfEntries R
Device.­LMAP.­MeasurementAgent.­{i}.­Instruction.­{i}.­MeasurementSuppression.­{i}. C
Alias W
Enable W
Name W
State R
StopRunning W
Start W
End W
SuppressionMatch W
Device.­LMAP.­Event.­{i}. C
CycleInterval W

LMAPCollector:1 Profile

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

Name Requirement
Device.­LMAP.­Report.­{i}. P
ReportDate R
AgentIdentifier R
GroupIdentifier R
MeasurementPoint R
ResultNumberOfEntries R
Device.­LMAP.­Report.­{i}.­Result.­{i}. P
TaskName R
ScheduleName R
ActionName R
EventTime R
CycleNumber R
Status R
Tags R
OptionNumberOfEntries R
ResultConflictNumberOfEntries R
ResultReportTableNumberOfEntries R
Device.­LMAP.­Report.­{i}.­Result.­{i}.­Option.­{i}. P
Order R
Name R
Value R
Device.­LMAP.­Report.­{i}.­Result.­{i}.­Conflict.­{i}. P
TaskName R
ScheduleName R
ActionName R
Device.­LMAP.­Report.­{i}.­Result.­{i}.­ReportTable.­{i}. P
ColumnLabels R
ResultReportRowNumberOfEntries R
RegistryNumberOfEntries R
Device.­LMAP.­Report.­{i}.­Result.­{i}.­ReportTable.­{i}.­ResultRow.­{i}. P
Values R
Device.­LMAP.­Report.­{i}.­Result.­{i}.­ReportTable.­{i}.­Registry.­{i}. P
RegistryEntry R
Roles R

BASAPM:1 Profile

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

Name Requirement
Device.­BASAPM. P
MeasurementEndpointNumberOfEntries R
Device.­BASAPM.­MeasurementEndpoint.­{i}. C
Alias W
MeasurementAgent W
DeviceOwnership W
OperationalDomain W
InternetDomain W
UseMeasurementEndpointInReports W
Device.­BASAPM.­MeasurementEndpoint.­{i}.­ISPDevice. P
ReferencePoint W
GeographicalLocation W
Device.­BASAPM.­MeasurementEndpoint.­{i}.­CustomerDevice. P
EquipmentIdentifier W
CustomerIdentifier W

TWAMPReflectorBasic:1 Profile

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

Name Requirement
Device.­IP.­Interface.­{i}. C
TWAMPReflectorNumberOfEntries R
Device.­IP.­Interface.­{i}.­TWAMPReflector.­{i}. C
Enable W
Status R
Port W
MaximumTTL W
IPAllowedList W
PortAllowedList W

STOMPConn:1 Profile

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

Name Requirement
Device.­STOMP. P
ConnectionNumberOfEntries R
Device.­STOMP.­Connection.­{i}. C
Alias W
Enable W
Status R
Host W
Port W
VirtualHost W
ServerRetryInitialInterval W
ServerRetryIntervalMultiplier W
ServerRetryMaxInterval W

STOMPHeartbeat:1 Profile

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

Name Requirement
Device.­STOMP.­Connection.­{i}. C
EnableHeartbeats W
OutgoingHeartbeat W
IncomingHeartbeat W

STOMPAgent:1 Profile

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

Name Requirement
Device.­LocalAgent.­MTP.­{i}.­STOMP. P
Reference R
Destination R
DestinationFromServer R

STOMPController:1 Profile

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

Name Requirement
Device.­LocalAgent.­Controller.­{i}.­MTP.­{i}.­STOMP. P
Reference R
Destination R

DeviceInfo:1 Profile

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

Name Requirement
Device.­DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ProductClass R
SerialNumber R
ModelName R
HardwareVersion R
FriendlyName R

Reboot:1 Profile

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

Name Requirement
Device. P
Reboot() P
Boot! P
Device.­LocalAgent.­Controller.­{i}.­BootParameter.­{i}. C
Enable W
ParameterName W

Firmware:1 Profile

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

Name Requirement
Device.­DeviceInfo. P
ActiveFirmwareImage R
BootFirmwareImage W
FirmwareImageNumberOfEntries R
Device.­DeviceInfo.­FirmwareImage.­{i}. P
Alias W
Name R
Version R
Available W
Status R
BootFailureLog R
Download() P
Device.­LocalAgent. P
TransferComplete! P

LocalAgent:1 Profile

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

Name Requirement
Device.­LocalAgent. P
EndpointID R
AdvertisedDeviceSubtypes R
Periodic! P
MTPNumberOfEntries R
Device.­LocalAgent.­MTP.­{i}. P
Alias R
Protocol R
Device.­LocalAgent.­MTP.­{i}.­CoAP. P
Port R
Path R

Controllers:1 Profile

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

Name Requirement
Device.­LocalAgent. P
ControllerNumberOfEntries R
Device.­LocalAgent.­Controller.­{i}. P
Enable R
Alias R
EndpointID R
AssignedRole R
PeriodicNotifInterval R
MTPNumberOfEntries R
Device.­LocalAgent.­Controller.­{i}.­MTP.­{i}. P
Enable R
Alias R
Protocol R
Device.­LocalAgent.­Controller.­{i}.­MTP.­{i}.­CoAP. P
Host R
Port R
Path R

Subscriptions:1 Profile

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

Name Requirement
Device.­LocalAgent. P
SubscriptionNumberOfEntries R
Device.­LocalAgent.­Subscription.­{i}. C
Enable W
Alias W
ID W
Recipient R
CreationDate R
NotifType W
ReferenceList W
Persistent W
TimeToLive W

Challenge:1 Profile

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

Name Requirement
Device.­LocalAgent.­ControllerTrust. P
RequestChallenge() P
ChallengeResponse() P
ChallengeNumberOfEntries R
Device.­LocalAgent.­ControllerTrust.­Challenge.­{i}. P
Alias R
Description R
Role R
Value R
ValueType R
Instruction R
InstructionType R

USPAgent:1 Profile

The USPAgent:1 profile for the Device:2 data model is defined as the union of the DeviceInfo:1, Reboot:1, Firmware:1, LocalAgent:1, Controllers:1, Subscriptions:1 and Challenge:1 profiles and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/03/29 at 09:48:14.
report.pl --exitcode=fatals --altnotifreqstyle --ignoreenableparameter --immutablenonfunctionalkeys --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-12-0-usp-diffs.html tr-181-2-12-0-usp.xml