 | USP Device:2.15 Root Object definition (changes)tr-181-2-15-1-usp.xml | ||
DATA MODEL DEFINITION | |||
License
Copyright (c) 2010-2022, Broadband Forum
The undersigned members have elected to grant the copyright to
their contributed material used in this software:
Copyright (c) 2017-2019, 2021 ARRIS Enterprises, LLC.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
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.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms https://www.broadband-forum.org/ipr-policy.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
Data Types
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MACAddress]). However, such parameters still indicate their SOAP data types.
| Data Type | Base Type | Description |
|---|---|---|
|
base64 |
- |
Base64 encoded binary (no line-length limitation). A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separate ranges can be specified, in which case the length MUST be in one of the ranges. |
|
boolean |
- |
Boolean, where the allowed values are 0 or 1 (or equivalently, true or false). |
|
dateTime |
- |
The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1]. |
|
decimal |
- |
Decimal number, with optional sign and optional fractional part. For some decimal types, a value range is given using the form decimal(Min:Max) or decimal(Min:Max step Step) where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1.0. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
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. |
|
string |
- |
For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges. |
|
unsignedInt |
- |
Unsigned integer in the range 0 to 4294967295, inclusive. For some unsignedInt types, a value range is given using the form unsignedInt(Min:Max) or unsigned(Min:Max step Step), where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
unsignedLong |
- |
Unsigned long integer in the range 0 to 18446744073709551615, inclusive. For some unsignedLong types, a value range is given using the form unsignedLong(Min:Max) or unsignedLong(Min:Max step Step), where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
Alias |
string(:64) |
A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
|
|
AmplitudeData |
hexBinary(0,2:4116) |
This data type represents a sequence of spectral amplitudes. Each spectral amplitude value corresponds to a bin. The format of the bin measurement is as follows. Sequence of:
|
|
CmRegState |
This data type defines the CM connectivity state as reported by the CM. Enumeration of:
See [CM-SP-MULPIv3.0], Cable Modem - CMTS Interaction. |
|
|
Dbm1000 |
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. |
|
|
DocsEqualizerData |
hexBinary(0,36:260) |
This data type represents the equalizer data as measured at the receiver interface. The format of the equalizer follows the structure of the Transmit Equalization Adjust RNG-RSP TLV of DOCSIS RFI v2.0. The equalizer coefficients are considered signed 16-bit integers in the range from -32768 (0x8000) to 32767 (0x7FFF). DOCSIS specifications require up to a maximum of 64 equalizer taps (n + m); therefore, this object size can be up to 260 bytes (4 + 4x64). The minimum object size (other than zero) for a t-spaced tap with a minimum of 8 symbols will be 36 (4 + 4x8). See [Figure 8-23/CM-SP-RFIv2.0]. |
|
DocsisUpstreamType |
Indicates the DOCSIS Upstream Channel Type. Enumeration of:
|
|
|
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:
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:
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.
This notation can also represent individual addresses by specifying all bits.
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(:45) |
IPv4 address (or subnet mask). Can be any IPv4 address that is permitted by the IPAddress data type. Possible patterns:
|
|
IPv4Prefix |
IPPrefix(:49) |
IPv4 address prefix. Can be any IPv4 prefix that is permitted by the IPPrefix data type. Possible patterns:
|
|
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. |
|
IoTUnitType |
Possible Unit types used for decimal values. Enumeration of:
|
|
|
JSONObject |
A JSON Object as defined in [Section 4/RFC7159]. |
|
|
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:
|
|
PSDBreakPointIndexAndLevel |
unsignedInt[2:2] |
|
|
PSMBreakPointIndexAndLevel |
unsignedInt[2:2] |
|
|
RangingState |
This data type defines the CM ranging state as reported by the CMTS. The enumerated values associated with the RangingState are: Enumeration of:
See [CM-SP-MULPIv3.0], Cable Modem - CMTS Interaction. |
|
|
SELTPAttenuationCharacteristicsIndexAndTFlog |
unsignedInt[2:2] |
|
|
SST |
Service Slice Type (SST). Enumeration of:
|
|
|
SpectrumAnalysisWindowFunction |
This object controls the windowing function which will be used when performing the discrete Fourier transform for the analysis. Note that all window functions may not be supported by all devices. If an attempt is made to set the object to an unsupported window function, an error of inconsistentValue will be returned. Enumeration of:
|
|
|
StatsCounter32 |
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 |
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. |
|
|
TLV8 |
hexBinary(0,2:255) |
This data type represents a single TLV encoding. This first octet represents the Type of the TLV. The second octet represents an unsigned 8-bit Length of the subsequent Value part of the TLV. The remaining octets represent the value. The Value could be an atomic value or a sequence of one or more sub-TLVs. See [CM-SP-MULPIv3.0], Common Radio Frequency Interface Encodings Annex. |
|
TenthdB |
This data type represents power levels that are normally expressed in dB. Units are in tenths of a dB; for example, 5.1 dB will be represented as 51. |
|
|
TenthdBmV |
This data type represents power levels that are normally expressed in dBmV. Units are in tenths of a dBmV; for example, 5.1 dBmV will be represented as 51. |
|
|
UERComplex |
int[2:2] |
Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
|
|
URL |
URI(:2048) |
Uniform Resource Locator. See [RFC3986] (URI), [IANA-uri-schemes], and individual URI scheme RFCs such as [RFC7252] (coap, coaps) and [RFC7230] (http, https). |
|
UUID |
string(36) |
Universally Unique Identifier. See [RFC4122]. Possible patterns:
|
References
|
3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4. |
|
|
3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2. |
|
|
3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1. |
|
|
3GPP TS 24.526, User Equipment (UE) policies for 5G System (5GS); Stage 3, 3GPP CT WG1. |
|
|
3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4. |
|
|
IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007. |
|
|
IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012. |
|
|
IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016. |
|
|
IEEE Std 802.11-2020, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2020. |
|
|
IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999. |
|
|
IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013. |
|
|
[802.11ax] |
IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021. |
|
IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999. |
|
|
IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003. |
|
|
[802.11k] |
IEEE Std 802.11k, Radio Resource Measurement of Wireless LANs, IEEE, May 2008. |
|
IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009. |
|
|
IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009. |
|
|
IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005. |
|
|
IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks - Link Aggregation, IEEE, 2014. |
|
|
IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004. |
|
|
IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006. |
|
|
IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011. |
|
|
IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004. |
|
|
IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015. |
|
|
[AMB] |
Agile MultiBand Specification, Wi-Fi Agile MultiBand Specification, Wi-Fi Alliance, December 2018. |
|
CM-SP-CM-OSSIv3.1, Cable Modem Operations Support System Interface Specification, CableLabs, October 2020. |
|
|
CM-SP-MULPIv3.0, DOCSIS 3.0 MAC and Upper Layer Protocols Interface Specification, CableLabs, December 2017. |
|
|
CM-SP-OSSIv3.0, DOCSIS 3.0 Operations Support System Interface Specification, CableLabs, December 2017. |
|
|
CM-SP-RFIv2.0, Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification, CableLabs, April 2009. |
|
|
[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. |
|
Wi-Fi Easy Connect Specification, Wi-Fi Easy Connect Specification, Wi-Fi Alliance, November 2022. |
|
|
[EasyMesh] |
EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, August 2024. |
|
[G.9701] |
G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014. |
|
[G.988] |
G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010. |
|
[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.9954] |
G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007. |
|
[G.996.2] |
G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T. |
|
[G.9960] |
G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T. |
|
[G.9961] |
G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T. |
|
[G.9964] |
G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T. |
|
[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.9973] |
G.9973, Protocol for identifying home network topology, ITU-T, 2011. |
|
[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 Alliance, 2007. |
|
IANA Protocol Numbers, Protocol Numbers, IANA. |
|
|
IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA. |
|
|
IANAifType, IANAifType-MIB DEFINITIONS, IANA, 2009. |
|
|
ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008. |
|
|
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. |
|
|
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997. |
|
|
IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA. |
|
|
[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. |
|
ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006. |
|
|
ITU E.118, The international telecommunication charge card, International Telecommunication Union, May 2006. |
|
|
ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010. |
|
|
ITU X.733, Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function, International Telecommunication Union, February 1992. |
|
|
JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2017. |
|
|
JJ-300.01, The List of Device Categories, TTC, 2018. |
|
|
[LIBPCAP] |
Libpcap, Libpcap File Format, Wireshark, 2015. |
|
[LMAPIFM] |
RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017. |
|
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. |
|
[MQTT50] |
MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019. |
|
[OUI] |
Organizationally Unique Identifiers (OUIs). |
|
[PCPProxy] |
RFC 7648, Port Control Protocol (PCP) Proxy Function, IETF, September 2015. |
|
[RFC1035] |
RFC 1035, Domain Names - Implementation and Specification, IETF, 1987. |
|
[RFC1332] |
RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992. |
|
[RFC1661] |
RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994. |
|
[RFC2104] |
RFC 2104, HMAC: Keyed-Hashing for Message Authentication, IETF, 1997. |
|
[RFC2131] |
RFC 2131, Dynamic Host Configuration Protocol, IETF. |
|
[RFC2132] |
RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF. |
|
[RFC2474] |
RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF. |
|
[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. |
|
[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. |
|
[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. |
|
[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. |
|
[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. |
|
[RFC3986] |
RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
|
[RFC4007] |
RFC 4007, IPv6 Scoped Address Architecture, IETF. |
|
[RFC4122] |
RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005. |
|
[RFC4191] |
RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005. |
|
[RFC4193] |
RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005. |
|
[RFC4291] |
RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006. |
|
[RFC4292] |
RFC 4292, IP Forwarding Table MIB, IETF, 2006. |
|
[RFC4293] |
RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006. |
|
[RFC4301] |
RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005. |
|
[RFC4302] |
RFC 4302, IP Authentication Header, IETF, December 2005. |
|
[RFC4303] |
RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005. |
|
[RFC4546] |
RFC 4546, Radio Frequency (RF) Interface Management Information Base for Data over Cable Service Interface Specifications (DOCSIS) 2.0 Compliant RF Interfaces, IETF, June 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. |
|
[RFC4868] |
RFC 4868, Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with IPsec, 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. |
|
[RFC6762] |
RFC 6762, Multicast DNS, IETF, February 2013. |
|
[RFC6838] |
RFC 6838, Media Type Specifications and Registration Procedures, IETF, January 2013. |
|
[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. |
|
[RFC7230] |
RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014. |
|
[RFC7252] |
RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014. |
|
[RFC7291] |
RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, July 2014. |
|
[RFC7348] |
RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014. |
|
[RFC7468] |
RFC 7468, Textual Encoding of PKIX, PKCS, and CMS Structures, IETF, April 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. |
|
[RFC7693] |
RFC 7693, The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC), IETF, November 2015. |
|
[RFC8089] |
RFC 8089, The "file" URI Scheme, IETF, February 2017. |
|
[RFC8141] |
RFC 8141, Uniform Resource Names (URNs), IETF, April 2017. |
|
[RFC8325] |
RFC 8325, Mapping Diffserv to IEEE 802.11, IETF, February 2018. |
|
[RFC862] |
RFC 862, Echo Protocol, IETF, 1983. |
|
[RFC8966] |
RFC 8966, The Babel Routing Protocol, IETF, January 2021. |
|
[RFC8967] |
RFC 8967, MAC Authentication for the Babel Routing Protocol, IETF, January 2021. |
|
[RFC8968] |
RFC 8968, Babel Routing Protocol over Datagram Transport Layer Security, IETF, January 2021. |
|
[RFC9046] |
RFC 9046, Babel Information Model, IETF, June 2021. |
|
[RFC959] |
RFC 959, File Transfer Protocol, IETF, 1985. |
|
[SOAP1.1] |
Simple Object Access Protocol (SOAP) 1.1, W3C. |
|
[TR-069] |
TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018. |
|
[TR-106] |
TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018. |
|
[TR-143] |
TR-143 Amendment 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015. |
|
[TR-159] |
TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008. |
|
[TR-181i2] |
TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022. |
|
[TR-232] |
TR-232, Bulk Data Collection, Broadband Forum, May 2012. |
|
[TR-262] |
TR-262, Femto Component Objects, Broadband Forum, November 2011. |
|
[TR-304] |
TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015. |
|
[TR-369] |
TR-369 Issue 1 Amendment 2, User Services Platform, Broadband Forum, January 2022. |
|
[TR-390] |
TR-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, May 2017. |
|
[TR-471] |
TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2023. |
|
[UPA-PLC] |
Universal Powerline Association, UPA. |
|
UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008. |
|
|
UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 2008. |
|
|
[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. |
|
[WMM] |
Wi-Fi Multimedia Technical Specification, Wi-Fi Multimedia Technical Specification, Wi-Fi Alliance, May 2012. |
|
[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. |
|
ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007. |
Legend
|
Object definition. |
|
Mount point definition. |
|
Parameter definition. |
|
Command or Event definition. |
|
Command Input / Output Arguments container. |
|
Command or Event Object Input / Output Argument definition. |
|
Command or Event Parameter Input / Output Argument definition. |
Device:2.15 Data Model
For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.
Changes since 2.14:
- Changed name = Device:2.14 ⇒ Device:2.15
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
|
Device. |
object |
R |
The top-level object for a Device. Changes since 2.14:
|
- |
2.0 |
|
Boot! |
event |
- |
Boot event indicating that the Device was rebooted. |
- |
2.12 |
|
⇒ Cause |
string |
R |
The cause of the boot. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
⇒ ParameterMap |
string |
R |
{{div|{{classes}}|Boot parameters configured via the recipient Controller's {{object|.LocalAgent.Controller.{i}.BootParameter}} table. Formatted as a {{datatype|expand}}}} Boot parameters configured via the recipient Controller's LocalAgent.Controller.{i}.BootParameter table. Formatted as a [JSONObject] A JSON Object as defined in [Section 4/RFC7159]. |
- |
2.12 |
|
SelfTestDiagnostics() |
command |
- |
[ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. |
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
PacketCaptureDiagnostics() |
command |
- |
[ASYNC] This diagnostic command is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. |
- |
2.13 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Password |
string(:256) |
W |
Password to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required. When read, this parameter returns an empty string, regardless of the actual value. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.13 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
ScheduleTimer() |
command |
- |
[ASYNC] {{div|{{classes}}|Schedule an async timer operation. A scheduled timer MUST persist across reboots. NOTE: This command changed from synchronous to asynchronous in version 2.14.}} Schedule an async timer operation. A scheduled timer MUST persist across reboots. NOTE: This command changed from synchronous to asynchronous in version 2.14. |
- |
2.12 |
|
Device.DeviceInfo. |
object |
R |
This object contains general device information. |
- |
2.12 |
|
DeviceCategory |
string[] |
R |
Comma-separated list of strings. {{div|{{classes}}|Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is {{empty}} if no such element is provided by the device. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. Standard HTIP device categories are defined in {{bibref|JJ-300.01}}. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.}} Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories. |
- |
2.12 |
|
ManufacturerOUI |
string(6) |
R |
Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:
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 |
|
CID |
string(6) |
R |
{{div|{{classes}}|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. {{pattern}} 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 {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.}} 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 |
|
ModelNumber |
string(:64) |
R |
{{div|{{classes}}|The model number of the device (human readable string), or {{empty}} if no model number is provided by the device. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the maximum length of the string is 31.}} The model number of the device (human readable string), or an empty string if no model number is provided by the device. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31. |
- |
2.12 |
|
ProductClass |
string(:64) |
R |
{{div|{{classes}}|Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the {{param|SerialNumber}} parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates.}} Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates. |
- |
2.12 |
|
SerialNumber |
string(:64) |
R |
{{div|{{classes}}|Identifier of the particular device that is unique for the indicated class of product and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates.}} Identifier of the particular device that is unique for the indicated class of product and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates. |
- |
2.12 |
|
SoftwareVersion |
string(:64) |
R |
A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware). To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build. For CPEs that support multiple firmware images, the value for this parameter MUST be the software version of the active 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 |
|
FirstUseDate |
dateTime |
R |
{{div|{{classes}}|Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset. If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value.}} Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset. If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DeviceImageNumberOfEntries |
unsignedInt |
R |
The number of entries in the associated table. Changes since 2.14:
|
- |
2.12 |
|
FriendlyName |
string(:32) |
W |
{{div|{{classes}}|The friendly name of the device. In {{bibref|TR-369}} the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of {{bibref|TR-369}}.}} |
- |
2.12 |
|
PEN |
string(:10) |
R |
{{div|{{classes}}|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 {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.}} 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 |
|
Device.DeviceInfo.VendorConfigFile.{i}. |
object(0:) |
R |
Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. This table of Vendor Configuration Files is for information only and does not allow the Controller 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. Whenever the Agent successfully restores a configuration file as a result of the Restore() Command, the Agent MUST update this Object. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Name |
string(:64) |
R |
Name of the vendor configuration file. If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name. Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name. Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file. Otherwise, the value of this parameter MUST be set to the value of the Command input argument Restore().Input.TargetFileName used to restore this configuration file. |
- |
2.12 |
|
Version |
string(:16) |
R |
A string identifying the configuration file version currently used in the CPE. If the CPE is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value. Otherwise, the value of this parameter MUST be an empty string. |
- |
2.12 |
|
UseForBackupRestore |
boolean |
R |
{{div|{{classes}}|When {{true}}, this parameter indicates that this {{object}} instance is to be used for backup and restoration purposes. Note: The backup and restore operations may require the use of multiple {{object}} instances. In this scenario the mechanism for detemining the order and combination of {{object}} instances used for backup and restoration purposes is implementation specific.}} When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes. Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific. |
- |
2.12 |
|
Backup() |
command |
- |
[ASYNC] {{div|{{classes}}|This command is issued to upload the configuration file specified by this {{object}} instance. All results of the actual upload will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ URL |
string(:2048) |
W |
[MANDATORY] The [URL] specifying the destination file location. HTTP and HTTPS transports MUST be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time. This URL MUST NOT include the "userinfo" component, as defined in [RFC3986]. |
- |
2.12 |
|
Restore() |
command |
- |
[ASYNC] {{div|{{classes}}|This command is issued to download a configuration file into this {{object}} instance. All results of the actual download will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ URL |
string(:2048) |
W |
[MANDATORY] The [URL] specifying the source file location. HTTP and HTTPS transports MUST be supported. If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time. This URL MUST NOT include the "userinfo" component, as defined in [RFC3986]. |
- |
2.12 |
|
⇒ FileSize |
unsignedInt |
W |
The size of the file to be downloaded in bytes. The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file. The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise. The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space. If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate. |
- |
2.12 |
|
⇒ TargetFileName |
string(:256) |
W |
The name of the file to be used on the target file system. This argument MAY be an empty string if the target file name can be extracted from the downloaded file itself, or from the URL argument, or if no target file name is needed. If this argument is specified, but the target file name is also indicated by another source (for example, if it is extracted from the downloaded file itself), this argument MUST be ignored. If the target file name is used, the downloaded file would replace any existing file of the same name (whether or not the Agent archives the replaced file is a local matter). If present, this Parameter is treated as an opaque string with no specific requirements for its format. That is, the TargetFileName value is to be interpreted based on the Agent's vendor-specific file naming conventions. Note that this specification does not preclude the use of a file naming convention in which the file’s path can be specified as part of the file name. |
- |
2.12 |
|
⇒ CheckSumAlgorithm |
string |
W |
{{div|{{classes}}|The hash algorithm to use when performing a checksum validation of the downloaded file. If the {{param|CheckSum}} input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the {{param|CheckSum}} input argument against a hash of the downloaded file.}} The hash algorithm to use when performing a checksum validation of the downloaded file. If the CheckSum input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the CheckSum input argument against a hash of the downloaded file. Enumeration of: |
- |
2.12 |
|
⇒ CheckSum |
hexBinary |
W |
The hash value of the downloaded file used to validate the integrity of the downloaded file. If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the CheckSumAlgorithm input argument. If this argument is an empty string, the Agent MUST NOT perform a checksum validation of the downloaded file. |
- |
2.12 |
|
Device.DeviceInfo.MemoryStatus. |
object |
R |
Status of the device's volatile physical memory. Changes since 2.14:
|
- |
2.12 |
|
Total |
unsignedInt |
R |
The total physical volatile RAM, in KiB, installed on the device. Changes since 2.14:
|
- |
2.12 |
|
Free |
unsignedInt |
R |
The free physical volatile RAM, in KiB, currently available on the device. Value Change Notification requests for this parameter MAY be denied. Changes since 2.14:
|
- |
2.12 |
|
TotalPersistent |
unsignedInt |
R |
The sum total physical Non-Volatile Memory (NVM), in KiB, installed on the device. This memory persists across reboots and can be used by the system, applications, or users. |
- |
2.15 |
|
FreePersistent |
unsignedInt |
R |
The sum total free physical Non-Volatile Memory (NVM), in KiB, currently available on the device. This memory persists across reboots and is available for use by the system, applications, or users. Value Change Notification requests for this parameter MAY be denied. |
- |
2.15 |
|
Device.DeviceInfo.ProcessStatus. |
object |
R |
Status of the processes on the device. |
- |
2.12 |
|
Device.DeviceInfo.ProcessStatus.Process.{i}. |
object(0:) |
R |
List of all processes running on the device. At most one entry in this table can exist with a given value for PID. |
- |
2.12 |
|
Size |
unsignedInt |
R |
The size in KiB of the memory occupied by the process. Value Change Notification requests for this parameter MAY be denied. Changes since 2.14:
|
- |
2.12 |
|
Device.DeviceInfo.TemperatureStatus. |
object |
R |
Status of the temperature of the device. |
- |
2.12 |
|
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. |
object(0:) |
R |
This object represents information that the device has obtained via sampling an internal temperature sensor. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.12 |
|
ResetTime |
dateTime |
R |
The time at which this temperature sensor was reset. Reset can be caused by:
|
- |
2.12 |
|
Value |
int(-274:) |
R |
{{div|{{classes}}|This temperature sensor's last good reading in {{units}}. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.}} This temperature sensor's last good reading in degrees celsius. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LastUpdate |
dateTime |
R |
{{div|{{classes}}|The time at which this temperature sensor's last good reading was obtained. The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset.}} The time at which this temperature sensor's last good reading was obtained. The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MinValue |
int(-274:) |
R |
{{div|{{classes}}|This temperature sensor's lowest value reading in {{units}} since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.}} This temperature sensor's lowest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. |
- |
2.12 |
|
MinTime |
dateTime |
R |
{{div|{{classes}}|The time at which this temperature sensor's lowest value was read. The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset.}} The time at which this temperature sensor's lowest value was read. The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset. |
- |
2.12 |
|
MaxValue |
int(-274:) |
R |
{{div|{{classes}}|This temperature sensor's highest value reading in {{units}} since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.}} This temperature sensor's highest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. |
- |
2.12 |
|
MaxTime |
dateTime |
R |
{{div|{{classes}}|The time at which this temperature sensor's highest value was read. The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset.}} The time at which this temperature sensor's highest value was read. The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset. |
- |
2.12 |
|
LowAlarmValue |
int(-274:) |
W |
This temperature sensor's low alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value. A change to this value will cause LowAlarmTime to be reset. |
- |
2.12 |
|
LowAlarmTime |
dateTime |
R |
Initial time at which this temperature sensor's LowAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106], indicates that an alarm has not been encountered since the last reset. |
- |
2.12 |
|
HighAlarmValue |
int(-274:) |
W |
This temperature sensor's high alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value. A change to this value will cause HighAlarmTime to be reset. |
- |
2.12 |
|
PollingInterval |
unsignedInt |
W |
The interval, measured in seconds, in which the device polls this TemperatureSensor. If the value is 0 then the device selects its own polling interval. If the value is greater than 0 then the device MUST use this value as the polling interval. |
- |
2.12 |
|
HighAlarmTime |
dateTime |
R |
Initial time at which this temperature sensor's HighAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106], indicates that an alarm has not been encountered since the last reset. |
- |
2.12 |
|
Device.DeviceInfo.NetworkProperties. |
object |
R |
This object defines the parameters that describe how the device handles network traffic. |
- |
2.12 |
|
TCPImplementation |
string[] |
R |
{{div|{{classes}}|{{list}} Indicates the TCP congestion control mechanism(s) implemented. {{enum}} Tahoe, Reno, and New Reno are defined in {{bibref|RFC2582}}}} Comma-separated list of strings. Indicates the TCP congestion control mechanism(s) implemented. Each list item is an enumeration of:
Tahoe, Reno, and New Reno are defined in [RFC2582] |
- |
2.12 |
|
Device.DeviceInfo.Processor.{i}. |
object(0:) |
R |
Each table entry represents a hardware or virtual processor that resides on this device. At most one entry in this table can exist with a given value for Alias. |
- |
2.12 |
|
Architecture |
string |
R |
{{div|{{classes}}|The architecture of the processor on the underlying hardware. {{enum}} For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}.}} The architecture of the processor on the underlying hardware. Enumeration of:
For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106]. |
- |
2.12 |
|
Device.DeviceInfo.VendorLogFile.{i}. |
object(0:) |
R |
{{div|{{classes}}|Each table entry represents a Vendor Log File. This table of log files is informational only and does not allow the Controller to operate on these files in any way.}} Each table entry represents a Vendor Log File. This table of log files is informational only and does not allow the Controller to operate on these files in any way. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Name |
string(:64) |
R |
{{div|{{classes}}|Name of the log file. Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism.}} Name of the log file. Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism. |
- |
2.12 |
|
Persistent |
boolean |
R |
{{div|{{classes}}|When {{true}}, the log file contents are preserved across a device reboot. When {{false}}, the log file contents will be purged when the device is rebooted.}} When true, the log file contents are preserved across a device reboot. When false, the log file contents will be purged when the device is rebooted. |
- |
2.12 |
|
Upload() |
command |
- |
[ASYNC] {{div|{{classes}}|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 {{event|Device.LocalAgent.TransferComplete!}} event.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ URL |
string(:2048) |
W |
[MANDATORY] The [URL] specifying the destination file location. HTTP and HTTPS transports MUST be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time. This URL MUST NOT include the "userinfo" component, as defined in [RFC3986]. |
- |
2.12 |
|
Device.DeviceInfo.Location.{i}. |
object(0:) |
W |
This object contains Location information. At most one entry in this table can exist with the same values for both Source and ExternalSource. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for ExternalSource such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
ExternalSource |
string |
R |
URL, MAC address, or other identifier that identifies an "External" source of this location. Meaningful only if Source has a value of External, otherwise it MUST be an empty string. If ExternalProtocol has a value of CWMP, this is the URL or IP address of the Controller. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
ExternalProtocol |
string |
R |
{{div|{{classes}}|Protocol used to acquire a location from an "External" source. {{enum}} Meaningful only if {{param|Source}} has a value of {{enum|External|Source}}, otherwise it MUST be {{empty}}.}} |
CWMP |
2.12 |
|
DataObject |
string(:1200) |
W |
The currently valid location information. Writable only when ExternalProtocol has a value of CWMP or USP. If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491]. If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). If obtained by an external source this is the location information as received. If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. CWMP or USP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). Only zero or one Location object instance with value CWMP or USP MUST exist at any given time. |
- |
2.12 |
|
Device.DeviceInfo.FirmwareImage.{i}. |
object(0:) |
R |
{{div|{{classes}}|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.}} 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. |
- |
2.12 |
|
Name |
string(:64) |
R |
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 Active, Available, InstallationFailed, or ActivationFailed. |
- |
2.12 |
|
Version |
string(:64) |
R |
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 by the device 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 |
R |
Status of the firmware image, as determined by the Agent. Enumeration of:
|
- |
2.12 |
|
BootFailureLog |
string |
R |
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] {{div|{{classes}}|This command is issued to download a firmware into this Firmware Image instance. All results of the actual download will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ URL |
string(:2048) |
W |
[MANDATORY] The [URL] specifying the source file location. HTTP and HTTPS transports MUST be supported. If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time. This URL MUST NOT include the "userinfo" component, as defined in [RFC3986]. |
- |
2.12 |
|
⇒ AutoActivate |
boolean |
W |
[MANDATORY] {{div|{{classes}}|If {{true}} the Agent MUST automatically activate the firmware once it is successfully downloaded. If {{false}} the Agent MUST NOT activate the firmware until explicitly instructed to do so by either invoking {{command|#.Activate()}} or setting {{param|##.BootFirmwareImage}} and rebooting the Agent.}} If true the Agent MUST automatically activate the firmware once it is successfully downloaded. If false the Agent MUST NOT activate the firmware until explicitly instructed to do so by either invoking Activate() or setting BootFirmwareImage and rebooting the Agent. |
- |
2.12 |
|
⇒ FileSize |
unsignedInt |
W |
The size of the file to be downloaded in bytes. The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file. The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise. The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space. If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate. |
- |
2.12 |
|
⇒ CheckSumAlgorithm |
string |
W |
{{div|{{classes}}|The hash algorithm to use when performing a checksum validation of the downloaded file. If the {{param|CheckSum}} input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the {{param|CheckSum}} input argument against a hash of the downloaded file.}} The hash algorithm to use when performing a checksum validation of the downloaded file. If the CheckSum input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the CheckSum input argument against a hash of the downloaded file. Enumeration of: |
- |
2.12 |
|
⇒ CheckSum |
hexBinary |
W |
The hash value of the downloaded file used to validate the integrity of the downloaded file. If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the CheckSumAlgorithm input argument. If this argument is an empty string, the Agent MUST NOT perform a checksum validation of the downloaded file. |
- |
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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ TimeWindow.{i}. |
object(1:5) |
W |
The time window(s) that dictate when the Agent activates the firmware image. An Agent MUST be able to accept a request with either one or two TimeWindow instances. The time windows MUST NOT overlap, i.e. if there are two time windows, the second window’s Start value has to be greater than or equal to the first window’s End value. This table MUST contain at least 1 and at most 5 entries. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇒ Mode |
string |
W |
[MANDATORY] Specifies when within this time window the Agent is permitted to activate the specified firmware image. Enumeration of:
|
- |
2.12 |
|
⇒ UserMessage |
string |
W |
A message that informs the user of a request to activate a new firmware image. The Agent MAY use this message when seeking confirmation from the user, e.g. when Mode is ConfirmationNeeded. When there is no need for such a message, it SHOULD be an empty string and MUST be ignored. |
- |
2.12 |
|
⇒ MaxRetries |
int(-1:10) |
W |
The maximum number of retries for activating the firmware image before regarding the transfer as having failed. Refers only to this time window (each time window can specify its own value). A value of 0 means “No retries are permitted”. A value of -1 means “the Agent determines the number of retries”, i.e. that the Agent can use its own retry policy, not that it has to retry forever. Only applicable when the Mode input argument is ConfirmationNeeded, otherwise this input argument MUST be ignored. |
- |
2.12 |
|
Device.Time. |
object |
R |
This object contains parameters relating an NTP or SNTP time client in the CPE. |
- |
2.12 |
|
Status |
string |
R |
Status of Time support on the CPE. Enumeration of:
|
- |
2.12 |
|
LocalTimeZone |
string(:256) |
W |
{{replaced: missing new argument}}****{{div: unexpected argument [div([classes()], The local time zone definition, encoded according to IEEE 1003.1 (POSIX). The following is an example value:), div([classes()], [li(>), 'EST+5 EDT,M4.1.0/2,M10.5.0/2'])] after: [classes()], {{li|>}}EST+5 EDT,M4.1.0/2,M10.5.0/2}}}} |
- |
2.12 |
|
Device.UserInterface. |
object |
R |
This object contains parameters relating to the user interface of the CPE. |
- |
2.12 |
|
PasswordRequired |
boolean |
W |
{{div|{{classes}}|Present only if the CPE provides a password-protected LAN-side user interface. Indicates whether or not the local user interface MUST require a password to be chosen by the user. If {{false}}, the choice of whether or not a password is used is left to the user.}} Present only if the CPE provides a password-protected LAN-side user interface. Indicates whether or not the local user interface MUST require a password to be chosen by the user. If false, the choice of whether or not a password is used is left to the user. |
- |
2.12 |
|
PasswordUserSelectable |
boolean |
W |
{{div|{{classes}}|Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. Indicates whether or not a password to protect the local user interface of the CPE MAY be selected by the user directly (i.e. {{param|.Users.User.{i}.Password}}), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. {{param|.LANConfigSecurity.ConfigPassword}}).}} Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. Indicates whether or not a password to protect the local user interface of the CPE MAY be selected by the user directly (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword). |
- |
2.12 |
|
PasswordReset() |
command |
- |
{{div|{{classes}}|Present only if the Agent provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. Reset {{param|.LANConfigSecurity.ConfigPassword}} to its factory value.}} 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 |
|
ISPLogoSize |
unsignedInt(0:4095) |
W |
Un-encoded binary image size in bytes. If ISPLogoSize input value is 0 then the ISPLogo is cleared. ISPLogoSize can also be used as a check to verify correct transfer and conversion of Base64 string to image size. |
- |
2.12 |
|
Device.UserInterface.RemoteAccess. |
object |
R |
This object contains parameters relating to remotely accessing the CPE's user interface. Remote access is defined as any entity not of a local subnet attempting to connect to the CPE. Remote access requires user authentication. To provide remote access authentication the CPE MUST support a "User" table with at least one instance that has "RemoteAccessCapable" set to true. |
- |
2.12 |
|
Device.InterfaceStack.{i}. |
object(0:) |
R |
This table contains information about the relationships between the multiple layers of interface objects ([Section 4.3/TR-181i2]). In particular, it contains information on which interfaces run on top of which other interfaces. This table is auto-generated by the CPE based on the LowerLayers parameters on individual interface objects. Each table row represents a "link" between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPE MUST delete the corresponding InterfaceStack row(s) that had referenced it. At most one entry in this table can exist with the same values for both HigherLayer and LowerLayer, or with a given value for Alias. |
- |
2.12 |
|
HigherLayer |
string(:256) |
R |
{{div|{{classes}}|{{noreference}}A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on top of the interface identified by the corresponding instance of {{param|LowerLayer}}. When the referenced higher layer interface is deleted, the CPE MUST delete the table row.}} A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on top of the interface identified by the corresponding instance of LowerLayer. When the referenced higher layer interface is deleted, the CPE MUST delete the table row. |
- |
2.12 |
|
LowerLayer |
string(:256) |
R |
{{div|{{classes}}|{{noreference}}A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs below the interface identified by the corresponding instance of {{param|HigherLayer}}. When the referenced lower layer interface is deleted, the CPE MUST delete the table row.}} A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs below the interface identified by the corresponding instance of HigherLayer. When the referenced lower layer interface is deleted, the CPE MUST delete the table row. |
- |
2.12 |
|
Device.DSL. |
object |
R |
This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. |
- |
2.12 |
|
Device.DSL.Line.{i}. |
object(0:) |
R |
{{div|{{classes}}|DSL Line table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This table models physical DSL lines.}} DSL Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the DSL line. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the DSL line. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the DSL line (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Line is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
LinkStatus |
string |
R |
Status of the DSL physical link. Enumeration of:
|
- |
2.12 |
|
StandardsSupported |
string[] |
R |
Comma-separated list of strings. List items indicate which DSL standards and recommendations are supported by the Line instance. Each list item is an enumeration of:
This parameter was DEPRECATED in 2.8.because its entries are out-of-date; {{param|StandardsSupportedXTSE}} points to a current list. Therefore its value MAY be {{empty}}an empty string if (and only if) {{param|StandardsSupportedXTSE}} is supported. This parameter is OBSOLETED in 2.14.supported This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
XTSE |
hexBinary(8) |
R |
{{div|{{classes}}|This configuration parameter defines the transmission system types to be allowed by the xTU on this {{object}} instance. Each bit is 0 if not allowed or 1 if allowed, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. Note: This parameter is defined as xDSL Transmission system enabling (XTSE) in ITU-T G.997.1. For a full definition, see Clause 7.3.1.1.1 of ITU-T Recommendation {{bibref|G.997.1}}.}} This configuration parameter defines the transmission system types to be allowed by the xTU on this Line instance. Each bit is 0 if not allowed or 1 if allowed, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. Note: This parameter is defined as xDSL Transmission system enabling (XTSE) in ITU-T G.997.1. For a full definition, see Clause 7.3.1.1.1 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
StandardUsed |
string |
R |
The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Line instance is using for the connection. Note: In G.997.1, this parameter is called "xDSL Transmission system". See ITU-T Recommendation [G.997.1]. This parameter was DEPRECATED This parameter was DEPRECATED in 2.8.because its entries are out-of-date; {{param|StandardUsedXTSE}} points to a current list. Therefore its value MAY be {{empty}}an empty string if (and only if) {{param|StandardUsedXTSUsed}} is supported. This parameter is OBSOLETED in 2.14. This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
LineEncoding |
string |
R |
{{div|{{classes}}|The line encoding method used in establishing the Layer 1 DSL connection between the CPE and the DSLAM. {{enum}} Note: Generally speaking, this variable does not change after provisioning.}} The line encoding method used in establishing the Layer 1 DSL connection between the CPE and the DSLAM. Enumeration of:
Note: Generally speaking, this variable does not change after provisioning. |
- |
2.12 |
|
AllowedProfiles |
string[] |
R |
Comma-separated list of strings. List items indicate which VDSL2 profiles are allowed on the line. Each list item is an enumeration of:
This enumeration was DELETED in 2.12 because the value is not defined in G997.1. Changes since 2.14:
)
|
- |
2.12 |
|
CurrentProfile |
string |
R |
The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. {{div|{{classes}}|Indicates which VDSL2 profile is currently in use on the line. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be {{empty}}.}} Indicates which VDSL2 profile is currently in use on the line. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string. |
- |
2.12 |
|
PowerManagementState |
string |
R |
{{div|{{classes}}|The power management state of the line. {{enum}} Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} The power management state of the line. Enumeration of:
Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
SuccessFailureCause |
unsignedInt(0:6) |
R |
The success failure cause of the initialization. An enumeration of the following integer values:
|
- |
2.12 |
|
UPBOKLER |
unsignedInt(0:1280) |
R |
{{div|{{classes}}|This parameter contains the estimated electrical loop length estimated by the VTU-R expressed in {{units}} at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of {{units}}. Note: This parameter is defined as UPBOKLE-R in Clause 7.5.1.23.2 of ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter contains the estimated electrical loop length estimated by the VTU-R expressed in 0.1 dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB. Note: This parameter is defined as UPBOKLE-R in Clause 7.5.1.23.2 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
UPBOKLEPb |
unsignedInt(0:1280,2047)[] |
R |
Comma-separated list of unsigned integers (0 to 1280, or 2047). VTU-O estimated upstream power back-off electrical length per band. This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported upstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1). Note: This parameter is defined as UPBOKLE-pb in Clause 7.5.1.23.3 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
UPBOKLERPb |
unsignedInt(0:1280,2047)[] |
R |
Comma-separated list of unsigned integers (0 to 1280, or 2047). VTU-R estimated upstream power back-off electrical length per band. This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported downstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1). The value of each list element is coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB. Note: This parameter is defined as UPBOKLE-R-pb in Clause 7.5.1.23.4 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
RXTHRSHds |
int(-640:0) |
R |
UPBO downstream receiver signal level threshold. This parameter reports the downstream received signal level threshold value used in the alternative electrical length estimation method (ELE-M1). This parameter represents an offset from -100 dBm/Hz, and ranges from -64 dB to 0 dB in steps of 0.1 dB. The value is coded as a 16 bit number in the range -64 (coded as -640) to 0 dB (coded as 0) in steps of 0.1 dB. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
ACTRAMODEds |
unsignedInt(1:4) |
R |
This parameter indicates the actual active rate adaptation mode in the downstream direction.
|
- |
2.12 |
|
ACTRAMODEus |
unsignedInt(1:4) |
R |
This parameter indicates the actual active rate adaptation mode in the upstream direction.
|
- |
2.12 |
|
ACTINPROCds |
unsignedInt |
R |
{{div|{{classes}}|This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the downstream direction. The format and usage is identical to the channel status parameter {{param|#.Channel.{i}.ACTINP}}. Note: This parameter is defined as ACTINP-ROC-ds in Clause 7.5.1.34.1 of ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the downstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP. Note: This parameter is defined as ACTINP-ROC-ds in Clause 7.5.1.34.1 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
ACTINPROCus |
unsignedInt |
R |
{{div|{{classes}}|This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the upstream direction. The format and usage is identical to the channel status parameter {{param|#.Channel.{i}.ACTINP}}. Note: This parameter is defined as ACTINP-ROC-us in Clause 7.5.1.34.2 ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the upstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP. Note: This parameter is defined as ACTINP-ROC-us in Clause 7.5.1.34.2 ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
SNRMROCds |
unsignedInt |
R |
{{div|{{classes}}|This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the downstream direction (expressed in {{units}}). The format is identical to the format of the line status parameter SNRM margin {{param|DownstreamNoiseMargin}}. Note: This parameter is defined as SNRM-ROC-ds in Clause 7.5.1.35.1 ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the downstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin DownstreamNoiseMargin. Note: This parameter is defined as SNRM-ROC-ds in Clause 7.5.1.35.1 ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
SNRMROCus |
unsignedInt |
R |
{{div|{{classes}}|This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the upstream direction (expressed in {{units}}). The format is identical to the format of the line status parameter SNRM margin ({{param|UpstreamNoiseMargin}}). Note: This parameter is defined as SNRM-ROC-us in Clause 7.5.1.35.2 ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the upstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin (UpstreamNoiseMargin). Note: This parameter is defined as SNRM-ROC-us in Clause 7.5.1.35.2 ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
LastStateTransmittedDownstream |
unsignedInt |
R |
This parameter represents the last successful transmitted initialization state in the downstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System. This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
LastStateTransmittedUpstream |
unsignedInt |
R |
This parameter represents the last successful transmitted initialization state in the upstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System. This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
UPBOKLE |
unsignedInt(0:1280) |
R |
{{div|{{classes}}|This parameter contains the estimated electrical loop length expressed in {{units}} at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value SHALL be coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter contains the estimated electrical loop length expressed in 0.1dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value SHALL be coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
MREFPSDds |
base64(0:145) |
R |
{{div|{{classes}}|This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
MREFPSDus |
base64(0:145) |
R |
{{div|{{classes}}|This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
LIMITMASK |
unsignedInt |
R |
Indicates the enabled VDSL2 Limit PSD mask of the selected PSD mask class. Bit mask as specified in ITU-T Recommendation G.997.1. Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
US0MASK |
unsignedInt |
R |
Indicates the allowed VDSL2 US0 PSD masks for Annex A operation. Bit mask as specified in see ITU-T Recommendation G.997.1. Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
TRELLISds |
int |
R |
{{div|{{classes}}|Reports whether trellis coding is enabled in the downstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} Reports whether trellis coding is enabled in the downstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. |
- |
2.12 |
|
TRELLISus |
int |
R |
{{div|{{classes}}|Reports whether trellis coding is enabled in the upstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} Reports whether trellis coding is enabled in the upstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. |
- |
2.12 |
|
ACTSNRMODEds |
unsignedInt |
R |
{{div|{{classes}}|Reports whether the OPTIONAL virtual noise mechanism is in use in the downstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Reports whether the OPTIONAL virtual noise mechanism is in use in the downstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. |
- |
2.12 |
|
ACTSNRMODEus |
unsignedInt |
R |
{{div|{{classes}}|Reports whether the OPTIONAL virtual noise mechanism is in use in the upstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Reports whether the OPTIONAL virtual noise mechanism is in use in the upstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. |
- |
2.12 |
|
VirtualNoisePSDds |
base64(0:97) |
R |
{{div|{{classes}}|Reports the virtual noise PSD for the downstream direction. Base64 encoded of the binary representation defined in G.997.1 by the parameter called TXREFVNds (maximum length is 97 octets, which requires 132 bytes for Base64 encoding). See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to {{empty}}.}} Reports the virtual noise PSD for the downstream direction. Base64 encoded of the binary representation defined in G.997.1 by the parameter called TXREFVNds (maximum length is 97 octets, which requires 132 bytes for Base64 encoding). See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. |
- |
2.12 |
|
VirtualNoisePSDus |
base64(0:49) |
R |
{{div|{{classes}}|Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding). See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to {{empty}}.}} Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding). See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. |
- |
2.12 |
|
ACTUALCE |
unsignedInt |
R |
{{div|{{classes}}|Reports the actual cyclic extension, as the value of m, in use for the connection. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 99.}} Reports the actual cyclic extension, as the value of m, in use for the connection. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 99. |
- |
2.12 |
|
UpstreamMaxBitRate |
unsignedInt |
R |
{{div|{{classes}}|The current maximum attainable data rate upstream (expressed in {{units}}). Note: This parameter is related to the G.997.1 parameter ATTNDRus, which is measured in bits/s. See ITU-T Recommendation {{bibref|G.997.1}}.}} The current maximum attainable data rate upstream (expressed in Kbps). Note: This parameter is related to the G.997.1 parameter ATTNDRus, which is measured in bits/s. See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamMaxBitRate |
unsignedInt |
R |
{{div|{{classes}}|The current maximum attainable data rate downstream (expressed in {{units}}). Note: This parameter is related to the G.997.1 parameter ATTNDRds, which is measured in bits/s. See ITU-T Recommendation {{bibref|G.997.1}}.}} The current maximum attainable data rate downstream (expressed in Kbps). Note: This parameter is related to the G.997.1 parameter ATTNDRds, which is measured in bits/s. See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UpstreamNoiseMargin |
int |
R |
{{div|{{classes}}|The current signal-to-noise ratio margin (expressed in {{units}}) in the upstream direction. Note: In G.997.1, this parameter is called SNRMus. See ITU-T Recommendation {{bibref|G.997.1}}.}} The current signal-to-noise ratio margin (expressed in 0.1dB) in the upstream direction. Note: In G.997.1, this parameter is called SNRMus. See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamNoiseMargin |
int |
R |
{{div|{{classes}}|The current signal-to-noise ratio margin (expressed in {{units}}) in the downstream direction. Note: In G.997.1, this parameter is called SNRMds. See ITU-T Recommendation {{bibref|G.997.1}}.}} The current signal-to-noise ratio margin (expressed in 0.1dB) in the downstream direction. Note: In G.997.1, this parameter is called SNRMds. See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRMpbus |
string[](:24) |
R |
{{div|{{classes}}|{{list}} Indicates the current signal-to-noise ratio margin of each upstream band. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 24) of strings. Indicates the current signal-to-noise ratio margin of each upstream band. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
SNRMpbds |
string[](:24) |
R |
{{div|{{classes}}|{{list}} Indicates the current signal-to-noise ratio margin of each band. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 24) of strings. Indicates the current signal-to-noise ratio margin of each band. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
INMIATOds |
unsignedInt(3:511) |
R |
{{div|{{classes}}|The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset, measured in DMT symbols, that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATO. See ITU-T Recommendation {{bibref|G.997.1}}.}} The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset, measured in DMT symbols, that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATO. See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
INMIATSds |
unsignedInt(0:7) |
R |
{{div|{{classes}}|The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATS. See ITU-T Recommendation {{bibref|G.997.1}}.}} The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATS. See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
INMCCds |
unsignedInt(0:64) |
R |
{{div|{{classes}}|The Impulse Noise Monitoring (INM) Cluster Continuation value, measured in DMT symbols, that the xTU receiver uses in the cluster indication process. Note: In G.997.1, this parameter is called INMCC. See ITU-T Recommendation {{bibref|G.997.1}}.}} The Impulse Noise Monitoring (INM) Cluster Continuation value, measured in DMT symbols, that the xTU receiver uses in the cluster indication process. Note: In G.997.1, this parameter is called INMCC. See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
INMINPEQMODEds |
unsignedInt(0:3) |
R |
{{div|{{classes}}|The Impulse Noise Monitoring (INM) Equivalent Impulse Noise Protection (INP) Mode that the xTU receiver uses in the computation of the Equivalent INP. Note: In G.997.1, this parameter is called INM_INPEQ_MODE. See ITU-T Recommendation {{bibref|G.997.1}}.}} The Impulse Noise Monitoring (INM) Equivalent Impulse Noise Protection (INP) Mode that the xTU receiver uses in the computation of the Equivalent INP. Note: In G.997.1, this parameter is called INM_INPEQ_MODE. See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
UpstreamAttenuation |
int |
R |
{{div|{{classes}}|The current upstream signal loss (expressed in {{units}}). Doesn't apply to VDSL2 {{bibref|G.993.2}}. Otherwise has the same value as the single element of {{param|TestParams.SATNus}}.}} The current upstream signal loss (expressed in 0.1dB). Doesn't apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNus. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamAttenuation |
int |
R |
{{div|{{classes}}|The current downstream signal loss (expressed in {{units}}). Doesn't apply to VDSL2 {{bibref|G.993.2}}. Otherwise has the same value as the single element of {{param|TestParams.SATNds}}.}} The current downstream signal loss (expressed in 0.1dB). Doesn't apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNds. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURVendor |
hexBinary(4) |
R |
xTU-R vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value "00000000". Note: In G.997.1, this parameter is called "xTU-R G.994.1 Vendor ID". See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
XTURCountry |
hexBinary(2) |
R |
T.35 country code of the xTU-R vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value "0000". Note: In G.997.1, this parameter is called "xTU-R G.994.1 Vendor ID". See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
XTURANSIStd |
unsignedInt |
R |
{{div|{{classes}}|xTU-R T1.413 Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0.}} xTU-R T1.413 Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. |
- |
2.12 |
|
XTURANSIRev |
unsignedInt |
R |
{{div|{{classes}}|xTU-R Vendor Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0.}} xTU-R Vendor Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. |
- |
2.12 |
|
XTUCVendor |
hexBinary(4) |
R |
{{div|{{classes}}|xTU-C vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value "00000000".}} xTU-C vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value "00000000". |
- |
2.12 |
|
XTUCCountry |
hexBinary(2) |
R |
{{div|{{classes}}|T.35 country code of the xTU-C vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value "0000".}} T.35 country code of the xTU-C vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value "0000". |
- |
2.12 |
|
XTUCANSIStd |
unsignedInt |
R |
{{div|{{classes}}|xTU-C T1.413 Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0.}} xTU-C T1.413 Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. |
- |
2.12 |
|
XTUCANSIRev |
unsignedInt |
R |
{{div|{{classes}}|xTU-C Vendor Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0.}} xTU-C Vendor Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. |
- |
2.12 |
|
Device.DSL.Line.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
TotalStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ShowtimeStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics. Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link. Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LastShowtimeStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
CurrentDayStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QuarterHourStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.Stats.Total. |
object |
R |
{{div|{{classes}}|This object contains DSL line total statistics. See {{bibref|G.997.1|Chapter 7.2.6}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL line total statistics. See [Chapter 7.2.6/G.997.1]. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
ErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Total number of errored {{units}} (ES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of errored seconds (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SeverelyErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Total number of severely errored {{units}} (SES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of severely errored seconds (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.Stats.Showtime. |
object |
R |
{{div|{{classes}}|This object contains DSL line statistics accumulated since the most recent DSL Showtime. See {{bibref|G.997.1|Chapter 7.2.6}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL line statistics accumulated since the most recent DSL Showtime. See [Chapter 7.2.6/G.997.1]. Note: The Showtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
ErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of errored {{units}} since the most recent DSL Showtime (ES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of errored seconds since the most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SeverelyErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of severely errored {{units}} since the most recent DSL Showtime (SES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of severely errored seconds since the most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.Stats.LastShowtime. |
object |
R |
{{div|{{classes}}|This object contains DSL line statistics accumulated since the second most recent DSL Showtime. See {{bibref|G.997.1|Chapter 7.2.6}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL line statistics accumulated since the second most recent DSL Showtime. See [Chapter 7.2.6/G.997.1]. Note: The LastShowtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
ErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of errored {{units}} since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of errored seconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SeverelyErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of severely errored {{units}} since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of severely errored seconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.Stats.CurrentDay. |
object |
R |
{{div|{{classes}}|This object contains DSL line statistics accumulated during the current day. See {{bibref|G.997.1|Chapter 7.2.6}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL line statistics accumulated during the current day. See [Chapter 7.2.6/G.997.1]. Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
ErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of errored {{units}} since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of errored seconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SeverelyErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of severely errored {{units}} since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of severely errored seconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.Stats.QuarterHour. |
object |
R |
{{div|{{classes}}|This object contains DSL line statistics accumulated during the current quarter hour. See {{bibref|G.997.1|Chapter 7.2.6}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL line statistics accumulated during the current quarter hour. See [Chapter 7.2.6/G.997.1]. Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
ErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of errored {{units}} since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of errored seconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SeverelyErroredSecs |
unsignedInt |
R |
{{div|{{classes}}|Number of severely errored {{units}} since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of severely errored seconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.TestParams. |
object |
R |
This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. |
- |
2.12 |
|
HLOGGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|HLOGpsds}}. Valid values are 1, 2, 4, 8, and 16. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, 8, and 16. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
HLOGGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the upstream direction for {{param|HLOGpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} Number of sub-carriers per sub-carrier group in the upstream direction for HLOGpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
HLOGpsds |
string[](:2559) |
R |
Comma-separated list (maximum number of characters 2559) of strings. Indicates the downstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
HLOGpsus |
string[](:2559) |
R |
Comma-separated list (maximum number of characters 2559) of strings. Indicates the upstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
HLOGMTds |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|HLOGpsds}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Indicates the number of symbols over which HLOGpsds was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
HLOGMTus |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|HLOGpsus}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Indicates the number of symbols over which HLOGpsus was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QLNGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|QLNpsds}}. Valid values are 1, 2, 4, 8, and 16. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, 8, and 16. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QLNGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the upstream direction for {{param|QLNpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} Number of sub-carriers per sub-carrier group in the upstream direction for QLNpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QLNpsds |
int[](:2047) |
R |
Comma-separated list (maximum number of characters 2047) of integers. Indicates the downstream quiet line noise per subcarrier group. The maximum number of elements is 256 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: QLNpsds is measured during initialization and is not updated during Showtime. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QLNpsus |
string[](:2047) |
R |
Comma-separated list (maximum number of characters 2047) of strings. Indicates the upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: QLNpsus is measured during initialization and is not updated during Showtime. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QLNMTds |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|QLNpsds}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Indicates the number of symbols over which QLNpsds was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QLNMTus |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|QLNpsus}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Indicates the number of symbols over which QLNpsus was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|SNRpsds}}. Valid values are 1, 2, 4, 8, and 16. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, 8, and 16. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the upstream direction for {{param|SNRpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} Number of sub-carriers per sub-carrier group in the upstream direction for SNRpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRpsds |
int[](:2047) |
R |
Comma-separated list (maximum number of characters 2047) of integers. Indicates the downstream SNR per subcarrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: SNRpsds is first measured during initialization and is updated during Showtime. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRpsus |
string[](:2047) |
R |
Comma-separated list (maximum number of characters 2047) of strings. Indicates the upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: SNRpsus is first measured during initialization and is updated during Showtime. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRMTds |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|SNRpsds}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Indicates the number of symbols over which SNRpsds was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRMTus |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|SNRpsus}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Indicates the number of symbols over which SNRpsus was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LATNds |
string[](:35) |
R |
{{div|{{classes}}|{{list}} Indicates the downstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of LATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LATNus |
string[](:35) |
R |
{{div|{{classes}}|{{list}} Indicates the upstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for ITU-T G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for ITU-T G.993.2. Interpretation of LATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SATNds |
string[](:35) |
R |
{{div|{{classes}}|{{list}} Indicates the downstream signal attenuation averaged across all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream signal attenuation averaged across all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SATNus |
string[](:35) |
R |
{{div|{{classes}}|{{list}} Indicates the upstream signal attenuation averaged across all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream signal attenuation averaged across all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Line.{i}.DataGathering. |
object |
R |
{{div|{{classes}}|This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2. Note: see ITU-T Recommendation {{bibref|G.993.2}}.}} This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2. Note: see ITU-T Recommendation [G.993.2]. |
- |
2.12 |
|
LoggingDepthR |
unsignedInt |
R |
{{div|{{classes}}|This parameter is the maximum depth of the entire data gathering event buffer at the VTU-R, in number of {{units}}, where each of the {{units}} consists of 6 bytes indicating a data gathering event as defined in {{bibref|G.993.2}}. Note: This parameter is defined as LOGGING_DEPTH_R in Clause 7.5.3.2 of ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter is the maximum depth of the entire data gathering event buffer at the VTU-R, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2]. Note: This parameter is defined as LOGGING_DEPTH_R in Clause 7.5.3.2 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
ActLoggingDepthReportingR |
unsignedInt |
R |
{{div|{{classes}}|This parameter is actual logging depth that is used for reporting the VTU-R event trace buffer over the eoc channel, in number of {{units}}, where each of the {{units}} consists of 6 bytes indicating a data gathering event as defined in {{bibref|G.993.2}}. Note: This parameter is defined as ACT_LOGGING_DEPTH_REPORTING_R in Clause 7.5.3.4 of ITU-T Recommendation {{bibref|G.997.1}}.}} This parameter is actual logging depth that is used for reporting the VTU-R event trace buffer over the eoc channel, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2]. Note: This parameter is defined as ACT_LOGGING_DEPTH_REPORTING_R in Clause 7.5.3.4 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
EventTraceBufferR |
string(:256) |
R |
The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the log file of the the data gathering event trace buffer containing the event records that originated at the VTU-R. This indicates the table entry that represents a Vendor Log File that contains the data gathering buffer at the VTU-R in the DeviceInfo.VendorLogFile table. This data gathering buffer MAY be retrieved wia an upload RPC of the identified Vendor Log File. Note: This parameter is defined as EVENT_TRACE_BUFFER_R in Clause 7.5.3.6 of ITU-T Recommendation [G.997.1] and Clause 11.5 of ITU-T Recommendation [G.993.2]. |
- |
2.12 |
|
Device.DSL.Channel.{i}. |
object(0:) |
R |
{{div|{{classes}}|DSL Channel table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This table models DSL channel(s) on top of physical DSL lines.}} DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models DSL channel(s) on top of physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the channel. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the channel. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the channel (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LinkEncapsulationUsed |
string |
R |
Indicates the link encapsulation standard that the Channel instance is using for the connection. Enumeration of: |
- |
2.12 |
|
LPATH |
unsignedInt(:3) |
R |
{{div|{{classes}}|Reports the index of the latency path supporting the bearer channel. Note: See ITU-T Recommendation {{bibref|G.997.1|Section 7.5.2.7}}.}} Reports the index of the latency path supporting the bearer channel. Note: See ITU-T Recommendation [Section 7.5.2.7/G.997.1]. |
- |
2.12 |
|
INTLVDEPTH |
unsignedInt |
R |
{{div|{{classes}}|Reports the interleaver depth D for the latency path indicated in {{param|LPATH}}. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
INTLVBLOCK |
int |
R |
{{div|{{classes}}|Reports the interleaver block length in use on the latency path indicated in {{param|LPATH}}. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} |
- |
2.12 |
|
ActualInterleavingDelay |
unsignedInt |
R |
{{div|{{classes}}|Reports the actual delay, in {{units}}, of the latency path due to interleaving. Note: In G.997.1, this parameter is called "Actual Interleaving Delay." See ITU-T Recommendation {{bibref|G.997.1}}.}} Reports the actual delay, in milliseconds, of the latency path due to interleaving. Note: In G.997.1, this parameter is called "Actual Interleaving Delay." See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
ACTINP |
int |
R |
{{div|{{classes}}|Reports the actual impulse noise protection (INP) provided by the latency path indicated in {{param|LPATH}}. The value is the actual INP in the L0 (i.e., Showtime) state. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} Reports the actual impulse noise protection (INP) provided by the latency path indicated in LPATH. The value is the actual INP in the L0 (i.e., Showtime) state. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. |
- |
2.12 |
|
INPREPORT |
boolean |
R |
{{div|{{classes}}|Reports whether the value reported in ACTINP was computed assuming the receiver does not use erasure decoding. Valid values are 0 (computed per the formula assuming no erasure decoding) and 1 (computed by taking into account erasure decoding capabilities of receiver). Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to {{false}}.}} Reports whether the value reported in ACTINP was computed assuming the receiver does not use erasure decoding. Valid values are 0 (computed per the formula assuming no erasure decoding) and 1 (computed by taking into account erasure decoding capabilities of receiver). Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to false. |
- |
2.12 |
|
NFEC |
int |
R |
{{div|{{classes}}|Reports the size, in {{units}}, of the Reed-Solomon codeword in use on the latency path indicated in {{param|LPATH}}. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} |
- |
2.12 |
|
RFEC |
int |
R |
{{div|{{classes}}|Reports the number of redundancy bytes per Reed-Solomon codeword on the latency path indicated in {{param|LPATH}}. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} |
- |
2.12 |
|
LSYMB |
int |
R |
{{div|{{classes}}|Reports the number of bits per symbol assigned to the latency path indicated in {{param|LPATH}}. This value does not include overhead due to trellis coding. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.}} Reports the number of bits per symbol assigned to the latency path indicated in LPATH. This value does not include overhead due to trellis coding. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. |
- |
2.12 |
|
UpstreamCurrRate |
unsignedInt |
R |
{{div|{{classes}}|The current physical layer aggregate data rate (expressed in {{units}}) of the upstream DSL connection. Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type).}} The current physical layer aggregate data rate (expressed in Kbps) of the upstream DSL connection. Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamCurrRate |
unsignedInt |
R |
{{div|{{classes}}|The current physical layer aggregate data rate (expressed in {{units}}) of the downstream DSL connection. Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type).}} The current physical layer aggregate data rate (expressed in Kbps) of the downstream DSL connection. Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ACTNDR |
unsignedInt |
R |
Actual net data rate expressed in Kbps. Independent whether retransmission is used or not in a given transmit direction:
|
- |
2.12 |
|
ACTINPREIN |
unsignedInt(0:255) |
R |
Actual impulse noise protection against REIN, expressed in 0.1 DMT symbols. If retransmission is used in a given transmit direction, this parameter reports the actual impulse noise protection (INP) against REIN (under specific conditions detailed in [ITU T G.998.4]) on the bearer channel in the L0 state. In the L2 state, the parameter contains the INP in the previous L0 state. The value is coded in fractions of DMT symbols with a granularity of 0.1 symbols. The range is from 0 to 25.4. A special value of 25.5 indicates an ACTINP_REIN of 25.5 or higher. Note: This parameter is defined as ACTINP_REIN in Clause 7.5.2.9 of ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
Device.DSL.Channel.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
TotalStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ShowtimeStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics. Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link. Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LastShowtimeStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
CurrentDayStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QuarterHourStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Channel.{i}.Stats.Total. |
object |
R |
{{div|{{classes}}|This object contains DSL channel total statistics {{bibref|G.997.1}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL channel total statistics [G.997.1]. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
XTURFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Total number of FEC errors detected (FEC-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of FEC errors detected (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Total number of FEC errors detected by the ATU-C (FEC-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of FEC errors detected by the ATU-C (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Total number of HEC errors detected (HEC-P as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of HEC errors detected (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Total number of HEC errors detected by the ATU-C (HEC-PFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of HEC errors detected by the ATU-C (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Total number of CRC errors detected (CV-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of CRC errors detected (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Total number of CRC errors detected by the ATU-C (CV-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Total number of CRC errors detected by the ATU-C (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Channel.{i}.Stats.Showtime. |
object |
R |
{{div|{{classes}}|This object contains DSL channel statistics accumulated since the most recent DSL Showtime {{bibref|G.997.1}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL channel statistics accumulated since the most recent DSL Showtime [G.997.1]. Note: The Showtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
XTURFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected since the most recent DSL Showtime (FEC-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected since the most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected by the ATU-C since the most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected by the ATU-C since the most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected by the ATU-C since the most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected by the ATU-C since the most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected since the most recent DSL Showtime (CV-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected since the most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected by the ATU-C since the most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected by the ATU-C since the most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Channel.{i}.Stats.LastShowtime. |
object |
R |
{{div|{{classes}}|This object contains DSL channel statistics accumulated since the second most recent DSL Showtime {{bibref|G.997.1}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL channel statistics accumulated since the second most recent DSL Showtime [G.997.1]. Note: The LastShowtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
XTURFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Channel.{i}.Stats.CurrentDay. |
object |
R |
{{div|{{classes}}|This object contains DSL channel statistics accumulated during the current day {{bibref|G.997.1}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL channel statistics accumulated during the current day [G.997.1]. Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
XTURFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.Channel.{i}.Stats.QuarterHour. |
object |
R |
{{div|{{classes}}|This object contains DSL channel statistics accumulated during the current quarter hour {{bibref|G.997.1}}. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL channel statistics accumulated during the current quarter hour [G.997.1]. Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
XTURFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCFECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCHECErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTURCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
XTUCCRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. {{bibref|G.997.1}}). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).}} Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}. |
object(0:) |
R |
DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a DSL.Channel instance or a FAST.Line instance for each bonded channel in the group. Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured by a Controller. The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup. At most one entry in this table can exist with a given value for Alias, or with a given value for Name, or with a given value for GroupID. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the bonding group. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the bonding group. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the bonding group (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
R |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. {{param}} is read-only for this object because bonding is expected to be configured by the CPE, not by the Controller.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers is read-only for this object because bonding is expected to be configured by the CPE, not by the Controller. |
- |
2.12 |
|
GroupStatus |
string[] |
R |
{{div|{{classes}}|{{list}} Indicates the current fault status of the DSL bonding group. {{enum}} Corresponds to {{bibref|TR-159}} oBondingGroup.aGroupStatus.}} Comma-separated list of strings. Indicates the current fault status of the DSL bonding group. Each list item is an enumeration of:
Corresponds to [TR-159] oBondingGroup.aGroupStatus. |
- |
2.12 |
|
BondSchemesSupported |
string[] |
R |
{{div|{{classes}}|{{list}} Supported DSL bonding schemes. {{enum}} Corresponds to {{bibref|TR-159}} oBondingGroup.aGroupBondSchemesSupported.}} Comma-separated list of strings. Supported DSL bonding schemes. Each list item is an enumeration of:
[G.998.1] ATM-based bonding Changes since 2.14:
)
[G.998.3] TDIM-based bonding Changes since 2.14:
) Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. |
object(0:) |
R |
{{div|{{classes}}|DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one {{object|.DSL.Channel}} instance or one {{object|.FAST.Line}} instance. There MUST be an instance of {{object}} for each DSL channel or FAST line that is bonded. When a {{object|.DSL.Channel}} or {{object|.FAST.Line}} is no longer bonded, then the CPE MUST delete the corresponding {{object}} instance. However, when a bonded {{object|.DSL.Channel}} or {{object|.FAST.Line}} becomes disabled, the channel remains bonded and so the corresponding {{object}} instance MUST NOT be deleted.}} DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one DSL.Channel instance or one FAST.Line instance. There MUST be an instance of BondedChannel for each DSL channel or FAST line that is bonded. When a DSL.Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded DSL.Channel or FAST.Line becomes disabled, the channel remains bonded and so the corresponding BondedChannel instance MUST NOT be deleted. At most one entry in this table can exist with a given value for Alias, or with a given value for Channel. |
- |
2.12 |
|
Channel |
string(:256) |
R |
{{div|{{classes}}|{{reference}}This is the channel that is being bonded. This is read-only because bonding is expected to be configured by the CPE, not by the Controller.}} The value MUST be the Path Name of a row in the DSL.Channel. or FAST.Line. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.This is the channel that is being bonded. This is read-only because bonding is expected to be configured by the CPE, not by the Controller. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet. |
object |
R |
Per-channel [G.998.2] Ethernet-based bonding parameters. This object MUST be present if, and only if, {{param|##.BondScheme}} is {{enum|Ethernet|##.BondScheme}}. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet.Stats. |
object |
R |
Per-channel [G.998.2] Ethernet-based bonding statistics. These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) lower layer (per-channel) interfaces. The CPE MUST reset the Stats parameters 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 |
|
Device.DSL.BondingGroup.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
TotalStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
CurrentDayStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QuarterHourStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.Stats.Total. |
object |
R |
{{div|{{classes}}|Total statistics for this bonding group. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} Total statistics for this bonding group. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
FailureReasons |
string[] |
R |
{{div|{{classes}}|{{list}} Indicates the failure conditions that have occurred during the accumulation period. {{enum}} Corresponds to {{bibref|G.998.1|section 11.4.3}} Current Group Failure Reason.}} Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:
Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.Stats.CurrentDay. |
object |
R |
{{div|{{classes}}|Current day statistics for this bonding group. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} Current day statistics for this bonding group. Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
FailureReasons |
string[] |
R |
{{div|{{classes}}|{{list}} Indicates the failure conditions that have occurred during the accumulation period. {{enum}} Corresponds to {{bibref|G.998.1|section 11.4.3}} Current Group Failure Reason.}} Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:
Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.Stats.QuarterHour. |
object |
R |
{{div|{{classes}}|Current quarter hour statistics for this bonding group. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} Current quarter hour statistics for this bonding group. Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
FailureReasons |
string[] |
R |
{{div|{{classes}}|{{list}} Indicates the failure conditions that have occurred during the accumulation period. {{enum}} Corresponds to {{bibref|G.998.1|section 11.4.3}} Current Group Failure Reason.}} Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:
Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason. |
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.Ethernet. |
object(0:1) |
R |
Ethernet-based bonding parameters [G.998.2]. This object MUST be present if, and only if, {{param|#.BondScheme}} is {{enum|Ethernet|#.BondScheme}}. This object MUST be present if, and only if, BondScheme is Ethernet. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Device.DSL.BondingGroup.{i}.Ethernet.Stats. |
object |
R |
[G.998.2] Ethernet-based bonding statistics. These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) and to its upper layer interface. PAF lower layer interface statistics are in the BondedChannel.{i}.Ethernet.Stats objects. The CPE MUST reset the Stats parameters 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 |
|
Device.DSL.Diagnostics. |
object |
R |
The DSL Diagnostics object. |
- |
2.12 |
|
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 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ ACTPSDds |
int |
R |
{{div|{{classes}}|Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ ACTPSDus |
int |
R |
{{div|{{classes}}|Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ ACTATPds |
int |
R |
{{div|{{classes}}|Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ ACTATPus |
int |
R |
{{div|{{classes}}|Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ HLINSCds |
int |
R |
{{div|{{classes}}|Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. |
- |
2.12 |
|
⇐ HLINSCus |
int |
R |
{{div|{{classes}}|Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. |
- |
2.12 |
|
⇐ HLINGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|HLINpsds}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ HLINGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|HLINpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ HLOGGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|HLOGpsds}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ HLOGGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the upstream direction for {{param|HLOGpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ HLOGpsds |
string[](:2559) |
R |
Comma-separated list (maximum number of characters 2559) of strings. List items represent downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. |
- |
2.12 |
|
⇐ HLOGpsus |
string[](:2559) |
R |
Comma-separated list (maximum number of characters 2559) of strings. List items represent upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. |
- |
2.12 |
|
⇐ HLOGMTds |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|HLOGpsds}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
⇐ HLOGMTus |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|HLOGpsus}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
⇐ LATNpbds |
string[](:24) |
R |
{{div|{{classes}}|{{list}} List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ LATNpbus |
string[](:24) |
R |
{{div|{{classes}}|{{list}} List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ SATNds |
string[](:24) |
R |
{{div|{{classes}}|{{list}} List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ SATNus |
string[](:24) |
R |
{{div|{{classes}}|{{list}} List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of {{param}} is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation {{bibref|G.997.1}}.}} Comma-separated list (maximum number of characters 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. |
- |
2.12 |
|
⇐ HLINpsds |
int[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. |
- |
2.12 |
|
⇐ HLINpsus |
string[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. |
- |
2.12 |
|
⇐ QLNGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|QLNpsds}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ QLNGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the upstream direction for {{param|QLNpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ QLNpsds |
int[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream quiet line noise per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. |
- |
2.12 |
|
⇐ QLNpsus |
string[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. |
- |
2.12 |
|
⇐ QLNMTds |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|QLNpsds}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
⇐ QLNMTus |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|QLNpsus}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
⇐ SNRGds |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the downstream direction for {{param|SNRpsds}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ SNRGus |
unsignedInt |
R |
{{div|{{classes}}|Number of sub-carriers per sub-carrier group in the upstream direction for {{param|SNRpsus}}. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.}} |
- |
2.12 |
|
⇐ SNRpsds |
int[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream SNR per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. |
- |
2.12 |
|
⇐ SNRpsus |
string[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. |
- |
2.12 |
|
⇐ SNRMTds |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|SNRpsds}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
⇐ SNRMTus |
unsignedInt |
R |
{{div|{{classes}}|Indicates the number of symbols over which {{param|SNRpsus}} was measured. Note: See ITU-T Recommendation {{bibref|G.997.1}}. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.}} |
- |
2.12 |
|
SELTUER() |
command |
- |
[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER). This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. |
- |
2.13 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ UERMaxMeasurementDuration |
unsignedInt(5:240) |
W |
{{div|{{classes}}|This parameter is the SELT UER maximum measurement duration (MMD) measured in {{units}}. This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.1.1}}.}} This parameter is the SELT UER maximum measurement duration (MMD) measured in seconds. This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation [Clause A.2.1.1/G.996.2]. |
- |
2.13 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ ExtendedBandwidthOperation |
boolean |
R |
This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false). If the option for extended bandwidth SELT is applied to UER, then UERGroupSize has three valid values: 1, 2 and 12. If the option for extended bandwidth SELT is not applied to UER, then UERGroupSize has two valid values: 1 and 2. UERGroupSize is reported if the option for extended bandwidth UER SELT is supported; otherwise, reporting of the group size is optional. |
- |
2.13 |
|
⇐ UER |
int[2:2][1:4096] |
R |
The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], ... Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of the following. [UERComplex] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
|
- |
2.13 |
|
⇐ UERScaleFactor |
unsignedInt |
R |
The Uncalibrated Echo Response (UER) scale factor. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2]. Note that the scale factor is chosen such that max(abs(a(i)), abs(b(i))) over all i is equal to 2^31 - 1, which doesn't allow UERScaleFactor to be zero. |
- |
2.13 |
|
⇐ UERGroupSize |
unsignedInt(1:2,12) |
R |
{{div|{{classes}}|The Uncalibrated Echo Response (UER) group size, UER_G. In units of {{units}}. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.2}}.}} The Uncalibrated Echo Response (UER) group size, UER_G. In units of subcarriers. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.2/G.996.2]. |
- |
2.13 |
|
⇐ UERVar |
int[0:4096] |
R |
Comma-separated list (0 to 4096 items) of integers. {{div|{{classes}}|This parameter represents the variance of the {{param|UER}}. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*{{param|UERGroupSize}}Df is VAR(i{{param|UERGroupSize}}*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz. This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in {{bibref|G.996.2|Clause A.2.2.2}}.}} This parameter represents the variance of the UER. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*UERGroupSizeDf is VAR(iUERGroupSize*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz. This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in [Clause A.2.2.2/G.996.2]. |
- |
2.13 |
|
SELTQLN() |
command |
- |
[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN). This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. |
- |
2.13 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ QLNMaxMeasurementDuration |
unsignedInt(1:240) |
W |
{{div|{{classes}}|This parameter is the SELT QLN maximum measurement duration (MMD) measured in {{units}}. This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.1.2}}.}} This parameter is the SELT QLN maximum measurement duration (MMD) measured in seconds. This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation [Clause A.2.1.2/G.996.2]. |
- |
2.13 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ ExtendedBandwidthOperation |
boolean |
R |
This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false). If the option for extended bandwidth SELT is applied to QLN, then QLNGroupSize has three valid values: 1, 2 and 12. If the option for extended bandwidth SELT is not applied to QLN, then QLNGroupSize has two valid values: 1 and 2. QLNGroupSize is reported if the option for extended bandwidth QLN SELT is supported; otherwise, reporting of the group size is optional. |
- |
2.13 |
|
⇐ QLN |
int[](:61430) |
R |
Comma-separated list (maximum number of characters 61430) of integers. List items represent SELT quiet line noise (QLN) per subcarrier group. Each list element is n(i), with i starting at 0. The value of QLN at frequency i*QLNGroupSizeDf with Df=4.3125 kHz is defined as QLN(iQLNGroupSize*Df) = -23 - (n(i)/2) dBm/Hz. This data format supports a QLN granularity of 0.5 dB and an dynamic range of -150 to -23 dBm/Hz. Interpretation of the SELT_QLN_R value is defined in [Clause A.2.2.3/G.996.2]. |
- |
2.13 |
|
⇐ QLNGroupSize |
unsignedInt(1:2,12) |
R |
{{div|{{classes}}|This parameter represents the Quiet Line Noise (QLN) group size. In units of {{units}}. This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.4}}.}} This parameter represents the Quiet Line Noise (QLN) group size. In units of subcarriers. This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation [Clause A.2.2.4/G.996.2]. |
- |
2.13 |
|
SELTP() |
command |
- |
[ASYNC] This command performs a DSL Single-Ended Line Test - Processed (SELT-P). This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [G.996.2]. |
- |
2.13 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ CapacityEstimateEnabling |
boolean |
W |
{{div|{{classes}}|Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value {{false}} if xDSL performance estimation is not required, {{true}} otherwise. The capacity estimate calculation enabling parameter is defined in {{bibref|G.996.2|Clause B.2.1.1}}.}} Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value false if xDSL performance estimation is not required, true otherwise. The capacity estimate calculation enabling parameter is defined in [Clause B.2.1.1/G.996.2]. |
- |
2.13 |
|
⇒ CapacitySignalPSD |
unsignedInt[2:2][1:48] |
W |
The capacity estimate signal Power Spectral Density (PSD): Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of the following. [PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and
|
- |
2.13 |
|
⇒ CapacityNoisePSD |
unsignedInt[2:2][1:48] |
W |
The capacity estimate noise Power Spectral Density (PSD): Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of the following. [PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and
|
- |
2.13 |
|
⇒ CapacityTargetMargin |
unsignedInt(0:310) |
W |
{{div|{{classes}}|The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of {{units}}. This capacity estimate target noise margin parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.4}}.}} The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of 0.1 dB. This capacity estimate target noise margin parameter is defined in ITU-T Recommendation [Clause B.2.1.4/G.996.2]. |
- |
2.13 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ LoopTermination |
string |
R |
{{div|{{classes}}|Loop termination indicator. {{enum}} This parameter is defined as LOOP-TERM in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.1}}.}} Loop termination indicator. Enumeration of:
This parameter is defined as LOOP-TERM in ITU-T Recommendation [Clause B.1.1.1/G.996.2]. |
- |
2.13 |
|
⇐ LoopLength |
unsignedInt(0:16383) |
R |
{{div|{{classes}}|This parameter is the loop length with units of {{units}}. This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.2}}.}} This parameter is the loop length with units of meters. This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation [Clause B.1.1.2/G.996.2]. |
- |
2.13 |
|
⇐ LoopTopology |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. List items represent paired parameters [LOOP_SEG_LEN, LOOP_SEG_BTAP] representing a concatenation of loop segment types, where LOOP_SEG_LEN represents the length of the segment in meters; and LOOP_SEG_BTAP is a string that identifies the segment type as either "in series" or "bridged tap". The first loop segment in the list shall be the segment connected to the SELT-PMD block, subsequent loop segments in the list shall describe the loop in the direction toward the far-end loop termination. This Loop Topology parameter is defined in ITU-T Recommendation [Clause B.1.1.3/G.996.2]. |
- |
2.13 |
|
⇐ AttenuationCharacteristics |
unsignedInt[2:2][0:8191] |
R |
Specifies the list of attenuation characteristics. Comma-separated list (0 to 8191 items) of SELTPAttenuation Characteristics Index And TFlogs, with each list item consisting of the following. [SELTPAttenuationCharacteristicsIndexAndTFlog] 1. The paired frequency spacing index in the range [0:8191], and
|
- |
2.13 |
|
⇐ TFlogGroupSize |
unsignedInt(1:2,12) |
R |
{{div|{{classes}}|This parameter represents the Transfer Function Log (TFlog) group size. In units of {{units}}. This parameter is defined as part of the SELT attenuation characteristics, {{param|AttenuationCharacteristics}}, defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.6}}.}} This parameter represents the Transfer Function Log (TFlog) group size. In units of subcarriers. This parameter is defined as part of the SELT attenuation characteristics, AttenuationCharacteristics, defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2]. |
- |
2.14 |
|
⇐ MissingFilter |
boolean |
R |
{{div|{{classes}}|Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter. The missing micro-filter or splitter parameter is defined in {{bibref|G.996.2|Clause B.1.1.4}}.}} Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter. The missing micro-filter or splitter parameter is defined in [Clause B.1.1.4/G.996.2]. |
- |
2.13 |
|
⇐ CapacityEstimate |
unsignedInt[1:2] |
R |
Capacity Estimate: Comma-separated list (1 to 2 items) of unsigned integers. This parameter represents the downstream and/or upstream capacity estimates in kbit/s. If only one value is supplied, then it's not specified whether it's the downstream value, the upstream value or some combination of the two. If two values are supplied, then the first is the downstream value and the second is the upstream value. The capacity estimate parameters are defined in [Clause B.1.1.7/G.996.2]. |
- |
2.13 |
|
Device.FAST. |
object |
R |
This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. |
- |
2.12 |
|
Device.FAST.Line.{i}. |
object(0:) |
R |
{{div|{{classes}}|FAST Line table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This table models physical FAST lines.}} FAST Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical FAST lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the FAST line (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Line is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
LinkStatus |
string |
R |
Status of the FAST physical link. Enumeration of:
|
- |
2.12 |
|
AllowedProfiles |
string[] |
R |
{{div|{{classes}}|{{list}} List items indicate which FAST profiles are allowed on the line. {{enum}} Note: In G.997.2, this parameter is called PROFILES. See ITU-T Recommendation {{bibref|G.997.2}}.}} Comma-separated list of strings. List items indicate which FAST profiles are allowed on the line. Each list item is an enumeration of:
Note: In G.997.2, this parameter is called PROFILES. See ITU-T Recommendation [G.997.2]. |
- |
2.12 |
|
PowerManagementState |
string |
R |
{{div|{{classes}}|The power management state of the line. {{enum}} Note: See ITU-T Recommendation {{bibref|G.9701}}.}} The power management state of the line. Enumeration of:
Note: See ITU-T Recommendation [G.9701]. |
- |
2.12 |
|
SuccessFailureCause |
unsignedInt(0:5) |
R |
The success failure cause of the initialization. An enumeration of the following integer values:
|
- |
2.12 |
|
UPBOKLER |
unsignedInt(0:1280) |
R |
{{div|{{classes}}|This parameter reports the estimate of the electrical length expressed in {{units}}, as determined by the FTU-R (see clause 7.3.1.4.2.1/{{bibref|G.9701}}) and conveyed in the R-MSG1 initialization message (see clause 12.3.3.2.3/{{bibref|G.9701}}). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of {{units}}. Note: This parameter is defined as UPBOKLE-R in Clause 7.10.4.2 of ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the estimate of the electrical length expressed in 0.1 dB, as determined by the FTU-R (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the R-MSG1 initialization message (see clause 12.3.3.2.3/[G.9701]). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB. Note: This parameter is defined as UPBOKLE-R in Clause 7.10.4.2 of ITU-T Recommendation [G.997.2]. |
- |
2.12 |
|
LastTransmittedDownstreamSignal |
unsignedInt(0:21) |
R |
{{div|{{classes}}|This parameter reports the downstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The downstream signal count is defined in clause 12.3.1/{{bibref|G.9701}}. Note: See clause 7.10.2.2 ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the downstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The downstream signal count is defined in clause 12.3.1/[G.9701]. Note: See clause 7.10.2.2 ITU-T Recommendation [G.997.2]. |
- |
2.12 |
|
LastTransmittedUpstreamSignal |
unsignedInt(0:21) |
R |
{{div|{{classes}}|This parameter reports the upstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The upstream signal count is defined in clause 12.3.1/{{bibref|G.9701}}. Note: See clause 7.10.2.3 ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the upstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The upstream signal count is defined in clause 12.3.1/[G.9701]. Note: See clause 7.10.2.3 ITU-T Recommendation [G.997.2]. |
- |
2.12 |
|
UPBOKLE |
unsignedInt(0:1280) |
R |
{{div|{{classes}}|This parameter reports the electrical length that would have been sent from the FTU-O to the FTU-R if the electrical length was not forced by the DPU-MIB. If the electrical length is not forced by the DPU-MIB, then this object reports the final electrical length, as determined by the FTU-O (see clause 7.3.1.4.2.1/{{bibref|G.9701}}) and conveyed in the O-UPDATE initialization message (see clause 12.3.3.2.4/{{bibref|G.9701}}). Note: See clause 7.10.4.1 in ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the electrical length that would have been sent from the FTU-O to the FTU-R if the electrical length was not forced by the DPU-MIB. If the electrical length is not forced by the DPU-MIB, then this object reports the final electrical length, as determined by the FTU-O (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the O-UPDATE initialization message (see clause 12.3.3.2.4/[G.9701]). Note: See clause 7.10.4.1 in ITU-T Recommendation [G.997.2]. |
- |
2.12 |
|
UpstreamMaxBitRate |
unsignedInt |
R |
{{div|{{classes}}|This parameter reports the attainable net data rate expressed in {{units}} as defined in clause 11.4.1.1.2/{{bibref|G.9701}}. Note: This parameter is related to the G.997.2 parameter ATTNDRus. See clause 7.11.2.1 ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701]. Note: This parameter is related to the G.997.2 parameter ATTNDRus. See clause 7.11.2.1 ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamMaxBitRate |
unsignedInt |
R |
{{div|{{classes}}|This parameter reports the attainable net data rate expressed in {{units}} as defined in clause 11.4.1.1.2/{{bibref|G.9701}}. Note: This parameter is related to the G.997.2 parameter ATTNDRds. See clause 7.11.2.1 ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701]. Note: This parameter is related to the G.997.2 parameter ATTNDRds. See clause 7.11.2.1 ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UpstreamNoiseMargin |
int |
R |
{{div|{{classes}}|This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/{{bibref|G.9701}} and 11.4.1.3/{{bibref|G.9701}}) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in {{units}}. Note: In G.997.2, this parameter is called SNRMus. See ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB. Note: In G.997.2, this parameter is called SNRMus. See ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamNoiseMargin |
int |
R |
{{div|{{classes}}|This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/{{bibref|G.9701}} and 11.4.1.3/{{bibref|G.9701}}) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in {{units}}. Note: In G.997.2, this parameter is called SNRMds. See ITU-T Recommendation {{bibref|G.997.2}}.}} This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB. Note: In G.997.2, this parameter is called SNRMds. See ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.FAST.Line.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
TotalStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ShowtimeStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics. Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link. Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LastShowtimeStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
CurrentDayStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
QuarterHourStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.FAST.Line.{i}.Stats.Total. |
object |
R |
{{div|{{classes}}|This object contains DSL line total statistics. Note: The {{object}} parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains DSL line total statistics. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
Device.FAST.Line.{i}.Stats.Showtime. |
object |
R |
{{div|{{classes}}|This object contains FAST line statistics since the most recent showtime. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains FAST line statistics since the most recent showtime. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
Device.FAST.Line.{i}.Stats.LastShowtime. |
object |
R |
{{div|{{classes}}|This object contains FAST line statistics since the second most recent showtime. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains FAST line statistics since the second most recent showtime. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
Device.FAST.Line.{i}.Stats.CurrentDay. |
object |
R |
{{div|{{classes}}|This object contains FAST line statistics accumulated during the current day. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains FAST line statistics accumulated during the current day. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
Device.FAST.Line.{i}.Stats.QuarterHour. |
object |
R |
{{div|{{classes}}|This object contains FAST line statistics accumulated during the current quarter hour. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.}} This object contains FAST line statistics accumulated during the current quarter hour. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. |
- |
2.12 |
|
Device.FAST.Line.{i}.TestParams. |
object |
R |
This object contains the FAST line test parameters that are available during the L0 (i.e., Showtime) state. |
- |
2.12 |
|
SNRGds |
unsignedInt |
R |
{{div|{{classes}}|Reports the number of sub-carriers in any one sub-carrier group used to represent the downstream SNR(f) values. Valid values are 1, 2, 4, and 8. Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.2 ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the number of sub-carriers in any one sub-carrier group used to represent the downstream SNR(f) values. Valid values are 1, 2, 4, and 8. Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.2 ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRGus |
unsignedInt |
R |
{{div|{{classes}}|Reports the number of sub-carriers in any one sub-carrier group used to represent the upstream SNR(f) values. Valid values are 1, 2, 4, and 8. Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.5 ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the number of sub-carriers in any one sub-carrier group used to represent the upstream SNR(f) values. Valid values are 1, 2, 4, and 8. Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.5 ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRpsds |
int[](:2047) |
R |
{{div|{{classes}}|{{list}} Reports the downstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. {{bibref|G.9701}}. Note: See clause 7.10.8.3 of ITU-T Recommendation {{bibref|G.997.2}}.}} Comma-separated list (maximum number of characters 2047) of integers. Reports the downstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. [G.9701]. Note: See clause 7.10.8.3 of ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRpsus |
string[](:2047) |
R |
{{div|{{classes}}|{{list}} Reports the upstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. {{bibref|G.9701}}. Note: See clause 7.10.8.6 of ITU-T Recommendation {{bibref|G.997.2}}.}} Comma-separated list (maximum number of characters 2047) of strings. Reports the upstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. [G.9701]. Note: See clause 7.10.8.6 of ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRMTds |
unsignedInt |
R |
{{div|{{classes}}|Reports the number of symbols used to measure the downstream SNR(f) values. The valid values 0..65535. Note: See clause 7.10.8.1 of ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the number of symbols used to measure the downstream SNR(f) values. The valid values 0..65535. Note: See clause 7.10.8.1 of ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SNRMTus |
unsignedInt |
R |
{{div|{{classes}}|Reports the number of symbols used to measure the upstream SNR(f) values. The valid values 0..65535. Note: See clause 7.10.8.4 of ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the number of symbols used to measure the upstream SNR(f) values. The valid values 0..65535. Note: See clause 7.10.8.4 of ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ACTINP |
unsignedInt |
R |
{{div|{{classes}}|Reports the actual INP against SHINE as defined in clause 11.4.1.1.7/{{bibref|G.9701}}. A special value indicates an actual INP against SHINE of 2047 symbols or higher. The valid values are 0..2046 and 2047 is the special value. Note: See ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the actual INP against SHINE as defined in clause 11.4.1.1.7/[G.9701]. A special value indicates an actual INP against SHINE of 2047 symbols or higher. The valid values are 0..2046 and 2047 is the special value. Note: See ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
NFEC |
unsignedInt |
R |
{{div|{{classes}}|Reports the DTU FEC codeword length (expressed in 1 byte unit) as defined in clause 9.3/{{bibref|G.9701}}. The valid range is 32..255. Note: See clause 7.11.4.1 ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the DTU FEC codeword length (expressed in 1 byte unit) as defined in clause 9.3/[G.9701]. The valid range is 32..255. Note: See clause 7.11.4.1 ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
RFEC |
int |
R |
{{div|{{classes}}|Reports the DTU FEC codeword redundancy as defined in clause 9.3/{{bibref|G.9701}}. Note: See ITU-T Recommendation {{bibref|G.997.2}}.}} Reports the DTU FEC codeword redundancy as defined in clause 9.3/[G.9701]. Note: See ITU-T Recommendation [G.997.2]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UpstreamCurrRate |
unsignedInt |
R |
{{div|{{classes}}|Reports the current physical layer aggregate data rate (expressed in {{units}}) of the upstream FAST as defined in clause 11.4.1.1.1/{{bibref|G.9701}}. The current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).}} Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701]. The current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamCurrRate |
unsignedInt |
R |
{{div|{{classes}}|Reports the current physical layer aggregate data rate (expressed in {{units}}) of the upstream FAST as defined in clause 11.4.1.1.1/{{bibref|G.9701}}. The current physical layer aggregate data rate (expressed in Kbps) of the downstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).}} Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701]. The current physical layer aggregate data rate (expressed in Kbps) of the downstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.Optical. |
object |
R |
This object models a generic optical interface technologies.interface. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. TheFor historical reasons, the data model definition is based on parts of [G.988]. However, it is not intended to model anything specific to IEEE PON or ITU-T PON technologies. Note that this object is not intended to model the optical transceiver either. |
- |
2.12 |
|
Device.Optical.Interface.{i}. |
object(0:) |
R |
Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the optical interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the optical interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the optical interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
OpticalSignalLevel |
int |
R |
Current measurement of total downstream optical signal level. [Dbm1000] 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. Valid values are -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments. This parameter is based on Optical signal level from [Section 9.2.1/G.988]. |
- |
2.12 |
|
LowerOpticalThreshold |
int |
R |
Optical level that is used to declare the downstream low received optical power alarm. [Dbm1000] ::::::: hide 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. ::::::: Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy. This parameter is based on Lower optical threshold from [Section 9.2.1/G.988]. This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm. Changes since 2.14:
|
- |
2.12 |
|
UpperOpticalThreshold |
int |
R |
Optical level that is used to declare the downstream high received optical power alarm. [Dbm1000] ::::::: hide 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. ::::::: Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy. This parameter is based on Upper optical threshold from [Section 9.2.1/G.988]. This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm. Changes since 2.14:
|
- |
2.12 |
|
TransmitOpticalLevel |
int |
R |
Current measurement of mean optical launch power. [Dbm1000] 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. Valid values are -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments. This parameter is based on Transmit optical level from [Section 9.2.1/G.988]. |
- |
2.12 |
|
LowerTransmitPowerThreshold |
int |
R |
Minimum mean optical launch power that is used to declare the low transmit optical power alarm. [Dbm1000] ::::::: hide 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. ::::::: Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy. This parameter is based on Lower transmit power threshold from [Section 9.2.1/G.988]. This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm. Changes since 2.14:
|
- |
2.12 |
|
UpperTransmitPowerThreshold |
int |
R |
Maximum mean optical launch power that is used to declare the high transmit optical power alarm. [Dbm1000] ::::::: hide 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. ::::::: Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy. This parameter is based on Upper transmit power threshold from [Section 9.2.1/G.988]. This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm. Changes since 2.14:
|
- |
2.12 |
|
Device.Optical.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.Cellular. |
object |
R |
This object models cellular interfaces and access points. |
- |
2.12 |
|
Device.Cellular.Interface.{i}. |
object(0:) |
R |
Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and a single USIM. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
RSSI |
int |
R |
The received signal strength in dBm. The allowed values depend on CurrentAccessTechnology:
Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
RSRP |
int |
R |
{{div|{{classes}}|The Reference Signal Received Power in {{units}} for {{enum|LTE|SupportedAccessTechnologies}}, {{enum|NR|SupportedAccessTechnologies}} values of {{param|CurrentAccessTechnology}}: {{li|*}}The valid range of RSRP values from worst to best is -140 {{units}} to -44 {{units}}}} The Reference Signal Received Power in dBm for LTE, NR values of CurrentAccessTechnology:
Value Change Notification requests for this parameter MAY be denied. |
- |
2.14 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality in dBm for LTE, NR values of CurrentAccessTechnology:
Value Change Notification requests for this parameter MAY be denied. |
- |
2.14 |
|
Device.Cellular.Interface.{i}.USIM. |
object |
R |
USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. |
- |
2.12 |
|
ICCID |
string(6:20) |
R |
Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:
Possible patterns:
|
- |
2.12 |
|
Device.Cellular.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.ATM. |
object |
R |
Asynchronous Transfer Mode (ATM) object that contains the Link interface and {{object: referenced Diagnostics.F5Loopback() is command, not object}} diagnostics. |
- |
2.12 |
|
Device.ATM.Link.{i}. |
object(0:) |
W |
{{div|{{classes}}|ATM link-layer table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a {{object|.DSL.Channel.}} or a {{object|.DSL.BondingGroup.}} object. When an ATM Link interface is used, a lower-layer {{object|.DSL.Channel}} interface MUST be configured with ATM encapsulation (see {{param|.DSL.Channel.{i}.LinkEncapsulationUsed}}).}} ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object. When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the link. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the link. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the link (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
VCSearchList |
string[](:256) |
W |
Comma-separated list (maximum number of characters 256) of strings. Ordered list of VPI/VCI pairs to search if a link using the DestinationAddress cannot be established. In the form "VPI1/VCI1, VPI2/VCI2, ...". Each list item matches one of:
|
- |
2.12 |
|
Device.ATM.Link.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
CRCErrors |
unsignedInt |
R |
{{div|{{classes}}|Count of the ATM layer cyclic redundancy check (CRC) errors. This refers to CRC errors at the ATM adaptation layer (AAL). The AAL in use is indicated by the {{param|#.AAL}} parameter. The value of the {{param}} parameter MUST be 0 for AAL types that have no CRCs.}} Count of the ATM layer cyclic redundancy check (CRC) errors. This refers to CRC errors at the ATM adaptation layer (AAL). The AAL in use is indicated by the AAL parameter. The value of the CRCErrors parameter MUST be 0 for AAL types that have no CRCs. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.ATM.Diagnostics. |
object |
R |
The ATM Diagnostics object. |
- |
2.12 |
|
F5Loopback() |
command |
- |
[ASYNC] This command provides access to an ATM-layer F5 OAM loopback test. |
- |
2.12 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
[MANDATORY] The value MUST be the Path Name of a row in the ATM.Link. table. This is the interface over which the test is to be performed. Changes since 2.14:
|
- |
2.12 |
|
⇒ NumberOfRepetitions |
unsignedInt(1:) |
W |
[MANDATORY] Number of repetitions of the ping test to perform before reporting the results. Changes since 2.14:
|
- |
2.12 |
|
⇒ Timeout |
unsignedInt(1:) |
W |
[MANDATORY] Timeout in milliseconds for the ping test. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
Device.DOCSIS. |
object |
R |
DOCSIS object. This object models the DOCSIS 3.x cable interface objects. |
- |
2.15 |
|
CapabilitiesReq |
hexBinary(0,2:255) |
R |
[docsIf3CmCapabilitiesReq/1.3.6.1.4.1.4491.2.1.20.1.21.1] [TLV8] This attribute contains the TLV encoding for TLV-5 sent in a REG-REQ. The first byte of this encoding is expected to be 0x05. See [CM-SP-MULPIv3.0], Modem Capabilities Encoding in the Common Radio Frequency Interface Encodings Annex. |
- |
2.15 |
|
CapabilitiesRsp |
hexBinary(0,2:255) |
R |
[docsIf3CmCapabilitiesRsp/1.3.6.1.4.1.4491.2.1.20.1.21.2] [TLV8] This attribute contains the TLV encoding for TLV-5 received in a REG-RSP. The first byte of this encoding is expected to be 0x05. See [CM-SP-MULPIv3.0], Modem Capabilities Encoding in the Common Radio Frequency Interface Encodings Annex. |
- |
2.15 |
|
DownstreamNumberOfEntries |
unsignedInt |
R |
The number of entries in the Downstream table. |
- |
2.15 |
|
UpstreamNumberOfEntries |
unsignedInt |
R |
The number of entries in the Upstream table. |
- |
2.15 |
|
DownstreamChannelNumberOfEntries |
unsignedInt |
R |
The number of entries in the DownstreamChannel table. |
- |
2.15 |
|
UpstreamChannelNumberOfEntries |
unsignedInt |
R |
The number of entries in the UpstreamChannel table. |
- |
2.15 |
|
InterfaceNumberOfEntries |
unsignedInt |
R |
The number of entries in the Interface table. |
- |
2.15 |
|
Device.DOCSIS.Downstream.{i}. |
object(0:) |
R |
DOCSIS Downstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Downstream interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
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 |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. This is a non-functional key and its value MUST NOT change once it's been set internally by the Agent. |
- |
2.12 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the interface entered its current operational state. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Downstream is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MaxBitRate |
int(-1:) |
W |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). A value of -1 indicates automatic selection of the maximum bit rate. |
- |
2.12 |
|
CurrentBitRate |
unsignedInt |
R |
The current upstream and downstream PHY bit rate on this interface (expressed in Mbps). A value of 0 indicates that the current bit rate is unknown. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DownstreamChannelList |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the DOCSIS.DownstreamChannel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Downstream Channels associated with this Downstream interface. |
- |
2.12 |
|
Device.DOCSIS.Downstream.{i}.Stats. |
object |
R |
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 |
R |
[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received on the interface, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsSent |
unsignedInt |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsReceived |
unsignedInt |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DOCSIS.Upstream.{i}. |
object(0:) |
R |
DOCSIS Upstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Upstream interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
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 |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. This is a non-functional key and its value MUST NOT change once it's been set internally by the Agent. |
- |
2.12 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the interface entered its current operational state. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Upstream is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MaxBitRate |
int(-1:) |
W |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). A value of -1 indicates automatic selection of the maximum bit rate. |
- |
2.12 |
|
CurrentBitRate |
unsignedInt |
R |
The current upstream and downstream PHY bit rate on this interface (expressed in Mbps). A value of 0 indicates that the current bit rate is unknown. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UpstreamChannelList |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the DOCSIS.UpstreamChannel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Upstream Channels associated with this Upstream interface. |
- |
2.12 |
|
Device.DOCSIS.Upstream.{i}.Stats. |
object |
R |
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 |
R |
[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received on the interface, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsSent |
unsignedInt |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsReceived |
unsignedInt |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DOCSIS.DownstreamChannel.{i}. |
object(0:) |
R |
[docsIfDownstreamChannelTable/1.3.6.1.2.1.10.127.1.1.1.1] This table describes the attributes of downstream channels (frequency bands). See [Tables 6-16, and 6-17/CM-SP-RFIv2.0]. At most one entry in this table can exist with a given value for Alias. |
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ID |
unsignedInt(0:255) |
R |
[docsIfDownChannelId/1.3.6.1.2.1.10.127.1.1.1.1.1] The Cable Modem Termination System identification of the downstream channel within this particular MAC interface. if the interface is down, the object returns the most current value. If the downstream channel ID is unknown, this object returns a value of 0. |
- |
2.12 |
|
Frequency |
int(0:1000000000) |
R |
[docsIfDownChannelFrequency/1.3.6.1.2.1.10.127.1.1.1.1.2] The center of the downstream frequency associated with this channel. This object will return the current tuner frequency. See [Section 6.3.3/CM-SP-RFIv2.0]. |
- |
2.12 |
|
Width |
int(0:16000000) |
R |
[docsIfDownChannelWidth/1.3.6.1.2.1.10.127.1.1.1.1.3] The bandwidth of this downstream channel. Most implementations are expected to support a channel width of 6 MHz (North America) and/or 8 MHz (Europe). See [Table 6-17/CM-SP-RFIv2.0]. |
- |
2.12 |
|
Modulation |
string |
R |
[docsIfDownChannelModulation/1.3.6.1.2.1.10.127.1.1.1.1.4] The modulation type associated with this downstream channel. If the interface is down, this object either returns the configured value (from the CMTS), the most current value (from the CM), or the value of Unknown. See the reference for specifics on the modulation profiles implied by QAM64 and QAM256. Enumeration of:
|
- |
2.12 |
|
Interleave |
string |
R |
[docsIfDownChannelInterleave/1.3.6.1.2.1.10.127.1.1.1.1.5] The Forward Error Correction (FEC) interleaving used for this downstream channel. The value Taps12increment17 is supported by EuroDOCSIS cable systems only, and the others by DOCSIS cable systems. If the interface is down, this object either returns the configured value (from the CMTS), the most current value (from the CM), or the value of Unknown. The value of Other is returned if the interleave is known but not defined in the above list. See the reference for the FEC configuration described by the setting of this object. Enumeration of:
See [Table 6-15/CM-SP-RFIv2.0]. |
- |
2.12 |
|
Power |
int |
R |
[docsIfDownChannelPower/1.3.6.1.2.1.10.127.1.1.1.1.6] [TenthdBmV] The received power level. If the interface is down, this object either returns the configured value (from the CMTS), the most current value (from the CM) or the value of 0. See the reference for recommended and required power levels. |
- |
2.12 |
|
Annex |
string |
R |
[docsIfDownChannelAnnex/1.3.6.1.2.1.10.127.1.1.1.1.7] The value of this object indicates the conformance of the implementation to important regional cable standards. Enumeration of:
|
- |
2.12 |
|
Device.DOCSIS.DownstreamChannel.{i}.SignalQuality. |
object |
R |
[docsIfSignalQualityTable/1.3.6.1.2.1.10.127.1.1.4.1] Describes the PHY signal quality of downstream channels. |
- |
2.12 |
|
SignalNoise |
int |
R |
[docsIfSigQSignalNoise/1.3.6.1.2.1.10.127.1.1.4.1.5] [TenthdB] Signal/Noise ratio as perceived for this channel. Describes the Signal/Noise of the downstream channel. |
- |
2.12 |
|
Microreflections |
int(0:255) |
R |
[docsIfSigQMicroreflections/1.3.6.1.2.1.10.127.1.1.4.1.6] Microreflections, including in-channel response as perceived on this interface, measured in dBc below the signal level. This object is not assumed to return an absolutely accurate value, but it gives a rough indication of microreflections received on this interface. It is up to the implementer to provide information as accurately as possible. |
- |
2.12 |
|
EqualizationData |
hexBinary(0,36:260) |
R |
[docsIfSigQEqualizationData/1.3.6.1.2.1.10.127.1.1.4.1.7] [DocsEqualizerData] Returns the equalization data for the downstream channel.
See [Figure 6-23/CM-SP-RFIv2.0]. |
- |
2.12 |
|
ExtUnerroreds |
unsignedLong |
R |
[docsIfSigQExtUnerroreds/1.3.6.1.2.1.10.127.1.1.4.1.8] [StatsCounter64] Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system. |
- |
2.12 |
|
ExtCorrecteds |
unsignedLong |
R |
[docsIfSigQExtCorrecteds/1.3.6.1.2.1.10.127.1.1.4.1.9] [StatsCounter64] Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system. |
- |
2.12 |
|
ExtUncorrectables |
unsignedLong |
R |
[docsIfSigQExtUncorrectables/1.3.6.1.2.1.10.127.1.1.4.1.10] [StatsCounter64] Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system. |
- |
2.12 |
|
Device.DOCSIS.DownstreamChannel.{i}.SignalQualityExt. |
object |
R |
[docsIf3SignalQualityExtTable/1.3.6.1.4.1.4491.2.1.20.1.24.1] Describes the received modulation error ratio of each downstream channel. |
- |
2.12 |
|
RxMER |
int |
R |
[docsIf3SignalQualityExtRxMER/1.3.6.1.4.1.4491.2.1.20.1.24.1.1] [TenthdB] RxMER provides an in-channel received Modulation Error Ratio (MER). RxMER is defined as an estimate, provided by the demodulator, of the ratio: (average constellation energy with equally likely symbols) / (average squared magnitude of error vector) RxMER is measured just prior to FEC (trellis/Reed-Solomon) decoding. RxMER includes the effects of the HFC channel as well as implementation effects of the modulator and demodulator. Error vector estimation may vary among demodulator implementations. In the case of S-CDMA mode, RxMER is measured on the de-spread signal. |
- |
2.12 |
|
RxMerSamples |
unsignedInt |
R |
[docsIf3SignalQualityExtRxMerSamples/1.3.6.1.4.1.4491.2.1.20.1.24.1.2] RxMerSamples is a statistically significant number of symbols processed to arrive at the RxMER value. |
- |
2.12 |
|
FbeNormalizationCoefficient |
int |
R |
[docsIf3SignalQualityExtFbeNormalizationCoefficient/1.3.6.1.4.1.4491.2.1.20.1.24.1.3] The Downstream Adaptive Decision Feedback Equalizer (DFE) is implemented as a Feedforward Equalizer (FFE) and a Feedback Equalizer (FBE). In order to evaluate the composite DFE response it is necessary to normalize the FBE coefficients to 1 and then evaluate the FFT(hffe)/FFT(1,hfbe), where the hfbe coefficients have been normalized to 1 using FbeNormalizationCoefficient. The complex data representing the hffe and hfbe coefficients is contained in the EqualizationData MIB. It is possible to implement the DFE such that the response is evaluated as FFT(hffe)/FFT(1,-hfbe). In this case the FbeNormalizationCoefficient will be reported as a negative number and the response will be evaluated as FFT(hffe)/FFT(1,hfbe). |
- |
2.12 |
|
Device.DOCSIS.UpstreamChannel.{i}. |
object(0:) |
W |
[docsIfUpstreamChannelTable/1.3.6.1.2.1.10.127.1.1.2.1] This table describes the attributes of attached upstream channels. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ID |
int(0:255) |
R |
[docsIfUpChannelId/1.3.6.1.2.1.10.127.1.1.2.1.1] The CMTS identification of the upstream channel. |
- |
2.12 |
|
Frequency |
int(0:1000000000) |
R |
[docsIfUpChannelFrequency/1.3.6.1.2.1.10.127.1.1.2.1.2] The center of the frequency band associated with this upstream interface. This object returns 0 if the frequency is undefined or unknown. Minimum permitted upstream frequency is 5,000,000 Hz for current technology. See [Table 4-2/CM-SP-RFIv2.0]. |
- |
2.12 |
|
Width |
int(0:64000000) |
R |
[docsIfUpChannelWidth/1.3.6.1.2.1.10.127.1.1.2.1.3] The bandwidth of this upstream interface. This object returns 0 if the interface width is undefined or unknown. Minimum permitted interface width is currently 200,000 Hz. See [Table 6-5/CM-SP-RFIv2.0]. |
- |
2.12 |
|
SlotSize |
unsignedInt |
R |
[docsIfUpChannelSlotSize/1.3.6.1.2.1.10.127.1.1.2.1.5] Applicable to TDMA and ATDMA channel types only. The number of 6.25 microsecond ticks in each upstream mini-slot. Returns zero if the value is undefined or unknown or in case of an SCDMA channel. |
- |
2.12 |
|
TxTimingOffset |
unsignedInt |
R |
[docsIfUpChannelTxTimingOffset/1.3.6.1.2.1.10.127.1.1.2.1.6] A measure of the current round trip time obtained from the ranging offset (initial ranging offset + ranging offset adjustments). Used for timing of CM upstream transmissions to ensure synchronized arrivals at the CMTS. Units are one 64th fraction of 6.25 microseconds. See [Section 6.2.19/CM-SP-RFIv2.0]. |
- |
2.12 |
|
RangingBackoffStart |
int(0:16) |
R |
[docsIfUpChannelRangingBackoffStart/1.3.6.1.2.1.10.127.1.1.2.1.7] The initial random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. |
- |
2.12 |
|
RangingBackoffEnd |
int(0:16) |
R |
[docsIfUpChannelRangingBackoffEnd/1.3.6.1.2.1.10.127.1.1.2.1.8] The final random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. |
- |
2.12 |
|
TxBackoffStart |
int(0:16) |
R |
[docsIfUpChannelTxBackoffStart/1.3.6.1.2.1.10.127.1.1.2.1.9] The initial random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. |
- |
2.12 |
|
TxBackoffEnd |
int(0:16) |
R |
[docsIfUpChannelTxBackoffEnd/1.3.6.1.2.1.10.127.1.1.2.1.10] The final random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. |
- |
2.12 |
|
Device.DOCSIS.UpstreamChannel.{i}.Status. |
object |
R |
[docsIf3CmStatusUsTable/1.3.6.1.4.1.4491.2.1.20.1.2.1] This object provides Upstream channel information previously available in the SNMP table docsIfCmStatusTable. |
- |
2.12 |
|
TxPower |
int |
R |
[docsIf3CmStatusUsTxPower/1.3.6.1.4.1.4491.2.1.20.1.2.1.1] [TenthdBmV] This attribute represents the operational CM transmit power for this SC-QAM upstream channel. In order for this attribute to provide consistent information under all circumstances, a 3.1 CM will report the average total power for the SC-QAM channel the same as was done for DOCSIS 3.0, regardless of whether it is operating with a 3.1 or a 3.0 CMTS. The value that is reported was referred to as Pr in the DOCSIS 3.0 PHY Spec. |
- |
2.12 |
|
T3Timeouts |
unsignedInt |
R |
[docsIf3CmStatusUsT3Timeouts/1.3.6.1.4.1.4491.2.1.20.1.2.1.2] [StatsCounter32] This attribute denotes the number of times counter T3 expired in the CM for this upstream channel. Discontinuities in the value of this counter can occur at re-initialization of the managed system. See [RFC2863]. |
- |
2.12 |
|
T4Timeouts |
unsignedInt |
R |
[docsIf3CmStatusUsT4Timeouts/1.3.6.1.4.1.4491.2.1.20.1.2.1.3] [StatsCounter32] This attribute denotes the number of times counter T4 expired in the CM for this upstream channel. Discontinuities in the value of this counter can occur at re-initialization of the managed system. See [RFC2863]. |
- |
2.12 |
|
RangingAborteds |
unsignedInt |
R |
[docsIf3CmStatusUsRangingAborteds/1.3.6.1.4.1.4491.2.1.20.1.2.1.4] [StatsCounter32] This attribute denotes the number of times the ranging process was aborted by the CMTS. Discontinuities in the value of this counter can occur at re-initialization of the managed system. See [RFC2863]. |
- |
2.12 |
|
ModulationType |
string |
R |
[docsIf3CmStatusUsModulationType/1.3.6.1.4.1.4491.2.1.20.1.2.1.5] [DocsisUpstreamType] This attribute indicates modulation type status currently used by the CM for this upstream channel. Since this object specifically identifies PHY Layer mode, the shared upstream channel type "tdmaAndAtdma" is not permitted. See [RFC2863]. |
- |
2.12 |
|
EqData |
hexBinary(0,36:260) |
R |
[docsIf3CmStatusUsEqData/1.3.6.1.4.1.4491.2.1.20.1.2.1.6] [DocsEqualizerData] This attribute indicates the pre-equalization data for the specified upstream Channel on this CM after convolution with data indicated in the RNG-RSP. This data is valid when docsIfUpChannelPreEqEnable RFC 4546 is set to true. |
- |
2.12 |
|
T3Exceededs |
unsignedInt |
R |
[docsIf3CmStatusUsT3Exceededs/1.3.6.1.4.1.4491.2.1.20.1.2.1.7] [StatsCounter32] This attribute denotes the number of times for excessive T3 timeouts. Discontinuities in the value of this counter can occur at re-initialization of the managed system. See [RFC2863]. |
- |
2.12 |
|
IsMuted |
boolean |
R |
[docsIf3CmStatusUsIsMuted/1.3.6.1.4.1.4491.2.1.20.1.2.1.8] This attribute denotes whether the upstream channel is muted. See [CM-SP-MULPIv3.0], Media Access Control specification. |
- |
2.12 |
|
RangingStatus |
string |
R |
[docsIf3CmStatusUsRangingStatus/1.3.6.1.4.1.4491.2.1.20.1.2.1.9] [RangingState] This attribute denotes the ranging state of the CM. See [CM-SP-MULPIv3.0], Media Access Control specification. |
- |
2.12 |
|
Device.DOCSIS.Interface.{i}. |
object(0:) |
R |
DOCSIS Layer 2 (MAC) interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the MAC level DOCSIS interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
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 |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. This is a non-functional key and its value MUST NOT change once it's been set internally by the Agent. |
- |
2.12 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the interface entered its current operational state. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. |
- |
2.12 |
|
MACAddress |
string |
R |
The MAC Address of the interface. |
- |
2.12 |
|
CMTSAddress |
string(:17) |
R |
[docsIfCmCmtsAddress/1.3.6.1.2.1.10.127.1.2.1.1.1] [MACAddress] Identifies the CMTS that is believed to control this MAC domain. This will be the source address from SYNC, MAP, and other MAC-layer messages. If the CMTS is unknown, returns 00-00-00-00-00-00. See [Section 8.2.2/CM-SP-RFIv2.0]. |
- |
2.12 |
|
Capabilities |
string[] |
R |
[docsIfCmCapabilities/1.3.6.1.2.1.10.127.1.2.1.1.2] Comma-separated list of strings. Identifies the capabilities of the MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability. Each list item is an enumeration of:
|
- |
2.12 |
|
FirmwareVersion |
string(:64) |
R |
A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. |
- |
2.12 |
|
DOCSISVersion |
string |
R |
[docsIfDocsisBaseCapability/1.3.6.1.2.1.10.127.1.1.5] Indication of the DOCSIS capability of the device. See [Annex G/CM-SP-RFIv2.0]. Enumeration of:
|
- |
2.12 |
|
MdCfgIpProvMode |
string |
R |
[docsIf3CmMdCfgIpProvMode/1.3.6.1.4.1.4491.2.1.20.1.31.1.1] MdCfgIpProvMode specifies how the IP provisioning mode is configured. The CM relies upon the CMTS to facilitate the successful IP address acquisition independently of the MDD. Enumeration of:
See [CM-SP-MULPIv3.0], IP Initialization Parameters TLV Section. |
- |
2.12 |
|
Device.DOCSIS.Interface.{i}.Stats. |
object |
R |
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 |
R |
[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received on the interface, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnknownProtoPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.DOCSIS.Interface.{i}.ConnectivityStatus. |
object |
R |
[docsIf3CmStatusTable/1.3.6.1.4.1.4491.2.1.20.1.1.1] This object defines attributes of the CM connectivity status. This object provides CM connectivity status information of the CM previously available in the SNMP table docsIfCmStatusTable. See [RFC4546]. |
- |
2.12 |
|
Value |
string |
R |
[docsIf3CmStatusValue/1.3.6.1.4.1.4491.2.1.20.1.1.1.1] [CmRegState] This attribute denotes the current CM connectivity state. For the case of IP acquisition related states, this attribute reflects states for the current CM provisioning mode, not the Other DHCP process associated with dual stack operation. See [CM-SP-MULPIv3.0], Establishing IP Connectivity. |
- |
2.12 |
|
StatusCode |
string(0,5:7) |
R |
[docsIf3CmStatusCode/1.3.6.1.4.1.4491.2.1.20.1.1.1.2] This attribute denotes the status code for CM as defined in the OSSI Specification. The status code consists of a single character indicating error groups, followed by a two-or three-digit number indicating the status condition, followed by a decimal. An example of a returned value could be "T101.0". The zero-length hex string indicates no status code yet registered. See [CM-SP-OSSIv3.0], Format and Content for Event, Syslog, and SNMP Notification Annex. |
- |
2.12 |
|
Resets |
unsignedInt |
R |
[docsIf3CmStatusResets/1.3.6.1.4.1.4491.2.1.20.1.1.1.3] [StatsCounter32] This attribute denotes the number of times the CM reset or initialized this interface. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
LostSyncs |
unsignedInt |
R |
[docsIf3CmStatusLostSyncs/1.3.6.1.4.1.4491.2.1.20.1.1.1.4] [StatsCounter32] This attribute denotes the number of times the CM lost synchronization with the downstream channel. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
InvalidMaps |
unsignedInt |
R |
[docsIf3CmStatusInvalidMaps/1.3.6.1.4.1.4491.2.1.20.1.1.1.5] [StatsCounter32] This attribute denotes the number of times the CM received invalid MAP messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
InvalidUcds |
unsignedInt |
R |
[docsIf3CmStatusInvalidUcds/1.3.6.1.4.1.4491.2.1.20.1.1.1.6] [StatsCounter32] This attribute denotes the number of times the CM received invalid UCD messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
InvalidRangingRsps |
unsignedInt |
R |
[docsIf3CmStatusInvalidRangingRsps/1.3.6.1.4.1.4491.2.1.20.1.1.1.7] [StatsCounter32] This attribute denotes the number of times the CM received invalid ranging response messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
InvalidRegRsps |
unsignedInt |
R |
[docsIf3CmStatusInvalidRegRsps/1.3.6.1.4.1.4491.2.1.20.1.1.1.8] [StatsCounter32] This attribute denotes the number of times the CM received invalid registration response messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
T1Timeouts |
unsignedInt |
R |
[docsIf3CmStatusT1Timeouts/1.3.6.1.4.1.4491.2.1.20.1.1.1.9] [StatsCounter32] This attribute denotes the number of times counter T1 expired in the CM. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
T2Timeouts |
unsignedInt |
R |
[docsIf3CmStatusT2Timeouts/1.3.6.1.4.1.4491.2.1.20.1.1.1.10] [StatsCounter32] This attribute denotes the number of times counter T2 expired in the CM. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface. See [RFC2863]. |
- |
2.12 |
|
Device.DOCSIS.SpectrumAnalysis. |
object |
R |
- |
2.12 |
|
|
Enable |
boolean |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdEnable/1.3.6.1.4.1.4491.2.1.20.1.34.1] This attribute is used to enable or disable the spectrum analyzer feature. Setting this attribute to true triggers the CM to initiate measurements for the spectrum analyzer feature based on the other configuration attributes for the feature. By default, the feature is disabled unless explicitly enabled. Note that the feature may be disabled by the system under certain circumstances if the spectrum analyzer would affect critical services. In such a case, the attribute will return false when read, and will reject sets to true with an error. Once the feature is enabled, any change to this object's configuration might not be effective until the feature is re-enabled again. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be false. |
- |
2.12 |
|
InactivityTimeout |
int(0:86400) |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdInactivityTimeout/1.3.6.1.4.1.4491.2.1.20.1.34.2] This attribute controls the length of time after the last spectrum analysis measurement before the feature is automatically disabled. If set to a value of 0, the feature will remain enabled until it is explicitly disabled. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 300. |
- |
2.12 |
|
FirstSegmentCenterFrequency |
unsignedInt |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdFirstSegmentCenterFrequency/1.3.6.1.4.1.4491.2.1.20.1.34.3] This attribute controls the center frequency of the first segment for the spectrum analysis measurement. The frequency bins for this segment lie symmetrically to the left and right of this center frequency. If the number of bins in a segment is odd, the segment center frequency lies directly on the center bin. If the number of bins in a segment is even, the segment center frequency lies halfway between two bins. Changing the value of this attribute may result in changes to the Result table. Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 93000000. |
- |
2.12 |
|
LastSegmentCenterFrequency |
unsignedInt |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdLastSegmentCenterFrequency/1.3.6.1.4.1.4491.2.1.20.1.34.4] This attribute controls the center frequency of the last segment of the spectrum analysis measurement. The frequency bins for this segment lie symmetrically to the left and right of this center frequency. If the number of bins in a segment is odd, the segment center frequency lies directly on the center bin. If the number of bins in a segment is even, the segment center frequency lies halfway between two bins. The value of the LastSegmentCenterFrequency should be equal to the FirstSegmentCenterFrequency plus and integer number of segment spans as determined by the SegmentFrequencySpan. Changing the value of this attribute may result in changes to the Result table. Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 993000000. |
- |
2.12 |
|
SegmentFrequencySpan |
unsignedInt(1000000:900000000) |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdSegmentFrequencySpan/1.3.6.1.4.1.4491.2.1.20.1.34.5] This attribute controls the frequency span of each segment (instance) of the Result.{i} table. If set to a value of 0, then a default span will be chosen based on the hardware capabilities of the device. Segments are contiguous from the FirstSegmentCenterFrequency to the LastSegmentCenterFrequency and the center frequency for each successive segment is incremented by the SegmentFrequencySpan. The number of segments is (LastSegmentCenterFrequency - FirstSegmentCenterFrequency)/SegmentFrequencySpan + 1. A segment is equivalent to an instance in the Result table. The chosen SegmentFrequencySpan affects the number of entries in Result table. A more granular SegmentFrequencySpan may adversely affect the amount of time needed to query the table entries in addition to possibly increasing the acquisition time. Changing the value of this attribute may result in changes to Result table. Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 7500000. |
- |
2.12 |
|
NumBinsPerSegment |
unsignedInt(2:2048) |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdNumBinsPerSegment/1.3.6.1.4.1.4491.2.1.20.1.34.6] This parameter controls the number of bins collected by the measurement performed for each segment (instance) in the Result table. Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 256. |
- |
2.12 |
|
EquivalentNoiseBandwidth |
unsignedInt(50:500) |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdEquivalentNoiseBandwidth/1.3.6.1.4.1.4491.2.1.20.1.34.7] This parameter allows the user to request an equivalent noise bandwidth for the resolution bandwidth filter used in the spectrum analysis. This corresponds to the spectral width of the window function used when performing a discrete Fourier transform for the analysis. The window function which corresponds to a value written to this parameter may be obtained by reading the value of WindowFunction. If an unsupported value is requested, the device may return an error, or choose the closest valid value to the one which is requested. If the closest value is chosen, then a subsequent read of this parameter will return the actual value which is in use. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 150. |
- |
2.12 |
|
WindowFunction |
string |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdWindowFunction/1.3.6.1.4.1.4491.2.1.20.1.34.8] [SpectrumAnalysisWindowFunction] This parameter controls or indicates the windowing function which will be used when performing the discrete Fourier transform for the analysis. The WindowFunction and the Equivalent Noise Bandwidth are related. If a particular WindowFunction is selected, then the EquivalentNoiseBandwidth for the function which is in use, will be reported by the EquivalentNoiseBandwidth parameter. Alternatively if an EquivalentNoiseBandwidth value is chosen then if a WindowFunction function representing that EquivalentNoiseBandwidth is defined in the CM, that value will be reported in WindowFunction, or a value of Other will be reported. Use of "modern" windowing functions not yet defined will likely be reported as Other. Enumeration of:
Note that all window functions may not be supported by all devices. If an attempt is made to set the object to an unsupported window function, or if writing of the WindowFunction is not supported, an error will be returned. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. |
- |
2.12 |
|
NumberOfAverages |
unsignedInt(1:1000) |
W |
[docsIf3CmSpectrumAnalysisCtrlCmdNumberOfAverages/1.3.6.1.4.1.4491.2.1.20.1.34.9] This parameter controls the number of averages that will be performed on spectral bins. The average will be computed using the 'leaky integrator' method, where: reported bin value = alpha*accumulated bin values + (1-alpha)*current bin value. Alpha is one minus the reciprocal of the number of averages. For example, if N=25, then alpha = 0.96. A value of 1 indicates no averaging. Re-writing the number of averages will restart the averaging process. If there are no accumulated values, the accumulators are made equal to the first measured bin amplitudes. If an attempt is made to set the parameter to an unsupported number of averages, an error will be returned. See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model. The factory default value MUST be 1. |
- |
2.12 |
|
ResultNumberOfEntries |
unsignedInt |
R |
The number of entries in the Result table. |
- |
2.12 |
|
Device.DOCSIS.SpectrumAnalysis.Result.{i}. |
object(0:) |
R |
[docsIf3CmSpectrumAnalysisMeasTable/1.3.6.1.4.1.4491.2.1.20.1.35.1] This table provides a list of spectral analysis measurements as performed across a range of center frequencies. The table is capable of representing a full scan of the spectrum. Each Result instance represents the spectral analysis around a single center frequency point in the spectrum. At most one entry in this table can exist with a given value for Frequency. |
- |
2.12 |
|
Frequency |
int(-2147483648:2147483647) |
R |
[docsIf3CmSpectrumAnalysisMeasFrequency/1.3.6.1.4.1.4491.2.1.20.1.35.1.1] The center frequency of the spectral analysis span which is represented by this instance. |
- |
2.12 |
|
AmplitudeData |
hexBinary(0,2:4116) |
R |
[docsIf3CmSpectrumAnalysisMeasAmplitudeData/1.3.6.1.4.1.4491.2.1.20.1.35.1.2] [AmplitudeData] This parameter provides a list of the spectral amplitudes as measured at the center frequency specified by the Frequency. The frequency bins are ordered from lowest to highest frequencies covering the frequency span. Information about the center frequency, frequency span, number of bins and resolution bandwidth are included to provide context to the measurement point. |
- |
2.12 |
|
TotalSegmentPower |
int |
R |
[docsIf3CmSpectrumAnalysisMeasTotalSegmentPower/1.3.6.1.4.1.4491.2.1.20.1.35.1.3] [TenthdB] This parameter provides the total RF power present in the segment with the center frequency equal to the Frequency and the span equal to the SegmentFrequencySpan. The value represents the sum of the spectrum power in all of the associated bins. The value is computed by summing power (not dB) values and converting the final sum to TenthdB. |
- |
2.12 |
|
Device.PTM. |
object |
R |
Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. |
- |
2.12 |
|
Device.PTM.Link.{i}. |
object(0:) |
W |
{{div|{{classes}}|PTM link-layer table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a {{object|.FAST.Line.}}, {{object|.DSL.Channel.}}, or a {{object|.DSL.BondingGroup.}} object. When a PTM Link interface is used, a lower-layer {{object|.DSL.Channel}} interface MUST be configured with PTM encapsulation (see {{param|.DSL.Channel.{i}.LinkEncapsulationUsed}}).}} PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a FAST.Line., DSL.Channel., or a DSL.BondingGroup. object. When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the link. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the link. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the link (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
Device.PTM.Link.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.Ethernet. |
object |
R |
Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the Channel Access Method (CAM) part of 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.12 |
|
Device.Ethernet.Interface.{i}. |
object(0:) |
R |
Ethernet interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical Ethernet ports, but in terms of the interface stack it alsoonly models the PHY and MACConnection levelAccess Method of the Ethernet interface.interface MAC. A {{object: argument unnecessary when referring to current object}} is also required to model a full Ethernet device. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MACunique Addressmanufacturer-assigned Ethernet hardware address of the interface.interface, also referred to as burned-in MAC address.Note: This is not necessarily the same as the Ethernet header source or destination MAC address,address used for higher-level protocols, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. Its main purpose is the identification of a specific Ethernet interface; the information can also can be used to perform Wake on LAN. |
- |
2.12 |
|
MaxBitRate |
int(-1:) |
W |
{{div|{{classes}}|The maximum upstream and downstream PHY bit rate supported by this interface (expressed in {{units}}). A value of -1 indicates automatic selection of the maximum bit rate.}} The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). A value of -1 indicates automatic selection of the maximum bit rate. |
- |
2.12 |
|
CurrentBitRate |
unsignedInt |
R |
{{div|{{classes}}|The current upstream and downstream PHY bit rate on this interface (expressed in {{units}}). A value of 0 indicates that the current bit rate is unknown.}} The current upstream and downstream PHY bit rate on this interface (expressed in Mbps). A value of 0 indicates that the current bit rate is unknown. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.Ethernet.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
PacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames transmitted out of the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsReceived |
unsignedLong |
R |
The total number of packetsEthernet frames received on the interface. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
The total number of outbound packetsEthernet frames that could not be transmitted because of errors. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsReceived |
unsignedInt |
R |
The total number of inbound packetsEthernet frames that contained errors preventing them from being delivered to a higher-layer protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsReceived |
unsignedLong |
R |
The total number of receivedEthernet frames packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsSent |
unsignedInt |
R |
The total number of outbound packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsReceived |
unsignedInt |
R |
The total number of inbound packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsReceived |
unsignedLong |
R |
The total number of received packets,Ethernet frames, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
The total number of received packets,Ethernet frames, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
The total number of packetsEthernet frames received via the interface which were discarded because of an unknown or unsupported protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.Ethernet.Link.{i}. |
object(0:) |
W |
Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames. 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 (if not supplied by the Controller on creation) choose initial values for Alias, Name and MACAddress such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the link. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the link. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the link (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
MACAddress |
string(:17) |
W |
[MACAddress] The MAC address used for packets sent via this interface. Provides the source MAC address for outgoing traffic and the destination MAC address for incoming traffic. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
PriorityTagging |
boolean |
W |
Enables or disables priority tagging on this Ethernet Link. When true, egress frames leaving this interface will be priority tagged with the frame's associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark or QoS.Classification.{i}.InnerEthernetPriorityMark. When false, egress frames leaving this interface will be untagged. The parameter does not affect reception of ingress frames. |
false |
2.12 |
|
Device.Ethernet.Link.{i}.Stats. |
object |
R |
Throughput statistics for this interface. link.The CPE MUST reset the interface'slink's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interfacelink becomes operationally down due to a previous administrative down (i.e. the interface'slink's Status parameter transitions to a down state after the interfacelink is disabled) or when the interfacelink becomes administratively up (i.e. the interface'slink's Enable parameter transitions from false to true). Administrative and operational interfacelink status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.12 |
|
BytesSent |
unsignedLong |
R |
The total number of bytes transmitted out of the interface,link, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BytesReceived |
unsignedLong |
R |
The total number of bytes received on the interface,link, including framing characters. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames transmitted out of the interface.link. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsReceived |
unsignedLong |
R |
The total number of packetsEthernet frames received on the interface.link. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
The total number of outbound packetsEthernet frames that could not be transmitted because of errors. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsReceived |
unsignedInt |
R |
The total number of inbound packetsEthernet frames that contained errors preventing them from being delivered to a higher-layer protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsReceived |
unsignedLong |
R |
The total number of received packets,Ethernet frames, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsSent |
unsignedInt |
R |
The total number of outbound packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsReceived |
unsignedInt |
R |
The total number of inbound packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsReceived |
unsignedLong |
R |
The total number of received packets,Ethernet frames, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
The total number of packetsEthernet frames 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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
The total number of received packets,Ethernet frames, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
The total number of packetsEthernet frames received via the interfacelink which were discarded because of an unknown or unsupported protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.Ethernet.VLANTermination.{i}. |
object(0:) |
W |
VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the VLANTermination entry. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the VLANTermination entry. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the VLANTermination entry (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
TPID |
unsignedInt |
W |
The Tag Protocol Identifier (TPID) assigned to this VLANTermination. The TPID is an EtherType value used to identify the frame as a tagged frame. Standard [Table 9.1/802.1Q-2011] TPID values are: *S-TAG 0x88A8 = 34984 *C-TAG 0x8100 = 33024 Non-Standard TPID values are: *S-TAG 0x9100 = 37120 |
33024 |
2.12 |
|
Device.Ethernet.VLANTermination.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.Ethernet.RMONStats.{i}. |
object(0:) |
W |
Ethernet statistics based on the [RFC2819] RMON-MIB etherStatsTable, with some extensions inspired by [Section 9.3.32/G.988]. Each instance is associated with an interface capable of transporting Ethernet-encapsulated packets, and contains a set of unidirectional Ethernet statistics. The statistics are sampled either on ingress or on egress. This is determined as follows:
At most one entry in this table can exist with a given value for Alias, or with the same values for all of Interface, VLANID and Queue. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this instance. Enumeration of:
|
Disabled |
2.12 |
|
Interface |
string |
W |
{{div|{{classes}}|The interface associated with this instance. {{reference|an interface that is capable of transporting Ethernet-encapsulated packets}} The term "capable of transporting Ethernet-encapsulated packets" means "has an Ethernet header" and therefore refers to any interface that is at or below an Ethernet.{{object|#.Link}} instance in the interface stack.}} The interface associated with this instance. The value MUST be the Path Name of an interface that is capable of transporting Ethernet-encapsulated packets. The term "capable of transporting Ethernet-encapsulated packets" means "has an Ethernet header" and therefore refers to any interface that is at or below an Ethernet.Link instance in the interface stack. |
<Empty> |
2.12 |
|
VLANID |
unsignedInt(0:4094) |
W |
Filter criterion. The VLAN ID for which statistics are to be collected. A zero value indicates that all packets, whether or not they have a VLAN header, will be considered. A non-zero value indicates that only packets that have the the specified VLAN ID will be considered. |
0 |
2.12 |
|
Queue |
string |
W |
The value MUST be the Path Name of a row in the Device.QoS.Queue. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Filter criterion. The egress queue with which this instance is associated. Only packets that are sent to the referenced queue will be considered. |
<Empty> |
2.12 |
|
DropEvents |
unsignedInt |
R |
{{div|{{classes}}|The total number of events in which packets were dropped due to lack of resources. Note that this number is not necessarily the number of packets dropped; it is just the number of times this condition has been detected. This parameter is based on etherStatsDropEvents from {{bibref|RFC2819}}.}} The total number of events in which packets were dropped due to lack of resources. Note that this number is not necessarily the number of packets dropped; it is just the number of times this condition has been detected. This parameter is based on etherStatsDropEvents from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including those in bad packets) received (excluding framing bits but including FCS bytes). This parameter is based on etherStatsOctets from {{bibref|RFC2819}}.}} The total number of bytes (including those in bad packets) received (excluding framing bits but including FCS bytes). This parameter is based on etherStatsOctets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets, broadcast packets, and multicast packets) received. This parameter is based on etherStatsPkts from {{bibref|RFC2819}}.}} The total number of packets (including bad packets, broadcast packets, and multicast packets) received. This parameter is based on etherStatsPkts from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
BroadcastPackets |
unsignedLong |
R |
{{div|{{classes}}|The total number of good {{units}} received that were directed to the broadcast address. Note that this does not include multicast packets. This parameter is based on etherStatsBroadcastPkts from {{bibref|RFC2819}}.}} The total number of good packets received that were directed to the broadcast address. Note that this does not include multicast packets. This parameter is based on etherStatsBroadcastPkts from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
MulticastPackets |
unsignedLong |
R |
{{div|{{classes}}|The total number of good {{units}} received that were directed to a multicast address. Note that this number does not include packets directed to the broadcast address. This parameter is based on etherStatsMulticastPkts from {{bibref|RFC2819}}.}} The total number of good packets received that were directed to a multicast address. Note that this number does not include packets directed to the broadcast address. This parameter is based on etherStatsMulticastPkts from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
CRCErroredPackets |
unsignedInt |
R |
{{div|{{classes}}|The total number of {{units}} received that had a length (excluding framing bits, but including FCS bytes) of between 64 and 1518 bytes, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of bytes (FCS Error) or a bad FCS with a non-integral number of bytes (Alignment Error). This parameter is based on etherStatsCRCAlignErrors from {{bibref|RFC2819}}.}} The total number of packets received that had a length (excluding framing bits, but including FCS bytes) of between 64 and 1518 bytes, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of bytes (FCS Error) or a bad FCS with a non-integral number of bytes (Alignment Error). This parameter is based on etherStatsCRCAlignErrors from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
UndersizePackets |
unsignedInt |
R |
{{div|{{classes}}|The total number of {{units}} received that were less than 64 bytes long (excluding framing bits, but including FCS bytes) and were otherwise well formed. This parameter is based on etherStatsUndersizePkts from {{bibref|RFC2819}}.}} The total number of packets received that were less than 64 bytes long (excluding framing bits, but including FCS bytes) and were otherwise well formed. This parameter is based on etherStatsUndersizePkts from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
OversizePackets |
unsignedInt |
R |
{{div|{{classes}}|The total number of {{units}} received that were longer than 1518 bytes (excluding framing bits, but including FCS bytes) and were otherwise well formed. This parameter is based on etherStatsOversizePkts from {{bibref|RFC2819}}.}} The total number of packets received that were longer than 1518 bytes (excluding framing bits, but including FCS bytes) and were otherwise well formed. This parameter is based on etherStatsOversizePkts from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets64Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts64Octets from {{bibref|RFC2819}}.}} The total number of packets (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts64Octets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets65to127Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets) received that were between 65 and 127 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts65to127Octets from {{bibref|RFC2819}}.}} The total number of packets (including bad packets) received that were between 65 and 127 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts65to127Octets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets128to255Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets) received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts6128to255Octets from {{bibref|RFC2819}}.}} The total number of packets (including bad packets) received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts6128to255Octets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets256to511Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets) received that were between 256 and 511 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts256to511Octets from {{bibref|RFC2819}}.}} The total number of packets (including bad packets) received that were between 256 and 511 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts256to511Octets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets512to1023Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets) received that were between 512 and 1023 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts512to1023Octets from {{bibref|RFC2819}}.}} The total number of packets (including bad packets) received that were between 512 and 1023 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts512to1023Octets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Packets1024to1518Bytes |
unsignedLong |
R |
{{div|{{classes}}|The total number of {{units}} (including bad packets) received that were between 1024 and 1518 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts1024to1518Octets from {{bibref|RFC2819}}.}} The total number of packets (including bad packets) received that were between 1024 and 1518 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts1024to1518Octets from [RFC2819]. Value Change Notification requests for this parameter MAY be denied. |
0 |
2.12 |
|
Device.Ethernet.LAG.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias, Name and MACAddress such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string.. See [Section 4.2.1/TR-181i2]. 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 |
|
Device.Ethernet.LAG.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.USB. |
object |
R |
Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. |
- |
2.12 |
|
Device.USB.Interface.{i}. |
object(0:) |
R |
USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
Device.USB.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.USB.Port.{i}. |
object(0:) |
R |
USB Port table. This table models master and slave USB physical ports on the device. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Power |
string |
R |
{{div|{{classes}}|Power configuration of the USB connection. {{enum}} Only applies when {{param|Type}} is {{enum|Device|Type}}. In other cases value is {{enum|Unknown}}.}} |
- |
2.12 |
|
Device.USB.USBHosts. |
object |
R |
{{div|{{classes}}|This object models the CPE's USB Host controllers. See {{bibref|TR-181i2|Appendix XVII}} for Theory of Operation.}} This object models the CPE's USB Host controllers. See [Appendix XVII/TR-181i2] for Theory of Operation. |
- |
2.12 |
|
Device.USB.USBHosts.Host.{i}. |
object(0:) |
R |
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. |
- |
2.12 |
|
PowerManagementEnable |
boolean |
W |
{{div|{{classes}}|When set to {{true}}, {{param}} enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see {{bibref|USB2.0}}, Chapters 4.3.2, 7.1.7.6, and 11.9). When set to {{false}} {{param}} immediately disables the Host controller Power Management policy.}} When set to true, PowerManagementEnable enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see [USB2.0], Chapters 4.3.2, 7.1.7.6, and 11.9). When set to false PowerManagementEnable immediately disables the Host controller Power Management policy. |
- |
2.12 |
|
Device.USB.USBHosts.Host.{i}.Device.{i}. |
object(0:) |
R |
Table of connected USB devices. At most one entry in this table can exist with a given value for DeviceNumber. |
- |
2.12 |
|
DeviceClass |
hexBinary(:1) |
R |
{{div|{{classes}}|Class Code as assigned by USB-IF. When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified.}} Class Code as assigned by USB-IF. When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified. |
- |
2.12 |
|
Port |
unsignedInt(:255) |
R |
{{div|{{classes}}|Hub port on parent device. 0 when no parent.}} Hub port on parent device. 0 when no parent. |
- |
2.12 |
|
Rate |
string |
R |
{{div|{{classes}}|Speed of the USB device. {{enum}} Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate.}} Speed of the USB device. Enumeration of:
Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate. |
- |
2.12 |
|
Parent |
string |
R |
{{div|{{classes}}|{{reference}} This is a reference to the parent USB device (e.g. hub device). This is {{empty}} for a device connected to the Host controller (root hub).}} The value MUST be the Path Name of a row in the Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the parent USB device (e.g. hub device). This is an empty string for a device connected to the Host controller (root hub). |
- |
2.12 |
|
IsSuspended |
boolean |
R |
{{div|{{classes}}|When {{true}} the associated Device is in a suspended (i.e. low-power) state (see {{bibref|USB2.0|Chapter 11.9}}). When {{false}} the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see {{bibref|USB2.0|Chapter 9.1.1}}).}} When true the associated Device is in a suspended (i.e. low-power) state (see [Chapter 11.9/USB2.0]). When false the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see [Chapter 9.1.1/USB2.0]). |
- |
2.12 |
|
IsSelfPowered |
boolean |
R |
{{div|{{classes}}|When {{true}} the associated device is at least partly powered by a local source (see {{bibref|USB2.0|Chapter 9.4.5}}). When {{false}} the associated device draws all the current it needs from the USB bus.}} When true the associated device is at least partly powered by a local source (see [Chapter 9.4.5/USB2.0]). When false the associated device draws all the current it needs from the USB bus. |
- |
2.12 |
|
Device.USB.USBHosts.Host.{i}.Device.{i}.Configuration.{i}. |
object(0:) |
R |
Table of device configurations. At most one entry in this table can exist with a given value for ConfigurationNumber. |
- |
2.12 |
|
Device.USB.USBHosts.Host.{i}.Device.{i}.Configuration.{i}.Interface.{i}. |
object(0:) |
R |
Table of device interface descriptors. At most one entry in this table can exist with a given value for InterfaceNumber. |
- |
2.12 |
|
InterfaceClass |
hexBinary(:1) |
R |
{{div|{{classes}}|Class Code as assigned by USB-IF. When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified.}} Class Code as assigned by USB-IF. When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified. |
- |
2.12 |
|
Device.HPNA. |
object |
R |
HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. |
- |
2.12 |
|
Device.HPNA.Interface.{i}. |
object(0:) |
R |
HPNA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of an HPNA interface [G.9954]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
Device.HPNA.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.HPNA.Interface.{i}.QoS. |
object |
R |
QoS configuration object. |
- |
2.12 |
|
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. |
object(0:) |
W |
Flow specification table. The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate FlowSpec entry (i.e. the FlowSpec entry whose TrafficClasses list contains a matching traffic class). For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Priority |
unsignedInt(0:7) |
W |
{{div|{{classes}}|Flow queue network priority. Priority 0 is the lowest priority.}} Flow queue network priority. Priority 0 is the lowest priority. |
0 |
2.12 |
|
Latency |
unsignedInt(0:999) |
W |
{{div|{{classes}}|Maximum latency of the flow (expressed in {{units}}). Value 0 means no latency requirements.}} Maximum latency of the flow (expressed in milliseconds). Value 0 means no latency requirements. |
0 |
2.12 |
|
Jitter |
unsignedInt(0:999) |
W |
{{div|{{classes}}|Maximum jitter of the flow (expressed in {{units}}). Value 0 means no jitter requirements.}} Maximum jitter of the flow (expressed in milliseconds). Value 0 means no jitter requirements. |
0 |
2.12 |
|
PacketSize |
unsignedInt(0:) |
W |
{{div|{{classes}}|Typical packet size. Value 0 means undefined packet size.}} Typical packet size. Value 0 means undefined packet size. |
0 |
2.12 |
|
MinRate |
unsignedInt |
W |
{{div|{{classes}}|Minimum required rate in Kbps. Value 0 means no MinRate requirements.}} Minimum required rate in Kbps. Value 0 means no MinRate requirements. |
0 |
2.12 |
|
AvgRate |
unsignedInt |
W |
{{div|{{classes}}|Average required rate in Kbps. Value 0 means no AvgRate requirements.}} Average required rate in Kbps. Value 0 means no AvgRate requirements. |
0 |
2.12 |
|
MaxRate |
unsignedInt |
W |
{{div|{{classes}}|Maximum required rate in Kbps. Value 0 means no MaxRate requirements.}} Maximum required rate in Kbps. Value 0 means no MaxRate requirements. |
0 |
2.12 |
|
PER |
unsignedInt |
W |
{{div|{{classes}}|The desired packet error rate (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127). Value 0 means no PER requirements.}} The desired packet error rate (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127). Value 0 means no PER requirements. |
0 |
2.12 |
|
Timeout |
unsignedInt |
W |
{{div|{{classes}}|Flow inactivity tear down timeout (expressed in {{units}}). Value 0 means unlimited timeout.}} Flow inactivity tear down timeout (expressed in milliseconds). Value 0 means unlimited timeout. |
0 |
2.12 |
|
Device.HPNA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table provides information about other HPNA devices that are directly accessible via this HPNA interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not this node is currently present in the HPNA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}} Whether or not this node is currently present in the HPNA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.HPNA.Diagnostics. |
object |
R |
The HPNA Diagnostics object. |
- |
2.12 |
|
PHYThroughput() |
command |
- |
[ASYNC] {{div|{{classes}}|HPNA PHY throughput diagnostics configuration and results. When diagnostics are requested, all HPNA nodes for which the {{param|#.Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
[MANDATORY] The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. Changes since 2.14:
|
- |
2.12 |
|
⇒ NumPacketsInBurst |
unsignedInt |
W |
[MANDATORY] Number of test packet in burst to be send during PHY diagnostics test from each HPNA device to other HPNA device in the HPNA network. Changes since 2.14:
|
- |
2.12 |
|
⇒ BurstInterval |
unsignedInt |
W |
[MANDATORY] Test packet burst interval length (expressed in milliseconds). Changes since 2.14:
|
- |
2.12 |
|
⇒ TestPacketPayloadLength |
unsignedInt(0:1480) |
W |
[MANDATORY] Payload length in the test packets. Changes since 2.14:
|
- |
2.12 |
|
⇒ PayloadEncoding |
unsignedInt |
W |
[MANDATORY] HPNA payload encoding in PHY diagnostics. 0 is used for negotiated payload between devices according to line conditions. Changes since 2.14:
|
- |
2.12 |
|
⇒ PayloadDataGen |
unsignedInt |
W |
[MANDATORY] Test packets payload data generator value. Changes since 2.14:
|
- |
2.12 |
|
⇒ PayloadType |
string |
W |
[MANDATORY] Test packets payload type. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
⇒ PriorityLevel |
unsignedInt(0:7) |
W |
[MANDATORY] Priority level of PHY diagnostics packets (0 lowest -7 highest). Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ Result.{i}. |
object(0:) |
R |
{{div|{{classes}}|PHY throughput diagnostics results. Each result object corresponds to unidirectional traffic between two PHY diagnostics-enabled nodes (so there are two such objects for each such pair).}} PHY throughput diagnostics results. Each result object corresponds to unidirectional traffic between two PHY diagnostics-enabled nodes (so there are two such objects for each such pair). This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with the same values for both SrcMACAddress and DestMACAddress. |
- |
2.12 |
|
PerformanceMonitoring() |
command |
- |
[ASYNC] {{div|{{classes}}|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.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
[MANDATORY] The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. Changes since 2.14:
|
- |
2.12 |
|
⇒ SampleInterval |
unsignedInt |
W |
[MANDATORY] Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The CPE MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the CPE MAY choose to align sample intervals with time of day, but is not required to do so. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ Nodes. |
object |
R |
Per-node HPNA performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the "current" interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the "current" interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. Changes since 2.14:
|
- |
2.12 |
|
⇐ CurrentStart |
dateTime |
R |
Start time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago. |
- |
2.12 |
|
⇐ CurrentEnd |
dateTime |
R |
End time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample. |
- |
2.12 |
|
⇐ Nodes.Node.{i}. |
object(1:) |
R |
{{div|{{classes}}|Per-node HPNA performance monitoring results during the current sample interval. Each table entry contains the results collected between an HPNA node (as indicated by {{param|MACAddress}}) and the local HPNA interface (as indicated by {{param|##.Interface}}). Note: Packet counters indicate the number of packets received between {{param|#.CurrentStart}} and {{param|#.CurrentEnd}}.}} Per-node HPNA performance monitoring results during the current sample interval. Each table entry contains the results collected between an HPNA node (as indicated by MACAddress) and the local HPNA interface (as indicated by Interface). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd. This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
⇐ Channels. |
object |
R |
{{div|{{classes}}|Per-channel HPNA performance monitoring results. Note: channels are unidirectional.}} Per-channel HPNA performance monitoring results. Note: channels are unidirectional. Changes since 2.14:
|
- |
2.12 |
|
⇐ Channels.Channel.{i}. |
object(0:) |
R |
Per-channel HPNA performance monitoring results. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with the same values for both HostSrcMACAddress and HostDestMACAddress. |
- |
2.12 |
|
⇐ FlowSpec |
string(:256) |
R |
{{div|{{classes}}|{{reference}} Identifies the FlowSpec associated with the channel. This parameter is only used for channels that correspond to egress traffic from the local HPNA interface. {{null}} means that the channel is not associated with any specified flow specification in the QoS object.}} The value MUST be the Path Name of a row in the HPNA.Interface.{i}.QoS.FlowSpec. table. Identifies the FlowSpec associated with the channel. This parameter is only used for channels that correspond to egress traffic from the local HPNA interface. An empty string means that the channel is not associated with any specified flow specification in the QoS object. |
- |
2.12 |
|
Device.MoCA. |
object |
R |
MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. |
- |
2.12 |
|
Device.MoCA.Interface.{i}. |
object(0:) |
R |
MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
FirmwareVersion |
string(:64) |
R |
{{div|{{classes}}|This interface's firmware version. This parameter is based on mocaIfSoftwareVersion from {{bibref|MOCA11-MIB}}.}} This interface's firmware version. This parameter is based on mocaIfSoftwareVersion from [MOCA11-MIB]. |
- |
2.12 |
|
MaxIngressBW |
unsignedInt |
R |
{{div|{{classes}}|The maximum bandwidth of this interface for flows onto the MoCA network in {{units}}. This parameter is based on mocaIfMaxIngressNodeBw from {{bibref|MOCA11-MIB}}.}} The maximum bandwidth of this interface for flows onto the MoCA network in Mbps. This parameter is based on mocaIfMaxIngressNodeBw from [MOCA11-MIB]. |
- |
2.12 |
|
MaxEgressBW |
unsignedInt |
R |
{{div|{{classes}}|The maximum bandwidth of this interface for flows from the MoCA network in {{units}}. This parameter is based on mocaIfMaxEgressNodeBw from {{bibref|MOCA11-MIB}}.}} The maximum bandwidth of this interface for flows from the MoCA network in Mbps. This parameter is based on mocaIfMaxEgressNodeBw from [MOCA11-MIB]. |
- |
2.12 |
|
HighestVersion |
string(:64) |
R |
Identifies the highest MoCA version that this interface supports. This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:
|
- |
2.12 |
|
CurrentVersion |
string(:64) |
R |
Identifies the MoCA version that the MoCA network is currently running. This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:
|
- |
2.12 |
|
NetworkCoordinator |
unsignedInt |
R |
{{div|{{classes}}|The Node ID of the current Network Coordinator (NC) for the MoCA network. This parameter is based on mocaIfNC from {{bibref|MOCA11-MIB}}.}} The Node ID of the current Network Coordinator (NC) for the MoCA network. This parameter is based on mocaIfNC from [MOCA11-MIB]. |
- |
2.12 |
|
NodeID |
unsignedInt |
R |
{{div|{{classes}}|The Node ID of this interface. This parameter is based on mocaIfNodeID from {{bibref|MOCA11-MIB}}.}} The Node ID of this interface. This parameter is based on mocaIfNodeID from [MOCA11-MIB]. |
- |
2.12 |
|
PreferredNC |
boolean |
W |
{{div|{{classes}}|Whether this interface is a preferred Network Coordinator (NC). This parameter is based on mocaIfPreferredNC from {{bibref|MOCA11-MIB}}.}} Whether this interface is a preferred Network Coordinator (NC). This parameter is based on mocaIfPreferredNC from [MOCA11-MIB]. |
- |
2.12 |
|
BackupNC |
unsignedInt |
R |
{{div|{{classes}}|The Node ID of the backup Network Coordinator node. This parameter is based on mocaIfBackupNC from {{bibref|MOCA11-MIB}}.}} The Node ID of the backup Network Coordinator node. This parameter is based on mocaIfBackupNC from [MOCA11-MIB]. |
- |
2.12 |
|
PrivacyEnabledSetting |
boolean |
W |
{{div|{{classes}}|The configured privacy mode. This indicates whether link-layer security is enabled ({{true}}) or disabled ({{false}}) for network admission. The configured privacy setting MAY NOT match the current operational state ({{param|PrivacyEnabled}}), since this setting is only applied during network formation or admission.}} The configured privacy mode. This indicates whether link-layer security is enabled (true) or disabled (false) for network admission. The configured privacy setting MAY NOT match the current operational state (PrivacyEnabled), since this setting is only applied during network formation or admission. |
- |
2.12 |
|
PrivacyEnabled |
boolean |
R |
{{div|{{classes}}|Indicates whether link-layer security is enabled or disabled. This parameter is based on mocaIfPrivacyEnable from {{bibref|MOCA11-MIB}}.}} Indicates whether link-layer security is enabled or disabled. This parameter is based on mocaIfPrivacyEnable from [MOCA11-MIB]. |
- |
2.12 |
|
FreqCapabilityMask |
hexBinary(8) |
R |
Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. For example, an interface that supports 1150 MHz through 1500 MHz would have a value of 0x000000001FFFC000. This parameter is based on mocaIfCapabilityMask from [MOCA11-MIB]. |
- |
2.12 |
|
FreqCurrentMaskSetting |
hexBinary(8) |
W |
{{div|{{classes}}|The configured hexadecimal encoded 64-bit mask of enabled frequencies for network admission. The configured frequencies MAY NOT match the current operational state ({{param|FreqCurrentMask}}), since this setting is only applied during network formation or admission.}} The configured hexadecimal encoded 64-bit mask of enabled frequencies for network admission. The configured frequencies MAY NOT match the current operational state (FreqCurrentMask), since this setting is only applied during network formation or admission. |
- |
2.12 |
|
FreqCurrentMask |
hexBinary(8) |
R |
{{div|{{classes}}|Hexadecimal encoded 64-bit mask of used frequencies. This is the bit map of the spectrum that can be used and is a subset of the {{param|FreqCapabilityMask}}. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfChannelMask from {{bibref|MOCA11-MIB}}.}} Hexadecimal encoded 64-bit mask of used frequencies. This is the bit map of the spectrum that can be used and is a subset of the FreqCapabilityMask. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfChannelMask from [MOCA11-MIB]. |
- |
2.12 |
|
CurrentOperFreq |
unsignedInt |
R |
{{div|{{classes}}|Current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when {{param|Status}} is {{enum|Up|Status}}. This parameter is based on mocaIfRFChannel from {{bibref|MOCA11-MIB}}.}} Current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when Status is Up. This parameter is based on mocaIfRFChannel from [MOCA11-MIB]. |
- |
2.12 |
|
LastOperFreq |
unsignedInt |
R |
{{div|{{classes}}|Last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the {{enum|Up|Status}} state. This parameter is based on mocaIfLOF from {{bibref|MOCA11-MIB}}.}} Last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the Up state. This parameter is based on mocaIfLOF from [MOCA11-MIB]. |
- |
2.12 |
|
KeyPassphrase |
string(12:17) |
W |
{{div|{{classes}}|MoCA Password. The value consists of numeric characters (0-9). {{pattern}} This parameter is based on mocaIfPassword from {{bibref|MOCA11-MIB}}.}} MoCA Password. The value consists of numeric characters (0-9). Possible patterns:
This parameter is based on mocaIfPassword from [MOCA11-MIB]. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
TxPowerLimit |
unsignedInt |
W |
Transmit Power attenuation in dB relative to the maximum transmit power. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfTxPowerLimit from [MOCA11-MIB]. |
- |
2.12 |
|
PowerCntlPhyTarget |
unsignedInt |
W |
Target PHY rate in Mbps for the power control algorithm. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfPowerControlTargetRate from [MOCA11-MIB]. |
- |
2.12 |
|
BeaconPowerLimit |
unsignedInt |
W |
Beacon Transmit Power attenuation in dB relative to the maximum transmit power. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB]. |
- |
2.12 |
|
NetworkTabooMask |
hexBinary(8) |
R |
{{div|{{classes}}|Hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfTabooChannelMask from {{bibref|MOCA11-MIB}}.}} Hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfTabooChannelMask from [MOCA11-MIB]. |
- |
2.12 |
|
NodeTabooMask |
hexBinary(8) |
R |
{{div|{{classes}}|Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfNodeTabooChannelMask from {{bibref|MOCA11-MIB}}.}} Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfNodeTabooChannelMask from [MOCA11-MIB]. |
- |
2.12 |
|
TxBcastRate |
unsignedInt |
R |
{{div|{{classes}}|The broadcast PHY transmit rate in {{units}} for this interface. This parameter is based on mocaIfTxGcdRate from {{bibref|MOCA11-MIB}}.}} The broadcast PHY transmit rate in Mbps for this interface. This parameter is based on mocaIfTxGcdRate from [MOCA11-MIB]. |
- |
2.12 |
|
TxBcastPowerReduction |
unsignedInt |
R |
{{div|{{classes}}|Transmit Power attenuation in {{units}} relative to the maximum transmit power for broadcast transmissions. This parameter is based on mocaIfTxGcdPowerReduction from {{bibref|MOCA11-MIB}}.}} Transmit Power attenuation in dB relative to the maximum transmit power for broadcast transmissions. This parameter is based on mocaIfTxGcdPowerReduction from [MOCA11-MIB]. |
- |
2.12 |
|
QAM256Capable |
boolean |
R |
{{div|{{classes}}|Whether this interface supports the 256 QAM feature. This parameter is based on mocaIfQAM256Capable from {{bibref|MOCA11-MIB}}.}} Whether this interface supports the 256 QAM feature. This parameter is based on mocaIfQAM256Capable from [MOCA11-MIB]. |
- |
2.12 |
|
PacketAggregationCapability |
unsignedInt(0:10) |
R |
{{div|{{classes}}|The packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 {{units}}) or 10 (10 {{units}}). This parameter is based on mocaIfPacketsAggrCapability from {{bibref|MOCA11-MIB}}.}} The packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). This parameter is based on mocaIfPacketsAggrCapability from [MOCA11-MIB]. |
- |
2.12 |
|
Device.MoCA.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.MoCA.Interface.{i}.QoS. |
object |
R |
The QoS object provides information on MoCA parameterized QoS for this interface [MoCAv1.1]. |
- |
2.12 |
|
EgressNumFlows |
unsignedInt |
R |
{{div|{{classes}}|The number of QoS flows that this interface has from the MoCA network. This parameter is based on mocaIfEgressNodeNumFlows from {{bibref|MOCA11-MIB}}.}} The number of QoS flows that this interface has from the MoCA network. This parameter is based on mocaIfEgressNodeNumFlows from [MOCA11-MIB]. |
- |
2.12 |
|
IngressNumFlows |
unsignedInt |
R |
{{div|{{classes}}|The number of QoS flows that this interface has onto the MoCA network. This parameter is based on mocaIfIngressNodeNumFlows from {{bibref|MOCA11-MIB}}.}} The number of QoS flows that this interface has onto the MoCA network. This parameter is based on mocaIfIngressNodeNumFlows from [MOCA11-MIB]. |
- |
2.12 |
|
Device.MoCA.Interface.{i}.QoS.FlowStats.{i}. |
object(0:) |
R |
The flow statistics table provides information on the MoCA parameterized QoS flows this interface has allocated onto the MoCA network. At most one entry in this table can exist with a given value for FlowID. |
- |
2.12 |
|
FlowID |
unsignedInt |
R |
{{div|{{classes}}|The flow ID used to identify a flow in the network. This parameter is based on mocaIfFlowID from {{bibref|MOCA11-MIB}}.}} The flow ID used to identify a flow in the network. This parameter is based on mocaIfFlowID from [MOCA11-MIB]. |
- |
2.12 |
|
PacketDA |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The Destination Address (DA) for the packets in this flow. This parameter is based on mocaIfPacketDA from {{bibref|MOCA11-MIB}}.}} The Destination Address (DA) for the packets in this flow. This parameter is based on mocaIfPacketDA from [MOCA11-MIB]. |
- |
2.12 |
|
MaxRate |
unsignedInt |
R |
{{div|{{classes}}|Maximum required rate in {{units}}. This parameter is based on mocaIfPeakDataRate from {{bibref|MOCA11-MIB}}.}} Maximum required rate in Kbps. This parameter is based on mocaIfPeakDataRate from [MOCA11-MIB]. |
- |
2.12 |
|
MaxBurstSize |
unsignedInt |
R |
{{div|{{classes}}|Maximum burst size. This parameter is based on mocaIfBurstSize from {{bibref|MOCA11-MIB}}.}} Maximum burst size. This parameter is based on mocaIfBurstSize from [MOCA11-MIB]. |
- |
2.12 |
|
LeaseTime |
unsignedInt |
R |
Flow lease time (expressed in seconds). A LeaseTime of 0 means unlimited lease time. This parameter is based on mocaIfLeaseTime from [MOCA11-MIB]. |
- |
2.12 |
|
LeaseTimeLeft |
unsignedInt |
R |
Flow lease time remaining (expressed in seconds). If LeaseTime is 0 then a LeaseTimeLeft of 0 means unlimited lease time; otherwise, a LeaseTimeLeft of 0 means expired. This parameter is based on mocaIfLeaseTimeLeft from [MOCA11-MIB]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
FlowPackets |
unsignedInt |
R |
{{div|{{classes}}|The number of packets transmitted for this flow. This parameter is based on mocaIfTxPacketsFlow from {{bibref|MOCA11-MIB}}.}} The number of packets transmitted for this flow. This parameter is based on mocaIfTxPacketsFlow from [MOCA11-MIB]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.MoCA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about other MoCA devices currently associated with this MoCA interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
NodeID |
unsignedInt |
R |
{{div|{{classes}}|The Node ID of this remote device. This parameter is based on mocaNodeIndex from {{bibref|MOCA11-MIB}}.}} The Node ID of this remote device. This parameter is based on mocaNodeIndex from [MOCA11-MIB]. |
- |
2.12 |
|
PreferredNC |
boolean |
R |
{{div|{{classes}}|Whether this remote device is a preferred Network Coordinator (NC). This parameter is based on mocaNodePreferredNC from {{bibref|MOCA11-MIB}}.}} Whether this remote device is a preferred Network Coordinator (NC). This parameter is based on mocaNodePreferredNC from [MOCA11-MIB]. |
- |
2.12 |
|
HighestVersion |
string(:64) |
R |
Identifies the highest MoCA version that this remote device supports. This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:
|
- |
2.12 |
|
PHYTxRate |
unsignedInt |
R |
{{div|{{classes}}|The PHY transmit rate (in {{units}}) to this remote device. This parameter is based on mocaMeshTxRate from {{bibref|MOCA11-MIB}}.}} The PHY transmit rate (in Mbps) to this remote device. This parameter is based on mocaMeshTxRate from [MOCA11-MIB]. |
- |
2.12 |
|
TxPowerControlReduction |
unsignedInt |
R |
{{div|{{classes}}|The reduction in transmitter level (in {{units}}) due to power control. This parameter is based on mocaNodeTxPowerReduction from {{bibref|MOCA11-MIB}}.}} The reduction in transmitter level (in dB) due to power control. This parameter is based on mocaNodeTxPowerReduction from [MOCA11-MIB]. |
- |
2.12 |
|
RxPowerLevel |
unsignedInt |
R |
{{div|{{classes}}|The power level (in {{units}}) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from {{bibref|MOCA11-MIB}}.}} The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from [MOCA11-MIB]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
TxBcastRate |
unsignedInt |
R |
{{div|{{classes}}|The broadcast PHY transmit rate (in {{units}}) from this remote device. This parameter is based on mocaNodeTxGcdRate from {{bibref|MOCA11-MIB}}.}} The broadcast PHY transmit rate (in Mbps) from this remote device. This parameter is based on mocaNodeTxGcdRate from [MOCA11-MIB]. |
- |
2.12 |
|
RxBcastPowerLevel |
unsignedInt |
R |
{{div|{{classes}}|The power level (in {{units}}) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxGcdPower from {{bibref|MOCA11-MIB}}.}} The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxGcdPower from [MOCA11-MIB]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
RxPackets |
unsignedInt |
R |
{{div|{{classes}}|The number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets). This parameter is based on mocaNodeRxPackets from {{bibref|MOCA11-MIB}}.}} The number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets). This parameter is based on mocaNodeRxPackets from [MOCA11-MIB]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
RxErroredAndMissedPackets |
unsignedInt |
R |
{{div|{{classes}}|The number of errored and missed packets received from this remote device. This parameter is based on mocaNodeRxDrops from {{bibref|MOCA11-MIB}}.}} The number of errored and missed packets received from this remote device. This parameter is based on mocaNodeRxDrops from [MOCA11-MIB]. |
- |
2.12 |
|
QAM256Capable |
boolean |
R |
{{div|{{classes}}|Whether this remote device supports the 256 QAM feature. This parameter is based on mocaNodeQAM256Capable from {{bibref|MOCA11-MIB}}.}} Whether this remote device supports the 256 QAM feature. This parameter is based on mocaNodeQAM256Capable from [MOCA11-MIB]. |
- |
2.12 |
|
PacketAggregationCapability |
unsignedInt(0:10) |
R |
{{div|{{classes}}|The packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 {{units}}) or 10 (10 {{units}}). This parameter is based on mocaNodePacketsAggrCapability from {{bibref|MOCA11-MIB}}.}} The packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). This parameter is based on mocaNodePacketsAggrCapability from [MOCA11-MIB]. |
- |
2.12 |
|
RxSNR |
unsignedInt |
R |
{{div|{{classes}}|The signal to noise level (in {{units}}) received at this interface from this remote device. This parameter is based on mocaNodeSNR from {{bibref|MOCA11-MIB}}.}} The signal to noise level (in dBm) received at this interface from this remote device. This parameter is based on mocaNodeSNR from [MOCA11-MIB]. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not this remote device is currently present in the MoCA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}} Whether or not this remote device is currently present in the MoCA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.Ghn. |
object |
R |
G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. |
- |
2.12 |
|
Device.Ghn.Interface.{i}. |
object(0:) |
R |
G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface, denoted as node MAC address or REGID in {{bibref|G.9961}}. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface, denoted as node MAC address or REGID in [G.9961]. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
ConnectionType |
string |
R |
This parameter was DEPRECATED This parameter was DEPRECATED in 2.8.because it has been replaced by {{param|ConnectionTypeMediumType}}. This parameter is OBSOLETED in 2.14. This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
DomainName |
string(:32) |
R |
{{div|{{classes}}|This is the domain name to which the interface is currently registered. {{empty}} indicates that the interface is currently not registered.}} This is the domain name to which the interface is currently registered. An empty string indicates that the interface is currently not registered. |
- |
2.12 |
|
DeviceId |
unsignedInt |
R |
{{div|{{classes}}|The Device Identifier assigned by the Domain Master, denoted as DEVICE_ID in {{bibref|G.9961}}. The value 0 indicates that the device is not currently registered.}} The Device Identifier assigned by the Domain Master, denoted as DEVICE_ID in [G.9961]. The value 0 indicates that the device is not currently registered. |
- |
2.12 |
|
StandardVersions |
string[] |
R |
Comma-separated list of strings. {{div|{{classes}}|The standard versions that the interface supports. The list MUST have an even number of items. The first item of each pair represents an ITU-T G.hn Recommendation while the second element of each pair represents the amendment version of the indicated Recommendation that this interface supports (the value 0 corresponds to the base Recommendation). For example, to indicate support for the G.9960 base document and G.9961 amendment 1, the corresponding list would be "G9960,0,G9961,1".}} The standard versions that the interface supports. The list MUST have an even number of items. The first item of each pair represents an ITU-T G.hn Recommendation while the second element of each pair represents the amendment version of the indicated Recommendation that this interface supports (the value 0 corresponds to the base Recommendation). For example, to indicate support for the G.9960 base document and G.9961 amendment 1, the corresponding list would be "G9960,0,G9961,1". |
- |
2.12 |
|
NotchedAmateurRadioBands |
hexBinary(:2) |
W |
{{div|{{classes}}|A bit map representing usage of international amateur bands (0 = masked, 1 = unmasked). The LSB represents the lowest band (1.8-2.0 MHz), the second LSB represents the second lowest band (3.5-4.0 MHz), and so on. The maximum value for this parameter is 0x03FF, i.e. it is a 10-bit quantity represented in 16 bits and the top 6 bits are always zero. International Radio amateur bands are described in {{bibref|G.9964|Table D-1}} and conveyed by the Domain Master in the Amateur radio band descriptor (see {{bibref|G.9961|Table 8-77}}).}} A bit map representing usage of international amateur bands (0 = masked, 1 = unmasked). The LSB represents the lowest band (1.8-2.0 MHz), the second LSB represents the second lowest band (3.5-4.0 MHz), and so on. The maximum value for this parameter is 0x03FF, i.e. it is a 10-bit quantity represented in 16 bits and the top 6 bits are always zero. International Radio amateur bands are described in [Table D-1/G.9964] and conveyed by the Domain Master in the Amateur radio band descriptor (see [Table 8-77/G.9961]). |
- |
2.12 |
|
NodeTypeDMConfig |
boolean |
W |
Requests the interface to become the Domain Master in the G.hn domain. This parameter is valid only if NodeTypeDMCapable is true. Note that, if more than one node is configured to act as Domain Master, G.hn specifies a protocol to ensure only one device actually becomes DM. |
- |
2.12 |
|
NodeTypeDMStatus |
boolean |
R |
{{div|{{classes}}|Indicates whether the interface is acting as Domain Master ({{true}}) or not ({{false}}). See Note in {{param|NodeTypeDMConfig}} regarding the possibility of more than one node being configured with {{param|NodeTypeDMConfig}} = {{true}}.}} Indicates whether the interface is acting as Domain Master (true) or not (false). See Note in NodeTypeDMConfig regarding the possibility of more than one node being configured with NodeTypeDMConfig = true. |
- |
2.12 |
|
PSM |
unsignedInt[2:2][2:32] |
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 PSMBreak Point Index And Levels, with each list item consisting of the following. [PSMBreakPointIndexAndLevel] 1. The PSM breakpoint sub-carrier index in the range [0:4095], and
|
- |
2.12 |
|
Device.Ghn.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|Throughput statistics for this interface at the different G.hn reference points described in {{bibref|G.9961|Clause 8.1}}. 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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961]. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.12 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. More specifically, this is the total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received on the interface, including framing characters. More specifically, this is the total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It can include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of packets transmitted out of the interface. More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.}} The total number of packets transmitted out of the interface. More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of packets received on the interface. More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.}} The total number of packets received on the interface. More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of outbound packets that could not be transmitted because of errors. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).}} The total number of outbound packets that could not be transmitted because of errors. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) but could not be transmitted because of errors (e.g., APDUs containing CRC errors). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.}} The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.}} 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|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. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.}} 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. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).}} 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow). Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|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. More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.}} 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. More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.}} 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.}} The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.}} 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.}} The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.}} The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
BlocksErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:
Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.Ghn.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about other G.hn devices connected to this G.hn interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|MAC address of remote G.hn device. This is denoted as REGID in {{bibref|G.9961}}.}} MAC address of remote G.hn device. This is denoted as REGID in [G.9961]. |
- |
2.12 |
|
TxPhyRate |
unsignedInt |
R |
{{div|{{classes}}|The PHY transmit Rate (expressed in {{units}}) to this remote device, denoted as PHY data rate in {{bibref|G.9961}}. Refer to Note 1 of {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down.}} The PHY transmit Rate (expressed in Mbps) to this remote device, denoted as PHY data rate in [G.9961]. Refer to Note 1 of [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
RxPhyRate |
unsignedInt |
R |
{{div|{{classes}}|The PHY receive Rate (expressed in {{units}}) from this remote device, denoted as PHY data rate in {{bibref|G.9961}}. Refer to Note 1 of {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down.}} The PHY receive Rate (expressed in Mbps) from this remote device, denoted as PHY data rate in [G.9961]. Refer to Note 1 of [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Active |
boolean |
R |
Whether or not this device is currently present in the G.hn domain. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. If Active is true, it indicates that the Status of the remote device is 0, 1, or 2 (see [Table 7-3/G.9961]). |
- |
2.12 |
|
Device.Ghn.Interface.{i}.SMMaskedBand.{i}. |
object(0:32) |
W |
{{div|{{classes}}|Specifies the list of masked bands to be applied to the G.hn interface. This information is conveyed by the Domain Master in the SM descriptor as specified in {{bibref|G.9961|Table 8-77}}. Instances of this object are expected to exist only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter {{param|#.IsDM}} is {{true}}.}} Specifies the list of masked bands to be applied to the G.hn interface. This information is conveyed by the Domain Master in the SM descriptor as specified in [Table 8-77/G.9961]. Instances of this object are expected to exist only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true. This table MUST contain at least 0 and at most 32 entries. At most one entry in this table can exist with a given value for BandNumber. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for BandNumber such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.Ghn.Diagnostics. |
object |
R |
The G.hn Diagnostics object. |
- |
2.12 |
|
PHYThroughput() |
command |
- |
[ASYNC] {{div|{{classes}}|G.hn PHY throughput diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the {{param|#.Interface.{i}.PHYThroughputDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string |
W |
[MANDATORY] The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. Changes since 2.14:
|
- |
2.12 |
|
⇒ DiagnoseMACAddress |
string(:17) |
W |
[MANDATORY] [MACAddress] {{div|{{classes}}|The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain.}} The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
PerformanceMonitoring() |
command |
- |
[ASYNC] {{div|{{classes}}|G.hn Performance Monitoring diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the {{param|#.Interface.{i}.PerformanceMonitoringDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string |
W |
[MANDATORY] The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. Changes since 2.14:
|
- |
2.12 |
|
⇒ DiagnoseMACAddress |
string(:17) |
W |
[MANDATORY] [MACAddress] {{div|{{classes}}|The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain.}} The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain. Changes since 2.14:
|
- |
2.12 |
|
⇒ SampleInterval |
unsignedInt |
W |
[MANDATORY] Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The node MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the device MAY choose to align sample intervals with time of day, but is not required to do so. Changes since 2.14:
|
- |
2.12 |
|
⇒ SNRGroupLength |
unsignedInt(1,2,4,8,16,32,64,128,256) |
W |
[MANDATORY] The number of sub-carriers in a group to be used for averaging SNR values when providing SNR information for a channel. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ Nodes. |
object |
R |
Per-node G.hn performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the "current" interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the "current" interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. Changes since 2.14:
|
- |
2.12 |
|
⇐ CurrentStart |
dateTime |
R |
Start time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago. |
- |
2.12 |
|
⇐ CurrentEnd |
dateTime |
R |
End time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample. |
- |
2.12 |
|
⇐ Nodes.Node.{i}. |
object(1:) |
R |
{{div|{{classes}}|Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses {{param|##.DiagnoseMACAddress}}) and {{param|DestinationMACAddress}}). Note: Packet counters indicate the number of packets received between {{param|#.CurrentStart}} and {{param|#.CurrentEnd}}.}} Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses DiagnoseMACAddress) and DestinationMACAddress). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd. This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for DestinationMACAddress. |
- |
2.12 |
|
⇐ BytesSent |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in {{bibref|G.9960|Clause 5.2.1}}), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in {{bibref|G.9961|Clause 8.1}}). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.}} The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. |
- |
2.12 |
|
⇐ BytesReceived |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.}} The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. |
- |
2.12 |
|
⇐ BlocksErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:
|
- |
2.12 |
|
⇐ Channels. |
object |
R |
{{div|{{classes}}|Per-channel G.hn performance monitoring results. Note: channels are unidirectional.}} Per-channel G.hn performance monitoring results. Note: channels are unidirectional. Changes since 2.14:
|
- |
2.12 |
|
Device.HomePlug. |
object |
R |
HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. |
- |
2.12 |
|
Device.HomePlug.Interface.{i}. |
object(0:) |
R |
HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
Version |
string(:16) |
R |
Indicates the HomePlug version of the interface. This element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example:
|
- |
2.12 |
|
ForceCCo |
boolean |
W |
Central Coordinator (CCo) selection mode. If false, CCo selection is automatic. If true, the local HomePlug interface is forced to be CCo and all other devices in the Logical Network MUST be set to automatic CCo selection. Typically ForceCCo is set to automatic CCo selection (false). The factory default value MUST be false. |
- |
2.12 |
|
OtherNetworksPresent |
string[](:64) |
R |
Comma-separated list (maximum number of characters 64) of strings. Indicates whether any other HomePlug networks are currently visible via this interface. Examples of valid list items include, but are not limited to:
|
- |
2.12 |
|
Device.HomePlug.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.HomePlug.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about other HomePlug devices connected to this HomePlug interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
EndStationMACs |
string(:17)[:16]() |
R |
[MACAddress] {{div|{{classes}}|{{list}} List items represent MAC addresses of end stations bridged by the remote HomePlug device. For example: "11:22:33:AA:BB:CC, 22:33:44:DD:EE:66"}} Comma-separated list (up to 16 items) (length ) of MAC Addresses. List items represent MAC addresses of end stations bridged by the remote HomePlug device. For example: "11:22:33:AA:BB:CC, 22:33:44:DD:EE:66" |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not this device is currently present in the HomePlug network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}} Whether or not this device is currently present in the HomePlug network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.UPA. |
object |
R |
Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. |
- |
2.12 |
|
Device.UPA.Interface.{i}. |
object(0:) |
R |
UPA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a UPA interface [UPA-PLC]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter.}} The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
EncryptionKey |
string(:36) |
W |
{{div|{{classes}}|Encryption key for secure PLC communications. This a human readable string used by the system to generate the encryption key to encrypt communications in powerline. It takes non extended ASCII characters (i.e. printable 7-bit ASCII character codes 32-126, which includes SPACE but excludes TAB, LF and CR). For example: bvjPekZiYUf9kjNKJASkgJ09adfoP01Fjvgd}} Encryption key for secure PLC communications. This a human readable string used by the system to generate the encryption key to encrypt communications in powerline. It takes non extended ASCII characters (i.e. printable 7-bit ASCII character codes 32-126, which includes SPACE but excludes TAB, LF and CR). For example: bvjPekZiYUf9kjNKJASkgJ09adfoP01Fjvgd When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
Device.UPA.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.UPA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about PLC connections running between this UPA interface and other UPA devices. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
LogicalNetwork |
string(:20) |
R |
{{div|{{classes}}|The name of the logical PLC network (human readable string). In the case where the associated device belongs to a different powerline network than the UPA interface, the actual network identifier of the neighboring network is not shown in {{param}}. Rather, only a generic string, e.g. "Network 1", "Network 2", etc is stored here due to security/privacy implications.}} The name of the logical PLC network (human readable string). In the case where the associated device belongs to a different powerline network than the UPA interface, the actual network identifier of the neighboring network is not shown in LogicalNetwork. Rather, only a generic string, e.g. "Network 1", "Network 2", etc is stored here due to security/privacy implications. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not this node is currently present in the UPA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}} Whether or not this node is currently present in the UPA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.UPA.Interface.{i}.ActiveNotch.{i}. |
object(0:) |
W |
This object contains the list of active notches of the UPA interface. A UPA device can have notches in its spectrum, where no power is transmitted in a given part of the spectrum. These notches are typically located in amateur radio bands, to avoid interference. Note: All ActiveNotch entries can be enabled/disabled as a group using the ActiveNotchEnable parameter. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.UPA.Interface.{i}.BridgeFor.{i}. |
object(0:) |
R |
{{div|{{classes}}|This object represents the bridge table of the UPA interface. Each instance is a bridge table entry. It shows the MAC addresses of the remote UPA devices with their associated port number, and the MAC addresses of the end-devices (PCs, STBs, routers, etc) connected to Ethernet port of the powerline adapters with their associated logical port. In this way the system identifies to which UPA device an external device is connected to.}} This object represents the bridge table of the UPA interface. Each instance is a bridge table entry. It shows the MAC addresses of the remote UPA devices with their associated port number, and the MAC addresses of the end-devices (PCs, STBs, routers, etc) connected to Ethernet port of the powerline adapters with their associated logical port. In this way the system identifies to which UPA device an external device is connected to. At most one entry in this table can exist with a given value for Alias, or with a given value for MACAddress. |
- |
2.12 |
|
Device.UPA.Diagnostics. |
object |
R |
The UPA Diagnostics object. |
- |
2.12 |
|
InterfaceMeasurement() |
command |
- |
[ASYNC] {{div|{{classes}}|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 {{param|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).}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Type |
string |
W |
[MANDATORY] Indicates the type of port measurement test to be carried out. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
⇒ Interface |
string(:256) |
W |
[MANDATORY] The value MUST be the Path Name of a row in the UPA.Interface. table. This is the local UPA interface from which the test is to be performed. Changes since 2.14:
|
- |
2.12 |
|
⇒ Port |
unsignedInt(0:65535) |
W |
[MANDATORY] PLC port being measured. This identifies which PLC connection to measure between the local interface (indicated by Interface) and the remote device (implied by Port). Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ Measurements |
unsignedInt[:1536]() |
R |
{{div|{{classes}}|{{list}} Result of Signal-to-Noise-Ratio measurement (if {{param|Type}} is {{enum|SNR|Type}}) or Channel Frequency Response measurement (if {{param|Type}} is {{enum|CFR|Type}}). List items indicate measurements per carrier for a PLC port (expressed in {{units}}).}} |
- |
2.12 |
|
Device.WiFi. |
object |
R |
The WiFi object is based on the WiFi AllianceIEEE 802.11 specifications ([802.11-2020]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). |
- |
2.7 |
|
NeighboringWiFiDiagnostic() |
command |
- |
[ASYNC] This command defines access to other WiFi SSIDs that this device is able to receive. |
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ Result.{i}. |
object(0:) |
R |
Neighboring SSID table. This table models the other WiFi SSIDs that this device is able to receive. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for BSSID. |
- |
2.12 |
|
⇐ SecurityModeEnabled |
string |
R |
The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:
|
- |
2.12 |
|
⇐ EncryptionMode |
string[] |
R |
Comma-separated list of strings. {{div|{{classes}}|The type of encryption the neighboring WiFi SSID advertises. When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list.}} The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.12 |
|
⇐ SupportedStandards |
string[] |
R |
Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Result instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:
|
- |
2.12 |
|
⇐ OperatingStandards |
string[] |
R |
Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this Result. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax are allowed. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used. |
- |
2.12 |
|
⇐ DTIMPeriod |
unsignedInt |
R |
The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] |
- |
2.12 |
|
Reset() |
command |
- |
This parametercommand represents a request to reset or reboot the WiFiWi-Fi sub-system without resetting or rebooting the device. |
- |
2.12 |
|
Device.WiFi.MultiAP. |
object |
R |
{{div|{{classes}}|This object describes a Wi-Fi network containing 1 or more Access Point devices. This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network.}} This object describes a Wi-Fi network containing 1 or more Access Point devices. This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network. This object and all sub-objects have been moved to new objects. This object was DEPRECATED in 2.15 because it has moved to WiFi.DataElements.Network MultiAP objects. :::::::: Changes since 2.14:
|
- |
2.13 |
|
Device.WiFi.DataElements. |
object |
R |
This object represents the Wi-Fi Alliance Data Elements as defined in [DataElements]. with extended capabilities in additional objects whose names begin with MultiAP. Changes since 2.14:
|
- |
2.13 |
|
Device.WiFi.DataElements.Network. |
object |
R |
This object describes a Wi-Fi network containing 1 or more Access Point (AP) devices. Changes since 2.14:
|
- |
2.15 |
|
ID |
string |
R |
A unique identifier for this particular Wi-Fi network. Changes since 2.14:
|
- |
2.15 |
|
TimeStamp |
string |
R |
The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
ControllerID |
string |
R |
A unique identifier for a Multi-AP controller. Changes since 2.14:
|
- |
2.15 |
|
MSCSDisallowedStaList |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. List of STAs for which Mirrored Stream Classification Service (MSCS) operation is disallowed. |
- |
2.15 |
|
SCSDisallowedStaList |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. List of STAs for which Stream Classification Service (SCS) operation is disallowed. |
- |
2.15 |
|
SSIDNumberOfEntries |
unsignedInt |
R |
The number of entries in the SSID table. |
- |
2.15 |
|
SetTrafficSeparation() |
command |
- |
[ASYNC] This command allows or disallows EasyMesh traffic separation [Section 19.1/EasyMesh]. If Enable is true then the parameters defining traffic separation details can also be input with this command. This command applies to all EasyMesh Agent devices in the Wi-Fi network. This command can configure Device.{i}.SSIDtoVIDMapping.{i}. and Device.{i}.TrafficSeparationAllowed. Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Enable |
boolean |
W |
[MANDATORY] : true: EasyMesh traffic separation is allowed.
|
- |
2.15 |
|
⇒ SSIDtoVIDMapping.{i}. |
object(0:) |
W |
The Service Set Identifier (SSID) to VLAN ID (VID) mapping for EasyMesh traffic separation [EasyMesh]. Consists of a table of pairs of SSID and corresponding VID. If this input is not provided, then existing Device.{i}.SSIDtoVIDMapping.{i}. apply. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for SSID. |
- |
2.15 |
|
⇒ SSID |
string |
W |
The SSID name. |
- |
2.15 |
|
⇒ VID |
unsignedInt(:4095) |
W |
The VLAN ID (VID). |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to allow or disallow EasyMesh traffic separation. Enumeration of:
|
- |
2.15 |
|
SetServicePrioritization() |
command |
- |
[ASYNC] This command allows or disallows EasyMesh service prioritization [Section 20/EasyMesh]. If Enable is true then the parameters defining service prioritization details can also be input with this command. This command can configure Device.{i}.SPRule.{i}., Device.{i}.DSCPMap and Device.{i}.ServicePrioritizationAllowed. This command applies to all EasyMesh Agent devices in the Wi-Fi network. Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Enable |
boolean |
W |
[MANDATORY] : true: EasyMesh service prioritization is allowed.
|
- |
2.15 |
|
⇒ DSCPMap |
hexBinary(:64) |
W |
A hexadecimal string of 64 PCP values (one octet per value) corresponding to the DSCP markings 0x00 to 0x3F, ordered by increasing DSCP value. Each octet is in the range 0x00 – 0x07. This is used to select a PCP value if a Service Prioritization Rule specifies Rule Output: 0x08. If this input is not provided, then the existing Device.{i}.DSCPMap applies. |
- |
2.15 |
|
⇒ SPRule.{i}. |
object(0:) |
W |
This object describes a list of service prioritization (SP) rules [EasyMesh]. If this input is not provided, then existing Device.{i}.SPRule.{i}. apply. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for ID. |
- |
2.15 |
|
⇒ ID |
unsignedInt |
W |
Service prioritization rule Identifier. |
- |
2.15 |
|
⇒ Precedence |
unsignedInt(:254) |
W |
Rule Precedence – higher number means higher priority. |
- |
2.15 |
|
⇒ Output |
unsignedInt(:9) |
W |
Rule Output. The value of, or method used to select the 802.1Q C-TAG Priority Code Point (PCP) output value. |
- |
2.15 |
|
⇒ AlwaysMatch |
boolean |
W |
Indicates if the rule always matches. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to allow or disallow EasyMesh service prioritization. Enumeration of:
|
- |
2.15 |
|
SetPreferredBackhauls() |
command |
- |
[ASYNC] This command sets preferred backhaul links for EasyMesh [EasyMesh] backhaul. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ PreferredBackhauls.{i}. |
object(1:) |
W |
Indicates preferred backhaul links for EasyMesh [EasyMesh] backhaul. Consists of a table of pairs of MAC addresses. For a WI-Fi connection pair, an entry contains the BSSID and bSTA MAC address. For a wired connection pair, an entry contains the interface MAC addresses. This command applies to all EasyMesh Agent devices in the Wi-Fi network. Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network. This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for BackhaulMACAddress. |
- |
2.15 |
|
⇒ BackhaulMACAddress |
string(:17) |
W |
[MANDATORY] [MACAddress] The MAC address of the BSS, or similar Ethernet interface, on this preferred backhaul link. |
- |
2.15 |
|
⇒ bSTAMACAddress |
string(:17) |
W |
[MANDATORY] [MACAddress] The MAC address of the backhaul STA (bSTA), or similar Ethernet interface, on this preferred backhaul link. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to set preferred backhaul links. Enumeration of:
|
- |
2.15 |
|
SetSSID() |
command |
- |
[ASYNC] This command specifies an SSID for fronthaul use across this Wi-Fi Multi-AP network, or on this single-AP. Also specifies the PassPhrase, whether to add or remove this SSID, and specifies the Band for each SSID. This command applies to all EasyMesh Agent devices in the Wi-Fi network, or to this AP in the single-AP case. This command can be used to set only PassPhrase if SSID matches an existing SSID.{i}.SSID for this Band for fronthaul use across this Wi-Fi Multi-AP network. This command can configure SSID.{i}. Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ SSID |
string |
W |
[MANDATORY] The SSID for fronthaul use across this Wi-Fi Multi-AP network. |
- |
2.15 |
|
⇒ AddRemove |
string |
W |
[MANDATORY] Indicates whether to add or remove this SSID.
Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network. If set to true, and this SSID already exists for this Band, then there is no change to the SSID, but the PassPhrase is set. |
- |
2.15 |
|
⇒ PassPhrase |
string |
W |
The WPA2 Passphrase and/or SAE password for this SSID. |
- |
2.15 |
|
⇒ Band |
string[] |
W |
Comma-separated list of strings. The band(s) for which this SSID applies. Each list item is an enumeration of:
If this input is not provided, then a value of All applies. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to set the SSID. Enumeration of:
|
- |
2.15 |
|
SetMSCSDisallowed() |
command |
- |
[ASYNC] This command disallows Mirrored Stream Classification Service (MSCS) service prioritization to particular STA(s). [EasyMesh] This command applies to all EasyMesh Agent devices in the Wi-Fi network. This command configures MSCSDisallowedStaList. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ MSCSDisallowedStaList |
string(:17)[] |
W |
[MANDATORY] [MACAddress] Comma-separated list of MAC Addresses. List of STAs for which MSCS operation is disallowed. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to disallow MSCS service prioritization to particular STA(s) Enumeration of:
|
- |
2.15 |
|
SetSCSDisallowed() |
command |
- |
[ASYNC] This command disallows Stream Classification Service (SCS) service prioritization to particular STA(s). [EasyMesh] This command applies to all EasyMesh Agent devices in the Wi-Fi network. This command can configure SCSDisallowedStaList. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ SCSDisallowedStaList |
string(:17)[] |
W |
[MANDATORY] [MACAddress] Comma-separated list of MAC Addresses. List of STAs for which SCS operation is disallowed. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to disallow SCS service prioritization to particular STA(s). Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.SSID.{i}. |
object(0:) |
R |
This object specifies SSIDs for fronthaul use across all agents in this Wi-Fi Multi-AP network, or on this single-AP. Also specifies the Band for each SSID. At most one entry in this table can exist with a given value for SSID. |
- |
2.15 |
|
SSID |
string(:64) |
R |
The SSID for fronthaul use across this Wi-Fi Multi-AP network. This is a non-functional key and its value MUST NOT change once it's been set internally by the Agent. |
- |
2.15 |
|
Band |
string[] |
R |
Comma-separated list of strings. The band(s) (GHz) for which this SSID applies. Each list item is an enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.MultiAPSteeringSummaryStats. |
object |
R |
The summary of statistics related to Multi-AP Steering for the Wi-Fi network. The counters contained in MultiAPSteeringSummaryStats are all reset on reboot. |
- |
2.15 |
|
NoCandidateAPFailures |
unsignedLong |
R |
[StatsCounter64] Number of times Associated Devices should have been steered but weren't because a better candidate AP couldn't be found. |
- |
2.15 |
|
BlacklistAttempts |
unsignedLong |
R |
[StatsCounter64] Number of times a Blacklist steer was attempted. |
- |
2.15 |
|
BlacklistSuccesses |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted Blacklist steer succeeded. |
- |
2.15 |
|
BlacklistFailures |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted Blacklist steer failed. |
- |
2.15 |
|
BTMAttempts |
unsignedLong |
R |
[StatsCounter64] Number of times a BTM (BSS Transition Management; [802.11k]) steer was attempted. |
- |
2.15 |
|
BTMSuccesses |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted BTM (BSS Transition Management; [802.11k]) steer succeeded. |
- |
2.15 |
|
BTMFailures |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted BTM (BSS Transition Management; [802.11k]) steer failed. |
- |
2.15 |
|
BTMQueryResponses |
unsignedLong |
R |
[StatsCounter64] Number of asynchronous BTM (BSS Transition Management; [802.11k]) Queries for which a BTM Request was issued. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}. |
object(1:) |
R |
Each instance of this object represents an individual Access Point device in the Wi-Fi network. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for ID. Changes since 2.14:
|
- |
2.15 |
|
ID |
string(:17) |
R |
[MACAddress] A unique identifier for this particular device within the Wi-Fi network as defined in [Section 3.1/DataElements]. |
- |
2.15 |
|
MultiAPCapabilities |
base64(1) |
R |
The Multi-AP capabilities supported by this device as defined by the APCapability TLV in [Section 17.2.6/EasyMesh]. |
- |
2.15 |
|
ReportUnsuccessfulAssociations |
boolean |
W |
Indicates whether the Multi-AP Agent or the single AP reports unsuccessful association attempts of client Stations (STAs) to the Multi-AP Controller. |
- |
2.15 |
|
MaxReportingRate |
unsignedInt |
R |
Maximum rate for reporting unsuccessful association attempts in attempts per minute. |
- |
2.15 |
|
APMetricsReportingInterval |
unsignedInt(:255) |
W |
AP Metrics Reporting Interval.
|
- |
2.15 |
|
Manufacturer |
string |
R |
Identifier of the manufacturer of the device. |
- |
2.15 |
|
SerialNumber |
string |
R |
Identifier of the particular Access Point device that is unique for the indicated model and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates. |
- |
2.15 |
|
ManufacturerModel |
string |
R |
Identifier of the manufacturer model to help the user more easily identify a particular piece of equipment. |
- |
2.15 |
|
SoftwareVersion |
string |
R |
Identifier of the software version currently installed in the Access Point device (i.e. version of the overall firmware). |
- |
2.15 |
|
ExecutionEnv |
string |
R |
Identifier of the execution environment (operating system) in the device. This parameter can be an entry in the table Device.SoftwareModules.ExecEnv.{i}.. |
- |
2.15 |
|
DSCPMap |
hexBinary(:64) |
R |
A hexadecimal string of 64 Priority Code Point (PCP) values (one octet per value) corresponding to the Differentiated Services Code Point (DSCP) markings 0x00 to 0x3F, ordered by increasing DSCP value. Each octet is in the range 0x00 – 0x07. This is used to select a PCP value if a Service Prioritization Rule specifies Rule Output: 0x08 |
- |
2.15 |
|
MaxPrioritizationRules |
unsignedInt(:255) |
R |
The maximum total number of service prioritization rules supported by the Agent. |
- |
2.15 |
|
PrioritizationSupport |
boolean |
R |
Indicates support for Service Prioritization. |
- |
2.15 |
|
MaxVIDs |
unsignedInt |
R |
Max Total Number of unique VLAN IDs (VIDs) the Multi-AP Agent supports. |
- |
2.15 |
|
APMetricsWiFi6 |
boolean |
R |
Associated Wi-Fi6 STA Status Inclusion Policy.
|
- |
2.15 |
|
CountryCode |
string(2) |
R |
Two-character country code in which the Multi-AP Agent is operating according to [ISO3166-1]. The characters are encoded as UTF-8. |
- |
2.15 |
|
LocalSteeringDisallowedSTAList |
string(:17)[] |
W |
[MACAddress] Comma-separated list of MAC Addresses. The STAs for which local steering is disallowed. |
- |
2.15 |
|
BTMSteeringDisallowedSTAList |
string(:17)[] |
W |
[MACAddress] Comma-separated list of MAC Addresses. The STAs for which BSS Transition Management (BTM) steering is disallowed. |
- |
2.15 |
|
DFSEnable |
boolean |
R |
Indicates if Dynamic Frequency Selection (DFS) is enabled or disabled. |
- |
2.15 |
|
ReportIndependentScans |
boolean |
W |
Channel Scan Reporting Policy, Report Independent Channel Scans
|
- |
2.15 |
|
AssociatedSTAinAPMetricsWiFi6 |
boolean |
W |
For EasyMesh [EasyMesh], this is the Associated Wi-Fi6 STA Status Inclusion Policy.
|
- |
2.15 |
|
MaxUnsuccessfulAssociationReportingRate |
unsignedInt |
W |
For EasyMesh [EasyMesh], this is the maximum rate for reporting unsuccessful association attempts (in attempts per minutes). |
- |
2.15 |
|
STASteeringState |
boolean |
R |
Indicates if EasyMesh [EasyMesh] controller-initiated station steering is disallowed or allowed on this device.
|
- |
2.15 |
|
CoordinatedCACAllowed |
boolean |
W |
Allow or disallow the use of EasyMesh [EasyMesh] Coordinated Channel Availability Check (CAC) on this device.
|
- |
2.15 |
|
TrafficSeparationAllowed |
boolean |
R |
This parameter indicates if EasyMesh traffic separation [Section 19.1/EasyMesh] is allowed or disallowed. |
- |
2.15 |
|
ServicePrioritizationAllowed |
boolean |
R |
This parameter indicates if EasyMesh service prioritization [Section 20/EasyMesh] is allowed or disallowed. |
- |
2.15 |
|
Default8021QNumberOfEntries |
unsignedInt |
R |
The number of entries in the Default8021Q table. |
- |
2.15 |
|
SSIDtoVIDMappingNumberOfEntries |
unsignedInt |
R |
The number of entries in the SSIDtoVIDMapping table. |
- |
2.15 |
|
CACStatusNumberOfEntries |
unsignedInt |
R |
The number of entries in the CACStatus table. |
- |
2.15 |
|
IEEE1905SecurityNumberOfEntries |
unsignedInt |
R |
The number of entries in the IEEE1905Security table. |
- |
2.15 |
|
SPRuleNumberOfEntries |
unsignedInt |
R |
The number of entries in the SPRule table. |
- |
2.15 |
|
AnticipatedChannelsNumberOfEntries |
unsignedInt |
R |
The number of entries in the AnticipatedChannels table. |
- |
2.15 |
|
AnticipatedChannelUsageNumberOfEntries |
unsignedInt |
R |
The number of entries in the AnticipatedChannelUsage table. |
- |
2.15 |
|
SetSTASteeringState() |
command |
- |
[ASYNC] Disallow or allow EasyMesh [EasyMesh] controller-initiated station (STA) steering on this device. This command can configure STASteeringState. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Disallowed |
boolean |
W |
[MANDATORY] : true: EasyMesh controller-initiated station steering disallowed;
|
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to allow or disallow EasyMesh controller-initiated station steering. Enumeration of:
|
- |
2.15 |
|
SetDFSState() |
command |
- |
[ASYNC] Enables/disables the use of Dynamic Frequency Selection (DFS) channels on this device. This command can configure DFSEnable. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DFSEnable |
boolean |
W |
[MANDATORY] : true: the use of Dynamic Frequency Selection (DFS) channels is allowed;
|
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to allow or disallow the use of Dynamic Frequency Selection (DFS) channels. Enumeration of:
|
- |
2.15 |
|
SetAnticipatedChannelPreference() |
command |
- |
[ASYNC] This command requests to set the Anticipated Channel Preference. The operating classes, and list of channels for each operating class, are input. For 2.4GHz and 5GHz bands, only 20MHz operating classes are valid inputs. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ OpClass |
unsignedInt(:255) |
W |
[MANDATORY] The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the operating class identifies the band and channel width. |
- |
2.15 |
|
⇒ ChannelList |
unsignedInt(:255)[] |
W |
[MANDATORY] Comma-separated list of unsigned integers (up to 255). The channel numbers in this Operating Class for which the capability is being described. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to set the anticipated channel preference. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Default8021Q.{i}. |
object(0:) |
W |
The default 802.1Q settings for EasyMesh service prioritization [EasyMesh]. At most one entry in this table can exist with a given value for PrimaryVID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for PrimaryVID such that the new entry does not conflict with any existing entries. |
- |
2.15 |
|
Enable |
boolean |
W |
Enables or disables default 802.1Q settings. |
false |
2.15 |
|
PrimaryVID |
unsignedInt(:4095) |
W |
The primary 802.1Q C-TAG (VLAN ID). If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.15 |
|
DefaultPCP |
unsignedInt(:7) |
W |
The default Priority Code Point (PCP). |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.SSIDtoVIDMapping.{i}. |
object(0:) |
R |
The Service Set Identifier (SSID) to VLAN ID mapping for EasyMesh traffic separation [EasyMesh]. At most one entry in this table can exist with a given value for SSID. |
- |
2.15 |
|
SSID |
string(:64) |
R |
The SSID. |
- |
2.15 |
|
VID |
unsignedInt(:4095) |
R |
The VLAN ID (VID). |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}. |
object(0:) |
R |
Latest Channel Availability Check (CAC) Status Report from the device. At most one entry in this table can exist with a given value for TimeStamp. |
- |
2.15 |
|
TimeStamp |
dateTime |
R |
The time this group was collected. |
- |
2.15 |
|
CACAvailableChannelNumberOfEntries |
unsignedInt |
R |
The number of entries in the CACAvailableChannel table. |
- |
2.15 |
|
CACNonOccupancyChannelNumberOfEntries |
unsignedInt |
R |
The number of entries in the CACNonOccupancyChannel table. |
- |
2.15 |
|
CACActiveChannelNumberOfEntries |
unsignedInt |
R |
The number of entries in the CACActiveChannel table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACAvailableChannel.{i}. |
object(0:) |
R |
This object describes available channels identified by Channel Availability Check (CAC). At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
Operating class of an available channel, from [Table E-4/802.11-2020]. |
- |
2.15 |
|
Channel |
unsignedInt(:255) |
R |
Single channel number of an available channel in the given operating class. |
- |
2.15 |
|
Minutes |
unsignedInt(:65535) |
R |
Minutes since CAC was completed identifying available channel. Equals zero for non-DFS channels. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACNonOccupancyChannel.{i}. |
object(0:) |
R |
This object describes channels identified by Channel Availability Check (CAC) that may not be occupied. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
Operating class of a channel that is in the non-occupancy list, from [Table E-4/802.11-2020]. |
- |
2.15 |
|
Channel |
unsignedInt(:255) |
R |
Single channel number in the operating class on which the radar was detected. |
- |
2.15 |
|
Seconds |
unsignedInt(:65535) |
R |
Seconds remaining in the non-occupancy duration for the channel specified by the operating class and channel pair. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACActiveChannel.{i}. |
object(0:) |
R |
This object describes channels with ongoing Channel Availability Check (CAC). At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
Operating class of a channel that has ongoing CAC, from [Table E-4/802.11-2020]. |
- |
2.15 |
|
Channel |
unsignedInt(:255) |
R |
Single channel number in the operating class that has an ongoing CAC. |
- |
2.15 |
|
Countdown |
unsignedInt |
R |
Seconds remaining to complete the CAC. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.SPRule.{i}. |
object(0:) |
R |
This object describes a list of service prioritization (SP) rules [EasyMesh]. At most one entry in this table can exist with a given value for ID. |
- |
2.15 |
|
ID |
unsignedInt |
R |
Service prioritization rule Identifier. |
- |
2.15 |
|
Precedence |
unsignedInt(:254) |
R |
Rule Precedence – higher number means higher priority. |
- |
2.15 |
|
Output |
unsignedInt(:9) |
R |
Rule Output. The value of, or method used to select, the 802.1Q C-TAG Priority Code Point (PCP) output value. |
- |
2.15 |
|
AlwaysMatch |
boolean |
R |
Indicates if the rule always matches. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.IEEE1905Security.{i}. |
object(0:) |
R |
This object describes the IEEE 1905 security capabilities. At most one entry in this table can exist with a given value for OnboardingProtocol. |
- |
2.15 |
|
OnboardingProtocol |
unsignedInt |
R |
Onboarding protocols supported;
This is a non-functional key and its value MUST NOT change once it's been set internally by the Agent. |
- |
2.15 |
|
IntegrityAlgorithm |
unsignedInt |
R |
Message integrity algorithms supported.
|
- |
2.15 |
|
EncryptionAlgorithm |
unsignedInt |
R |
Message encryption algorithms supported.
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.AnticipatedChannels.{i}. |
object(0:) |
R |
This object contains a table of Wi-Fi 6 [802.11ax] operating classes, and channels within those operating classes, which have anticipated channel preference. Operating Class contains an enumerated value from [Table E-4/802.11-2020]}. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020]. Note that the operating class identifies the band and channel width. This changed from readOnly to readWrite in version 2.15. |
- |
2.15 |
|
ChannelList |
unsignedInt(:255)[] |
R |
Comma-separated list of unsigned integers (up to 255). The channel numbers in this Operating Class. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.AnticipatedChannelUsage.{i}. |
object(0:) |
R |
This object reports Wi-Fi 6 [802.11ax] anticipated medium usage on channels (and subsets of those channels) on which the device is operating. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
The operating class per [Table E-4/802.11-2020]. |
- |
2.15 |
|
Channel |
unsignedInt(:255) |
R |
The channel number in the given operating class of the channel on which the anticipated channel usage is reported. |
- |
2.15 |
|
ReferenceBSSID |
string(:17) |
R |
[MACAddress] Reference BSSID. Start Time values in this object are referenced to the Time Sync Function (TSF) timer value indicated in the Timestamp field in Beacon frames transmitted by this BSSID on the channel. |
- |
2.15 |
|
EntryNumberOfEntries |
unsignedInt |
R |
The number of entries in the Entry table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.AnticipatedChannelUsage.{i}.Entry.{i}. |
object(0:) |
R |
This object reports an entry for anticipated channel usage [802.11ax]. At most one entry in this table can exist with a given value for BurstStartTime. |
- |
2.15 |
|
BurstStartTime |
hexBinary(4) |
R |
Least significant 4 octets of the TSF timer of the Reference BSSID, at the start of the anticipated first burst of channel usage. Note: a burst is a continuous or quasi-continuous period of channel usage. For IEEE 802.11 transmissions, a burst might comprise only one PPDU, or multiple closely spaced PPDUs. |
- |
2.15 |
|
BurstLength |
unsignedInt |
R |
Duration of each burst of channel usage in microseconds. |
- |
2.15 |
|
Repetitions |
unsignedInt |
R |
Number of repetitions of the burst of channel usage;
|
- |
2.15 |
|
BurstInterval |
unsignedInt |
R |
Interval between two successive bursts of channel usage in microseconds; set to zero if Repetitions is zero. |
- |
2.15 |
|
RUBitmask |
hexBinary(2:10) |
R |
Bitmask of 26-tone Resource Units (RUs) defined in [Section 27.3.2.2/802.11ax], where the (i-1)th bit position is set to one if the nominal bandwidth of the channel usage corresponding to this entry fully or partially overlaps with the RUi, and is otherwise set to zero. |
- |
2.15 |
|
TransmitterIdentifier |
string(:17) |
R |
[MACAddress] One of:
|
- |
2.15 |
|
PowerLevel |
int |
R |
Indicates maximum transmit power during each channel usage burst in dBm; equal to 255 when unknown or when the entry corresponds to multiple transmitters with different transmit powers |
- |
2.15 |
|
ChannelUsageReason |
string |
R |
The reason for this anticipated channel usage. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice. |
object |
R |
This object represents an individual Access Point device. |
- |
2.15 |
|
ManufacturerOUI |
string(6) |
R |
Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:
The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates. |
- |
2.15 |
|
LastContactTime |
dateTime |
R |
The last time that the Access Point device was contacted via the Multi-AP control protocol. |
- |
2.15 |
|
AssocIEEE1905DeviceRef |
string |
R |
The value MUST be the Path Name of a row in the IEEE1905.AL.NetworkTopology.IEEE1905Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. AssocIEEE1905DeviceRef is a reference to the IEEE 1905.1 Network Topology Device. Since IEEE 1905.1 is a common protocol used by Multi-AP Controllers for communications, this parameter allows the MultiAP portion of the data model to reference the associated IEEE 1905.1 portion of the data model. |
- |
2.15 |
|
EasyMeshControllerOperationMode |
string |
R |
This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM controller functionality. Enumeration of:
|
- |
2.15 |
|
EasyMeshAgentOperationMode |
string |
R |
This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM agent functionality. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul. |
object |
R |
This object represents an individual Access Point device's Backhaul and unique aspects in the Wi-Fi network. The endpoints of the backhaul interface are represented by the (Device's ID and interface MAC Address). This object represents the upward view of the backhaul interface. The two endpoints of the backhaul interface are - (BackhaulDeviceID, BackhaulMACAddress) of the uplinked Backhaul Device - MACAddress of this Access Point Device BackhaulDeviceID / BackhaulMACAddress <-- LinkType --- < MACAddress an empty string is reserved for the Backhaul instance that represents the Multi-AP Controller. |
- |
2.15 |
|
LinkType |
string |
R |
The medium being used to backhaul this Access Point Device to the Backhaul Access Point Device. The None value is reserved for the Backhaul instance that represents the Multi-AP Controller. Enumeration of:
|
- |
2.15 |
|
BackhaulMACAddress |
string(:17) |
R |
[MACAddress] The MAC Address at the far end of the backhaul link of the interface on the network that is providing a backhaul for this Access Point Device. This along with BackhaulDeviceID, helps to identfy the backhaul interface endpoint. An empty string is reserved for the Backhaul instance that represents the Multi-AP Controller. |
- |
2.15 |
|
BackhaulDeviceID |
string(:17) |
R |
[MACAddress] The Device's ID of the Device on the network that is providing a Backhaul Link for this Access Point Device. |
- |
2.15 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC Address at the near end of the backhaul link of this Access Point Device's backhaul interface that is connecting via LinkType to BackhaulMACAddress of the Backhaul Device identified by BackhaulDeviceID. |
- |
2.15 |
|
CurrentOperatingClassProfileNumberOfEntries |
unsignedInt |
R |
The number of entries in the CurrentOperatingClassProfile table. |
- |
2.15 |
|
SteerWiFiBackhaul() |
command |
- |
[ASYNC] This command requests the Wi-Fi backhaul link to be steered to associate to a different BSS when the device is working as a bridge in a mesh network. The device needs to already have the necessary credentials for the switch to happen. The TargetBSS should be an instance of a Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.BSSID. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ TargetBSS |
string(:17) |
W |
[MANDATORY] [MACAddress] Basic Service Set Identifier (BSSID) of the target BSS which the associated device(s) is to be associated to. |
- |
2.15 |
|
⇒ Channel |
unsignedInt |
W |
The number of the Wi-Fi channel the backhaul BSS is to be associated to. If Channel is not specified, then the radio is to determine which channel to use to associate to the requested SSID. |
- |
2.15 |
|
⇒ TimeOut |
unsignedInt |
W |
[MANDATORY] The maximum timeout for this backhaul steering to occur in milliseconds. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the response to the Wi-Fi backhaul steering request. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.CurrentOperatingClassProfile.{i}. |
object(0:) |
R |
Describes one of the current Operating Classes in use by this Radio. One Opeating Class is indicated for each current Operating Channel Bandwidth. The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel. At most one entry in this table can exist with a given value for Class. |
- |
2.15 |
|
Class |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] that this radio is currently operating on. |
- |
2.15 |
|
Channel |
unsignedInt(:255) |
R |
This Channel number in the Operating Class that this Radio is currently operating on. |
- |
2.15 |
|
TxPower |
int(-127:127) |
R |
Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class. Represented as 2's complement signed integer in units of decibels relative to 1 mW (dBm). |
- |
2.15 |
|
TimeStamp |
dateTime |
R |
The time this group was collected. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.Stats. |
object |
R |
This object represents the statistics of the backhaul interface view from the current Device's ID |
- |
2.15 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted across the backhaul medium (as identified by the value of the LinkType parameter), including framing characters. |
- |
2.15 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received across the backhaul medium (as identified by the value of the LinkType parameter), including framing characters. |
- |
2.15 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted across the backhaul medium (as identified by the value of the LinkType parameter), including framing characters. |
- |
2.15 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received across the backhaul medium (as identified by the value of the LinkType parameter), including framing characters. |
- |
2.15 |
|
ErrorsSent |
unsignedLong |
R |
[StatsCounter64] The total number of outbound packets that could not be transmitted because of errors. |
- |
2.15 |
|
ErrorsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. |
- |
2.15 |
|
LinkUtilization |
unsignedInt(:100) |
R |
Current utilization (expressed in %) of the medium (as identified by the value of the LinkType parameter) being used to backhaul this Access Point device to the Multi-AP Controller. A value of 0 is used for the Stats instance that represents the Access Point on the Multi-AP Controller. |
- |
2.15 |
|
SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength of the backhaul link of the Access Point (AP) to the Multi-AP Controller, measured in dBm. RCPI threshold is encoded per [Table 9-176/802.11-2020]. The value of this parameter is indeterminate if the value of the LinkType parameter is anything other than Wi-Fi. |
- |
2.15 |
|
LastDataDownlinkRate |
unsignedInt |
R |
The data transmit rate in kbps that was most recently used for transmission of data from the access point to the associated device. |
- |
2.15 |
|
LastDataUplinkRate |
unsignedInt |
R |
The data transmit rate in kbps that was most recently used for transmission of data from the associated device to the access point. |
- |
2.15 |
|
TimeStamp |
dateTime |
R |
The time this group was collected. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. |
object(1:) |
R |
This object represents all of the individual Radios contained within the identified Access Point device known to the controller. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for ID. Changes since 2.14:
|
- |
2.15 |
|
ID |
base64(6) |
R |
A unique identifier for this particular Radio within the identified Access Point as defined in [Section 3.1/DataElements]. |
- |
2.15 |
|
Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
Utilization |
unsignedInt(0:255) |
R |
(Total Channel Utililzation) The percentage of time (linearly scaled with 255 representing 100%) that the Access Point device sensed the medium was busy, as indicated by either the physical or virtual carier sense (CS) mechanism. This is essentially the amount of time spent transmiting (both successful and failed transmissions), receiving (both local and non-local transmissions), and processing noise.noise [Section 9.4.2.27/802.11-2020].When more than one channel is in use for the BSS operating on the radio, the Utilization value is calculated only for the primary channel. |
- |
2.15 |
|
Transmit |
unsignedInt(0:255) |
R |
{{div|{{classes}}|(Transmit Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on sending individually or group addressed transmissions (successful and failed). When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel.}} (Transmit Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on sending individually or group addressed transmissions (successful and failed). When more than one channel is in use for the BSS operating on the radio, the Transmit value is calculated only for the primary channel. |
- |
2.15 |
|
ReceiveSelf |
unsignedInt(:255) |
R |
{{div|{{classes}}|(Receive Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed local transmissions (i.e. transmissions from any STA associated with any BSS operating on this radio). When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel.}} (Receive Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed local transmissions (i.e. transmissions from any STA associated with any BSS operating on this radio). When more than one channel is in use for the BSS operating on the radio, the ReceiveSelf value is calculated only for the primary channel. |
- |
2.15 |
|
ReceiveOther |
unsignedInt(0:255) |
R |
{{div|{{classes}}|(Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatin gon this radio). When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel.}} (Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatin gon this radio). When more than one channel is in use for the BSS operating on the radio, the ReceiveOther value is calculated only for the primary channel. |
- |
2.15 |
|
TrafficSeparationCombinedFronthaul |
boolean |
R |
Indicates traffic separation on combined fronthaul and Profile-1 backhaul support [EasyMesh]. |
- |
2.15 |
|
TrafficSeparationCombinedBackhaul |
boolean |
R |
Indicates traffic separation on combined Profile-1 backhaul and Profile-2 backhaul support [EasyMesh]. |
- |
2.15 |
|
SteeringPolicy |
unsignedInt(:2) |
W |
Steering Policy:
|
- |
2.15 |
|
ChannelUtilizationThreshold |
unsignedInt(:255) |
W |
Channel Utilization Threshold (defined per Basic Service Set (BSS) Load element [Section 9.4.2.27/802.11-2020].). |
- |
2.15 |
|
RCPISteeringThreshold |
unsignedInt(:220) |
W |
RCPI Steering Threshold (encoded per [Table 9-176/802.11-2020]). |
- |
2.15 |
|
STAReportingRCPIThreshold |
unsignedInt(:220) |
W |
Station (STA) Metrics Reporting RCPI Threshold.
|
- |
2.15 |
|
STAReportingRCPIHysteresisMarginOverride |
unsignedInt |
W |
STA Metrics Reporting RCPI Hysteresis Margin Override.
|
- |
2.15 |
|
ChannelUtilizationReportingThreshold |
unsignedInt |
W |
AP Metrics Channel Utilization Reporting Threshold.
|
- |
2.15 |
|
AssociatedSTATrafficStatsInclusionPolicy |
boolean |
W |
Associated STA Traffic Stats Inclusion Policy.
|
- |
2.15 |
|
AssociatedSTALinkMetricsInclusionPolicy |
boolean |
W |
Associated STA Link Metrics Inclusion Policy.
|
- |
2.15 |
|
ChipsetVendor |
string |
R |
A string identifying the Wi-Fi chip vendor of this radio in the device. |
- |
2.15 |
|
APMetricsWiFi6 |
boolean |
R |
Associated Wi-Fi6 STA Status Inclusion Policy.
|
- |
2.15 |
|
DisAllowedOpClassChannelsNumberOfEntries |
unsignedInt |
R |
The number of entries in the DisAllowedOpClassChannels table. |
- |
2.15 |
|
ChannelScanRequest() |
command |
- |
[ASYNC] Request to initiate a channel scan. The operating classes, and list of channels for each operating class, are input. For 2.4GHz and 5GHz bands, only 20MHz operating classes are valid inputs. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ OpClass |
unsignedInt(:255) |
W |
[MANDATORY] The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the operating class identifies the band and channel width. |
- |
2.15 |
|
⇒ ChannelList |
unsignedInt(:255)[] |
W |
[MANDATORY] Comma-separated list of unsigned integers (up to 255). The channel numbers in this Operating Class for which the capability is being described. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to initiate a channel scan. Enumeration of:
|
- |
2.15 |
|
RadioEnable() |
command |
- |
[ASYNC] Request to enable or disable this radio. This command can result in updating Enabled. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Enable |
boolean |
W |
[MANDATORY] : true: this radio is to be enabled.
|
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to enable or disable this radio. Enumeration of:
|
- |
2.15 |
|
SetTxPowerLimit() |
command |
- |
[ASYNC] This command sets the upper limit on transmit power TransmitPowerLimit for this radio and OperatingClass. This command can configure CurrentOperatingClassProfile.{i}.TransmitPowerLimit. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ TransmitPowerLimit |
int(-128:127) |
W |
[MANDATORY] This is the upper limit on nominal transmit Equivalent Isotropically Radiated Power (EIRP) that this radio can use for the OperatingClass. In units of decibels relative to 1 mW dBm. |
- |
2.15 |
|
⇒ OperatingClass |
unsignedInt(:255) |
W |
[MANDATORY] The Operating Class per [Table E-4/802.11-2020] of the radio. Note that the Operating Class identifies the band and channel width. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to set a transmit power limit. Enumeration of:
|
- |
2.15 |
|
SetSpatialReuse() |
command |
- |
[ASYNC] This command sets the spatial reuse configuration of this radio. Applies only to Wi-Fi 6 and possibly later generations of radios. Acronyms: Spatial Reuse Group (SRG), Overlapping Basic Service Set (OBSS), Preamble Detection (PD). This command can configure SpatialReuse.. If some input parameter(s) are not provided, then the corresponding existing parameter in SpatialReuse. applies. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ BSSColor |
unsignedInt |
W |
The value of the BSS Color subfield of the HEOperations.BSSColorInformation field being transmitted by BSSs operating on this radio. (EasyMesh TLV Field: BSS Color) |
- |
2.15 |
|
⇒ HESIGASpatialReuseValue15Allowed |
boolean |
W |
Indicates if the Agent is allowed to set HESIGA.SpatialReuse field to value 15 (PSR_AND_NON_SRG_OBSS_PD_PROHIBITED) in HE PPDU transmissions of this radio. (EasyMesh TLV Field: HESIGA_Spatial_reuse_value15_allowed)
|
- |
2.15 |
|
⇒ SRGInformationValid |
boolean |
W |
This field indicates whether the SRG Information fields (SRG OBSS PD Min Offset, SRG OBSS PD Max Offset, SRG BSS Color Bitmap and SRG Partial BSSID Bitmap) in this command are valid. (EasyMesh TLV Field: SRG Information Valid)
|
- |
2.15 |
|
⇒ NonSRGOffsetValid |
boolean |
W |
This field indicates whether the Non-SRG OBSSPD Max Offset field in this command is valid. (EasyMesh TLV Field: Non-SRG Offset Valid)
|
- |
2.15 |
|
⇒ PSRDisallowed |
boolean |
W |
Indicates if the Agent is disallowed to use Parameterized Spatial Reuse (PSR)-based Spatial Reuse for transmissions by the specified radio. (EasyMesh TLV Field: PSR Disallowed)
|
- |
2.15 |
|
⇒ NonSRGOBSSPDMaxOffset |
unsignedInt |
W |
The value of dot11NonSRGAPOBSSPDMaxOffset (i.e the Non-SRG OBSSPD Max Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: Non-SRG OBSSPD Max Offset) This field is valid only if NonSRGOffsetValid is true. |
- |
2.15 |
|
⇒ SRGOBSSPDMinOffset |
unsignedInt |
W |
The value of dot11SRGAPOBSSPDMinOffset (i.e. the SRG OBSSPD Min Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG OBSSPD Min Offset) This field is valid only if SRGInformationValid is true. |
- |
2.15 |
|
⇒ SRGOBSSPDMaxOffset |
unsignedInt |
W |
The value of dot11SRGAPOBSSPDMaxOffset (i.e. the SRG OBSSPD Max Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG OBSSPD Max Offset) This field is valid only if SRGInformationValid is true. |
- |
2.15 |
|
⇒ SRGBSSColorBitmap |
hexBinary(8) |
W |
The value of dot11SRGAPBSSColorBitmap (i.e. the SRG BSS Color Bitmap being used to control the tranmissions of the specified radio). (EasyMesh TLV Field: SRG BSS Color Bitmap) This field is valid only if SRGInformationValid is true. |
- |
2.15 |
|
⇒ SRGPartialBSSIDBitmap |
hexBinary(8) |
W |
The value of dot11SRGAPBSSIDBitmap (i.e. the SRG Partial BSSID Color Bitmap being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG Partial BSSID Bitmap) This field is valid only if SRGInformationValid is true. Note: See rules in section 26.10.2.3 of [17] regarding the members of an SRG. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to set the spatial reuse configuration of this radio. Enumeration of:
|
- |
2.15 |
|
WiFiRestart() |
command |
- |
[ASYNC] Request a restart of the Wi-Fi subsystem. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to restart the Wi-Fi subsystem. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. |
- |
2.14 |
|
TimeStamp |
string |
R |
The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.14 |
|
OperatingClass |
unsignedInt(:255) |
R |
The Operating Class per [802.11-2020]Table E-4 in {{bibref|802.11-2016 of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for Channel. |
- |
2.14 |
|
TimeStamp |
string |
R |
The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.14 |
|
Utilization |
unsignedInt(:255) |
R |
The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.14 |
|
Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for BSSID. |
- |
2.14 |
|
SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per [802.11-2020]Table 9-154 of {{bibref|802.11-20169-176). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.14 |
|
ChannelUtilization |
unsignedInt(:255) |
R |
The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by [802.11-2020]Section 9.4.2.28 in {{bibref|802.11-20169.4.2.27. |
- |
2.14 |
|
StationCount |
unsignedInt |
R |
The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta. |
object |
R |
Contains the MACAddressMedium Access Control (MAC) address of the STA on this radio providing Wi-Fi backhaul to this device. |
- |
2.13 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanCapability. |
object |
R |
This object describes the channel scan capabilities of a radio. |
- |
2.15 |
|
OnBootOnly |
boolean |
R |
“On boot only” flag, Indicates whether the specified radio is capable only of “On boot” scans. |
- |
2.15 |
|
Impact |
unsignedInt(:3) |
R |
Scan Impact of using this radio to perform a scan.
|
- |
2.15 |
|
MinimumInterval |
unsignedInt |
R |
Minimum Scan Interval, the minimum interval in seconds between the start of two consecutive channel scans on this radio. |
- |
2.15 |
|
OpClassChannelsNumberOfEntries |
unsignedInt |
R |
The number of entries in the OpClassChannels table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanCapability.OpClassChannels.{i}. |
object(1:) |
R |
Table of the operating classes (selected from [Table E-4/802.11-2020]) and channel numbers in each operating class that the radio is capable of scanning. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the operating class identifies the band and channel width. |
- |
2.15 |
|
ChannelList |
unsignedInt(:255)[] |
R |
Comma-separated list of unsigned integers (up to 255). The channel numbers in this Operating Class for which the capability is being described. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CACCapability. |
object |
R |
This object describes the Channel Availability Check (CAC) capabilities of a radio. |
- |
2.15 |
|
CACMethodNumberOfEntries |
unsignedInt |
R |
The number of entries in the CACMethod table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CACCapability.CACMethod.{i}. |
object(0:4) |
R |
List of Channel Availability Check (CAC) method information for each type of CAC that the radio can perform. Each type is defined by a method and time to complete. For each type, the classes and channels allowed are enumerated. This table MUST contain at least 0 and at most 4 entries. At most one entry in this table can exist with a given value for Method. |
- |
2.15 |
|
Method |
unsignedInt |
R |
CAC method supported;
|
- |
2.15 |
|
NumberOfSeconds |
unsignedInt |
R |
Number of seconds required to complete this method of CAC. |
- |
2.15 |
|
OpClassChannelsNumberOfEntries |
unsignedInt |
R |
The number of entries in the OpClassChannels table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CACCapability.CACMethod.{i}.OpClassChannels.{i}. |
object(1:) |
R |
Table of the operating classes (selected from [Table E-4/802.11-2020]) and channel numbers in each operating class supported for this method of CAC. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
OpClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the operating class identifies the band and channel width. |
- |
2.15 |
|
ChannelList |
unsignedInt(:255)[] |
R |
Comma-separated list of unsigned integers (up to 255). The channel numbers in this Operating Class for which the capability is being described. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities. |
object |
R |
This object represents the capabilities of the radio which may be different from the current operational configuration. Changes since 2.14:
|
- |
2.13 |
|
HTCapabilities |
base64(1) |
R |
Describes the HT capabilities of the radio as defined by the HTCapabilities TLV [Section 17.2.8/EasyMesh]. |
- |
2.13 |
|
VHTCapabilities |
base64(2:6) |
R |
Describes the VHT capabilities of the radio as defined by the VHTCapabilities TLV [Section 17.2.9/EasyMesh]. |
- |
2.13 |
|
HECapabilities |
base64(4:14) |
R |
Describes the HE capabilities of the radio as defined by the HECapabilities TLV [Section 17.2.10/EasyMesh]. This parameter was DEPRECATED in 2.15 because it is superseded by {{object: non-existent #.WiFi6APRole}} and {{object: non-existent #.WiFi6bSTARole}}. Changes since 2.14:
|
- |
2.13 |
|
AKMFrontHaulNumberOfEntries |
unsignedInt |
R |
The number of entries in the AKMFrontHaul table. |
- |
2.15 |
|
AKMBackhaulNumberOfEntries |
unsignedInt |
R |
The number of entries in the AKMBackhaul table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi6APRole. |
object |
R |
Describes the Wi-Fi 6 capabilities for the AP role. |
- |
2.15 |
|
HE160 |
boolean |
R |
Indicates support for High Efficiency (HE) 160 MHz. |
- |
2.15 |
|
HE8080 |
boolean |
R |
Indicates support for HE 80+80 MHz. |
- |
2.15 |
|
MCSNSS |
base64(4:12) |
R |
Supported High Efficiency-Modulation and Coding Scheme (HE-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-788d/802.11ax] Supported HE-MCS And NSS Set field format. HE-MCS And NSS Set field for 160MHz is present if 160MHz is supported. HE-MCS And NSS Set field for 80+80MHz is present if 80+80MHz is supported. |
- |
2.15 |
|
SUBeamformer |
boolean |
R |
Indicates support for Single-User (SU) Beamformer. |
- |
2.15 |
|
SUBeamformee |
boolean |
R |
Indicates support for SU Beamformee. |
- |
2.15 |
|
MUBeamformer |
boolean |
R |
Indicates support for Multi-User (MU) Beamformer. |
- |
2.15 |
|
Beamformee80orLess |
boolean |
R |
Indicates support for Beamformee Space-Time Stream (STS) ≤ 80 MHz. |
- |
2.15 |
|
BeamformeeAbove80 |
boolean |
R |
Indicates support for Beamformee STS > 80 MHz. |
- |
2.15 |
|
ULMUMIMO |
boolean |
R |
Indicates support for Uplink (UL) Multi-User Multiple Input, Multiple Output (MU-MIMO). |
- |
2.15 |
|
ULOFDMA |
boolean |
R |
Indicates support for UL Orthogonal Frequency Division Multiplexing (OFDMA). |
- |
2.15 |
|
MaxDLMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per DL MU-MIMO Transmitter (TX) in an AP role. |
- |
2.15 |
|
MaxULMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per UL MU-MIMO Receiver (RX) in an AP role. |
- |
2.15 |
|
MaxDLOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per Downlink (DL) OFDMA TX in an AP role. |
- |
2.15 |
|
MaxULOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per UL OFDMA RX in an AP role. |
- |
2.15 |
|
RTS |
boolean |
R |
Indicates support for Request To Send (RTS). |
- |
2.15 |
|
MURTS |
boolean |
R |
Indicates support for MU RTS. |
- |
2.15 |
|
MultiBSSID |
boolean |
R |
Indicates support for Multi-Basic Service Set Identifier (BSSID). |
- |
2.15 |
|
MUEDCA |
boolean |
R |
Indicates support for MU Enhanced distributed channel access (EDCA). |
- |
2.15 |
|
TWTRequestor |
boolean |
R |
Indicates support for Target Wake Time (TWT) Requestor. |
- |
2.15 |
|
TWTResponder |
boolean |
R |
Indicates support for TWT Responder. |
- |
2.15 |
|
SpatialReuse |
boolean |
R |
Indicates support for EasyMesh configuration and reporting of BSS Color and Spatial Reuse. |
- |
2.15 |
|
AnticipatedChannelUsage |
boolean |
R |
Indicates support for Anticipated Channel Usage (ACU) reporting. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi6bSTARole. |
object |
R |
Describes the Wi-Fi 6 capabilities for the backhaul Station (bSTA) role. |
- |
2.15 |
|
HE160 |
boolean |
R |
Indicates support for High Efficiency (HE) 160 MHz. |
- |
2.15 |
|
HE8080 |
boolean |
R |
Indicates support for HE 80+80 MHz. |
- |
2.15 |
|
MCSNSS |
base64(4:12) |
R |
Supported High Efficiency-Modulation and Coding Scheme (HE-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-788d/802.11ax] Supported HE-MCS And NSS Set field format. HE-MCS And NSS Set field for 160MHz is present if 160MHz is supported. HE-MCS And NSS Set field for 80+80MHz is present if 80+80MHz is supported. |
- |
2.15 |
|
SUBeamformer |
boolean |
R |
Indicates support for Single-User (SU) Beamformer. |
- |
2.15 |
|
SUBeamformee |
boolean |
R |
Indicates support for SU Beamformee. |
- |
2.15 |
|
MUBeamformer |
boolean |
R |
Indicates support for Multi-User (MU) Beamformer. |
- |
2.15 |
|
Beamformee80orLess |
boolean |
R |
Indicates support for Beamformee Space-Time Stream (STS) ≤ 80 MHz. |
- |
2.15 |
|
BeamformeeAbove80 |
boolean |
R |
Indicates support for Beamformee STS > 80 MHz. |
- |
2.15 |
|
ULMUMIMO |
boolean |
R |
Indicates support for Uplink (UL) Multi-User Multiple Input, Multiple Output (MU-MIMO). |
- |
2.15 |
|
ULOFDMA |
boolean |
R |
Indicates support for UL Orthogonal Frequency Division Multiplexing (OFDMA). |
- |
2.15 |
|
MaxDLMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per DL MU-MIMO Transmitter (TX) in an AP role. |
- |
2.15 |
|
MaxULMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per UL MU-MIMO Receiver (RX) in an AP role. |
- |
2.15 |
|
MaxDLOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per Downlink (DL) OFDMA TX in an AP role. |
- |
2.15 |
|
MaxULOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per UL OFDMA RX in an AP role. |
- |
2.15 |
|
RTS |
boolean |
R |
Indicates support for Request To Send (RTS). |
- |
2.15 |
|
MURTS |
boolean |
R |
Indicates support for MU RTS. |
- |
2.15 |
|
MultiBSSID |
boolean |
R |
Indicates support for Multi-Basic Service Set Identifier (BSSID). |
- |
2.15 |
|
MUEDCA |
boolean |
R |
Indicates support for MU Enhanced distributed channel access (EDCA). |
- |
2.15 |
|
TWTRequestor |
boolean |
R |
Indicates support for Target Wake Time (TWT) Requestor. |
- |
2.15 |
|
TWTResponder |
boolean |
R |
Indicates support for TWT Responder. |
- |
2.15 |
|
SpatialReuse |
boolean |
R |
Indicates support for EasyMesh configuration and reporting of BSS Color and Spatial Reuse. |
- |
2.15 |
|
AnticipatedChannelUsage |
boolean |
R |
Indicates support for Anticipated Channel Usage (ACU) reporting. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.AKMFrontHaul.{i}. |
object(0:) |
R |
Authentication and Key Management (AKM) Suite (security mode) capabilities for the fronthaul BSS. At most one entry in this table can exist with a given value for OUI. |
- |
2.15 |
|
OUI |
base64 |
R |
Any Organizationally Unique Identifier (OUI) value specified in [Table 9-151/802.11-2020]). |
- |
2.15 |
|
Type |
unsignedInt(:255) |
R |
Any suite type value specified in [Table 9-151/802.11-2020]. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.AKMBackhaul.{i}. |
object(0:) |
R |
Authentication and Key Management (AKM) Suite (security mode) capabilities for the backhaul BSS. At most one entry in this table can exist with a given value for OUI. |
- |
2.15 |
|
OUI |
base64 |
R |
Any Organizationally Unique Identifier (OUI) value specified in [Table 9-151/802.11-2020]). |
- |
2.15 |
|
Type |
unsignedInt(:255) |
R |
Any suite type value specified in [Table 9-151/802.11-2020]. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}. |
object(0:) |
R |
Describes one of the possible Operating Classes supported by this Radio. At most one entry in this table can exist with a given value for Class. |
- |
2.13 |
|
Class |
unsignedInt(:255) |
R |
The Operating Class per [802.11-2020]Table E-4 in {{bibref|802.11-2016 that this radio is capable of operating on. |
- |
2.13 |
|
MaxTxPower |
int(-127:127) |
R |
{{div|{{classes}}|Maximum Transmit Power EIRP that this radio is capable of transmitting in the current regulatory domain for the Operating Class. Represented as 2's complement signed integer in units of decibels relative to 1 mW ({{units}}).}} Maximum Transmit Power EIRP that this radio is capable of transmitting in the current regulatory domain for the Operating Class. Represented as 2's complement signed integer in units of decibels relative to 1 mW (dBm). |
- |
2.13 |
|
NonOperable |
unsignedInt(:255)[] |
R |
{{div|{{classes}}|{{list}} The channel numbers which are statically non-operable in the Operating Class (i.e. the Radio is never able to operate on these channels). Other channels from this Operating Class which are not listed here are supported for the Radio.}} Comma-separated list of unsigned integers (up to 255). The channel numbers which are statically non-operable in the Operating Class (i.e. the Radio is never able to operate on these channels). Other channels from this Operating Class which are not listed here are supported for the Radio. |
- |
2.13 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}. |
object(0:) |
R |
Describes one of the current Operating Classes in use by this Radio. One OpeatingOperating Class is indicated for each current Operating Channel Bandwidth. The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel. At most one entry in this table can exist with a given value for Class. Changes since 2.14:
|
- |
2.13 |
|
Class |
unsignedInt(:255) |
R |
The Operating Class per [802.11-2020]Table E-4 in {{bibref|802.11-2016 that this radio is currently operating on. |
- |
2.13 |
|
TxPower |
int(-127:127) |
R |
{{div|{{classes}}|Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class. Represented as 2's complement signed integer in units of decibels relative to 1 mW ({{units}}).}} Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class. Represented as 2's complement signed integer in units of decibels relative to 1 mW (dBm). |
- |
2.13 |
|
TransmitPowerLimit |
int(-128:127) |
R |
{{div: unexpected argument Class after: [classes()], ['This is the upper limit on nominal transmit Equivalent Isotropically', nl(), 'Radiated Power (EIRP) that this radio is allowed to use for the', nl(), 'current {param']}}. In units of decibels relative to 1 mW dBm.}} |
- |
2.15 |
|
TimeStamp |
string |
R |
The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.13 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.DisAllowedOpClassChannels.{i}. |
object(0:) |
W |
The operating classes, and list of channels for each operating class, which are not allowed to be used on this radio. At most one entry in this table can exist with a given value for OpClass. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for OpClass such that the new entry does not conflict with any existing entries. |
- |
2.15 |
|
Enable |
boolean |
W |
Enables or disables disallowed operating classes and channels. |
false |
2.15 |
|
OpClass |
unsignedInt(:255) |
W |
The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the operating class identifies the band and channel width. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.15 |
|
ChannelList |
unsignedInt(:255)[] |
W |
Comma-separated list of unsigned integers (up to 255). The channel numbers in this Operating Class for which the capability is being described. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.SpatialReuse. |
object |
R |
The spatial reuse configuration of this radio. Applies only to Wi-Fi 6 [802.11ax] and possibly later generations of radios. Acronyms: Spatial Reuse Group (SRG), Overlapping Basic Service Set (OBSS), Preamble Detection (PD). |
- |
2.15 |
|
PartialBSSColor |
unsignedInt |
R |
The value of the Partial Basic Service Set (BSS) Color subfield of the HEOperations.BSSColorInformation field being transmitted by BSSs operating on this radio. (EasyMesh TLV Field: Partial BSS Color) |
- |
2.15 |
|
BSSColor |
unsignedInt |
R |
The value of the BSS Color subfield of the HEOperations.BSSColorInformation field being transmitted by BSSs operating on this radio. (EasyMesh TLV Field: BSS Color) |
- |
2.15 |
|
HESIGASpatialReuseValue15Allowed |
boolean |
R |
Indicates if the Agent is allowed to set HESIGA.SpatialReuse field to value 15 (PSR_AND_NON_SRG_OBSS_PD_PROHIBITED) in HE PPDU transmissions of this radio. (EasyMesh TLV Field: HESIGA_Spatial_reuse_value15_allowed)
|
- |
2.15 |
|
SRGInformationValid |
boolean |
R |
This field indicates whether the SRG Information fields (SRG OBSS PD Min Offset, SRG OBSS PD Max Offset, SRG BSS Color Bitmap and SRG Partial BSSID Bitmap) in this command are valid. (EasyMesh TLV Field: SRG Information Valid)
|
- |
2.15 |
|
NonSRGOffsetValid |
boolean |
R |
This field indicates whether the Non-SRG OBSSPD Max Offset field in this command is valid. (EasyMesh TLV Field: Non-SRG Offset Valid)
|
- |
2.15 |
|
PSRDisallowed |
boolean |
R |
Indicates if the Agent is disallowed to use Parameterized Spatial Reuse (PSR)-based Spatial Reuse for transmissions by the specified radio. (EasyMesh TLV Field: PSR Disallowed)
|
- |
2.15 |
|
NonSRGOBSSPDMaxOffset |
unsignedInt |
R |
The value of dot11NonSRGAPOBSSPDMaxOffset (i.e the Non-SRG OBSSPD Max Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: Non-SRG OBSSPD Max Offset) This field is valid only if NonSRGOffsetValid is true. |
- |
2.15 |
|
SRGOBSSPDMinOffset |
unsignedInt |
R |
The value of dot11SRGAPOBSSPDMinOffset (i.e. the SRG OBSSPD Min Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG OBSSPD Min Offset) This field is valid only if SRGInformationValid is true. |
- |
2.15 |
|
SRGOBSSPDMaxOffset |
unsignedInt |
R |
The value of dot11SRGAPOBSSPDMaxOffset (i.e. the SRG OBSSPD Max Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG OBSSPD Max Offset) This field is valid only if SRGInformationValid is true. |
- |
2.15 |
|
SRGBSSColorBitmap |
hexBinary(8) |
R |
The value of dot11SRGAPBSSColorBitmap (i.e. the SRG BSS Color Bitmap being used to control the tranmissions of the specified radio). (EasyMesh TLV Field: SRG BSS Color Bitmap) This field is valid only if SRGInformationValid is true. |
- |
2.15 |
|
SRGPartialBSSIDBitmap |
hexBinary(8) |
R |
The value of dot11SRGAPBSSIDBitmap (i.e. the SRG Partial BSSID Color Bitmap being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG Partial BSSID Bitmap) This field is valid only if SRGInformationValid is true. Note: See rules in section 26.10.2.3 of [17] regarding the members of an SRG. |
- |
2.15 |
|
NeighborBSSColorInUseBitmap |
hexBinary(8) |
R |
Bitmap of BSS colors of Overlapping BSSs (OBSSs) that the High-Efficiency (HE) AP has identified by itself or via the autonomous BSS Color collision reports received from associated non-AP HE STAs. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. |
object(1:) |
R |
A single logical BSS operating on this radio. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for BSSID. Changes since 2.14:
|
- |
2.15 |
|
TimeStamp |
string |
R |
The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
ByteCounterUnits |
unsignedInt(1:2) |
R |
Byte Counter Units.
|
- |
2.15 |
|
Profile1bSTAsDisallowed |
boolean |
R |
Profile-1 Backhaul STA association disallowed.
|
- |
2.15 |
|
Profile2bSTAsDisallowed |
boolean |
R |
Profile-2 Backhaul STA association disallowed.
|
- |
2.15 |
|
AssociationAllowanceStatus |
unsignedInt(0:1) |
R |
The status of allowance of new client device associations on this BSS.
|
- |
2.15 |
|
EstServiceParametersBE |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=BE, defined per [802.11-2020]Figure 9-588 in {{bibref|802.11-20169-637 and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.15 |
|
EstServiceParametersBK |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=BK, defined per [802.11-2020]Figure 9-588 in {{bibref|802.11-20169-637 and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.15 |
|
EstServiceParametersVI |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=VI, defined per [802.11-2020]Figure 9-588 in {{bibref|802.11-20169-637 and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.15 |
|
EstServiceParametersVO |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=VO, defined per [802.11-2020]Figure 9-588 in {{bibref|802.11-20169-637 and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.15 |
|
BackhaulUse |
boolean |
R |
Indicates that this BSS is in use as a backhaul BSS;
In [EasyMesh] 0 is in use and 1 is not in use. |
- |
2.15 |
|
FronthaulUse |
boolean |
R |
Indicates that this BSS is in use as a fronthaul BSS;
In [EasyMesh] 0 is in use and 1 is not in use. |
- |
2.15 |
|
R1disallowed |
boolean |
R |
Multi-AP Profile-1 [3] (R1) disallowed status.
In [EasyMesh] 0 is allowed and 1 is disallowed. |
- |
2.15 |
|
R2disallowed |
boolean |
R |
Multi-AP Profile-2 [3] (R2) disallowed status.
In [EasyMesh] 0 is allowed and 1 is disallowed. |
- |
2.15 |
|
MultiBSSID |
boolean |
R |
Multiple BSSID Set;
In [EasyMesh], 1 is configured and 0 is not-configured. |
- |
2.15 |
|
TransmittedBSSID |
boolean |
R |
Transmitted BSSID;
In [EasyMesh], 1 is transmitted and 0 is non-transmitted. |
- |
2.15 |
|
FronthaulAKMsAllowed |
string[] |
W |
Comma-separated list of strings. List items indicate Authentication and Key Management (AKM) suites/security modes allowed at this BSS for fronthaul. Each list item is an enumeration of:
|
- |
2.15 |
|
BackhaulAKMsAllowed |
string[] |
W |
Comma-separated list of strings. List items indicate Authentication and Key Management (AKM) suites/security modes allowed at this BSS for backhaul. Each list item is an enumeration of:
|
- |
2.15 |
|
QMDescriptorNumberOfEntries |
unsignedInt |
R |
The number of entries in the QMDescriptor table. |
- |
2.15 |
|
SetQMDescriptors() |
command |
- |
[ASYNC] This command configures each of the descriptor elements for Mirrored Stream Classification Service (MSCS), Stream Classification Service (SCS), or QoS Management. [EasyMesh]. This command can configure QMDescriptor.{i}.. If QMDescriptor.{i}.DescriptorElement is for SCS or MSCS, the AP adds/changes/removes the rule according to the descriptor element request type. If a QMDescriptor.{i}.DescriptorElement is a QoS Management DSCP Policy, the AP sends it to the STA identified by the QMDescriptor.{i}.ClientMAC. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ QMDescriptor.{i}. |
object(1:) |
W |
This object contains a table of DescriptorElement. This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for ClientMAC. |
- |
2.15 |
|
⇒ ClientMAC |
string(:17) |
W |
[MANDATORY] [MACAddress] MAC address of the Station (STA) for which this descriptor applies. |
- |
2.15 |
|
⇒ DescriptorElement |
hexBinary |
W |
[MANDATORY] The descriptor element. One of:
|
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to configure descriptor elements. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.QMDescriptor.{i}. |
object(0:) |
R |
This object contains a table of DescriptorElement. At most one entry in this table can exist with a given value for ClientMAC. |
- |
2.15 |
|
ClientMAC |
string(:17) |
R |
[MACAddress] MAC address of STA for which this descriptor applies. |
- |
2.15 |
|
DescriptorElement |
hexBinary |
R |
The descriptor element. One of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.MultiAPSteering. |
object |
R |
A single logical Access Point operating on this radio. |
- |
2.15 |
|
BlacklistAttempts |
unsignedLong |
R |
[StatsCounter64] Number of times a Blacklist steer was attempted for this Access Point. Blacklist steering is the process of forcing a connected STA to move to another Access Point by temporarily blocking its access to the current Access Point. |
- |
2.15 |
|
BTMAttempts |
unsignedLong |
R |
[StatsCounter64] Number of times a BTM (BSS Transition Management; [802.11k]) steer was attempted for this Access Point. |
- |
2.15 |
|
BTMQueryResponses |
unsignedLong |
R |
[StatsCounter64] Number of asynchronous BTM (BSS Transition Management; [802.11k]) Queries for which a BTM Request was issued by this Access Point. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. |
object(0:) |
R |
Object describing a single Associated Device (STA). At most one entry in this table can exist with a given value for MACAddress. Changes since 2.14:
|
- |
2.13 |
|
TimeStamp |
string |
R |
The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.13 |
|
HECapabilities |
base64(4:14) |
R |
Describes the HE capabilities of the Associated Device (STA). This parameter was DEPRECATED in 2.15 because it is superseded by {{object: non-existent #.WiFi6Capabilities}}. Changes since 2.14:
|
- |
2.13 |
|
ClientCapabilities |
base64 |
R |
The frame body of the most recently received (Re)Association Request frame from this client (STA), as defined in Table 9-34 and Table 9-36 of [802.11-2020] in the order of the underlying referenced standard. |
- |
2.15 |
|
EstMACDataRateDownlink |
unsignedInt |
R |
Estimate of the MAC layer throughput in Mbps achievable in the downlink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/EasyMesh]. |
- |
2.13 |
|
EstMACDataRateUplink |
unsignedInt |
R |
Estimate of the MAC layer throughput in Mbps achievable in the uplink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/EasyMesh]. |
- |
2.13 |
|
SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength of the uplink from the associated STA to the access point - measured in dBm. RCPI threshold (encoded per [802.11-2020]Table 9-154 of {{bibref|802.11-20169-176,}, and described in [Section /EasyMesh]10.3.1 of {{bibref|MAPv1.0). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.13 |
|
MeasurementReport |
base64[] |
R |
Comma-separated list of Base64s. Measurement Report element(s) received from the Associated Device (STA) that constitute the latest Beacon report as defined in [802.11-2020]Figure 9-199 of {{bibref|802.11-20169-230. |
- |
2.13 |
|
CellularDataPreference |
string |
W |
This is the Cellular Data Preference for a Agile Multiband (AMB) capable STA This specifies the use of the cellular data connection. [AMB] Enumeration of:
|
- |
2.15 |
|
ReAssociationDelay |
unsignedInt(:65535) |
W |
Re-association Delay [AMB]. The time, in seconds, after a BTM steer from AP1 to AP2 during which the station cannot go back and re-associate with AP1. |
- |
2.15 |
|
TIDQueueSizesNumberOfEntries |
unsignedInt |
R |
The number of entries in the TIDQueueSizes table. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA. |
object |
R |
The summary of statistics and operations for an individual STA on the Wi-Fi network. The counters contained in MultiAPSTA are all reset on reboot. |
- |
2.15 |
|
AssociationTime |
dateTime |
R |
Date and time in UTC when the device was associated. |
- |
2.15 |
|
Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP). Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
SteeringHistoryNumberOfEntries |
unsignedInt |
R |
The number of entries in the SteeringHistory table. |
- |
2.15 |
|
Disassociate() |
command |
- |
[ASYNC] This command represents a request to disassociate this associated device. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DisassociationTimer |
unsignedInt |
W |
[MANDATORY] The time for which the associated device is to be disassociated in minutes. If set to 0, then the associated device is blocked indefinately. |
- |
2.15 |
|
⇒ ReasonCode |
unsignedInt |
W |
[MANDATORY] The reason code for the request for the associated device to be disassociated, as defined in [Table 9-49/802.11-2020]. |
- |
2.15 |
|
⇒ Silent |
boolean |
W |
An optional input, if true then this is a request for a Silent Disassociate, whereby the AP is to remove the station from its list of associated devices without sending a message to the station. If this input in not provided, then a value of false is assumed. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the response to the request to disassociate an associated device. Enumeration of:
|
- |
2.15 |
|
BTMRequest() |
command |
- |
[ASYNC] This command requests initiation of a BSS Transition Management (BTM) request to influence this client's roaming behavior to another BSS as defined in [Section 9.6.13.9/802.11-2020]. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DisassociationImminent |
boolean |
W |
[MANDATORY] Indicates if the disassociation is imminent, as defined in [Section 9.6.13.9/802.11-2020]. |
- |
2.15 |
|
⇒ DisassociationTimer |
unsignedInt |
W |
[MANDATORY] The number of beacon transmission times until the AP sends a disassociation frame to this station. If DisassociationTimer=0 then DisassociationTimer is not used. |
- |
2.15 |
|
⇒ BSSTerminationDuration |
unsignedInt |
W |
[MANDATORY] The number of minutes for which the BSS is not present. If BSSTerminationDuration=0 or if this input in not provided, then BSSTerminationDuration is not used. |
- |
2.15 |
|
⇒ ValidityInterval |
unsignedInt |
W |
The amount of time in beacon intervals that the BTMRequest() is valid for. If ValidityInterval=0 or if this input in not provided, then ValidityInterval is not used. |
- |
2.15 |
|
⇒ SteeringTimer |
unsignedInt |
W |
The amount of time in beacon intervals that this associated device is not allowed to return to the original BSS. If SteeringTimer=0 or if this input in not provided, then SteeringTimer is not used. |
- |
2.15 |
|
⇒ TargetBSS |
string(:17) |
W |
[MANDATORY] [MACAddress] BSSID of the target BSS which the associated device(s) is to be associated to. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the response to the BSS Transition Management (BTM) request. Enumeration of:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringSummaryStats. |
object |
R |
The summary of statistics related to Multi-AP Steering for this STA on the Wi-Fi network. The counters contained in SteeringSummaryStats are all reset on reboot. |
- |
2.12 |
|
NoCandidateAPFailures |
unsignedLong |
R |
[StatsCounter64] Number of times this Associated Device should have been steered but wasn't because a better candidate AP couldn't be found. |
- |
2.12 |
|
BlacklistAttempts |
unsignedLong |
R |
[StatsCounter64] Number of times a Blacklist steer was attempted on this Associated Device. |
- |
2.12 |
|
BlacklistSuccesses |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted Blacklist steer succeeded for this Associated Device. |
- |
2.12 |
|
BlacklistFailures |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted Blacklist steer failed for this Associated Device. |
- |
2.12 |
|
BTMAttempts |
unsignedLong |
R |
[StatsCounter64] Number of times a BTM (BSS Transition Management; [802.11k]) steer was attempted on this Associated Device. |
- |
2.12 |
|
BTMSuccesses |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted BTM (BSS Transition Management; [802.11k]) steer succeeded for this Associated Device. |
- |
2.12 |
|
BTMFailures |
unsignedLong |
R |
[StatsCounter64] Number of times an attempted BTM (BSS Transition Management; [802.11k]) steer failed for this Associated Device. |
- |
2.12 |
|
BTMQueryResponses |
unsignedLong |
R |
[StatsCounter64] Number of asynchronous BTM (BSS Transition Management; [802.11k]) Queries for which a BTM Request was issued to this Associated Device. |
- |
2.12 |
|
LastSteerTime |
unsignedInt |
R |
The number of seconds since this Associated Device was last attempted to be steered. |
- |
2.12 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringHistory.{i}. |
object(0:) |
R |
The history of Multi-AP Steering for this STA on the Wi-Fi network. The contents of this multi-instance object are reset on reboot. At most one entry in this table can exist with the same values for all of Time, APOrigin and APDestination. |
- |
2.12 |
|
Time |
dateTime |
R |
The date/time when steering was initiated for the Associated Device. |
- |
2.12 |
|
APOrigin |
string |
R |
The BSSID of the Access Point that initiated the steering. |
- |
2.12 |
|
TriggerEvent |
string |
R |
The type of event that caused the steering to be initiaited. Enumeration of:
NOTE: This might be Unknown for BTM Query Response steers. |
- |
2.12 |
|
SteeringApproach |
string |
R |
The type of steering that was attempted. Enumeration of:
|
- |
2.12 |
|
APDestination |
string |
R |
The BSSID of the destination Access Point of a successful steer. A failed steering attempt will leave this parameter an empty string. |
- |
2.12 |
|
SteeringDuration |
unsignedInt |
R |
The amount of time in seconds required for the steer to complete successfully. A failed steering attempt will leave this parameter 0. |
- |
2.12 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.WiFi6Capabilities. |
object |
R |
Describes the Wi-Fi 6 capabilities of the Associated Device (STA). |
- |
2.15 |
|
HE160 |
boolean |
R |
Indicates support for High Efficiency (HE) 160 MHz. |
- |
2.15 |
|
HE8080 |
boolean |
R |
Indicates support for HE 80+80 MHz. |
- |
2.15 |
|
MCSNSS |
base64(4:12) |
R |
Supported High Efficiency-Modulation and Coding Scheme (HE-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-788d/802.11ax] Supported HE-MCS And NSS Set field format. HE-MCS And NSS Set field for 160MHz is present if 160MHz is supported. HE-MCS And NSS Set field for 80+80MHz is present if 80+80MHz is supported. |
- |
2.15 |
|
SUBeamformer |
boolean |
R |
Indicates support for Single-User (SU) Beamformer. |
- |
2.15 |
|
SUBeamformee |
boolean |
R |
Indicates support for SU Beamformee. |
- |
2.15 |
|
MUBeamformer |
boolean |
R |
Indicates support for Multi-User (MU) Beamformer. |
- |
2.15 |
|
Beamformee80orLess |
boolean |
R |
Indicates support for Beamformee Space-Time Stream (STS) ≤ 80 MHz. |
- |
2.15 |
|
BeamformeeAbove80 |
boolean |
R |
Indicates support for Beamformee STS > 80 MHz. |
- |
2.15 |
|
ULMUMIMO |
boolean |
R |
Indicates support for Uplink (UL) Multi-User Multiple Input, Multiple Output (MU-MIMO). |
- |
2.15 |
|
ULOFDMA |
boolean |
R |
Indicates support for UL Orthogonal Frequency Division Multiplexing (OFDMA). |
- |
2.15 |
|
MaxDLMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per DL MU-MIMO Transmitter (TX) in an AP role. |
- |
2.15 |
|
MaxULMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per UL MU-MIMO Receiver (RX) in an AP role. |
- |
2.15 |
|
MaxDLOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per Downlink (DL) OFDMA TX in an AP role. |
- |
2.15 |
|
MaxULOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per UL OFDMA RX in an AP role. |
- |
2.15 |
|
RTS |
boolean |
R |
Indicates support for Request To Send (RTS). |
- |
2.15 |
|
MURTS |
boolean |
R |
Indicates support for MU RTS. |
- |
2.15 |
|
MultiBSSID |
boolean |
R |
Indicates support for Multi-Basic Service Set Identifier (BSSID). |
- |
2.15 |
|
MUEDCA |
boolean |
R |
Indicates support for MU Enhanced distributed channel access (EDCA). |
- |
2.15 |
|
TWTRequestor |
boolean |
R |
Indicates support for Target Wake Time (TWT) Requestor. |
- |
2.15 |
|
TWTResponder |
boolean |
R |
Indicates support for TWT Responder. |
- |
2.15 |
|
SpatialReuse |
boolean |
R |
Indicates support for EasyMesh configuration and reporting of BSS Color and Spatial Reuse. |
- |
2.15 |
|
AnticipatedChannelUsage |
boolean |
R |
Indicates support for Anticipated Channel Usage (ACU) reporting. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.TIDQueueSizes.{i}. |
object(0:) |
R |
Object describing Traffic Identifiers (TIDs), and Queue Size for each TID, for this Associated Device (STA). At most one entry in this table can exist with a given value for TID. |
- |
2.15 |
|
TID |
unsignedInt(:255) |
R |
The TID of the corresponding Queue Size field. |
- |
2.15 |
|
Size |
unsignedInt(:255) |
R |
Queue Size for this TID. Its format is defined in Table 9-10-QoS Control field [802.11-2020]. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.MultiAPRadio. |
object |
R |
This object represents an individual Access Point Radio in the Wi-Fi network. |
- |
2.15 |
|
RadarDetections |
unsignedInt[](:1024) |
R |
Comma-separated list (maximum number of characters 1024) of unsigned integers. List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC). |
- |
2.15 |
|
FullScan() |
command |
- |
[ASYNC] This parameter represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific DwellTime and HomeTime. This command will result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DwellTime |
unsignedInt |
W |
[MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. |
- |
2.15 |
|
⇒ DFSDwellTime |
unsignedInt |
W |
[MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. |
- |
2.15 |
|
⇒ HomeTime |
unsignedInt |
W |
The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. |
- |
2.15 |
|
⇒ SSID |
string |
W |
The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to initiate a full band scan. Enumeration of:
|
- |
2.15 |
|
⇐ ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.15 |
|
⇐ OperatingClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for Channel. |
- |
2.15 |
|
⇐ Channel |
unsignedInt(:255) |
R |
The channel number of the Channel scanned by the Radio given the Operating Class. |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ Utilization |
unsignedInt(:255) |
R |
The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for BSSID. |
- |
2.15 |
|
⇐ BSSID |
string(:17) |
R |
[MACAddress] The BSSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SSID |
string |
R |
The SSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.15 |
|
⇐ ChannelBandwidth |
string |
R |
Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. |
- |
2.15 |
|
⇐ ChannelUtilization |
unsignedInt(:255) |
R |
The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ StationCount |
unsignedInt |
R |
The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ SecurityModeEnabled |
string |
R |
The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:
|
- |
2.15 |
|
⇐ EncryptionMode |
string[] |
R |
Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.15 |
|
⇐ SupportedStandards |
string[] |
R |
Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:
Each value indicates support for the indicated standard. |
- |
2.15 |
|
⇐ OperatingStandards |
string[] |
R |
Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS. Each value indicates support for the indicated standard. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used. |
- |
2.15 |
|
⇐ BasicDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. |
- |
2.15 |
|
⇐ SupportedDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. |
- |
2.15 |
|
⇐ SupportedNSS |
unsignedInt |
R |
The maximum number of spatial streams (NSS) that can be supported. |
- |
2.15 |
|
⇐ DTIMPeriod |
unsignedInt |
R |
The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] |
- |
2.15 |
|
⇐ BeaconPeriod |
unsignedInt |
R |
Time interval (in ms) between transmitting beacons. |
- |
2.15 |
|
ChannelScan() |
command |
- |
[ASYNC] This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific DwellTime. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DwellTime |
unsignedInt |
W |
[MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. |
- |
2.15 |
|
⇒ DFSDwellTime |
unsignedInt |
W |
[MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. |
- |
2.15 |
|
⇒ HomeTime |
unsignedInt |
W |
The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. |
- |
2.15 |
|
⇒ SSID |
string |
W |
The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. |
- |
2.15 |
|
⇒ OpClass.{i}. |
object(0:) |
W |
The Operating Classes for which this channel scan is requested. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇒ OperatingClass |
unsignedInt(:255) |
W |
[MANDATORY] The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. Note that the Operating Class identifies the band and channel width. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. |
- |
2.15 |
|
⇒ OpClass.{i}.Channel.{i}. |
object(0:) |
W |
The Channels for which this channel scan is requested. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇒ Channel |
unsignedInt(:255) |
W |
[MANDATORY] The Channel number of the Channel that is requested to be scanned. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to initiate a channel scan. Enumeration of:
|
- |
2.15 |
|
⇐ ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.15 |
|
⇐ OperatingClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for Channel. |
- |
2.15 |
|
⇐ Channel |
unsignedInt(:255) |
R |
The channel number of the Channel scanned by the Radio given the Operating Class. |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ Utilization |
unsignedInt(:255) |
R |
The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for BSSID. |
- |
2.15 |
|
⇐ BSSID |
string(:17) |
R |
[MACAddress] The BSSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SSID |
string |
R |
The SSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.15 |
|
⇐ ChannelBandwidth |
string |
R |
Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. |
- |
2.15 |
|
⇐ ChannelUtilization |
unsignedInt(:255) |
R |
The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ StationCount |
unsignedInt |
R |
The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ SecurityModeEnabled |
string |
R |
The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:
|
- |
2.15 |
|
⇐ EncryptionMode |
string[] |
R |
Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.15 |
|
⇐ SupportedStandards |
string[] |
R |
Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:
Each value indicates support for the indicated standard. |
- |
2.15 |
|
⇐ OperatingStandards |
string[] |
R |
Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS. Each value indicates support for the indicated standard. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used. |
- |
2.15 |
|
⇐ BasicDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. |
- |
2.15 |
|
⇐ SupportedDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. |
- |
2.15 |
|
⇐ SupportedNSS |
unsignedInt |
R |
The maximum number of spatial streams (NSS) that can be supported. |
- |
2.15 |
|
⇐ DTIMPeriod |
unsignedInt |
R |
The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] |
- |
2.15 |
|
⇐ BeaconPeriod |
unsignedInt |
R |
Time interval (in ms) between transmitting beacons. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}. |
object(0:) |
R |
Each instance represents a Non-AP STA that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.13 |
|
SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RCPI) of the uplink from the Non-AP STA - measured in dBm. (RCPI threshold is encoded per [802.11-2020]Table 9-154 of {{bibref|802.11-20169-176, and described in 103.2[Section/EasyMesh] of {{bibref|MAPv1.010.3.2). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.13 |
|
Device.WiFi.DataElements.AssociationEvent. |
object |
R |
This object contains the events generated when a STA associates to a BSS. Changes since 2.14:
|
- |
2.13 |
|
Associated! |
event |
- |
The event is generated when an Associated Device (STA) associates to a BSS. |
- |
2.15 |
|
⇒ BSSID |
string(:17) |
R |
[MACAddress] The MAC Address of the logical BSS (BSSID) which is reporting the Association Event. |
- |
2.15 |
|
⇒ MACAddress |
string(:17) |
R |
[MACAddress] The MAC Address of the Associated Device (STA). |
- |
2.15 |
|
⇒ StatusCode |
unsignedInt |
R |
The status code sent to the Associated Device (STA) in the Association Response frame as defined by [Table 9-50/802.11-2020]. |
- |
2.15 |
|
⇒ HTCapabilities |
base64(1) |
R |
Describes the HT capabilities of the Associated Device (STA). |
- |
2.15 |
|
⇒ VHTCapabilities |
base64(2:6) |
R |
Describes the VHT capabilities of the Associated Device (STA). |
- |
2.15 |
|
⇒ HECapabilities |
base64(4:14) |
R |
Describes the HE capabilities of the Associated Device (STA). |
- |
2.15 |
|
⇒ TimeStamp |
string |
R |
The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}. |
object(0:) |
R |
The events generated when an Associated Device (STA) associates to a BSS. Changes since 2.14:
|
- |
2.13 |
|
BSSID |
string(:17) |
R |
[MACAddress] The MAC Address of the logical BSS ( BSSID)(BSSID) which is reporting the Association Event. |
- |
2.13 |
|
StatusCode |
unsignedInt |
R |
The status code sent to the Associated Device (STA) in the Association Response frame as defined by [802.11-2020]Table 9-46 in {{bibref|802.11-20169-50. |
- |
2.13 |
|
TimeStamp |
string |
R |
The time this event washappened. collected.Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.13 |
|
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}.WiFi6Capabilities. |
object |
R |
Describes the Wi-Fi 6 capabilities of the Associated Device (STA). |
- |
2.15 |
|
HE160 |
boolean |
R |
Indicates support for High Efficiency (HE) 160 MHz. |
- |
2.15 |
|
HE8080 |
boolean |
R |
Indicates support for HE 80+80 MHz. |
- |
2.15 |
|
MCSNSS |
base64(4:12) |
R |
Supported High Efficiency-Modulation and Coding Scheme (HE-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-788d/802.11ax] Supported HE-MCS And NSS Set field format. HE-MCS And NSS Set field for 160MHz is present if 160MHz is supported. HE-MCS And NSS Set field for 80+80MHz is present if 80+80MHz is supported. |
- |
2.15 |
|
SUBeamformer |
boolean |
R |
Indicates support for Single-User (SU) Beamformer. |
- |
2.15 |
|
SUBeamformee |
boolean |
R |
Indicates support for SU Beamformee. |
- |
2.15 |
|
MUBeamformer |
boolean |
R |
Indicates support for Multi-User (MU) Beamformer. |
- |
2.15 |
|
Beamformee80orLess |
boolean |
R |
Indicates support for Beamformee Space-Time Stream (STS) ≤ 80 MHz. |
- |
2.15 |
|
BeamformeeAbove80 |
boolean |
R |
Indicates support for Beamformee STS > 80 MHz. |
- |
2.15 |
|
ULMUMIMO |
boolean |
R |
Indicates support for Uplink (UL) Multi-User Multiple Input, Multiple Output (MU-MIMO). |
- |
2.15 |
|
ULOFDMA |
boolean |
R |
Indicates support for UL Orthogonal Frequency Division Multiplexing (OFDMA). |
- |
2.15 |
|
MaxDLMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per DL MU-MIMO Transmitter (TX) in an AP role. |
- |
2.15 |
|
MaxULMUMIMO |
unsignedInt(:255) |
R |
Max number of users supported per UL MU-MIMO Receiver (RX) in an AP role. |
- |
2.15 |
|
MaxDLOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per Downlink (DL) OFDMA TX in an AP role. |
- |
2.15 |
|
MaxULOFDMA |
unsignedInt(:255) |
R |
Max number of users supported per UL OFDMA RX in an AP role. |
- |
2.15 |
|
RTS |
boolean |
R |
Indicates support for Request To Send (RTS). |
- |
2.15 |
|
MURTS |
boolean |
R |
Indicates support for MU RTS. |
- |
2.15 |
|
MultiBSSID |
boolean |
R |
Indicates support for Multi-Basic Service Set Identifier (BSSID). |
- |
2.15 |
|
MUEDCA |
boolean |
R |
Indicates support for MU Enhanced distributed channel access (EDCA). |
- |
2.15 |
|
TWTRequestor |
boolean |
R |
Indicates support for Target Wake Time (TWT) Requestor. |
- |
2.15 |
|
TWTResponder |
boolean |
R |
Indicates support for TWT Responder. |
- |
2.15 |
|
SpatialReuse |
boolean |
R |
Indicates support for EasyMesh configuration and reporting of BSS Color and Spatial Reuse. |
- |
2.15 |
|
AnticipatedChannelUsage |
boolean |
R |
Indicates support for Anticipated Channel Usage (ACU) reporting. |
- |
2.15 |
|
Device.WiFi.DataElements.DisassociationEvent. |
object |
R |
This object contains the events generated when an Associated Device (STA) disassociates from a BSS. Changes since 2.14:
|
- |
2.13 |
|
Disassociated! |
event |
- |
The event is generated when an Associated Device (STA) disassociates from a BSS. |
- |
2.15 |
|
⇒ BSSID |
string(:17) |
R |
[MACAddress] The MAC Address of the logical BSS ( BSSID) which is reporting the Disassociation Event. |
- |
2.15 |
|
⇒ MACAddress |
string(:17) |
R |
[MACAddress] The MAC Address of the Associated Device (STA). |
- |
2.15 |
|
⇒ ReasonCode |
unsignedInt |
R |
The Reason Code received by the AP from the Associated Device (STA) in the most recent Disassociation or Deauthentication frame or sent by the AP to the Associated Device (STA) in the most recent Disassociation or Deauthentication frame as defined in [Table 9-49/802.11-2020]. |
- |
2.15 |
|
⇒ BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted to the Associated Device (STA). |
- |
2.15 |
|
⇒ BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received from the Associated Device (STA). |
- |
2.15 |
|
⇒ PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted to the Associated Device (STA). |
- |
2.15 |
|
⇒ PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received from the Associated Device (STA). |
- |
2.15 |
|
⇒ ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets that could not be transmitted to the Associated Device (STA) because of errors. These might be due to the number of retransmissions exceeding the retry limit or from other causes. |
- |
2.15 |
|
⇒ ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets from the Associated Device (STA) that contained errors preventing them from being delivered to a higher-layer protocol. |
- |
2.15 |
|
⇒ RetransCount |
unsignedInt |
R |
[StatsCounter32] The total number of transmitted packets to the Associated Device (STA) which were retransmissions. N retransmissions of the same packet results in this counter incrementing by N. |
- |
2.15 |
|
⇒ TimeStamp |
string |
R |
The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}. |
object(0:) |
R |
The events generated when an Associated Device (STA) disassociates from a BSS. |
- |
2.13 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC addressAddress of the Associated Device (STA). |
- |
2.13 |
|
ReasonCode |
unsignedInt |
R |
The Reason Code received by the AP from the Associated Device (STA) in the most recent Disassociation or Deauthentication frame or sent by the AP to the Associated Device (STA) in the most recent Disassociation or DeauthenticaitonDeauthentication frame as defined in [802.11-2020]Table 9-45 in {{bibref|802.11-20169-49. |
- |
2.13 |
|
RetransCount |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of transmitted packets to the Associated Device (STA) which were retransmissions. N retransmissions of the same packet results in this counter incrementing by N.}} The total number of transmitted packets to the Associated Device (STA) which were retransmissions. N retransmissions of the same packet results in this counter incrementing by N. |
- |
2.13 |
|
TimeStamp |
string |
R |
The time this event washappened. collected.Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.13 |
|
Device.WiFi.DataElements.FailedConnectionEvent. |
object |
R |
This object contains the events generated when a Station (STA) fails to connect to a Basic Service Set (BSS). |
- |
2.15 |
|
FailedConnectionEventDataNumberOfEntries |
unsignedInt |
R |
The number of entries in the FailedConnectionEventData table. |
- |
2.15 |
|
FailedConnection! |
event |
- |
The event is generated when an Associated Device (STA) fails to connect to a BSS. |
- |
2.15 |
|
⇒ MACAddress |
string(:17) |
R |
[MACAddress] STA MAC Address identifying the client that has attempted to connect. |
- |
2.15 |
|
⇒ StatusCode |
unsignedInt |
R |
Status Code set to a non-zero value that indicates the reason for association or authentication failure as defined in [Table 9-50/802.11-2020], or Status Code set to zero and ReasonCode provided. |
- |
2.15 |
|
⇒ ReasonCode |
unsignedInt |
R |
Reason Code indicating the reason the STA was disassociated or deauthenticated as defined in [Table 9-49/802.11-2020]. |
- |
2.15 |
|
⇒ TimeStamp |
string |
R |
The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
Device.WiFi.DataElements.FailedConnectionEvent.FailedConnectionEventData.{i}. |
object(0:) |
R |
This object describes the data provided with a failed connection event |
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] STA MAC Address identifying the client that has attempted to connect. |
- |
2.12 |
|
StatusCode |
unsignedInt |
R |
Status Code set to a non-zero value that indicates the reason for association or authentication failure as defined in [Table 9-50/802.11-2020], or Status Code set to zero and ReasonCode provided. |
- |
2.12 |
|
ReasonCode |
unsignedInt |
R |
Reason Code indicating the reason the STA was disassociated or deauthenticated as defined in [Table 9-49/802.11-2020]. |
- |
2.12 |
|
TimeStamp |
string |
R |
The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.12 |
|
Device.WiFi.Radio.{i}. |
object(0:) |
R |
This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]). If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information. Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.14:
|
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the radio. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the radio. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the radio (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Radio is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
An interface might have some SSIDs pointing towards the Internet and other SSIDs pointing towards End Devices. This is indicated by the associated SSID.{i}.Upstream parameters. This interface's Upstream parameter is set to true if any of the associated SSID.{i}.Upstream parameters are true, and is set to false otherwise.This parameter was DEPRECATED becausein it2.12 gives(and a wrong indication for multiple SSIDs. Use the {{param|#.SSID.{i}.Upstream}} parameter instead. This parameter isthen OBSOLETED in 2.14.2.14) because it couldn't describe all multi-SSID use cases. It has now been restored, and its multi-SSID behavior has been clarified. Changes since 2.14:
|
- |
2.12 |
|
OperatingFrequencyBand |
string |
W |
The value MUST be a member of the list reported by the SupportedFrequencyBands parameter. {{div|{{classes}}|Indicates the frequency band at which the radio is operating. If the radio supports multiple bands, and {{param}} is changed, then all parameters whose value is not valid for the new frequency band (e.g. {{param|Channel}}) MUST be set to a valid value (according to some CPE vendor-specific behavior).}} Indicates the frequency band at which the radio is operating. If the radio supports multiple bands, and OperatingFrequencyBand is changed, then all parameters whose value is not valid for the new frequency band (e.g. Channel) MUST be set to a valid value (according to some CPE vendor-specific behavior). |
- |
2.12 |
|
SupportedStandards |
string[] |
R |
Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Radio instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:
|
- |
2.12 |
|
OperatingStandards |
string[] |
W |
Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax are allowed. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used. |
- |
2.12 |
|
PossibleChannels |
string[](:1024) |
R |
Comma-separated list (maximum number of characters 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n, ac, ax) and the regulatory domain. Ranges in the form "n-m" are permitted. For example, for 802.11b and North America, would be "1-11". |
- |
2.12 |
|
ChannelsInUse |
string[](:1024) |
R |
{{div|{{classes}}|{{list}} List items represent channels that the radio determines to be currently in use (including any that it is using itself). Ranges in the form "n-m" are permitted.}} Comma-separated list (maximum number of characters 1024) of strings. List items represent channels that the radio determines to be currently in use (including any that it is using itself). Ranges in the form "n-m" are permitted. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Channel |
unsignedInt(1:255) |
W |
The current radio channel used by the connection. To request automatic channel selection, set AutoChannelEnable to true. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. For channels in "wide mode" (802.11n where a 40MHz channel bandwidth is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through ExtensionChannel. Note: Valid Channel values depend on the OperatingFrequencyBand value specified and the RegulatoryDomain. |
- |
2.12 |
|
AutoChannelEnable |
boolean |
W |
Enable or disable automatic channel selection. Set to false to disable the automatic channel selection procedure, in which case the currently selected channel remains selected. Set to true to enable the automatic channel selection procedure. This procedure MUST automatically select the channel, and MAY also change it subsequently. AutoChannelEnable MUST automatically change to false whenever the channel is manually selected, i.e. whenever the Channel parameter is written. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. |
- |
2.12 |
|
AutoChannelRefreshPeriod |
unsignedInt |
W |
{{div|{{classes}}|The time period in {{units}} between two consecutive automatic channel selections. A value of 0 means that the automatic channel selection is done only at boot time. This parameter is significant only if {{param|AutoChannelEnable}} is set to {{true}}.}} The time period in seconds between two consecutive automatic channel selections. A value of 0 means that the automatic channel selection is done only at boot time. This parameter is significant only if AutoChannelEnable is set to true. |
- |
2.12 |
|
CenterFrequencySegement0 |
unsignedInt |
W |
When operating in 80+80MHz, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. This parameter is DEPRECATED in **{{deprecated: missing reason argument}}2.14{{replaced: unexpected argument [] after: , []}}**due to a typo. Use {{param|CenterFrequencySegement0CenterFrequencySegment0}} instead.instead |
- |
2.13 |
|
CenterFrequencySegement1 |
unsignedInt |
W |
When operating in 80+80MHz, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. This parameter is DEPRECATED in **{{deprecated: missing reason argument}}2.14{{replaced: unexpected argument [] after: , []}}**due to a typo. Use {{param|CenterFrequencySegement1CenterFrequencySegment1}} instead.instead |
- |
2.13 |
|
TransmitPowerSupported |
int(-1:100)[](:64) |
R |
{{div|{{classes}}|{{list}} List items represent supported transmit power levels as {{units}} of full power. For example, "0,25,50,75,100". A -1 item indicates auto mode (automatic decision by CPE). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE.}} Comma-separated list (maximum number of characters 64) of integers (-1 to 100). List items represent supported transmit power levels as percentage of full power. For example, "0,25,50,75,100". A -1 item indicates auto mode (automatic decision by CPE). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE. |
- |
2.12 |
|
CCAReport |
hexBinary(12) |
R |
The clear channel assessment (CCA) report in the format specified in [Clause 8.4.2.24.3/802.11-2012]. When read, the value of this parameter MUST correspond to CCARequest. How this is achieved is a local matter to the CPE. If this parameter is read before a CCARequest has been issued, then its value is an empty string. |
- |
2.12 |
|
DTIMPeriod |
unsignedInt |
W |
This specifies the number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM Count field is 0. This parameter is based on dot11DTIMPeriod from [802.11-2020]. |
- |
2.12 |
|
EnableRRM |
boolean |
W |
Enables or disables 802.11k [802.11k] Radio Resource Management (RRM). |
- |
2.14 |
|
ManagementPacketRate |
unsignedInt |
W |
The rate of Wi-Fi management frames (expressed in kbps). |
- |
2.15 |
|
RemoteMeasurementRequest() |
command |
- |
[ASYNC] This command requests initiation of a Remote Measurement request to retrieve measurement data from a BSS on this radio. Upon receipt of this request, this radio is to initiate a measurement of the output SignalStrength and Noise for the indicated input. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ TargetBSS |
string(:17) |
W |
[MANDATORY] [MACAddress] The BSSID of the remote BSS. |
- |
2.15 |
|
⇒ Timeout |
unsignedInt |
W |
[MANDATORY] The duration after which the request is timed out in seconds. |
- |
2.15 |
|
⇒ OperatingClass |
unsignedInt(:255) |
W |
[MANDATORY] The Operating Class in [Table E-4/802.11-2020] for which the measurement is requested. |
- |
2.15 |
|
⇒ Channel |
unsignedInt |
W |
[MANDATORY] The number of the channel for which the measurement is requested. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ SignalStrength |
unsignedInt(:255) |
R |
The received signal strength (RSSI) as received by the radio measured in dBm. RSSI is encoded as per [Table 9-176/802.11-2020]. Reserved: 221 - 255. |
- |
2.15 |
|
⇐ Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power as received by the radio. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
⇐ Status |
string |
R |
Indicates the response to the Remote Measurement request. Enumeration of:
|
- |
2.15 |
|
InitiateCCAMeasurement() |
command |
- |
[ASYNC] This command represents a request to initiate a Clear Channel Assessment (CCA) measurement scan on this radio on the given channel using a specific DwellTime. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Channel |
unsignedInt |
W |
[MANDATORY] The number of the Wi-Fi channel the clear channel assessment (CCA) measurement is run on. |
- |
2.15 |
|
⇒ DwellTime |
unsignedInt |
W |
[MANDATORY] The duration of the CCA measurement in milliseconds. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ CCAReport |
hexBinary(12) |
R |
The clear channel assessment (CCA) report in the format specified in [Section 9.4.2.21.3/802.11-2020]. When read, the value of this parameter MUST correspond to Channel. How this is achieved is a local matter to the CPE. |
- |
2.15 |
|
⇐ Status |
string |
R |
Indicates the response to the request to initiate a Clear Channel Assessment (CCA) measurement. Enumeration of:
|
- |
2.15 |
|
FullScan() |
command |
- |
[ASYNC] This parameter represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific DwellTime and HomeTime. This command will result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DwellTime |
unsignedInt |
W |
[MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. |
- |
2.15 |
|
⇒ DFSDwellTime |
unsignedInt |
W |
[MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. |
- |
2.15 |
|
⇒ HomeTime |
unsignedInt |
W |
The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. |
- |
2.15 |
|
⇒ SSID |
string |
W |
The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to initiate a full band scan. Enumeration of:
|
- |
2.15 |
|
⇐ ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.15 |
|
⇐ OperatingClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for Channel. |
- |
2.15 |
|
⇐ Channel |
unsignedInt(:255) |
R |
The channel number of the Channel scanned by the Radio given the Operating Class. |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ Utilization |
unsignedInt(:255) |
R |
The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for BSSID. |
- |
2.15 |
|
⇐ BSSID |
string(:17) |
R |
[MACAddress] The BSSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SSID |
string |
R |
The SSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.15 |
|
⇐ ChannelBandwidth |
string |
R |
Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. |
- |
2.15 |
|
⇐ ChannelUtilization |
unsignedInt(:255) |
R |
The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ StationCount |
unsignedInt |
R |
The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ SecurityModeEnabled |
string |
R |
The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:
|
- |
2.15 |
|
⇐ EncryptionMode |
string[] |
R |
Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.15 |
|
⇐ SupportedStandards |
string[] |
R |
Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:
Each value indicates support for the indicated standard. |
- |
2.15 |
|
⇐ OperatingStandards |
string[] |
R |
Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS. Each value indicates support for the indicated standard. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used. |
- |
2.15 |
|
⇐ BasicDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. |
- |
2.15 |
|
⇐ SupportedDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. |
- |
2.15 |
|
⇐ SupportedNSS |
unsignedInt |
R |
The maximum number of spatial streams (NSS) that can be supported. |
- |
2.15 |
|
⇐ DTIMPeriod |
unsignedInt |
R |
The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] |
- |
2.15 |
|
⇐ BeaconPeriod |
unsignedInt |
R |
Time interval (in ms) between transmitting beacons. |
- |
2.15 |
|
ChannelScan() |
command |
- |
[ASYNC] This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific DwellTime. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ DwellTime |
unsignedInt |
W |
[MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. |
- |
2.15 |
|
⇒ DFSDwellTime |
unsignedInt |
W |
[MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. |
- |
2.15 |
|
⇒ HomeTime |
unsignedInt |
W |
The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. |
- |
2.15 |
|
⇒ SSID |
string |
W |
The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. |
- |
2.15 |
|
⇒ OpClass.{i}. |
object(0:) |
W |
The Operating Classes for which this channel scan is requested. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇒ OperatingClass |
unsignedInt(:255) |
W |
[MANDATORY] The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. Note that the Operating Class identifies the band and channel width. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. |
- |
2.15 |
|
⇒ OpClass.{i}.Channel.{i}. |
object(0:) |
W |
The Channels for which this channel scan is requested. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇒ Channel |
unsignedInt(:255) |
W |
[MANDATORY] The Channel number of the Channel that is requested to be scanned. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the type of outcome of the request to initiate a channel scan. Enumeration of:
|
- |
2.15 |
|
⇐ ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.15 |
|
⇐ OperatingClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for Channel. |
- |
2.15 |
|
⇐ Channel |
unsignedInt(:255) |
R |
The channel number of the Channel scanned by the Radio given the Operating Class. |
- |
2.15 |
|
⇐ TimeStamp |
string |
R |
The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.15 |
|
⇐ Utilization |
unsignedInt(:255) |
R |
The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured for the primary operating channel. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. |
- |
2.15 |
|
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). At most one entry in this table can exist with a given value for BSSID. |
- |
2.15 |
|
⇐ BSSID |
string(:17) |
R |
[MACAddress] The BSSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SSID |
string |
R |
The SSID indicated by the neighboring BSS. |
- |
2.15 |
|
⇐ SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). Reserved: 221 - 255. NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. |
- |
2.15 |
|
⇐ ChannelBandwidth |
string |
R |
Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. |
- |
2.15 |
|
⇐ ChannelUtilization |
unsignedInt(:255) |
R |
The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ StationCount |
unsignedInt |
R |
The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.27/802.11-2020]. |
- |
2.15 |
|
⇐ SecurityModeEnabled |
string |
R |
The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:
|
- |
2.15 |
|
⇐ EncryptionMode |
string[] |
R |
Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.15 |
|
⇐ SupportedStandards |
string[] |
R |
Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:
Each value indicates support for the indicated standard. |
- |
2.15 |
|
⇐ OperatingStandards |
string[] |
R |
Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS. Each value indicates support for the indicated standard. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used. |
- |
2.15 |
|
⇐ BasicDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. |
- |
2.15 |
|
⇐ SupportedDataTransferRates |
string[](:256) |
R |
Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. |
- |
2.15 |
|
⇐ SupportedNSS |
unsignedInt |
R |
The maximum number of spatial streams (NSS) that can be supported. |
- |
2.15 |
|
⇐ DTIMPeriod |
unsignedInt |
R |
The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] |
- |
2.15 |
|
⇐ BeaconPeriod |
unsignedInt |
R |
Time interval (in ms) between transmitting beacons. |
- |
2.15 |
|
Device.WiFi.SSID.{i}. |
object(0:) |
W |
{{div|{{classes}}|WiFi SSID table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a {{object|#.Radio}} object. WiFi SSID is also a multiplexing layer, i.e. more than one {{object}} can be stacked above a single {{object|#.Radio}}.}} WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object. WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio. At most one entry in this table can exist with a given value for Alias, or with a given value for Name, or with a given value for BSSID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Name and BSSID such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the SSID entry. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the SSID entry. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the SSID entry (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
BSSID |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|The Basic Service Set ID. This is the MAC address of the access point, which can either be local (when this instance models an access point SSID) or remote (when this instance models an end point SSID).}} The Basic Service Set ID. This is the MAC address of the access point, which can either be local (when this instance models an access point SSID) or remote (when this instance models an end point SSID). The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC address of this interface. If this instance models an access point SSID, MACAddress is the same as BSSID. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. |
- |
2.12 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
See Radio.{i}.Upstream parameter.for Ifdetails bothof exist,how the parametertwo {{param|#.Radio.{i}.Upstream}}Upstream isparameters ignored.interact. |
- |
2.12 |
|
Device.WiFi.AccessPoint.{i}. |
object(0:) |
W |
This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter. For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row. At most one entry in this table can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of this access point. Enumeration of:
|
Disabled |
2.12 |
|
RetryLimit |
unsignedInt(0:7) |
W |
The maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit. This parameter was DEPRECATED This parameter was DEPRECATED in 2.11.because it is really a {{object|AccessPoint#.Radio}} attribute. Use {{param|RetryLimit#.Radio.{i}.RetryLimit}}. This parameter is OBSOLETED in 2.14. This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
WMMCapability |
boolean |
R |
Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC).(AC) [WMM]. |
- |
2.12 |
|
UAPSDCapability |
boolean |
R |
{{div|{{classes}}|Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies WMM support.}} Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies WMM support. |
- |
2.12 |
|
UAPSDEnable |
boolean |
W |
{{div|{{classes}}|Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. Note: U-APSD can only be enabled if WMM is also enabled.}} Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. Note: U-APSD can only be enabled if WMM is also enabled. |
- |
2.12 |
|
MaxAssociatedDevices |
unsignedInt |
W |
The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. This parameter has been DEPRECATED This parameter was DEPRECATED in 2.13.in favor of {{param|MaxAssociatedDevicesMaxAllowedAssociations}}. This parameter is OBSOLETED in 2.14. This parameter was OBSOLETED in 2.14-2.15. |
0 |
2.12 |
|
IsolationEnable |
boolean |
W |
{{div|{{classes}}|Enables or disables device isolation. A value of {{true}} means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot).}} Enables or disables device isolation. A value of true means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot). |
- |
2.12 |
|
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 |
R |
This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. |
- |
2.12 |
|
ModesSupported |
string[] |
R |
Comma-separated list of strings. Indicates which security modes this AccessPoint instance is capable of supporting. The WPA3-Personal value is the same as WPA3-SAE. The WPA3-Personal-Transition value is the same as WPA2-PSK-WPA3-SAE. Each list item is an enumeration of:
|
- |
2.12 |
|
EncryptionMode |
string[] |
W |
Comma-separated list of strings. {{div|{{classes}}|The type of encryption in use. When {{param|ModeEnabled}} is one of {{enum|WPA3-Personal|ModesSupported}}, {{enum|WPA3-Personal-Transition|ModesSupported}}, or {{enum|WPA3-Enterprise|ModesSupported}}, {{enum|TKIP}} is not valid, and should not be in the list.}} The type of encryption in use. When ModeEnabled is one of WPA3-Personal, WPA3-Personal-Transition, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.14 |
|
WEPKey |
hexBinary(5,13) |
W |
A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
|
hexBinary(:32) |
W |
A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The Controller SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
KeyPassphrase |
string(8:63) |
W |
{{div|{{classes}}|A passphrase from which the {{param|PreSharedKey}} is to be generated, for {{enum|WPA-Personal|ModeEnabled}} or {{enum|WPA2-Personal|ModeEnabled}} or {{enum|WPA-WPA2-Personal|ModeEnabled}} security modes. If {{param}} is written, then {{param|PreSharedKey}} for WPA2 is immediately generated. The Controller SHOULD NOT set both the {{param}} and the {{param|PreSharedKey}} directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 ({{bibref|RFC2898}}).}} A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey for WPA2 is immediately generated. The Controller SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 ([RFC2898]). When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
RekeyingInterval |
unsignedInt |
W |
{{div|{{classes}}|The interval (expressed in {{units}}) in which the keys are re-generated. This is applicable to WPA, WPA2 and Mixed (WPA-WPA2) modes in Personal or Enterprise mode (i.e. when {{param|ModeEnabled}} is set to a value other than {{enum|None|ModeEnabled}} or {{enum|WEP-64|ModeEnabled}} or {{enum|WEP-128|ModeEnabled}}.}} The interval (expressed in seconds) in which the keys are re-generated. This is applicable to WPA, WPA2 and Mixed (WPA-WPA2) modes in Personal or Enterprise mode (i.e. when ModeEnabled is set to a value other than None or WEP-64 or WEP-128. |
3600 |
2.12 |
|
SAEPassphrase |
string |
W |
{{div|{{classes}}|A passphrase for {{enum|WPA3-Personal|ModeEnabled}} or {{enum|WPA3-Personal-Transition|ModeEnabled}} security modes. NOTE: this parameter is for WPA3. WPA2 {{param|PreSharedKey}} is generated from {{param|KeyPassphrase}}.}} A passphrase for WPA3-Personal or WPA3-Personal-Transition security modes. NOTE: this parameter is for WPA3. WPA2 PreSharedKey is generated from KeyPassphrase. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.13 |
|
SecondaryRadiusServerIPAddr |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|The IP Address of a secondary RADIUS server used for WLAN security. {{param}} is only applicable when {{param|ModeEnabled}} is an Enterprise type (i.e. {{enum|WPA-Enterprise|ModeEnabled}}, {{enum|WPA2-Enterprise|ModeEnabled}}, {{enum|WPA3-Enterprise|ModeEnabled}}, or {{enum|WPA-WPA2-Enterprise|ModeEnabled}}). The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion {{bibref|RFC2865}}.}} The IP Address of a secondary RADIUS server used for WLAN security. SecondaryRadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion [RFC2865]. |
- |
2.12 |
|
SecondaryRadiusServerPort |
unsignedInt |
W |
{{div|{{classes}}|The port number of the secondary RADIUS server used for WLAN security. {{param}} is only applicable when {{param|ModeEnabled}} is an Enterprise type (i.e. {{enum|WPA-Enterprise|ModeEnabled}}, {{enum|WPA2-Enterprise|ModeEnabled}}, {{enum|WPA3-Enterprise|ModeEnabled}}, or {{enum|WPA-WPA2-Enterprise|ModeEnabled}}). If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server.}} The port number of the secondary RADIUS server used for WLAN security. SecondaryRadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server. |
1812 |
2.12 |
|
SecondaryRadiusSecret |
string |
W |
{{div|{{classes}}|The secret used for handshaking with the secondary RADIUS server {{bibref|RFC2865}}. If this parameter is not implemented, the secondary RADIUS server will use the same secret as the primary RADIUS server.}} The secret used for handshaking with the secondary RADIUS server [RFC2865]. If this parameter is not implemented, the secondary RADIUS server will use the same secret as the primary RADIUS server. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
Reset() |
command |
- |
{{div|{{classes}}|Reset this {{object|#}} instance's WiFi security settings to their factory default values. The affected settings include {{param|ModeEnabled}}, {{param|WEPKey}}, {{param|PreSharedKey}}, {{param|KeyPassphrase}}, {{param|SAEPassphrase}}, and {{param|#.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 {{param|ModeEnabled}} is an Enterprise type, i.e. {{enum|WPA-Enterprise|ModesSupported}}, {{enum|WPA2-Enterprise|ModesSupported}}, {{enum|WPA3-Enterprise|ModesSupported}}, or {{enum|WPA-WPA2-Enterprise|ModesSupported}}.}} Reset this Security instance's WiFi security settings to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey, KeyPassphrase, SAEPassphrase, and WPS.PIN (if applicable). If the command cannot be executed, the agent MUST reject the command. Possible failure reasons include a lack of default values or if ModeEnabled is an Enterprise type, i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise. |
- |
2.12 |
|
Device.WiFi.AccessPoint.{i}.WPS. |
object |
R |
{{div: unexpected argument WPSv2.0 after: [classes()], ['This object contains parameters related to Wi-Fi Protected Setup for', nl(), 'this access point (as specified in ', bibref(WPSv1.0), ' or', nl(), '{bibref']}}).}} Changes since 2.14:
|
- |
2.12 |
|
ConfigMethodsSupported |
string[] |
R |
Comma-separated list of strings. WPS configuration methods supported by the device. Each list item is an enumeration of:
|
- |
2.12 |
|
Version |
string |
R |
{{div|{{classes}}|The Wi-Fi Simple Configuration version supported by the device, a string of the form m.n where m is the major version and n is the minor version. For example, a value of 1.0 denotes WSC 1.0 and a value of 2.0 denotes WSC 2.0.}} The Wi-Fi Simple Configuration version supported by the device, a string of the form m.n where m is the major version and n is the minor version. For example, a value of 1.0 denotes WSC 1.0 and a value of 2.0 denotes WSC 2.0. |
- |
2.12 |
|
PIN |
string(:8) |
W |
{{div|{{classes}}|Represents the Device PIN used for PIN based pairing between WPS peers. This PIN is either a four digit number or an eight digit number. {{hidden}}}} Represents the Device PIN used for PIN based pairing between WPS peers. This PIN is either a four digit number or an eight digit number. When read, this parameter returns an empty string, regardless of the actual value. Possible patterns:
|
- |
2.12 |
|
InitiateWPSPBC() |
command |
- |
[ASYNC] Initiates a Wi-Fi Protected Setup (WPS) Push Button Configuration (PBC) process as defined in [WPS 2.0] . |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the response to the request to start Wi-Fi Protected Setup (WPS) Push Button Configuration (PBC). Enumeration of:
|
- |
2.15 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
A table of the devices currently associated with the access point. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not this node is currently present in the WiFi AccessPoint network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}} Whether or not this node is currently present in the WiFi AccessPoint network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats. |
object |
R |
{{div|{{classes}}|These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames. The CPE MUST reset these {{object}} parameters (unless otherwise stated in individual object or parameter descriptions) either when the {{param|##.Status}} of the parent {{object|##}} object transitions from {{enum|Disabled|##.Status}} to {{enum|Enabled|##.Status}}, or when it transitions from {{enum|Enabled|##.Status}} to {{enum|Disabled|##.Status}}.}} These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames. The CPE MUST reset these Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Status of the parent AccessPoint object transitions from Disabled to Enabled, or when it transitions from Enabled to Disabled. |
- |
2.12 |
|
Device.WiFi.AccessPoint.{i}.AC.{i}. |
object(4:4) |
R |
This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:
This table MUST contain exactly 4 entries. At most one entry in this table can exist with a given value for AccessCategory. |
- |
2.12 |
|
AIFSN |
unsignedInt(2:15) |
W |
Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
ECWMin |
unsignedInt(0:15) |
W |
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255, (expressed in microseconds). This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
ECWMax |
unsignedInt(0:15) |
W |
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255, (expressed in microseconds). This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
TxOpMax |
unsignedInt(0:255) |
W |
Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU). This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
Device.WiFi.AccessPoint.{i}.AC.{i}.Stats. |
object |
R |
This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). The CPE MUST reset the Access Point's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point's Status parameter transitions to a Disabled state) or when the Access Point becomes administratively up (i.e. the Access Point's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.12 |
|
Device.WiFi.AccessPoint.{i}.Accounting. |
object |
R |
This object contains the parameters related to RADIUS accounting functionality for the access point. |
- |
2.12 |
|
SecondaryServerIPAddr |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|The IP Address of a secondary RADIUS accounting server. The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion. {{bibref|RFC2866}}}} The IP Address of a secondary RADIUS accounting server. The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion. [RFC2866] |
- |
2.12 |
|
SecondaryServerPort |
unsignedInt |
W |
{{div|{{classes}}|The port number of the secondary RADIUS server used for accounting. The default port is 1813 as defined in {{bibref|RFC2866}}. If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server.}} The port number of the secondary RADIUS server used for accounting. The default port is 1813 as defined in [RFC2866]. If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server. |
1813 |
2.12 |
|
SecondarySecret |
string |
W |
{{div|{{classes}}|The secret used for handshaking with the secondary RADIUS accounting server {{bibref|RFC2865}}. If this parameter is not implemented, the secondary RADIUS server will use the same secret as the primary RADIUS server.}} The secret used for handshaking with the secondary RADIUS accounting server [RFC2865]. If this parameter is not implemented, the secondary RADIUS server will use the same secret as the primary RADIUS server. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
InterimInterval |
unsignedInt(0,60:) |
W |
Specifies the default interim accounting interval in seconds, which is used for service accounting when the Acct-Interim-Interval attribute is not configured. [Section 2.1/RFC2869] The value MUST NOT be smaller than 60. The value SHOULD NOT be smaller than 600, and careful consideration should be given to its impact on network traffic [Section 5.16/RFC2869]. A value of 0 means no interim accounting messages are sent. |
0 |
2.12 |
|
Device.WiFi.EndPoint.{i}. |
object(0:) |
W |
This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point. For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row. At most one entry in this table can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of this end point. Enumeration of:
|
Disabled |
2.12 |
|
Device.WiFi.EndPoint.{i}.Profile.{i}. |
object(0:) |
W |
EndPoint Profile table. At most one entry in this table can exist with a given value for Alias, or with the same values for all of SSID, Location and Priority. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, SSID and Location such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this Profile. When there are multiple WiFi EndPoint Profiles, e.g. each instance supports a different SSID and/or different security configuration, this parameter can be used to control which of the instances are currently enabled.}} Enables or disables this Profile. When there are multiple WiFi EndPoint Profiles, e.g. each instance supports a different SSID and/or different security configuration, this parameter can be used to control which of the instances are currently enabled. |
false |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|Indicates the status of this Profile. {{enum}} The {{enum|Active}} value is reserved for the instance that is actively connected. The {{enum|Available}} value represents an instance that is not currently active, but is also not disabled or in error. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} Indicates the status of this Profile. Enumeration of:
The Active value is reserved for the instance that is actively connected. The Available value represents an instance that is not currently active, but is also not disabled or in error. The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
Priority |
unsignedInt(:255) |
W |
The profile Priority defines one of the criteria used by the End Point to automatically select the "best" AP when several APs with known profiles are simultaneously available for association. In this situation, the End Point has to select the AP with the higher priority in its profile. If there are several APs with the same priority, providing different SSID or the same SSID, then the wireless end point has to select the APs according to other criteria like signal quality, SNR, etc. 0 is the highest priority. |
0 |
2.12 |
|
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. |
object |
R |
This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007]. |
- |
2.12 |
|
WEPKey |
hexBinary(5,13) |
W |
A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
|
hexBinary(:32) |
W |
A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The Controller SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
KeyPassphrase |
string(8:63) |
W |
{{div|{{classes}}|A passphrase from which the {{param|PreSharedKey}} is to be generated, for {{enum|WPA-Personal|ModeEnabled}} or {{enum|WPA2-Personal|ModeEnabled}} or {{enum|WPA-WPA2-Personal|ModeEnabled}} security modes. If {{param}} is written, then {{param|PreSharedKey}} is immediately generated. The Controller SHOULD NOT set both the {{param}} and the {{param|PreSharedKey}} directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 {{bibref|RFC2898}}.}} A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey is immediately generated. The Controller SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 [RFC2898]. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
SAEPassphrase |
string |
W |
{{div|{{classes}}|A passphrase for {{enum|WPA3-Personal|ModeEnabled}} or {{enum|WPA3-Personal-Transition|ModeEnabled}} security modes. NOTE: this parameter is for WPA3. WPA2 {{param|PreSharedKey}} is generated from {{param|KeyPassphrase}}.}} A passphrase for WPA3-Personal or WPA3-Personal-Transition security modes. NOTE: this parameter is for WPA3. WPA2 PreSharedKey is generated from KeyPassphrase. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.13 |
|
Device.WiFi.EndPoint.{i}.WPS. |
object |
R |
This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this end point. |
- |
2.12 |
|
ConfigMethodsSupported |
string[] |
R |
Comma-separated list of strings. WPS configuration methods supported by the device. Each list item is an enumeration of:
|
- |
2.12 |
|
Version |
string |
R |
{{div|{{classes}}|The Wi-Fi Simple Configuration version supported by the device, a string of the form m.n where m is the major version and n is the minor version. For example, a value of 1.0 denotes WSC 1.0 and a value of 2.0 denotes WSC 2.0.}} The Wi-Fi Simple Configuration version supported by the device, a string of the form m.n where m is the major version and n is the minor version. For example, a value of 1.0 denotes WSC 1.0 and a value of 2.0 denotes WSC 2.0. |
- |
2.12 |
|
PIN |
unsignedInt(4,8) |
W |
{{div|{{classes}}|Represents the Device PIN used for PIN based pairing between WPS peers. This PIN is either a four digit number or an eight digit number. {{hidden}}}} Represents the Device PIN used for PIN based pairing between WPS peers. This PIN is either a four digit number or an eight digit number. When read, this parameter returns 0, regardless of the actual value. |
- |
2.12 |
|
Device.WiFi.EndPoint.{i}.AC.{i}. |
object(4:4) |
R |
This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:
This table MUST contain exactly 4 entries. At most one entry in this table can exist with a given value for AccessCategory. |
- |
2.12 |
|
AIFSN |
unsignedInt(2:15) |
W |
Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
ECWMin |
unsignedInt(0:15) |
W |
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255, (expressed in microseconds). This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
ECWMax |
unsignedInt(0:15) |
W |
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255, (expressed in microseconds). This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
TxOpMax |
unsignedInt(0:255) |
W |
Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU). This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification. Changes since 2.14:
|
- |
2.12 |
|
Device.WiFi.EndPoint.{i}.AC.{i}.Stats. |
object |
R |
This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). The CPE MUST reset the EndPoint's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the EndPoint becomes operationally down due to a previous administrative down (i.e. the EndPoint's Status parameter transitions to a Disabled state) or when the EndPoint becomes administratively up (i.e. the EndPoint's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.12 |
|
Device.ZigBee. |
object |
R |
Top level object for ZigBee capabilities based on the [ZigBee2007] specification. |
- |
2.12 |
|
Device.ZigBee.Interface.{i}. |
object(0:) |
R |
ZigBee interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the ZigBee interface of a ZigBee end device, ZigBee router or ZigBee coordinator. 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 ZDOReference. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
Device.ZigBee.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.ZigBee.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table provides information about other ZigBee devices that are directly accessible via this interface. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is "FF:FF:FF:FF:FF:FF:FF:FF" and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more AssociatedDevice instances have the same key value the implemenation is undefined. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not this device is currently present in the ZigBee network as defined in {{bibref|ZigBee2007|section 2.4.4.1}}. The ability to list inactive devices is OPTIONAL. If the CPE includes inactive devices in this table, {{param}} MUST be set to {{false}} for each inactive device. The length of time an inactive device remains listed in this table is a local matter to the CPE.}} Whether or not this device is currently present in the ZigBee network as defined in [Section 2.4.4.1/ZigBee2007]. The ability to list inactive devices is OPTIONAL. If the CPE includes inactive devices in this table, Active MUST be set to false for each inactive device. The length of time an inactive device remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.ZigBee.ZDO.{i}. |
object(0:) |
R |
ZigBee Device Object (ZDO) provides management capabilities of the ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee Device as defined in [Section 2.5/ZigBee2007]. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is "FF:FF:FF:FF:FF:FF:FF:FF" and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more ZDO instances have the same key value the implemenation is undefined |
- |
2.12 |
|
BindingTableNumberOfEntries |
unsignedInt |
R |
The number of entries in the associated table. Changes since 2.14:
|
- |
2.12 |
|
Device.ZigBee.ZDO.{i}.NodeDescriptor. |
object |
R |
The NodeDescriptor object describes the node capabilities of the ZigBee device as defined in [Section 2.3.2.3 Node Descriptor/ZigBee2007]. |
- |
2.12 |
|
LogicalType |
string |
R |
{{div|{{classes}}|The type of ZigBee device that is extracted from the Logical Type Field as defined in {{bibref|ZigBee2007|Table 2.29}}. {{enum}}}} The type of ZigBee device that is extracted from the Logical Type Field as defined in [Table 2.29/ZigBee2007]. Enumeration of:
|
- |
2.12 |
|
FrequencyBand |
string[] |
R |
{{div|{{classes}}|Specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio utilized by the ZigBee device. {{list}} {{enum}}}} Specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio utilized by the ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.12 |
|
MACCapability |
string[] |
R |
{{div|{{classes}}|Specifies the IEEE 802.15.4-2003 MAC sub-layer capabilities for this ZigBee device. {{list}} {{enum}}}} Specifies the IEEE 802.15.4-2003 MAC sub-layer capabilities for this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.12 |
|
ServerMask |
string[] |
R |
{{div|{{classes}}|Specifies the system server capabilities of this ZigBee device. {{list}} {{enum}}}} Specifies the system server capabilities of this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.12 |
|
DescriptorCapability |
string[] |
R |
{{div|{{classes}}|Specifies the descriptor capabilities of this ZigBee device. {{list}} {{enum}}}} Specifies the descriptor capabilities of this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.12 |
|
Device.ZigBee.ZDO.{i}.PowerDescriptor. |
object |
R |
The PowerDescriptor object describes the power capabilities of the ZigBee device as defined in [Section 2.3.2.4 Node Power Descriptor/ZigBee2007]. |
- |
2.12 |
|
CurrentPowerMode |
string |
R |
{{div|{{classes}}|Specifies the current sleep/power-saving mode of the ZigBee device. {{enum}}}} Specifies the current sleep/power-saving mode of the ZigBee device. Enumeration of:
|
- |
2.12 |
|
AvailablePowerSource |
string[] |
R |
{{div|{{classes}}|Specifies the power sources available on this ZigBee device. {{list}} {{enum}}}} Specifies the power sources available on this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.12 |
|
CurrentPowerSource |
string |
R |
{{div|{{classes}}|The current power source field specifies the current power source being utilized by the node. {{enum}}}} The current power source field specifies the current power source being utilized by the node. Enumeration of:
|
- |
2.12 |
|
CurrentPowerSourceLevel |
string |
R |
{{div|{{classes}}|Specifies the level of charge of the current power source. {{enum}}}} Specifies the level of charge of the current power source. Enumeration of:
|
- |
2.12 |
|
Device.ZigBee.ZDO.{i}.Security. |
object |
R |
The Security object provides the configuration capabilities needed to perform the Security Management functionality defined in [Section 4 Security Management/ZigBee2007]. |
- |
2.12 |
|
SecurityLevel |
string |
R |
{{div|{{classes}}|Specifies how an outgoing frame is to be secured, how an incoming frame purportedly has been secured; it also indicates whether or not the payload is encrypted and to what extent data authenticity over the frame is provided, as reflected by the length of the message integrity code (MIC). {{enum}}}} Specifies how an outgoing frame is to be secured, how an incoming frame purportedly has been secured; it also indicates whether or not the payload is encrypted and to what extent data authenticity over the frame is provided, as reflected by the length of the message integrity code (MIC). Enumeration of:
|
- |
2.12 |
|
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}. |
object(0:) |
W |
The ApplicationEndpoint object describes the application endpoint as defined in [Section 2.1.2 Application Framework/ZigBee2007]. At most one entry in this table can exist with a given value for EndpointId, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for EndpointId and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
EndpointId |
unsignedInt(:240) |
W |
{{div|{{classes}}|The Endpoint Identifier for this object as defined in {{bibref|ZigBee2007|section 2.1.2 Application Framework}}. An {{object}} with an {{param}} value of 0 is designated as the device application: This is a special application that is responsible for device operation and contains logic to manage the device's networking and general maintenance features.}} The Endpoint Identifier for this object as defined in [Section 2.1.2 Application Framework/ZigBee2007]. An ApplicationEndpoint with an EndpointId value of 0 is designated as the device application: This is a special application that is responsible for device operation and contains logic to manage the device's networking and general maintenance features. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.ZigBee.Discovery. |
object |
R |
This object is used for managing the discovery of ZigBee devices within a ZigBee Area Network. ZigBee Devices are discovered via the ZDO instance associated with the ZigBee Coordinator of an Area Network. |
- |
2.12 |
|
Device.ZigBee.Discovery.AreaNetwork.{i}. |
object(0:) |
W |
{{div|{{classes}}|This object specifies the ZigBee devices that are discovered by the {{param|Coordinator}}. As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the {{object}} object is provisioned and not discovered.}} This object specifies the ZigBee devices that are discovered by the Coordinator. As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the AreaNetwork object is provisioned and not discovered. At most one entry in this table can exist with a given value for Alias, or with a given value for Coordinator. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Coordinator such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the current discovery operation. {{enum}}}} The status of the current discovery operation. Enumeration of:
|
- |
2.12 |
|
ZDOReference |
string(:256) |
R |
{{div|{{classes}}|The ZDO object for this device that is used to discover the ZigBee capabilities of attached devices. {{reference}}}} The ZDO object for this device that is used to discover the ZigBee capabilities of attached devices. The value MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.12 |
|
ZDOList |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). {{div|{{classes}}|The list of ZDO objects discovered in this Area Network by the ZigBee Coordinator. {{reference}}}} The list of ZDO objects discovered in this Area Network by the ZigBee Coordinator. Each list item MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. |
- |
2.12 |
|
Device.Bridging. |
object |
R |
Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. |
- |
2.12 |
|
MaxDBridgeEntries |
unsignedInt |
R |
{{div|{{classes}}|The maximum number of 802.1D {{bibref|802.1D-2004}} entries available in the {{object|.Bridging.Bridge}} table. A positive value for this parameter implies support for 802.1D. There is no guarantee that this many 802.1D Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges.}} The maximum number of 802.1D [802.1D-2004] entries available in the Bridging.Bridge table. A positive value for this parameter implies support for 802.1D. There is no guarantee that this many 802.1D Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges. |
- |
2.12 |
|
MaxQBridgeEntries |
unsignedInt |
R |
{{div|{{classes}}|The maximum number of 802.1Q {{bibref|802.1Q-2011}} entries available in the {{object|.Bridging.Bridge}} table. A non-zero value for this parameter implies support for 802.1Q. There is no guarantee that this many 802.1Q Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges.}} The maximum number of 802.1Q [802.1Q-2011] entries available in the Bridging.Bridge table. A non-zero value for this parameter implies support for 802.1Q. There is no guarantee that this many 802.1Q Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges. |
- |
2.12 |
|
Device.Bridging.Bridge.{i}. |
object(0:) |
W |
Bridge table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this {{object}}. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} |
Disabled |
2.12 |
|
Device.Bridging.Bridge.{i}.Port.{i}. |
object(0:) |
W |
{{div|{{classes}}|Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean {{param|ManagementPort}} parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same {{object|##.Bridge}} instance.}} Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the bridge port. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the bridge port. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the bridge port (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. When {{param|ManagementPort}} is set to {{true}} the CPE MUST set {{param}} to reference all non-management bridge ports that are within the same {{object|##.Bridge}} instance (and update {{param}} when subsequent non-management bridge ports are added or deleted on that Bridge). The Controller SHOULD NOT set {{param}} in this case.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. When ManagementPort is set to true the CPE MUST set LowerLayers to reference all non-management bridge ports that are within the same Bridge instance (and update LowerLayers when subsequent non-management bridge ports are added or deleted on that Bridge). The Controller SHOULD NOT set LowerLayers in this case. |
<Empty> |
2.12 |
|
Type |
string |
W |
The type of bridge port as defined in 802.1Q [Section 17 IEEE8021BridgePortType/802.1Q-2011]. Enumeration of: Enumeration of:
|
- |
2.12 |
|
PVID |
int(1:4094) |
W |
{{div|{{classes}}|PVID (or Port VID) is the VLAN ID with which an untagged or priority tagged frame that arrives on this port will be associated (i.e. default Port VLAN ID as defined in 802.1Q {{bibref|802.1Q-2011}}). For an 802.1D Bridge {{bibref|802.1D-2004}}, this parameter MUST be ignored.}} PVID (or Port VID) is the VLAN ID with which an untagged or priority tagged frame that arrives on this port will be associated (i.e. default Port VLAN ID as defined in 802.1Q [802.1Q-2011]). For an 802.1D Bridge [802.1D-2004], this parameter MUST be ignored. |
1 |
2.12 |
|
TPID |
unsignedInt |
W |
The Tag Protocol Identifier (TPID) assigned to this Port. The TPID is an EtherType value used to identify the frame as a tagged frame. Standard [Table 9.1/802.1Q-2011] TPID values are: *S-TAG 0x88A8 = 34984 *C-TAG 0x8100 = 33024 Non-Standard TPID values are: *S-TAG 0x9100 = 37120 |
33024 |
2.12 |
|
AcceptableFrameTypes |
string |
W |
{{div|{{classes}}|Indicates which types of frame arriving on this port will be admitted to the bridge (i.e. Bridge Port acceptable frame types as defined in 802.1Q {{bibref|802.1Q-2011}}). {{enum}} For an 802.1D {{bibref|802.1D-2004}} Bridge, the value of this parameter MUST be {{enum|AdmitAll}}.}} Indicates which types of frame arriving on this port will be admitted to the bridge (i.e. Bridge Port acceptable frame types as defined in 802.1Q [802.1Q-2011]). Enumeration of:
For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be AdmitAll. |
AdmitAll |
2.12 |
|
IngressFiltering |
boolean |
W |
{{div|{{classes}}|Enables or disables Ingress Filtering as defined in 802.1Q {{bibref|802.1Q-2011}}. If enabled ({{true}}), causes frames arriving on this port to be discarded if the port is not in the VLAN ID's member set (which is configured via the {{object|#.VLANPort}} table). For an 802.1D {{bibref|802.1D-2004}} Bridge, the value of this parameter MUST be {{false}}.}} Enables or disables Ingress Filtering as defined in 802.1Q [802.1Q-2011]. If enabled (true), causes frames arriving on this port to be discarded if the port is not in the VLAN ID's member set (which is configured via the VLANPort table). For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be false. |
false |
2.12 |
|
ServiceAccessPrioritySelection |
boolean |
W |
{{div|{{classes}}|This parameter controls the Service Access Priority selection function as described in {{bibref|802.1Q-2011|section 6.13}}. The parameter is applicable to deployments of {{object|##.Bridge}} instances that are referenced by {{param|###.Bridging.ProviderBridge.{i}.SVLANcomponent}}.}} This parameter controls the Service Access Priority selection function as described in [Section 6.13/802.1Q-2011]. The parameter is applicable to deployments of Bridge instances that are referenced by Bridging.ProviderBridge.{i}.SVLANcomponent. |
false |
2.12 |
|
ServiceAccessPriorityTranslation |
unsignedInt(0:7)[8:8]() |
W |
{{div|{{classes}}|{{list}} List items represent service access priority translation values for each ingress priority on this {{object}} as described in {{bibref|802.1Q-2011|section 6.13}}. The parameter is applicable to deployments of {{object|##.Bridge}} instances that are referenced by {{param|###.Bridging.ProviderBridge.{i}.SVLANcomponent}}.}} Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent service access priority translation values for each ingress priority on this Port as described in [Section 6.13/802.1Q-2011]. The parameter is applicable to deployments of Bridge instances that are referenced by Bridging.ProviderBridge.{i}.SVLANcomponent. |
0,1,2,3,4,5,6,7 |
2.12 |
|
PriorityTagging |
boolean |
W |
Enables or disables priority tagging on this Bridge Port. When true, egress frames leaving this interface will be priority tagged with the frame's associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark. When false, egress frames leaving this interface will be untagged. The parameter does not affect reception of ingress frames. Only applies on bridge ports that are untagged member of one or more VLAN's. |
false |
2.12 |
|
Device.Bridging.Bridge.{i}.Port.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. |
object |
R |
{{div|{{classes}}|{{object}} provides the management control for the processing of the Priority Code Point (PCP) field for the 802.1Q header as defined in {{bibref|802.1Q-2011|section 6.9.3 Priority Code Point Encoding}}. The object is applicable to deployments of {{object|####.Bridging.ProviderBridge}} where the {{object|###.Bridge}} instance is referenced by {{param|####.Bridging.ProviderBridge.{i}.SVLANcomponent}} or {{param|####.Bridging.ProviderBridge.{i}.CVLANcomponents}} parameters.}} PriorityCodePoint provides the management control for the processing of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011]. The object is applicable to deployments of Bridging.ProviderBridge where the Bridge instance is referenced by Bridging.ProviderBridge.{i}.SVLANcomponent or Bridging.ProviderBridge.{i}.CVLANcomponents parameters. |
- |
2.12 |
|
PCPEncoding |
string(31)[4:4]() |
W |
Comma-separated list (4 items) (length ) of strings (length 31). This parameter provides the management control for the processing of the encoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-3/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: "8P0D","7P1D", "6P2D" "5P3D". Each list entry matches the following pattern: Each list item matches one of:
|
- |
2.12 |
|
PCPDecoding |
string(15)[4:4]() |
W |
Comma-separated list (4 items) (length ) of strings (length 15). This parameter provides the management control for the processing of the decoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-4/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: "8P0D","7P1D", "6P2D" "5P3D". Each list entry matches the following pattern: Each list item matches one of:
|
- |
2.12 |
|
Device.Bridging.Bridge.{i}.VLAN.{i}. |
object(0:) |
W |
{{div|{{classes}}|Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge. This table only applies to an 802.1Q {{bibref|802.1Q-2011}} Bridge.}} Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge. This table only applies to an 802.1Q [802.1Q-2011] Bridge. At most one entry in this table can exist with a given value for Alias, or with a given value for VLANID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and VLANID such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.Bridging.Bridge.{i}.VLANPort.{i}. |
object(0:) |
W |
Bridge VLAN egress port and untagged port membership table. This table only applies to an 802.1Q [802.1Q-2011] Bridge. Note: The VLANPort 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 VLANPort row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending VLANPort row. At most one entry in this table can exist with a given value for Alias, or with the same values for both VLAN and Port. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.Bridging.Filter.{i}. |
object(0:) |
W |
Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance. Bridge VLAN classification only applies for 802.1Q [802.1Q-2011] Bridges. For enabled table entries, if Bridge or Interface is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Several of this object's parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as filter criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this Filter table entry. Enumeration of:
|
Disabled |
2.12 |
|
Bridge |
string(:256) |
W |
{{div|{{classes}}|{{reference|a {{object|.Bridging.Bridge}} object in case of a 802.1D bridge or a {{object|.Bridging.Bridge.{i}.VLAN}} object in case of a 802.1Q bridge}} Note: either way, this identifies the bridge (because each bridge has a VLAN table). Defines the Bridge or Bridge VLAN to which ingress frames will be classified based upon matches of the classification criteria.}} The value MUST be the Path Name of a Bridging.Bridge object in case of a 802.1D bridge or a Bridging.Bridge.{i}.VLAN object in case of a 802.1Q bridge. If the referenced object is deleted, the parameter value MUST be set to an empty string. Note: either way, this identifies the bridge (because each bridge has a VLAN table). Defines the Bridge or Bridge VLAN to which ingress frames will be classified based upon matches of the classification criteria. |
<Empty> |
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 ingress frame on the Interface, 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 |
|
Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} This MUST relate to the same bridge as does {{param|Bridge}}. Defines the Bridge Port on which ingress frame classification will occur.}} The value MUST be the Path Name of a row in the Bridge.{i}.Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This MUST relate to the same bridge as does Bridge. Defines the Bridge Port on which ingress frame classification will occur. |
<Empty> |
2.12 |
|
DHCPType |
string |
W |
{{div|{{classes}}|The DHCP protocol associated with the {{object}} instance. Affects only parameters that specify DHCP option values as filter criteria (all such parameter descriptions note this fact). {{enum}} If {{param}} is {{enum|DHCPv4}}, then {{object}} parameters that are DHCPv6-specific are ignored. If {{param}} is {{enum|DHCPv6}}, then {{object}} parameters that are DHCPv4-specific are ignored.}} The DHCP protocol associated with the Filter instance. Affects only parameters that specify DHCP option values as filter criteria (all such parameter descriptions note this fact). Enumeration of:
If DHCPType is DHCPv4, then Filter parameters that are DHCPv6-specific are ignored. If DHCPType is DHCPv6, then Filter parameters that are DHCPv4-specific are ignored. |
DHCPv4 |
2.12 |
|
VLANIDFilter |
unsignedInt(0:4094) |
W |
Classification criterion. The 802.1Q [802.1Q-2011] VLAN ID. For an 802.1D [802.1D-2004] Bridge, which has no concept of VLANs, the VLAN ID MUST be 0. |
0 |
2.12 |
|
EthertypeFilterList |
unsignedInt[](:256) |
W |
Classification criterion. Comma-separated list (maximum number of characters 256) of unsigned integers. Each list item represents an Ethertype value. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on Ethertype. |
<Empty> |
2.12 |
|
EthertypeFilterExclude |
boolean |
W |
If false, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit only those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit all packets except those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, packets are admitted regardless of Ethertype. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on Ethertype. |
true |
2.12 |
|
SourceMACAddressFilterList |
string[](:512) |
W |
Classification criterion. Comma-separated list (maximum number of characters 512) of strings, each representing a MAC Address. Each list entry MAY optionally specify a bit-mask, where matching of a packet's MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. |
<Empty> |
2.12 |
|
SourceMACAddressFilterExclude |
boolean |
W |
If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. |
true |
2.12 |
|
DestMACAddressFilterList |
string[](:512) |
W |
Classification criterion. Comma-separated list (maximum number of characters 512) of strings. Each list item specifies a MAC Address. List items MAY optionally specify a bit-mask after the MAC Address, where matching of a packet's MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 |
<Empty> |
2.12 |
|
DestMACAddressFilterExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the {{param|DestMACAddressFilterList}} entries. If the {{param|DestMACAddressFilterList}} is empty, no packets are admitted. If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the {{param|DestMACAddressFilterList}} entries. If the {{param|DestMACAddressFilterList}} is empty, packets are admitted regardless of MAC address.}} If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, packets are admitted regardless of MAC address. |
true |
2.12 |
|
SourceMACFromVendorClassIDFilter |
string(:255) |
W |
Classification criterion. A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCPv4 Vendor Class Identifier (Option 60 as defined in [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in SourceMACFromVendorClassIDMode. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. |
<Empty> |
2.12 |
|
SourceMACFromVendorClassIDFilterv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in [RFC3315]) was equal to the specified value. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.12 |
|
SourceMACFromVendorClassIDFilterExclude |
boolean |
W |
If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromVendorClassIDFilter (for DHCPv4) or SourceMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromVendorClassIDFilter (for DHCPv4) or SourceMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address |
true |
2.12 |
|
SourceMACFromVendorClassIDMode |
string |
W |
SourceMACFromVendorClassIDFilter pattern match criterion. Enumeration of:
|
Exact |
2.12 |
|
DestMACFromVendorClassIDFilter |
string(:255) |
W |
Classification criterion. A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCPv4 Vendor Class Identifier (Option 60 as defined in [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in DestMACFromVendorClassIDMode. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. |
<Empty> |
2.12 |
|
DestMACFromVendorClassIDFilterv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in [RFC3315]) was equal to the specified value. The option value is binary, so an exact match is REQUIRED. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.12 |
|
DestMACFromVendorClassIDFilterExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromVendorClassIDFilter}} (for {{enum|DHCPv4|DHCPType}}) or {{param|DestMACFromVendorClassIDFilterv6}} (for {{enum|DHCPv6|DHCPType}}). If this corresponding filter parameter is {{empty}}, no packets are admitted. If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromVendorClassIDFilter}} (for {{enum|DHCPv4|DHCPType}}) or {{param|DestMACFromVendorClassIDFilterv6}} (for {{enum|DHCPv6|DHCPType}}). If this corresponding filter parameter is {{empty}}, packets are admitted regardless of MAC address.}} If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromVendorClassIDFilter (for DHCPv4) or DestMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromVendorClassIDFilter (for DHCPv4) or DestMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, packets are admitted regardless of MAC address. |
true |
2.12 |
|
DestMACFromVendorClassIDMode |
string |
W |
{{div|{{classes}}|{{param|DestMACFromVendorClassIDFilter}} pattern match criterion. {{enum}} For example, if {{param|DestMACFromVendorClassIDFilter}} is Example then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.}} DestMACFromVendorClassIDFilter pattern match criterion. Enumeration of:
For example, if DestMACFromVendorClassIDFilter is Example then an Option 60 value of "Example device" will match with DestMACFromVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix. |
Exact |
2.12 |
|
SourceMACFromClientIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.12 |
|
SourceMACFromClientIDFilterExclude |
boolean |
W |
If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If SourceMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If the SourceMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. |
true |
2.12 |
|
DestMACFromClientIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.12 |
|
DestMACFromClientIDFilterExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromClientIDFilter}}. If {{param|DestMACFromClientIDFilter}} is {{empty}}, no packets are admitted. If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromClientIDFilter}}. If the {{param|DestMACFromClientIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.}} If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If DestMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If the DestMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address. |
true |
2.12 |
|
SourceMACFromUserClassIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.12 |
|
SourceMACFromUserClassIDFilterExclude |
boolean |
W |
If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If SourceMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If the SourceMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. |
true |
2.12 |
|
DestMACFromUserClassIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.12 |
|
DestMACFromUserClassIDFilterExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromUserClassIDFilter}}. If {{param|DestMACFromUserClassIDFilter}} is {{empty}}, no packets are admitted. If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromUserClassIDFilter}}. If the {{param|DestMACFromUserClassIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.}} If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If DestMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If the DestMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address. |
true |
2.12 |
|
DestIP |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|Classification criterion. Destination IP address. {{empty}} indicates this criterion is not used for classification.}} Classification criterion. Destination IP address. An empty string indicates this criterion is not used for classification. |
<Empty> |
2.12 |
|
DestIPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the (masked) DestIP entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) DestIP entry, if specified.}} If false, the class includes only those packets that match the (masked) DestIP entry, if specified. If true, the class includes all packets except those that match the (masked) DestIP entry, if specified. |
false |
2.12 |
|
SourceIP |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|Classification criterion. Source IP address. {{empty}} indicates this criterion is not used for classification.}} Classification criterion. Source IP address. An empty string indicates this criterion is not used for classification. |
<Empty> |
2.12 |
|
SourceIPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the (masked) {{param|SourceIP}} entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) {{param|SourceIP}} entry, if specified.}} |
false |
2.12 |
|
Protocol |
int(-1:255) |
W |
{{div|{{classes}}|Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
ProtocolExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|Protocol}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|Protocol}} entry, if specified.}} |
false |
2.12 |
|
DestPort |
int(-1:65535) |
W |
{{div|{{classes}}|Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
DestPortRangeMax |
int(-1:65535) |
W |
Classification criterion. If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. |
-1 |
2.12 |
|
DestPortExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|DestPort}} entry (or port range), if specified. If {{true}}, the class includes all packets except those that match the {{param|DestPort}} entry (or port range), if specified.}} |
false |
2.12 |
|
SourcePort |
int(-1:65535) |
W |
{{div|{{classes}}|Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
SourcePortRangeMax |
int(-1:65535) |
W |
Classification criterion. If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. |
-1 |
2.12 |
|
SourcePortExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|SourcePort}} entry (or port range), if specified. If {{true}}, the class includes all packets except those that match the {{param|SourcePort}} entry (or port range), if specified.}} If false, the class includes only those packets that match the SourcePort entry (or port range), if specified. If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified. |
false |
2.12 |
|
Device.Bridging.ProviderBridge.{i}. |
object(0:) |
W |
Provider Bridge table. A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects. When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags). When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this ProviderBridge. Enumeration of:
|
Disabled |
2.12 |
|
Device.PPP. |
object |
R |
Point-to-Point Protocol [RFC1661]. This object contains the Interface table. |
- |
2.12 |
|
SupportedNCPs |
string[] |
R |
Comma-separated list of strings. {{div|{{classes}}|The Network Control Protocols (NCPs) that are supported by the device. {{enum}} Note that {{enum|IPv6CP}} is an IPv6 capability.}} |
- |
2.12 |
|
Device.PPP.Interface.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
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 |
|
ConnectionTrigger |
string |
W |
{{div|{{classes}}|Trigger used to establish the PPP connection. {{enum}} Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE, such as use of the {{param|IdleDisconnectTime}} and/or {{param|AutoDisconnectTime}} parameters in this object.}} Trigger used to establish the PPP connection. Enumeration of:
Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object. |
- |
2.12 |
|
Device.PPP.Interface.{i}.PPPoE. |
object(0:1) |
R |
{{div|{{classes}}|PPPoE object that functionally groups PPPoE related parameters. PPPoE is only applicable when the lower layer provides Ethernet frames, e.g. ATM with EoA, PTM, or anything else that supports an Ethernet MAC.}} PPPoE object that functionally groups PPPoE related parameters. PPPoE is only applicable when the lower layer provides Ethernet frames, e.g. ATM with EoA, PTM, or anything else that supports an Ethernet MAC. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Device.PPP.Interface.{i}.IPCP. |
object |
R |
IP Control Protocol (IPCP) client object for this PPP interface [RFC1332]. IPCP only applies to IPv4. |
- |
2.12 |
|
PassthroughEnable |
boolean |
W |
{{div|{{classes}}|If {{false}}, the PPP Interface retrieved information is configured on the IP Interface stacked on top of this PPP Interface. If {{true}}, the PPP Interface retrieved information is propagated to the parameters in the referenced {{param|PassthroughDHCPPool}} object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers).}} If false, the PPP Interface retrieved information is configured on the IP Interface stacked on top of this PPP Interface. If true, the PPP Interface retrieved information is propagated to the parameters in the referenced PassthroughDHCPPool object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers). |
false |
2.12 |
|
Device.PPP.Interface.{i}.IPv6CP. |
object |
R |
IPv6 Control Protocol (IPv6CP) client object for this PPP interface [RFC5072]. IPv6CP only applies to IPv6. |
- |
2.12 |
|
LocalInterfaceIdentifier |
string(:45) |
R |
[IPv6Address] {{div|{{classes}}|The interface identifier for the local end of the PPP link, negotiated using the IPv6CP Interface-Identifier option {{bibref|RFC5072|Section 4.1}}. The identifier is represented as the rightmost 64 bits of an IPv6 address (the leftmost 64 bits MUST be zero and MUST be ignored by the recipient).}} The interface identifier for the local end of the PPP link, negotiated using the IPv6CP Interface-Identifier option [Section 4.1/RFC5072]. The identifier is represented as the rightmost 64 bits of an IPv6 address (the leftmost 64 bits MUST be zero and MUST be ignored by the recipient). |
- |
2.12 |
|
RemoteInterfaceIdentifier |
string(:45) |
R |
[IPv6Address] {{div|{{classes}}|The interface identifier for the remote end of the PPP link, negotiated using the IPv6CP Interface-Identifier option {{bibref|RFC5072|Section 4.1}}. The identifier is represented as the rightmost 64 bits of an IPv6 address (the leftmost 64 bits MUST be zero and MUST be ignored by the recipient).}} The interface identifier for the remote end of the PPP link, negotiated using the IPv6CP Interface-Identifier option [Section 4.1/RFC5072]. The identifier is represented as the rightmost 64 bits of an IPv6 address (the leftmost 64 bits MUST be zero and MUST be ignored by the recipient). |
- |
2.12 |
|
Device.PPP.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
Device.PPP.Interface.{i}.PPPoA. |
object(0:1) |
R |
PPPoA object that functionally groups PPPoA related parameters. This object is OBSOLETED This object was DEPRECATED in 2.12.because it contains no standard parameters and its existence causes confusion.confusion This object was OBSOLETED in 2.12. This object was DELETED in 2.15. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Device.IP. |
object |
R |
IP object that contains the Interface, ActivePort, and Diagnostics objects. |
- |
2.12 |
|
IPv4Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the IPv4 stack, and so the use of IPv4 on the device. This affects only layer 3 and above. When {{false}}, IP interfaces that had been operationally up and passing IPv4 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv6 stack).}} Enables or disables the IPv4 stack, and so the use of IPv4 on the device. This affects only layer 3 and above. When false, IP interfaces that had been operationally up and passing IPv4 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv6 stack). |
- |
2.12 |
|
IPv4Status |
string |
R |
{{div|{{classes}}|Indicates the status of the IPv4 stack. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} Indicates the status of the IPv4 stack. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
IPv6Capable |
boolean |
R |
{{div|{{classes}}|Indicates whether the device is IPv6 capable. Note: If {{false}}, it is expected that IPv6-related parameters, enumeration values, etc will not be implemented by the device.}} Indicates whether the device is IPv6 capable. Note: If false, it is expected that IPv6-related parameters, enumeration values, etc will not be implemented by the device. |
- |
2.12 |
|
IPv6Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the IPv6 stack, and so the use of IPv6 on the device. This affects only layer 3 and above. When {{false}}, IP interfaces that had been operationally up and passing IPv6 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv4 stack).}} Enables or disables the IPv6 stack, and so the use of IPv6 on the device. This affects only layer 3 and above. When false, IP interfaces that had been operationally up and passing IPv6 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv4 stack). |
- |
2.12 |
|
IPv6Status |
string |
R |
{{div|{{classes}}|Indicates the status of the IPv6 stack. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} Indicates the status of the IPv6 stack. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
Device.IP.Interface.{i}. |
object(0:) |
W |
IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface. Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface's IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables. Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the Controller to create) Interface instances of type Loopback. When the Controller administratively disables the interface, i.e. sets Enable to false, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the Controller administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It's up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. Any Tunneled IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces. Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface (regardless of {{param|IPv4Enable}} and {{param|IPv6Enable}}). This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface (regardless of IPv4Enable and IPv6Enable). This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
IPv4Enable |
boolean |
W |
If set to true, attaches this interface to the IPv4 stack. If set to false, detaches this interface from the IPv4 stack. Once detached from the IPv4 stack, the interface will now no longer be able to pass IPv4 packets, and will be operationally down (unless also attached to an enabled IPv6 stack). For an IPv4 capable device, if IPv4Enable is not present this interface SHOULD be permanently attached to the IPv4 stack. Note that IPv4Enable is independent of Enable, and that to administratively enable an interface for IPv4 it is necessary for both Enable and IPv4Enable to be true. |
- |
2.12 |
|
IPv6Enable |
boolean |
W |
If set to true, attaches this interface to the IPv6 stack. If set to false, detaches this interface from the IPv6 stack. Once detached from the IPv6 stack, the interface will now no longer be able to pass IPv6 packets, and will be operationally down (unless also attached to an enabled IPv4 stack). For an IPv6 capable device, if IPv6Enable is not present this interface SHOULD be permanently attached to the IPv6 stack. Note that IPv6Enable is independent of Enable, and that to administratively enable an interface for IPv6 it is necessary for both Enable and IPv6Enable to be true. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
Down |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. {{param}} MUST be {{empty}} and read-only when {{param|Type}} is {{enum|Loopback|Type}}, {{enum|Tunnel|Type}}, or {{enum|Tunneled|Type}}.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers MUST be an empty string and read-only when Type is Loopback, Tunnel, or Tunneled. |
<Empty> |
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 |
|
Type |
string |
R |
{{div|{{classes}}|IP interface type. {{enum}} For {{enum|Loopback}}, {{enum|Tunnel}}, and {{enum|Tunneled}} IP interface objects, the {{param|LowerLayers}} parameter MUST be {{empty}}.}} |
Normal |
2.12 |
|
Loopback |
boolean |
W |
{{div|{{classes}}|When set to {{true}}, the IP interface becomes a loopback interface and the CPE MUST set {{param|Type}} to {{enum|Loopback|Type}}. In this case, the CPE MUST also set {{param|LowerLayers}} to {{empty}} and fail subsequent attempts at setting {{param|LowerLayers}} until the interface is no longer a loopback. Support for manipulating loopback interfaces is OPTIONAL.}} When set to true, the IP interface becomes a loopback interface and the CPE MUST set Type to Loopback. In this case, the CPE MUST also set LowerLayers to an empty string and fail subsequent attempts at setting LowerLayers until the interface is no longer a loopback. Support for manipulating loopback interfaces is OPTIONAL. |
false |
2.12 |
|
AutoIPEnable |
boolean |
W |
{{div|{{classes}}|If {{true}}, enables auto-IP on the interface {{bibref|RFC3927}}. This mechanism is only used with IPv4. When auto-IP is enabled on an interface, an {{object|IPv4Address}} object will dynamically be created and configured with auto-IP parameter values. The exact conditions under which an auto-IP address is created (e.g. always when enabled or only in absence of dynamic IP addressing) is implementation specific.}} If true, enables auto-IP on the interface [RFC3927]. This mechanism is only used with IPv4. When auto-IP is enabled on an interface, an IPv4Address object will dynamically be created and configured with auto-IP parameter values. The exact conditions under which an auto-IP address is created (e.g. always when enabled or only in absence of dynamic IP addressing) is implementation specific. |
false |
2.12 |
|
Device.IP.Interface.{i}.IPv4Address.{i}. |
object(0:) |
W |
IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the Controller. At most one entry in this table can exist with a given value for Alias, or with the same values for both IPAddress and SubnetMask. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and IPAddress such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this IPv4Address table entry. Enumeration of:
|
Disabled |
2.12 |
|
Alias |
string(:64) |
W |
{{div|{{classes}}|{{datatype|expand}} This parameter can only be modified if {{param|AddressingType}} is {{enum|Static|AddressingType}}.}} [Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
This parameter can only be modified if AddressingType is Static. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
IPAddress |
string(:45) |
W |
[IPv4Address] {{div|{{classes}}|IPv4 address. This parameter can only be modified if the {{param|AddressingType}} is {{enum|Static|AddressingType}}.}} IPv4 address. This parameter can only be modified if the AddressingType is Static. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
SubnetMask |
string(:45) |
W |
[IPv4Address] {{div|{{classes}}|Subnet mask. This parameter can only be modified if the {{param|AddressingType}} is {{enum|Static|AddressingType}}.}} Subnet mask. This parameter can only be modified if the AddressingType is Static. |
<Empty> |
2.12 |
|
Device.IP.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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 |
|
BroadcastPacketsSent |
unsignedLong |
R |
{{div|{{classes}}|The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.}} The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
{{div|{{classes}}|The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.}} The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. |
- |
2.12 |
|
Device.IP.Interface.{i}.TWAMPReflector.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
IPAllowedList |
string[](:255) |
W |
Comma-separated list (maximum number of characters 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:
|
- |
2.12 |
|
PortAllowedList |
string[](:255) |
W |
Comma-separated list (maximum number of characters 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.Interface.{i}.IPv6Address.{i}. |
object(0:) |
W |
This table contains the IP interface's IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses. There are several ways in which entries can be added to and deleted from this table, including:
At most one entry in this table can exist with a given value for Alias, or with a given value for IPAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this IPv6Address table entry. Enumeration of:
|
Disabled |
2.12 |
|
IPAddressStatus |
string |
R |
{{div|{{classes}}|The status of {{param|IPAddress}}, indicating whether it can be used for communication. See also {{param|PreferredLifetime}} and {{param|ValidLifetime}}. {{enum}} This parameter is based on ipAddressStatus and ipAddressStatusTC from {{bibref|RFC4293}}.}} The status of IPAddress, indicating whether it can be used for communication. See also PreferredLifetime and ValidLifetime. Enumeration of:
This parameter is based on ipAddressStatus and ipAddressStatusTC from [RFC4293]. |
Invalid |
2.12 |
|
Alias |
string(:64) |
W |
{{div|{{classes}}|{{datatype|expand}} This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.}} [Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
IPAddress |
string(:45) |
W |
[IPv6Address] IPv6 address. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressAddr from [RFC4293]. |
<Empty> |
2.12 |
|
Origin |
string |
R |
{{div|{{classes}}|Mechanism via which the IP address was assigned. {{enum}} This parameter is based on ipOrigin from {{bibref|RFC4293}}.}} Mechanism via which the IP address was assigned. Enumeration of:
This parameter is based on ipOrigin from [RFC4293]. |
Static |
2.12 |
|
Prefix |
string |
W |
The value MUST be the Path Name of a row in the IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. IPv6 address prefix. Some addresses, e.g. addresses assigned via the DHCPv6 IA_NA option, are not associated with a prefix, and some WellKnown prefixes might not be modeled. In both of these cases Prefix will be an empty string. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressPrefix from [RFC4293]. |
<Empty> |
2.12 |
|
PreferredLifetime |
dateTime |
W |
{{div|{{classes}}|The time at which this address will cease to be preferred (i.e. will become deprecated), or {{null}} if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if the {{param|Origin}} is {{enum|Static|Origin}}.}} |
9999-12-31T23:59:59Z |
2.12 |
|
ValidLifetime |
dateTime |
W |
{{div|{{classes}}|The time at which this address will cease to be valid (i.e. will become invalid), or {{null}} if unknown. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if the {{param|Origin}} is {{enum|Static|Origin}}.}} |
9999-12-31T23:59:59Z |
2.12 |
|
Anycast |
boolean |
W |
Indicates whether this is an anycast address [Section 2.6/RFC4291]. Anycast addresses are syntactically identical to unicast addresses and so need to be configured explicitly. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressType from [RFC4293]. |
false |
2.12 |
|
Device.IP.Interface.{i}.IPv6Prefix.{i}. |
object(0:) |
W |
This table contains the interface's IPv6 prefixes. There MUST be an entry for each such prefix, not only for prefixes learned from router advertisements. There are several ways in which entries can be added to and deleted from this table, including:
At most one entry in this table can exist with a given value for Alias, or with a given value for Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this {{object}} table entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this IPv6Prefix table entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
PrefixStatus |
string |
R |
{{div|{{classes}}|The status of {{param|Prefix}}, indicating whether it can be used for communication. See also {{param|PreferredLifetime}} and {{param|ValidLifetime}}. {{enum}} This parameter is based on ipAddressStatus and ipAddressStatusTC from {{bibref|RFC4293}}.}} The status of Prefix, indicating whether it can be used for communication. See also PreferredLifetime and ValidLifetime. Enumeration of:
This parameter is based on ipAddressStatus and ipAddressStatusTC from [RFC4293]. |
Invalid |
2.12 |
|
Alias |
string(:64) |
W |
{{div|{{classes}}|{{datatype|expand}} This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.}} [Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Prefix |
string(:49) |
W |
[IPv6Prefix] IPv6 address prefix. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressPrefixPrefix from [RFC4293]. |
<Empty> |
2.12 |
|
Origin |
string |
R |
Mechanism via which the prefix was assigned or most recently updated. Enumeration of:
|
Static |
2.12 |
|
StaticType |
string |
W |
Static prefix sub-type. For a Static prefix, this can be set to PrefixDelegation or Child, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the Controller to pre-create "prefix slots" with known path names that can be referenced from elsewhere in the data model before they have been populated. Enumeration of:
|
Static |
2.12 |
|
ParentPrefix |
string |
W |
The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. {{div|{{classes}}|Indicates the parent prefix from which this prefix was derived. The parent prefix is relevant only for {{enum|Child|Origin}} prefixes and for {{enum|Static|Origin}} {{enum|Child|StaticType}} prefixes (both of which will always be on downstream interfaces), i.e. for {{param|Origin}}={{enum|Child|Origin}} and for ({{param|Origin}},{{param|StaticType}}) = ({{enum|Static|Origin}},{{enum|Child|StaticType}}) prefixes. This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}} (which makes sense only for a prefix whose {{param|StaticType}} is already or will be changed to {{enum|Child|StaticType}}).}} Indicates the parent prefix from which this prefix was derived. The parent prefix is relevant only for Child prefixes and for Static Child prefixes (both of which will always be on downstream interfaces), i.e. for Origin=Child and for (Origin,StaticType) = (Static,Child) prefixes. This parameter can only be modified if Origin is Static (which makes sense only for a prefix whose StaticType is already or will be changed to Child). |
<Empty> |
2.12 |
|
ChildPrefixBits |
string(:49) |
W |
[IPv6Prefix] A prefix that specifies the length of Static Child prefixes and how they are derived from their ParentPrefix. It will be used if and only if it is not an empty string and is longer than the parent prefix (if it is not used, derivation of such prefixes is implementation-specific). Any bits to the right of the parent prefix are set to the bits in this prefix. For example, for a parent prefix of fedc::/56, if this parameter had the value 123:4567:89ab:cdef::/64, the child /64 would be fedc:0:0:ef::/64. For a parent prefix of fedc::/60, the child /64 would be fedc:0:0:f::/64. This parameter can only be modified if Origin is Static. |
<Empty> |
2.12 |
|
OnLink |
boolean |
W |
On-link flag [Section 4.6.2/RFC4861] as received (in the RA) for RouterAdvertisement. Indicates whether this prefix can be used for on-link determination. This parameter can only be modified if Origin is Static. This parameter is based on ipAddressPrefixOnLinkFlag from [RFC4293]. |
false |
2.12 |
|
Autonomous |
boolean |
W |
Autonomous address configuration flag [Section 4.6.2/RFC4861] as received (in the RA) for RouterAdvertisement. Indicates whether this prefix can be used for generating global addresses as specified by SLAAC [RFC4862]. This parameter can only be modified if Origin is Static. This parameter is based on ipAddressPrefixAutonomousFlag from [RFC4293]. |
false |
2.12 |
|
PreferredLifetime |
dateTime |
W |
{{div|{{classes}}|This parameter is based on ipAddressPrefixAdvPreferredLifetime from {{bibref|RFC4293}}. The time at which this prefix will cease to be preferred (i.e. will become deprecated), or {{null}} if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.}} This parameter is based on ipAddressPrefixAdvPreferredLifetime from [RFC4293]. The time at which this prefix will cease to be preferred (i.e. will become deprecated), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. |
9999-12-31T23:59:59Z |
2.12 |
|
ValidLifetime |
dateTime |
W |
{{div|{{classes}}|This parameter is based on ipAddressPrefixAdvValidLifetime from {{bibref|RFC4293}}. The time at which this prefix will cease to be valid (i.e. will become invalid), or {{null}} if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.}} This parameter is based on ipAddressPrefixAdvValidLifetime from [RFC4293]. The time at which this prefix will cease to be valid (i.e. will become invalid), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. |
9999-12-31T23:59:59Z |
2.12 |
|
Device.IP.ActivePort.{i}. |
object(0:) |
R |
This table lists the ports on which TCP connections are listening or established. At most one entry in this table can exist with the same values for all of LocalIPAddress, LocalPort, RemoteIPAddress and RemotePort. |
- |
2.12 |
|
RemoteIPAddress |
string(:45) |
R |
[IPAddress] {{div|{{classes}}|The remote IP address of the source of inbound packets. This will be {{null}} for listening connections (only connections in {{enum|ESTABLISHED|Status}} state have remote addresses).}} The remote IP address of the source of inbound packets. This will be an empty string for listening connections (only connections in ESTABLISHED state have remote addresses). |
- |
2.12 |
|
RemotePort |
unsignedInt(0:65535) |
R |
{{div|{{classes}}|The remote port of the source of inbound packets. This will be {{null}} for listening connections (only connections in {{enum|ESTABLISHED|Status}} state have remote addresses).}} The remote port of the source of inbound packets. This will be 0 for listening connections (only connections in ESTABLISHED state have remote addresses). |
- |
2.12 |
|
Device.IP.Diagnostics. |
object |
R |
The IP Diagnostics object. Changes since 2.14:
|
- |
2.12 |
|
IPPing() |
command |
- |
[ASYNC] This command provides access to an IP-layer ping test. |
- |
2.12 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If {{empty}} is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of a table row. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ ProtocolVersion |
string |
W |
[MANDATORY] Indicates the IP protocol to be used. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
⇒ Host |
string(:256) |
W |
[MANDATORY] {{div|{{classes}}|Host name or address of the host to ping. In the case where {{param}} is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use.}} Host name or address of the host to ping. In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use. Changes since 2.14:
|
- |
2.12 |
|
⇒ NumberOfRepetitions |
unsignedInt(1:) |
W |
[MANDATORY] Number of repetitions of the ping test to perform before reporting the results. Changes since 2.14:
|
- |
2.12 |
|
⇒ Timeout |
unsignedInt(1:) |
W |
[MANDATORY] Timeout in milliseconds for the ping test. Changes since 2.14:
|
- |
2.12 |
|
⇒ DataBlockSize |
unsignedInt(1:65535) |
W |
[MANDATORY] Size of the data block in bytes to be sent for each ping. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
TraceRoute() |
command |
- |
[ASYNC] This command defines access to an IP-layer trace-route test for the specified IP interface. |
- |
2.12 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If {{empty}} is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of a table row. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ ProtocolVersion |
string |
W |
[MANDATORY] Indicates the IP protocol to be used. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
⇒ Host |
string(:256) |
W |
[MANDATORY] {{div|{{classes}}|Host name or address of the host to find a route to. In the case where {{param}} is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use.}} Host name or address of the host to find a route to. In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ RouteHops.{i}. |
object(0:) |
R |
Contains the array of hop results returned. If a route could not be determined, this array will be empty This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇐ RTTimes |
unsignedInt[1:3](:16) |
R |
Comma-separated list (1 to 3 items) (maximum number of characters 16) of unsigned integers. Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop. A list item of 0 indicates that the corresponding response was not received. Round trip times of less than 1 milliseconds MUST be rounded up to 1. The number of list entries is determined by the value of NumberOfTries. |
- |
2.12 |
|
DownloadDiagnosticsMaxIncrementalResult |
unsignedInt(1:) |
R |
The maximum number of rowsinstances in DownloadDiagnostics().IncrementalResult that the CPEimplementation will store.return. |
- |
2.12 |
|
DownloadDiagnostics() |
command |
- |
[ASYNC] {{div|{{classes}}|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.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If {{empty}} is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ DownloadURL |
string(:2048) |
W |
[MANDATORY] The [URL] for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
Changes since 2.14:
|
- |
2.12 |
|
⇒ DSCP |
unsignedInt(0:63) |
W |
{{div|{{classes}}|The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero.}} The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. |
- |
2.12 |
|
⇒ EthernetPriority |
unsignedInt(0:7) |
W |
{{div|{{classes}}|Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero.}} Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. |
- |
2.12 |
|
⇒ TimeBasedTestMeasurementInterval |
unsignedInt(0:999) |
W |
{{div|{{classes}}|The measurement interval duration in {{units}} for objects in {{object|IncrementalResult}} for a time based FTP/HTTP download test (when {{param|TimeBasedTestDuration}} > 0). The default value SHOULD be 0, which implies {{object|IncrementalResult}} collection is disabled. For example if {{param|TimeBasedTestDuration}} is 90 {{units}} and {{param}} is 10 {{units}}, there will be 9 results in {{object|IncrementalResult}}, each with a 10 {{units}} duration.}} The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP download test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. |
- |
2.12 |
|
⇒ TimeBasedTestMeasurementOffset |
unsignedInt(0:255) |
W |
{{div|{{classes}}|This {{param}} works in conjunction with {{param|TimeBasedTestMeasurementInterval}} to allow the interval measurement to start a number of {{units}} after {{param|BOMTime}}. The test measurement interval in {{object|IncrementalResult}} starts at time {{param|BOMTime}} + {{param}} to allow for slow start window removal of file transfers. This {{param}} is in {{units}}. The default value SHOULD be 0.}} This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval to allow the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers. This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0. |
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ ROMTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ BOMTime |
dateTime |
R |
Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ EOMTime |
dateTime |
R |
End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TotalBytesReceived |
unsignedInt |
R |
The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesSent |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at BOMTime and at EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesReceivedUnderFullLoading |
unsignedInt |
R |
The total number of bytes (at the IP layer) received in between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. |
- |
2.12 |
|
⇐ TotalBytesSentUnderFullLoading |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. |
- |
2.12 |
|
⇐ TCPOpenRequestTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TCPOpenResponseTime |
dateTime |
R |
Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ PerConnectionResult.{i}. |
object(0:) |
R |
Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇐ ROMTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ BOMTime |
dateTime |
R |
Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ EOMTime |
dateTime |
R |
End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TotalBytesReceived |
unsignedInt |
R |
The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. |
- |
2.12 |
|
⇐ TotalBytesSent |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at BOMTime and at EOMTime and subtracting. |
- |
2.12 |
|
⇐ TCPOpenRequestTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TCPOpenResponseTime |
dateTime |
R |
Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ IncrementalResult.{i}. |
object(0:) |
R |
Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇐ TotalBytesReceived |
unsignedInt |
R |
The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at StartTime and at EndTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesSent |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at StartTime and at EndTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ StartTime |
dateTime |
R |
{{div|{{classes}}|The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z}} The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z |
- |
2.12 |
|
⇐ EndTime |
dateTime |
R |
{{div|{{classes}}|The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z}} The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z |
- |
2.12 |
|
UploadDiagnosticsMaxIncrementalResult |
unsignedInt(1:) |
R |
The maximum number of rowsinstances in UploadDiagnostics().IncrementalResult that the CPEimplementation will store.return. |
- |
2.12 |
|
UploadDiagnostics() |
command |
- |
[ASYNC] {{div|{{classes}}|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.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If {{empty}} is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ UploadURL |
string(:2048) |
W |
[MANDATORY] The [URL] for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
Changes since 2.14:
|
- |
2.12 |
|
⇒ DSCP |
unsignedInt(0:63) |
W |
{{div|{{classes}}|DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero.}} DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. |
- |
2.12 |
|
⇒ EthernetPriority |
unsignedInt(0:7) |
W |
{{div|{{classes}}|Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero.}} Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. |
- |
2.12 |
|
⇒ TestFileLength |
unsignedInt |
W |
{{div|{{classes}}|The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent.}} The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent. |
- |
2.12 |
|
⇒ TimeBasedTestMeasurementInterval |
unsignedInt(0:999) |
W |
{{div|{{classes}}|The measurement interval duration in {{units}} for objects in {{object|IncrementalResult}} for a time based FTP/HTTP upload test (when {{param|TimeBasedTestDuration}} > 0). The default value SHOULD be 0, which implies {{object|IncrementalResult}} collection is disabled. For example if {{param|TimeBasedTestDuration}} is 90 {{units}} and {{param}} is 10 {{units}}, there will be 9 results in {{object|IncrementalResult}}, each with a 10 {{units}} duration.}} The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP upload test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. |
- |
2.12 |
|
⇒ TimeBasedTestMeasurementOffset |
unsignedInt(0:255) |
W |
{{div|{{classes}}|This {{param}} works in conjunction with {{param|TimeBasedTestMeasurementInterval}} and allows the interval measurement to start a number of {{units}} after {{param|BOMTime}}. The test measurement interval in {{object|IncrementalResult}} starts at time {{param|BOMTime}} + {{param}} to allow for slow start window removal of file transfers. This {{param}} is in {{units}}. The default value SHOULD be 0.}} This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval and allows the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers. This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0. |
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ ROMTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ BOMTime |
dateTime |
R |
Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ EOMTime |
dateTime |
R |
End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TotalBytesReceived |
unsignedInt |
R |
The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesSent |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at BOMTime and at EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesReceivedUnderFullLoading |
unsignedInt |
R |
The total number of bytes (at the IP layer) received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesSentUnderFullLoading |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TCPOpenRequestTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TCPOpenResponseTime |
dateTime |
R |
Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ PerConnectionResult.{i}. |
object(0:) |
R |
Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇐ ROMTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ BOMTime |
dateTime |
R |
Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ EOMTime |
dateTime |
R |
End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TotalBytesReceived |
unsignedInt |
R |
The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesSent |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at BOMTime and at EOMTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TCPOpenRequestTime |
dateTime |
R |
Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ TCPOpenResponseTime |
dateTime |
R |
Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
|
- |
2.12 |
|
⇐ IncrementalResult.{i}. |
object(0:) |
R |
Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇐ TotalBytesReceived |
unsignedInt |
R |
The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceivedStats.BytesReceived on the Interface object at StartTime and at EndTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ TotalBytesSent |
unsignedInt |
R |
The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSentStats.BytesSent on the Interface object at StartTime and at EndTime and subtracting. If Interface is an empty string, this parameter cannot be determined and SHOULD be 0. |
- |
2.12 |
|
⇐ StartTime |
dateTime |
R |
{{div|{{classes}}|The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z}} The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z |
- |
2.12 |
|
⇐ EndTime |
dateTime |
R |
{{div|{{classes}}|The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z}} The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z |
- |
2.12 |
|
UDPEchoDiagnostics() |
command |
- |
[ASYNC] This command defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143]. |
- |
2.12 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference|the IP-layer interface over which the test is to be performed|ignore}} Example: Device.IP.Interface.1 If {{empty}} is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ Host |
string(:256) |
W |
[MANDATORY] Host name or address of the host to perform tests to. Changes since 2.14:
|
- |
2.12 |
|
⇒ Port |
unsignedInt(1:65535) |
W |
[MANDATORY] Port on the host to perform tests to. Changes since 2.14:
|
- |
2.12 |
|
⇒ Timeout |
unsignedInt(1:) |
W |
[MANDATORY] Timeout in milliseconds for the test. That is, the amount of time to wait for the return of a packet that was sent to the Host. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
⇐ IndividualPacketResult.{i}. |
object(0:) |
R |
This object provides the results from individual UDPEchoPlus test packets collected during a test if EnableIndividualPacketResults is set to true. It should contain NumberOfRepetitions objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.12 |
|
⇐ PacketSendTime |
dateTime |
R |
{{div|{{classes}}|Time the client sent this UDP Echo Plus packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z}} Time the client sent this UDP Echo Plus packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z |
- |
2.12 |
|
⇐ PacketReceiveTime |
dateTime |
R |
Time the client receives the response packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z If this response is never received, PacketReceiveTime SHOULD be set to the Unknown Time value as specified in [Section 3.2.2/TR-106]. |
- |
2.12 |
|
⇐ TestRespReplyTimeStamp |
unsignedInt |
R |
{{div|{{classes}}|The TestRespReplyTimeStamp field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0.}} The TestRespReplyTimeStamp field in the response packet [Section A.1.4/TR-143] from the UDP Echo Plus server (i.e. Host) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If PacketSuccess is false, TestRespReplyTimeStamp SHOULD be 0. |
- |
2.12 |
|
IPLayerMaxIncrementalResult |
unsignedInt(1:) |
R |
The maximum number of rowsinstances in IPLayerCapacity().IncrementalResult that the deviceimplementation will store.return. |
- |
2.14 |
|
IPLayerCapSupportedSoftwareVersion |
string(:64) |
R |
Indicates the installed version of the test software. The software version string will be implementation-dependent, and SHOULD identify both the implementation and the version (e.g., UDPST-7.2.1). |
- |
2.15 |
|
IPLayerCapSupportedControlProtocolVersion |
string(:64) |
R |
Indicates the control protocol version supported by the test software. Refer to [TR-471] for more information. |
- |
2.15 |
|
IPLayerCapSupportedMetrics |
string[] |
R |
Comma-separated list of strings. Indicates the test metrics from [Section 5.2/TR-471] that are supported by the device. Note that [TR-471] mandates support for and use of IPLR and Sampled RTT. Each list item is an enumeration of:
Changes since 2.14:
|
- |
2.14 |
|
IPLayerCapacity() |
command |
- |
[ASYNC] {{div|{{classes}}|This command defines the IP Layer Capacity measurement configuration. IP Layer Capacity measurement is specified in {{bibref|TR-471}}. Data received in the IP Layer Capacity measurement do not require storage on the device.}} This command defines the IP Layer Capacity measurement configuration. IP Layer Capacity measurement is specified in [TR-471]. Data received in the IP Layer Capacity measurement do not require storage on the device. Changes since 2.14:
|
- |
2.14 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
Note that {{bibref|TR-471}} mandates support for and use of IPLR and Sampled RTT. The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the device MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.14 |
|
⇒ JumboFramesPermitted |
boolean |
W |
If true, jumbo frames are allowed.allowed Defaultabove 1 Gbps. The default value SHOULD be {{false}}true. |
- |
2.14 |
|
⇒ UDPPayloadMin |
unsignedInt(35:8972) |
W |
Minimum reference size of UDP payload in octets. No default. The implementation will algorithmically determine a value if none is configured. The value SHOULD be set to a value that avoids fragmentation (i.e., using path MTU discovery). Changes since 2.14:
|
- |
2.14 |
|
⇒ UDPPayloadMax |
unsignedInt(35:8972) |
W |
Maximum reference size of UDP payload in octets. No default. The implementation will algorithmically determine a value if none is configured. The value SHOULD be set to the largest value that avoids fragmentation (i.e., using path MTU discovery). If JumboFramesPermitted is false, the maximum value MUST be 1472 octets. If JumboFramesPermitted is true, this value can be as large as 90008972 octets. UDPPayloadMax MUST be greater than or equal to UDPPayloadMin. Changes since 2.14:
|
- |
2.14 |
|
⇒ UDPPayloadContent |
string |
W |
UDP Payload Content Type, If there is payload compression in the path and tests intend to characterize a possible advantage due to compression, then payload content SHOULD be supplied by a pseudo-random sequence generator, by using part of a compressed file, or by other means. Payload may also contain the test protocol PDUs. The default value SHOULD be zeroes. Enumeration of:
|
- |
2.15 |
|
⇒ PortMin |
unsignedInt(49152:65535) |
W |
Starting value for range of Dynamic Ports supported for test traffic and status feedback messages. PortMin MUST be less than or equal to PortMax, if specified. If PortMin and PortMax are not specified, the full range of Ports in the Dynamic Ports range (49152-65535) that have been specifically set aside by IANA MAY be used. Changes since 2.14:
|
- |
2.14 |
|
⇒ PortMax |
unsignedInt(49152:65535) |
W |
Indicates the upper bound of the supported Dynamic Port range, where PortMin indicates the starting port number. PortMax MUST be greater than or equal to PortMin., if specified. If PortMin and PortMax are not specified, the full range of Ports in the Dynamic Ports range (49152-65535) that have been specifically set aside by IANA MAY be used. Changes since 2.14:
|
- |
2.14 |
|
⇒ IPDVEnable |
boolean |
W |
Enables one-way IPDV (IP packetPacket Delay Variation) metric.metric Defaultfor load rate adjustment algorithm. When true (enabled), one-way delay variation is used, otherwise round-trip delay variation is used. The default value SHOULD be false. |
- |
2.14 |
|
⇒ IPRREnable |
boolean |
W |
Enables IPRR (IP packet Reordering Ratio) metric. DefaultThe default value SHOULD be false. |
- |
2.14 |
|
⇒ RIPREnable |
boolean |
W |
Enables RIPRR (Replicated IP Packet Ratio) metric. The default value SHOULD be false. |
- |
2.15 |
|
⇒ StartSendingRate |
unsignedInt(500:10000000) |
W |
The Sending Rate for a Fixed test or the initial Sending Rate value for a Search test. Value specified in kbps. The default value SHOULD be 500 kbps. Changes since 2.14:
|
- |
2.14 |
|
⇒ NumberFirstModeTestSubIntervals |
unsignedInt(0:100) |
W |
When the value >= 1, bimodal test mode is requested and the value represents the number of sub-intervals to be included in the first capacity test mode. The remaining sub-intervals of NumberTestSubIntervals are for the second capacity test mode. Value = 0 indicates that bimodal testing is disabled. The value MUST NOT be greater than NumberTestSubIntervals. The default value SHOULD be 0. |
- |
2.15 |
|
⇒ StatusFeedbackInterval |
unsignedInt(5:250) |
W |
Period of status feedback message (receiver of offered load returns messages to the sender with results of measured metrics). Value specified in milliseconds. The default value SHOULD be 50 milliseconds. |
- |
2.14 |
|
⇒ TimeoutNoTraffic |
unsignedInt(5:30) |
W |
Timeout value. Value specified in seconds. The default value SHOULD be 5 seconds. This parameter was DEPRECATED in 2.15 because it is superseded by TimeoutNoTestTraffic due to new precision requirement. Refer to [TR-471] for details. Changes since 2.14:
|
- |
2.14 |
|
⇒ TimeoutNoTestTraffic |
unsignedInt(500:1000) |
W |
Timeout value. If no test traffic packets are received for TimeoutNoTestTraffic milliseconds, test will timeout. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. |
- |
2.15 |
|
⇒ TimeoutNoStatusMessage |
unsignedInt(500:1000) |
W |
Timeout value. If no status message packets are received for TimeoutNoStatusMessage milliseconds, test will timeout. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. |
- |
2.15 |
|
⇒ Tmax |
unsignedInt(50:3000) |
W |
Maximum waiting time for packets to arrive. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. |
- |
2.14 |
|
⇒ TmaxRTT |
unsignedInt(50:3000) |
W |
Maximum Round Trip Time waiting time for packets to arrive. Value specified in milliseconds. The default value SHOULD be 3000 milliseconds. |
- |
2.14 |
|
⇒ TimestampResolution |
unsignedInt(1:1000) |
W |
Indicates the requested precision of timestamp values. The test implementation will determine the actual precision to use based on the implemented resolution capabilities of the protocols used and this requested value. If the implemented resolution capabilities of the IPLayerCapSupportedMetrics protocols being used are able to provide the requested resolution, this resolution SHOULD be provided. Value specified in microseconds. The default value SHOULD be 1 microseconds. |
- |
2.14 |
|
⇒ SeqErrThresh |
unsignedInt(0:100) |
W |
This parameter is only meaningful if TestType is Search. Threshold for Loss or Reordering or Replication impairments measured (events where received packet sequence number did not increase by one). The default value SHOULD be 10. |
- |
2.15 |
|
⇒ ReordDupIgnoreEnable |
boolean |
W |
This parameter is only meaningful if TestType is Search. When true (enabled) only Loss counts toward received packet sequence number errors, and reordering and Duplication impairments are ignored. When false (disabled), Loss, Reordering and Duplication are all counted as sequence number errors. The default value SHOULD be false (disabled). |
- |
2.15 |
|
⇒ LowerThresh |
unsignedInt(5:250) |
W |
This parameter is only meaningful if TestType is Search. The lower threshold on the range of Round Trip Time (RTT) variation. Value specified in milliseconds. The default value SHOULD be 30 milliseconds. |
- |
2.14 |
|
⇒ UpperThresh |
unsignedInt(5:250) |
W |
This parameter is only meaningful if TestType is Search. The upper threshold on the range of Round Trip Time (RTT) variation. Value specified in milliseconds. The default value SHOULD be 90 milliseconds. |
- |
2.14 |
|
⇒ HighSpeedDelta |
unsignedInt(2:) |
W |
This parameter is only meaningful if TestType is Search. The number of rows to move in a single adjustment when initially increasing offered load (to ramp up quickly). The default value SHOULD be 10. |
- |
2.14 |
|
⇒ SlowAdjThresh |
unsignedInt(2:) |
W |
This parameter is only meaningful if TestType is Search. Threshold on the measured number of consecutive status reports indicating loss and/or delay variation above UpperThresh (SlowAdjCount). The default value SHOULD be 2.3. |
- |
2.14 |
|
⇒ HSpeedThresh |
unsignedInt(1:) |
W |
This parameter is only meaningful if TestType is Search. Threshold for transition between low and high sending rate step sizes (such as 1Mbps and 100 Mbps). If JumboFramesPermitted is true this may result in use of jumbo frames. The default value SHOULD be 1 Gbps. |
- |
2.14 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.14 |
|
⇐ MaxIPLayerCapacity |
decimal |
R |
The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 32 digits beyond the decimal. 10^6 bits/second = 1 Mbps.Mbps. |
- |
2.14 |
|
⇐ MaxETHCapacityNoFCS |
decimal |
R |
Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ MaxETHCapacityWithFCS |
decimal |
R |
Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ MaxETHCapacityWithFCSVLAN |
decimal |
R |
Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ ReplicatedRatioAtMax |
decimal |
R |
Ratio of replicated packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ InterfaceEthMbpsAtMax |
decimal |
R |
The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. |
- |
2.15 |
|
⇐ IPLayerCapacitySummary |
decimal |
R |
The IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ LossRatioSummary |
decimal |
R |
Ratio of lost packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ RTTRangeSummary |
decimal |
R |
The range of measured Round Trip Time (RTT) during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ PDVRangeSummary |
decimal |
R |
The range of Packet Delay Variation (PDV) during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ MinOnewayDelaySummary |
decimal |
R |
The minimum one-way delay during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ MinRTTSummary |
decimal |
R |
The minimum RTT during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ ReorderedRatioSummary |
decimal |
R |
Ratio of reordered packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ ReplicatedRatioSummary |
decimal |
R |
Ratio of replicated packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ InterfaceEthMbpsSummary |
decimal |
R |
The number of bits observed on the Interface during an IP-Layer Capacity test for the entire time interval of duration TestInterval, divided by the duration of TestInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. |
- |
2.15 |
|
⇐ TimestampResolutionUsed |
unsignedInt |
R |
Indicates the timestamp resolution of reported results. This is a function of the measurement protocol, and it is usually determined once the protocol chosen. Value specified in microseconds. |
- |
2.14 |
|
⇐ ModalResult.{i}. |
object(1:) |
R |
Modal test results. Only returned when bimodal test mode is enabled (NumberFirstModeTestSubIntervals >=1). If returned, it MUST contain 1 or more entries, with instance number 1 corresponding to the second mode and instance number 2 corresponding to the third mode. Results for the Maximum in each mode/instance are calculated based on IncrementalResult.{i}. data within the boundary of its corresponding mode. This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). |
- |
2.15 |
|
⇐ MaxIPLayerCapacity |
decimal |
R |
The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values within corresponding mode across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ TimeOfMax |
dateTime |
R |
Time in UTC of end of the sub-interval when MaxIPLayerCapacity was measured. If the value of MaxIPLayerCapacity occurred in multiple sub-intervals, this MUST be the earliest of these sub-intervals. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z |
- |
2.15 |
|
⇐ MaxETHCapacityNoFCS |
decimal |
R |
Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ MaxETHCapacityWithFCS |
decimal |
R |
Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ MaxETHCapacityWithFCSVLAN |
decimal |
R |
Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. |
- |
2.15 |
|
⇐ LossRatioAtMax |
decimal |
R |
Ratio of lost packets to total packets during sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ RTTRangeAtMax |
decimal |
R |
The range of Round Trip Time (RTT) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ PDVRangeAtMax |
decimal |
R |
The range of Packet Delay Variation (PDV) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ MinOnewayDelayAtMax |
decimal |
R |
The minimum one-way delay during the sub-interval of MaxIPLayerCapacity. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ ReorderedRatioAtMax |
decimal |
R |
Ratio of reordered packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ ReplicatedRatioAtMax |
decimal |
R |
Ratio of replicated packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ InterfaceEthMbpsAtMax |
decimal |
R |
The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. |
- |
2.15 |
|
⇐ IncrementalResult.{i}. |
object(0:) |
R |
Results for time segmented tests (tests where NumberTestSubIntervals > 1). This data is calculated across all connections in the test. A new object is created every TestSubInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when new test is started or results are otherwise cleared. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps). Changes since 2.14:
|
- |
2.14 |
|
⇐ IPLayerCapacity |
decimal |
R |
Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from [TR-471] Equation 1, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. Result is expressed in Mbps with 32 digits beyond the decimal. 10^6 bits/second = 1 Mbps.Mbps. |
- |
2.14 |
|
⇐ ReplicatedRatio |
decimal |
R |
Ratio of replicated packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
⇐ InterfaceEthMbps |
decimal |
R |
The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at TimeOfSubInterval, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. |
- |
2.15 |
|
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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference|the IP-layer interface over which the test is to be performed|ignore}} Example: Device.IP.Interface.1 If {{empty}} is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ ProtocolVersion |
string |
W |
[MANDATORY] Indicates the IP protocol version to be used. Enumeration of:
The default value MUST be Any. Changes since 2.14:
|
- |
2.12 |
|
⇒ Protocol |
string |
W |
[MANDATORY] The protocol over which the test is to be performed. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
⇒ HostList |
string(:256)[:10]() |
W |
[MANDATORY] Comma-separated list (up to 10 items) (length ) of strings (maximum number of characters per item 256). Each entry is a Host name or address of a host to ping. Changes since 2.14:
|
- |
2.12 |
|
⇒ NumberOfRepetitions |
unsignedInt(1:) |
W |
[MANDATORY] Number of repetitions of the ping test to perform for each HostList entry before reporting the results. Changes since 2.14:
|
- |
2.12 |
|
⇒ Timeout |
unsignedInt(1:) |
W |
[MANDATORY] Timeout in milliseconds for each iteration of the ping test where the total number of iterations is the value of NumberOfRepetitions times the number of entities in the HostList Parameter. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
Device.IP.Diagnostics.UDPEchoConfig. |
object |
R |
This object allows the CPE to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. |
- |
2.12 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of IP-layer interface over which the CPE MUST listen and receive UDP echo requests on. The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets. |
- |
2.12 |
|
TimeFirstPacketReceived |
dateTime |
R |
Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456, The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
TimeLastPacketReceived |
dateTime |
R |
Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 The time that the server receives the most recent UDP echo packet. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.LLDP. |
object |
R |
This object contains Link Layer Discovery Protocol (LLDP) [802.1AB-2009] related objects and parameters. |
- |
2.12 |
|
Device.LLDP.Discovery. |
object |
R |
{{div|{{classes}}|This object is used for managing the discovery of LLDP devices. The CPE MAY, but need not, retain some or all of the information in this object across reboot.}} This object is used for managing the discovery of LLDP devices. The CPE MAY, but need not, retain some or all of the information in this object across reboot. |
- |
2.12 |
|
Device.LLDP.Discovery.Device.{i}. |
object(0:) |
R |
This table contains information about discovered LLDP devices. At most one entry in this table can exist with the same values for both ChassisIDSubtype and ChassisID. |
- |
2.12 |
|
ChassisIDSubtype |
unsignedInt(:255) |
R |
The chassis identifier subtype, which is included in the value of the LLDPDU's Chassis ID TLV (TLV Type = 1). The following subtype values are defined:
|
- |
2.12 |
|
ChassisID |
string(1:255) |
R |
{{div|{{classes}}|The chassis identifier, which is included in the value of the LLDPDU's Chassis ID TLV (TLV Type = 1). Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the Chassis ID is set to the representative MAC address. If LLDPDUs are sent and received from two or more LLDP agents of the same HTIP-Ethernet Bridge, this value is same in all LLDPDUs.}} The chassis identifier, which is included in the value of the LLDPDU's Chassis ID TLV (TLV Type = 1). Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the Chassis ID is set to the representative MAC address. If LLDPDUs are sent and received from two or more LLDP agents of the same HTIP-Ethernet Bridge, this value is same in all LLDPDUs. |
- |
2.12 |
|
Host |
string(:256)[](:1024) |
R |
Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. {{div|{{classes}}|{{list}}Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this device. When the entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.}} Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256).Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this device. When the entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. |
- |
2.12 |
|
Device.LLDP.Discovery.Device.{i}.Port.{i}. |
object(0:) |
R |
This table contains information about ports on discovered LLDP devices. At most one entry in this table can exist with the same values for both PortIDSubtype and PortID. |
- |
2.12 |
|
PortIDSubtype |
unsignedInt(:255) |
R |
The port identifier subtype, which is included in the value of the LLDPDU's Port ID TLV (TLV Type = 2). The following subtype values are defined:
|
- |
2.12 |
|
TTL |
unsignedInt(:65535) |
R |
{{div|{{classes}}|The LLDPDU lifetime (in {{units}}), which is the value of the latest TimeToLive TLV (TLV Type = 3). If this value is 0, it means that the LLDP agent or the MAC service function of the port is stopped.}} The LLDPDU lifetime (in seconds), which is the value of the latest TimeToLive TLV (TLV Type = 3). If this value is 0, it means that the LLDP agent or the MAC service function of the port is stopped. |
- |
2.12 |
|
PortDescription |
string(:255) |
R |
{{div|{{classes}}|The port description, which is the value of the latest Port Description TLV (TLV Type = 4), or {{empty}} if no Port Description TLV has been received. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the parameter value is likely to be one of the names defined in {{bibref|JJ-300.00|Appendix A (List of Interface Standard Names)}}.}} The port description, which is the value of the latest Port Description TLV (TLV Type = 4), or an empty string if no Port Description TLV has been received. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the parameter value is likely to be one of the names defined in [Appendix A (List of Interface Standard Names)/JJ-300.00]. |
- |
2.12 |
|
MACAddressList |
string(:17)[:255]() |
R |
[MACAddress] Comma-separated list (up to 255 items) (length ) of MAC Addresses. The device's MAC addresses, which are included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or an empty string if no list of MAC addresses has been received. The parameter is relevant when there is a LLDP device which has a MAC copy function and has two or more MAC addresses. Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 3 (MAC Address List). |
- |
2.12 |
|
Device.LLDP.Discovery.Device.{i}.Port.{i}.LinkInformation. |
object |
R |
{{div|{{classes}}|The port's link information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the {{bibref|OUI}} in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 2 (Link Information).}} The port's link information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 2 (Link Information). |
- |
2.12 |
|
InterfaceType |
unsignedInt |
R |
The port's interface type, or 0 if no interface type has been received. Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, it's an IANA interface type [IANAifType]. For example, IANAifType defines the following interface types for wired line (UTP cable), wireless line, power line, and coaxial cable:
|
- |
2.12 |
|
Device.LLDP.Discovery.Device.{i}.DeviceInformation. |
object |
R |
{{div|{{classes}}|The device information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the {{bibref|OUI}} in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 1 (Device Information).}} The device information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 1 (Device Information). |
- |
2.12 |
|
DeviceCategory |
string[] |
R |
Comma-separated list of strings. {{div|{{classes}}|Each list item indicates a device category (e.g."AV_TV" and "AV_Recorder"), or the value is {{empty}} if no device categories were provided. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. Standard HTIP device categories are defined in {{bibref|JJ-300.01}}. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.}} Each list item indicates a device category (e.g."AV_TV" and "AV_Recorder"), or the value is an empty string if no device categories were provided. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories. |
- |
2.12 |
|
ManufacturerOUI |
string(0:6) |
R |
{{div|{{classes}}|The manufacturer OUI, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no manufacturer OUI was provided. {{pattern}}}} The manufacturer OUI, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or an empty string if no manufacturer OUI was provided. Possible patterns:
|
- |
2.12 |
|
ModelName |
string(:31) |
R |
{{div|{{classes}}|The model name, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no model name was provided. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}.}} |
- |
2.12 |
|
ModelNumber |
string(:31) |
R |
{{div|{{classes}}|The model number, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no model number was provided. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}.}} |
- |
2.12 |
|
Device.LLDP.Discovery.Device.{i}.DeviceInformation.VendorSpecific.{i}. |
object(0:) |
R |
The vendor-specific device information, which is included in the value of the LLDPDU's Organizationally Specific TLV (TLV Type = 127). At most one entry in this table can exist with the same values for both OrganizationCode and InformationType. Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the [OUI] in the third octet is E0271A (TTC-OUI), the organizationally defined subtype in the sixth octet is 1 (Device Information), and the device information ID in the seventh octet is 255 (Vendor-specific extension field). |
- |
2.12 |
|
Device.IPsec. |
object |
R |
IPsec [RFC4301] object that supports the configuration of Encapsulating Security Payload (ESP) [RFC4303] and Authentication Header (AH) [RFC4302] in tunnel mode [Section 3.2/RFC4301]. Use of IKEv2 [RFC5996] is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). See the IPsec Theory of Operation [Appendix IX/TR-181i2] for a description of the working of this IPsec data model. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|IPsec status. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} IPsec status. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
IKEv2SupportedEncryptionAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported IKEv2 encryption algorithms [Transform Type 1/IKEv2-params]. Each list item is an enumeration of:
|
- |
2.12 |
|
ESPSupportedEncryptionAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported ESP encryption algorithms [Transform Type 1/IKEv2-params] [Section 3.1.1/RFC4835]. Each list item is an enumeration of:
|
- |
2.12 |
|
IKEv2SupportedPseudoRandomFunctions |
string[] |
R |
Comma-separated list of strings. Supported IKEv2 pseudo-random functions [Transform Type 2/IKEv2-params]. Each list item is an enumeration of:
|
- |
2.12 |
|
SupportedIntegrityAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported integrity algorithms [Transform Type 3/IKEv2-params]. Each list item is an enumeration of:
|
- |
2.12 |
|
SupportedDiffieHellmanGroupTransforms |
string[] |
R |
Comma-separated list of strings. Supported Diffie-Hellman group transforms [Transform Type 4/IKEv2-params]. Each list item is an enumeration of:
|
- |
2.12 |
|
MaxFilterEntries |
unsignedInt |
R |
{{div|{{classes}}|The maximum number of entries in the {{object|Filter}} table. A value of 0 means no specific limit.}} The maximum number of entries in the Filter table. A value of 0 means no specific limit. |
- |
2.12 |
|
MaxProfileEntries |
unsignedInt |
R |
{{div|{{classes}}|The maximum number of entries in the {{object|Profile}} table. A value of 0 means no specific limit.}} The maximum number of entries in the Profile table. A value of 0 means no specific limit. |
- |
2.12 |
|
Device.IPsec.Stats. |
object |
R |
{{div|{{classes}}|Global IPsec statistics. These statistics include all IPsec traffic, i.e. all IKEv2 negotiation, IKEv2 SAs and child SAs. The CPE MUST reset global IPsec Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when IPsec is disabled ({{param|.IPsec.Enable}} is set to {{false}}) or when IPsec is enabled ({{param|.IPsec.Enable}} is set to {{true}}).}} Global IPsec statistics. These statistics include all IPsec traffic, i.e. all IKEv2 negotiation, IKEv2 SAs and child SAs. The CPE MUST reset global IPsec Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when IPsec is disabled (IPsec.Enable is set to false) or when IPsec is enabled (IPsec.Enable is set to true). |
- |
2.12 |
|
Device.IPsec.Filter.{i}. |
object(0:) |
W |
Filter table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] selection criteria. Each (ordered) entry defines a set of selection criteria and references a Profile table entry that specifies how matching packets will be processed. SPD filtering is performed for all packets that might need to cross the IPsec boundary [Section 3.1/RFC4301]. Given that IPsec operates at the IP level, this means that SPD filtering conceptually occurs after bridging and before routing. 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this IPsec Filter table entry. Enumeration of:
|
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 |
|
Interface |
string(:256) |
W |
{{div|{{classes}}|SPD selection criterion. {{reference}} This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface. However, the types of interfaces for which filters can be instantiated is a local matter to the CPE.}} SPD selection criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface. However, the types of interfaces for which filters can be instantiated is a local matter to the CPE. |
<Empty> |
2.12 |
|
AllInterfaces |
boolean |
W |
{{div|{{classes}}|SPD selection criterion. This specifies that all ingress interfaces are associated with the entry. If {{true}}, the value of {{param|Interface}} is ignored since all ingress interfaces are indicated.}} SPD selection criterion. This specifies that all ingress interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress interfaces are indicated. |
false |
2.12 |
|
DestIP |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|SPD selection criterion. Destination IP address. {{empty}} indicates this criterion is not used, i.e. is ANY.}} SPD selection criterion. Destination IP address. An empty string indicates this criterion is not used, i.e. is ANY. |
<Empty> |
2.12 |
|
DestMask |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|SPD selection criterion. Destination IP address mask. If not {{empty}}, only the indicated network portion of the {{param|DestIP}} address is to be used for selection. {{empty}} indicates that the full {{param|DestIP}} address is to be used for selection.}} |
<Empty> |
2.12 |
|
DestIPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the rule matches only those packets that match the (masked) {{param|DestIP}} entry, if specified. If {{true}}, the rule matches all packets except those that match the (masked) {{param|DestIP}} entry, if specified.}} |
false |
2.12 |
|
SourceIP |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|SPD selection criterion. Source IP address. {{empty}} indicates this criterion is not used, i.e. is ANY.}} SPD selection criterion. Source IP address. An empty string indicates this criterion is not used, i.e. is ANY. |
<Empty> |
2.12 |
|
SourceMask |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|SPD selection criterion. Source IP address mask. If not {{empty}}, only the indicated network portion of the {{param|SourceIP}} address is to be used for selection. {{empty}} indicates that the full {{param|SourceIP}} address is to be used for selection.}} |
<Empty> |
2.12 |
|
SourceIPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the rule matches only those packets that match the (masked) {{param|SourceIP}} entry, if specified. If {{true}}, the rule matches all packets except those that match the (masked) {{param|SourceIP}} entry, if specified.}} |
false |
2.12 |
|
Protocol |
int(-1:255) |
W |
SPD selection criterion. Protocol number. A value of -1 indicates this criterion is not used, i.e. is ANY. Note that [RFC4301] refers to this as the Next Layer Protocol. It is obtained from the IPv4 Protocol or the IPv6 Next Header fields. |
-1 |
2.12 |
|
ProtocolExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the rule matches only those packets that match {{param|Protocol}}, if specified. If {{true}}, the rule matches all packets except those that match {{param|Protocol}}, if specified.}} |
false |
2.12 |
|
DestPort |
int(-1:65535) |
W |
SPD selection criterion. Destination port number. A value of -1 indicates this criterion is not used, i.e. is ANY. The value of this parameter is ignored for protocols that do not use ports, e.g. ICMP (1). |
-1 |
2.12 |
|
DestPortRangeMax |
int(-1:65535) |
W |
SPD selection criterion. If specified, indicates a destination port address range from DestPort through DestPortRangeMax (inclusive), in which case DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no destination port range is specified. |
-1 |
2.12 |
|
DestPortExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the rule matches only those packets that match {{param|DestPort}} (or port range), if specified. If {{true}}, the rule matches all packets except those that match {{param|DestPort}} (or port range), if specified.}} |
false |
2.12 |
|
SourcePort |
int(-1:65535) |
W |
SPD selection criterion. Source port number. A value of -1 indicates this criterion is not used, i.e. is ANY. The value of this parameter is ignored for protocols that do not use ports, e.g. ICMP (1). |
-1 |
2.12 |
|
SourcePortRangeMax |
int(-1:65535) |
W |
SPD selection criterion. If specified, indicates a source port address range from SourcePort through SourcePortRangeMax (inclusive), in which case SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no source port range is specified. |
-1 |
2.12 |
|
SourcePortExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the rule matches only those packets that match {{param|SourcePort}} (or port range), if specified. If {{true}}, the rule matches all packets except those that match {{param|SourcePort}} (or port range), if specified.}} If false, the rule matches only those packets that match SourcePort (or port range), if specified. If true, the rule matches all packets except those that match SourcePort (or port range), if specified. |
false |
2.12 |
|
Profile |
string |
W |
The profile that defines the IPsec treatment for matching packets. The value MUST be the Path Name of a row in the Profile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If ProcessingChoice is Protect, Profile MUST NOT be an empty string. In this case, if it ever becomes an empty string, e.g. because the referenced profile is deleted, this IPsec Filter table entry is invalid and Status MUST be set to Error_Misconfigured. If ProcessingChoice is not Protect, Profile is ignored. Any changes to the referenced profile will have an immediate effect on any established IPsec tunnels. Such changes will often force IKEv2 sessions and child SAs to be re-established. |
- |
2.12 |
|
Device.IPsec.Profile.{i}. |
object(0:) |
W |
Profile table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] processing info. Each entry defines the IPsec treatment for packets that match the Filter entries that reference the entry. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
MaxChildSAs |
unsignedInt |
W |
Controls the maximum number of child Security Association (SA) pairs that can be negotiated by a single IKEv2 session. If a new child SA pair is needed, but the current IKEv2 session already has MaxChildSAs child SA pairs, an additional IKEv2 session (and therefore an additional IPsec tunnel) will be established. A value of 0 means no specific limit. Note that support for more than one child SA pair per IKEv2 session is OPTIONAL [Section 1.3/RFC5996]. |
- |
2.12 |
|
ForwardingPolicy |
unsignedInt |
W |
{{div|{{classes}}|Identifier of the forwarding policy associated with traffic that is associated with this profile. The forwarding policy can be referenced by entries in the {{object|##.Routing.Router.{i}.IPv4Forwarding}} and {{object|##.Routing.Router.{i}.IPv6Forwarding}} tables, and therefore allows SPD selection criteria to influence the forwarding decision.}} Identifier of the forwarding policy associated with traffic that is associated with this profile. The forwarding policy can be referenced by entries in the Routing.Router.{i}.IPv4Forwarding and Routing.Router.{i}.IPv6Forwarding tables, and therefore allows SPD selection criteria to influence the forwarding decision. |
0 |
2.12 |
|
Protocol |
string |
W |
{{div|{{classes}}|The "child" security protocol. This is not to be confused with {{object|#.Filter}}.{{param|#.Filter.{i}.Protocol}}, which is an SPD selector that can select packets that already have AH or ESP headers. {{object}}.{{param}} selects whether AH or ESP will be used when encapsulating a packet.}} The "child" security protocol. This is not to be confused with Filter.Filter.{i}.Protocol, which is an SPD selector that can select packets that already have AH or ESP headers. Profile.Protocol selects whether AH or ESP will be used when encapsulating a packet. Enumeration of:
|
ESP |
2.12 |
|
IKEv2AuthenticationMethod |
string |
W |
{{div|{{classes}}|IKEv2 CPE authentication method {{bibref|RFC5996|Section 2.15}}. {{reference|an enabled row in the {{object|.Security.Certificate}} table or in another table that contains appropriate CPE credentials}} If {{empty}}, or the referenced row is disabled or deleted, the CPE chooses the authentication method based on local policy.}} IKEv2 CPE authentication method [Section 2.15/RFC5996]. The value MUST be the Path Name of an enabled row in the Security.Certificate table or in another table that contains appropriate CPE credentials. If an empty string, or the referenced row is disabled or deleted, the CPE chooses the authentication method based on local policy. |
<Empty> |
2.12 |
|
AntiReplayWindowSize |
unsignedInt |
W |
{{div|{{classes}}|The size of the AH or ESP Anti-Replay Window. {{bibref|RFC4302|Section B.2}} {{bibref|RFC4303|Section A2}} A value of 0 means that Sequence Number Verification is disabled.}} The size of the AH or ESP Anti-Replay Window. [Section B.2/RFC4302] [Section A2/RFC4303] A value of 0 means that Sequence Number Verification is disabled. |
0 |
2.12 |
|
DSCPMarkPolicy |
int(-2:63) |
W |
DSCP with which to mark the outer IP header for traffic that is associated with this IPsec channel. A value of -1 indicates copy from the incoming packet. A value of -2 indicates automatic marking of DSCP. De-tunneled packets are never re-marked. Automatic DSCP marking behavior is a local matter to the CPE, possibly influenced by other Broadband Forum standards that it supports. |
- |
2.12 |
|
IKEv2SATrafficLimit |
unsignedLong |
W |
{{div|{{classes}}|IKEv2 SA lifetime in {{units}}, or zero if there is no traffic constraint on its expiration. If both {{param}} and {{param|IKEv2SATimeLimit}} are non-zero, the IKEv2 SA is deleted when the first limit is reached.}} IKEv2 SA lifetime in bytes, or zero if there is no traffic constraint on its expiration. If both IKEv2SATrafficLimit and IKEv2SATimeLimit are non-zero, the IKEv2 SA is deleted when the first limit is reached. |
- |
2.12 |
|
IKEv2SATimeLimit |
unsignedInt |
W |
{{div|{{classes}}|IKEv2 SA lifetime in {{units}}, or zero if there is no time constraint on its expiration. If both {{param}} and {{param|IKEv2SATrafficLimit}} are non-zero, the IKEv2 SA is deleted when the first limit is reached.}} IKEv2 SA lifetime in seconds, or zero if there is no time constraint on its expiration. If both IKEv2SATimeLimit and IKEv2SATrafficLimit are non-zero, the IKEv2 SA is deleted when the first limit is reached. |
- |
2.12 |
|
ChildSATrafficLimit |
unsignedLong |
W |
{{div|{{classes}}|Child SA lifetime in {{units}}, or zero if there is no traffic constraint on its expiration. If both {{param}} and {{param|ChildSATimeLimit}} are non-zero, the child SA is deleted when the first limit is reached.}} Child SA lifetime in bytes, or zero if there is no traffic constraint on its expiration. If both ChildSATrafficLimit and ChildSATimeLimit are non-zero, the child SA is deleted when the first limit is reached. |
- |
2.12 |
|
ChildSATimeLimit |
unsignedInt |
W |
{{div|{{classes}}|Child SA lifetime in {{units}}, or zero if there is no time constraint on its expiration. If both {{param}} and {{param|ChildSATrafficLimit}} are non-zero, the child SA is deleted when the first limit is reached.}} Child SA lifetime in seconds, or zero if there is no time constraint on its expiration. If both ChildSATimeLimit and ChildSATrafficLimit are non-zero, the child SA is deleted when the first limit is reached. |
- |
2.12 |
|
Device.IPsec.Tunnel.{i}. |
object(0:) |
R |
Represents an IPsec tunnel, i.e. a virtual IP interface that models an IPsec tunnel entry point and exit point. A Tunnel instance always references (and has the same lifetime as) a (Tunnel,Tunneled) IP.Interface pair. The Tunnel instance models the IPsec-specific concepts, the Tunnel IP.Interface instance models the generic concepts, and the Tunneled IP.Interface instance exists only so it can be referenced by forwarding or filter rules. Tunnel instances are automatically created (as needed) when Filter instances are enabled and disabled. Each instance's Filters parameter references the Filter instances that require the Tunnel instance to exist. If this list ever becomes an empty string, e.g. because all the referenced Filter instances have been disabled or deleted, the CPE MAY choose not to delete the Tunnel instance (and its associated (Tunnel,Tunneled) IP.Interface pair). This can be desirable, because QoS.Classification, Routing.Router.{i}.IPv4Forwarding, Routing.Router.{i}.IPv6Forwarding etc instances might be referencing the IP.Interface instances. At most one entry in this table can exist with a given value for Alias, or with the same values for both TunnelInterface and TunneledInterface. |
- |
2.12 |
|
Device.IPsec.Tunnel.{i}.Stats. |
object |
R |
Statistics for this IPsec tunnel, i.e. all traffic that has passed through the tunnel, including IKEv2 negotiation, IKEv2 SA and ChildSA traffic. The CPE 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. its associated IP.Interface.{i}.Status parameter transitions to a down state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. its associated IP.Interface.{i}.Enable parameter transition from false to true). Note that this object does not include generic statistics that are available in the associated IP.Interface.{i}.Stats object. |
- |
2.12 |
|
Device.IPsec.IKEv2SA.{i}. |
object(0:) |
R |
Represents an IKEv2 Security Association (SA), corresponding to an IKEv2 session. Instances are automatically created and deleted as IKEv2 SAs are created and deleted. At most one entry in this table can exist with a given value for Tunnel. |
- |
2.12 |
|
Tunnel |
string |
R |
{{div|{{classes}}|The associated {{object|#.Tunnel}} instance. {{reference}} Note that {{param}} is a unique key, i.e only one {{object}} instance is associated with a given {{object|#.Tunnel}} instance. During rekeying {{bibref|RFC5996|Section 2.8}}, a new IKEv2 SA is created and inherits the existing IKEv2 SA's child SAs, then the old IKEv2 SA is deleted. From the management point of view the new and old IKEv2 SAs are the same SA and MUST be modeled using the same {{object}} instance.}} The associated Tunnel instance. The value MUST be the Path Name of a row in the Tunnel. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Note that Tunnel is a unique key, i.e only one IKEv2SA instance is associated with a given Tunnel instance. During rekeying [Section 2.8/RFC5996], a new IKEv2 SA is created and inherits the existing IKEv2 SA's child SAs, then the old IKEv2 SA is deleted. From the management point of view the new and old IKEv2 SAs are the same SA and MUST be modeled using the same IKEv2SA instance. |
- |
2.12 |
|
EncryptionAlgorithm |
string(:64) |
R |
{{div|{{classes}}|The encryption algorithm applied to traffic carried by this IKEv2 SA. This will be one of the {{param|#.Profile.{i}.IKEv2AllowedEncryptionAlgorithms}} from the {{object|#.Profile}} instance via which this IKEv2 SA was created.}} The encryption algorithm applied to traffic carried by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedEncryptionAlgorithms from the Profile instance via which this IKEv2 SA was created. |
- |
2.12 |
|
EncryptionKeyLength |
unsignedInt |
R |
{{div|{{classes}}|The length of the encryption key in {{units}} used for the algorithm specified in the {{param|EncryptionAlgorithm}} parameter. The value is 0 if the key length is implicit in the specified algorithm or there is no encryption applied.}} The length of the encryption key in bits used for the algorithm specified in the EncryptionAlgorithm parameter. The value is 0 if the key length is implicit in the specified algorithm or there is no encryption applied. |
- |
2.12 |
|
PseudoRandomFunction |
string(:64) |
R |
{{div|{{classes}}|The pseudo-random function used by this IKEv2 SA. This will be one of the {{param|#.Profile.{i}.IKEv2AllowedPseudoRandomFunctions}} from the {{object|#.Profile}} instance via which this IKEv2 SA was created.}} The pseudo-random function used by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedPseudoRandomFunctions from the Profile instance via which this IKEv2 SA was created. |
- |
2.12 |
|
IntegrityAlgorithm |
string(:64) |
R |
{{div|{{classes}}|The integrity algorithm applied to the traffic carried by this IKEv2 SA. This will be one of the {{param|#.Profile.{i}.IKEv2AllowedIntegrityAlgorithms}} from the {{object|#.Profile}} instance via which this IKEv2 SA was created.}} The integrity algorithm applied to the traffic carried by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedIntegrityAlgorithms from the Profile instance via which this IKEv2 SA was created. |
- |
2.12 |
|
DiffieHellmanGroupTransform |
string(:64) |
R |
{{div|{{classes}}|The Diffie-Hellman Group used by this IKEv2 SA. This will be one of the {{param|#.Profile.{i}.IKEv2AllowedDiffieHellmanGroupTransforms}} from the {{object|#.Profile}} instance via which this IKEv2 SA was created.}} The Diffie-Hellman Group used by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedDiffieHellmanGroupTransforms from the Profile instance via which this IKEv2 SA was created. |
- |
2.12 |
|
Device.IPsec.IKEv2SA.{i}.Stats. |
object |
R |
{{div|{{classes}}|Statistics for this IKEv2 Security Association (SA). The CPE MUST reset the IKEv2 SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the associated {{param|#.Tunnel}} instance's Stats parameters are reset.}} Statistics for this IKEv2 Security Association (SA). The CPE MUST reset the IKEv2 SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the associated Tunnel instance's Stats parameters are reset. |
- |
2.12 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of outbound {{units}} from this IKEv2 SA discarded for any reason. This can include {{units}} dropped due to a lack of transmit buffer space. Note that this refers to IKE protocol {{units}}, and not to {{units}} carried by other SAs.}} The total number of outbound packets from this IKEv2 SA discarded for any reason. This can include packets dropped due to a lack of transmit buffer space. Note that this refers to IKE protocol packets, and not to packets carried by other SAs. |
- |
2.12 |
|
DecryptionErrors |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of inbound {{units}} to this IKEv2 SA discarded due to decryption errors. Note that this refers to IKEv2 protocol {{units}}, and not to {units}} The total number of inbound packets to this IKEv2 SA discarded due to decryption errors. Note that this refers to IKEv2 protocol packets, and not to {units carried by other SAs.}} |
- |
2.12 |
|
IntegrityErrors |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of inbound {{units}} to this IKEv2 SA discarded due to integrity errors. Note that this refers to IKEv2 protocol {{units}}, and not to {{units}} carried by other SAs.}} The total number of inbound packets to this IKEv2 SA discarded due to integrity errors. Note that this refers to IKEv2 protocol packets, and not to packets carried by other SAs. |
- |
2.12 |
|
OtherReceiveErrors |
unsignedInt |
R |
[StatsCounter32] {{div|{{classes}}|The total number of inbound {{units}} to this IKEv2 SA discarded for reasons other than decryption or integrity errors. This can include {{units}} dropped due to a lack of receive buffer space. Note that this refers to IKEv2 protocol {{units}}, and not to {{units}} carried by other SAs.}} The total number of inbound packets to this IKEv2 SA discarded for reasons other than decryption or integrity errors. This can include packets dropped due to a lack of receive buffer space. Note that this refers to IKEv2 protocol packets, and not to packets carried by other SAs. |
- |
2.12 |
|
Device.IPsec.IKEv2SA.{i}.ReceivedCPAttr.{i}. |
object(0:) |
W |
{{div|{{classes}}|This is a transitory table that lists all the IKEv2 Configuration Payload (CP) {{bibref|RFC5996|Section 3.15}} Attributes that have been received via CFG_REPLY messages. Table entries are automatically created to correspond with received Attributes. However, it is a local matter to the CPE when to delete old table entries. If the same Attribute is received multiple times, it is up to the CPE to decide which entries to include (i.e. whether the same Attribute will be present multiple times). In order to allow for the same Attribute to be present multiple times within the table, this table has no unique key defined.}} This is a transitory table that lists all the IKEv2 Configuration Payload (CP) [Section 3.15/RFC5996] Attributes that have been received via CFG_REPLY messages. Table entries are automatically created to correspond with received Attributes. However, it is a local matter to the CPE when to delete old table entries. If the same Attribute is received multiple times, it is up to the CPE to decide which entries to include (i.e. whether the same Attribute will be present multiple times). In order to allow for the same Attribute to be present multiple times within the table, this table has no unique key defined. |
- |
2.12 |
|
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}. |
object(0:) |
R |
Represents a child Security Association (SA) pair, i.e. an inbound child SA and an outbound child SA. At most one entry in this table can exist with a given value for InboundSPI, or with a given value for OutboundSPI. |
- |
2.12 |
|
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}.Stats. |
object |
R |
{{div|{{classes}}|Statistics for this child Security Association (SA). The CPE MUST reset the child SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the parent {{object|#}} instance's Stats parameters are reset.}} Statistics for this child Security Association (SA). The CPE MUST reset the child SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the parent ChildSA instance's Stats parameters are reset. |
- |
2.12 |
|
Device.GRE. |
object |
R |
This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.12 |
|
Device.GRE.Tunnel.{i}. |
object(0:) |
W |
GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.GRE.Tunnel.{i}.Stats. |
object |
R |
{{div|{{classes}}|Statistics for this GRE tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from {{false}} to {{true}}).}} Statistics for this GRE tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). |
- |
2.12 |
|
Device.GRE.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
GRE Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the GRE Header as defined in [RFC2784] and extensions to the GRE Header as defined in [RFC2890]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of [RFC2890] is supported there is only one instance of this Interface object per tunnel. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|Statistics for this GRE tunnel interface, i.e. all traffic that has passed through the interface. The device MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e., the interface's Status parameter transitions to a down state after the interface has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from {{false}} to {{true}}).}} Statistics for this GRE tunnel interface, i.e. all traffic that has passed through the interface. The device MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e., the interface's Status parameter transitions to a down state after the interface has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true). |
- |
2.12 |
|
Device.GRE.Filter.{i}. |
object(0:) |
W |
GRE Filter table. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions:
At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this filter. Enumeration of:
|
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 |
|
VLANIDCheck |
int(-1:) |
W |
{{div|{{classes}}|Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering.}} 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 |
{{div|{{classes}}|If {{false}}, the filter includes only those packets that match the {{param|VLANIDCheck}} entry, if specified. If {{true}}, the filter includes all packets except those that match the {{param|VLANIDCheck}} entry, if specified.}} 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.
|
- |
2.12 |
|
Device.L2TPv3. |
object |
R |
{{div|{{classes}}|This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Layer Two Tunneling Protocol version 3 (L2TPv3) ({{bibref|RFC3931}}). This object also provides a means to treat packets that are encapsulated within a L2TPv3 Tunnel by using a set of {{object|Filter}} objects to determine the treatment of the packet.}} 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 |
|
Device.L2TPv3.Tunnel.{i}. |
object(0:) |
W |
{{div|{{classes}}|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 {{object}} object has one or more {{object|Interface}} objects that further define the sessions or flows within the tunnel.}} 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
RemoteEndpoints |
string(:256)[:4] |
W |
Comma-separated list (up to 4 items) of strings (maximum number of characters per item 256). {{div|{{classes}}|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.}} 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 |
|
Device.L2TPv3.Tunnel.{i}.Stats. |
object |
R |
{{div|{{classes}}|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}}).}} 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 |
|
Device.L2TPv3.Tunnel.{i}.Interface.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
SessionID |
int(-1,1:65535) |
W |
{{div|{{classes}}|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 {{object}} instance.}} 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 |
|
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
{{div|{{classes}}|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}}).}} 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 |
|
Device.L2TPv3.Filter.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this filter. Enumeration of:
|
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 |
|
VLANIDCheck |
int(-1:) |
W |
{{div|{{classes}}|Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering.}} 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 |
{{div|{{classes}}|If {{false}}, the filter includes only those packets that match the {{param|VLANIDCheck}} entry, if specified. If {{true}}, the filter includes all packets except those that match the {{param|VLANIDCheck}} entry, if specified.}} 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.
|
- |
2.12 |
|
Device.VXLAN. |
object |
R |
{{div|{{classes}}|This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Virtual eXtensible Local Area Network (VXLAN) ({{bibref|RFC7348}}). This object also provides a means to treat packets that are encapsulated within a VXLAN Tunnel by using a set of {{object|Filter}} objects to determine the treatment of the packet.}} 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 |
|
Device.VXLAN.Tunnel.{i}. |
object(0:) |
W |
{{div|{{classes}}|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 {{object}} object has one or more {{object|Interface}} objects that further define the sessions or flows within the tunnel.}} 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
RemoteEndpoints |
string(:256)[:4] |
W |
Comma-separated list (up to 4 items) of strings (maximum number of characters per item 256). {{div|{{classes}}|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.}} 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 |
|
Device.VXLAN.Tunnel.{i}.Stats. |
object |
R |
{{div|{{classes}}|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}}).}} 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 |
|
Device.VXLAN.Tunnel.{i}.Interface.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
VNI |
int(-1,0:16777215) |
W |
{{div|{{classes}}|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 {{object}} instance.}} 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 |
R |
{{div|{{classes}}|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}}).}} 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 |
|
Device.VXLAN.Filter.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this filter. Enumeration of:
|
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 |
|
VLANIDCheck |
int(-1:) |
W |
{{div|{{classes}}|Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering.}} 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 |
{{div|{{classes}}|If {{false}}, the filter includes only those packets that match the {{param|VLANIDCheck}} entry, if specified. If {{true}}, the filter includes all packets except those that match the {{param|VLANIDCheck}} entry, if specified.}} 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.
|
- |
2.12 |
|
Device.MAP. |
object |
R |
{{div|{{classes}}|The Mapping of Address and Port (MAP) object {{bibref|RFC7597}} {{bibref|RFC7599}} {{bibref|RFC7598}}. This object applies only to gateway devices that support IPv4 on the LAN side, include a {{object|#.NAT}}, and typically have only IPv6 connectivity on the WAN side. See the MAP Theory of Operation {{bibref|TR-181i2|Appendix XV}} for a description of the working of this MAP data model.}} 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-181i2] for a description of the working of this MAP data model. |
- |
2.12 |
|
Device.MAP.Domain.{i}. |
object(0:) |
W |
MAP domain settings [RFC7597] [RFC7599]. Each instance models a MAP domain. MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):
At most one entry in this table can exist with a given value for Alias, or with the same values for both WANInterface and IPv6Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, WANInterface and IPv6Prefix such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The current operational state of the MAP domain. The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid.}} The current operational state of the MAP domain. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. Enumeration of:
|
- |
2.12 |
|
TransportMode |
string |
W |
{{div|{{classes}}|The transport mode to use. Corresponds to the {{bibref|RFC7598}} S46_CONT_MAPE and S46_CONT_MAPT container options.}} The transport mode to use. Corresponds to the [RFC7598] S46_CONT_MAPE and S46_CONT_MAPT container options. Enumeration of: |
Translation |
2.12 |
|
WANInterface |
string |
W |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP interface with which this MAP domain is associated. This will always be a NAT-ted upstream (WAN) interface. The End-user IPv6 prefix IPv6Prefix is one of this IP interface's prefixes. The MAP IPv6 address is derived from the End-user IPv6 prefix and is one of this IP interface's IP addresses, with an IP.Interface.{i}.IPv6Address.{i}.Origin of MAP. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with IPv6Prefix) doesn't conflict with any existing entries. |
- |
2.12 |
|
IPv6Prefix |
string |
W |
The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. {{div|{{classes}}|The MAP domain's End-user IPv6 prefix. This MUST reference one of {{param|WANInterface}}'s prefixes. If the Controller configures this prefix directly, the CPE MUST use the Controller-configured prefix. Otherwise, the CPE MUST select one of {{param|WANInterface}}'s prefixes; the selected prefix will typically have {{param|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} = {{enum|PrefixDelegation|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}.}} The MAP domain's End-user IPv6 prefix. This MUST reference one of WANInterface's prefixes. If the Controller configures this prefix directly, the CPE MUST use the Controller-configured prefix. Otherwise, the CPE MUST select one of WANInterface's prefixes; the selected prefix will typically have IP.Interface.{i}.IPv6Prefix.{i}.Origin = PrefixDelegation. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with WANInterface) doesn't conflict with any existing entries. |
- |
2.12 |
|
BRIPv6Prefix |
string(:49) |
W |
[IPv6Prefix] The MAP Border Relay (BR) address or prefix.
|
- |
2.12 |
|
DSCPMarkPolicy |
int(-2:63) |
W |
DSCP with which to mark the outer IP header for traffic that is associated with this MAP domain. Downstream packets are never re-marked. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
|
- |
2.12 |
|
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. This parameter was DEPRECATED This parameter was DEPRECATED in 2.12.because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the {{object|DomainRule.{i}.}} object. This parameter is OBSOLETED in 2.14.object This parameter was OBSOLETED in 2.14-2.15. |
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. This parameter was DEPRECATED This parameter was DEPRECATED in 2.12.because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the {{object|DomainRule.{i}.}} object. This parameter is OBSOLETED in 2.14.object This parameter was OBSOLETED in 2.14-2.15. |
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. This parameter was DEPRECATED This parameter was DEPRECATED in 2.12.because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the {{object|DomainRule.{i}.}} object. This parameter is OBSOLETED in 2.14.object This parameter was OBSOLETED in 2.14-2.15. |
0 |
2.12 |
|
IncludeSystemPorts |
boolean |
W |
Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range [0:2^(16-{{param: non-existent PSIDOffset{{inserted: unexpected argument obsoleted after: []}}}})-1] are excluded, e.g. for the default {{param: non-existent PSIDOffset{{inserted: unexpected argument obsoleted after: []}}}} value of 4,6, ports [0:4095][0:1023] are not included in the Port-sets. This parameter is related to [RFC7597]'s N, which is defined as the number of ports (e.g., 1024) excluded from the lower end of the range. The parameter is relevant only when {{param: non-existent PSIDOffset{{inserted: unexpected argument obsoleted after: []}}}} is 0; false corresponds to N=1024 and true corresponds to N=0. This parameter was DEPRECATED in 2.15 because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. Changes since 2.14:
|
false |
2.12 |
|
Device.MAP.Domain.{i}.Rule.{i}. |
object(0:) |
W |
The MAP domain's Mapping Rules [RFC7597]. The rule with the longest match between its IPv6Prefix and the end-user IPv6Prefix is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule. At most one entry in this table can exist with a given value for Alias, or with a given value for IPv6Prefix, or with a given value for IPv4Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this {{object}} instance. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} |
Disabled |
2.12 |
|
Origin |
string |
R |
{{div|{{classes}}|The mechanism via which the {{object}} was created. If the CPE supports MAP configuration via both DHCPv6 and CWMP, it is up to the implementation to determine how the two mechanisms will interact.}} The mechanism via which the Rule was created. If the CPE supports MAP configuration via both DHCPv6 and CWMP, it is up to the implementation to determine how the two mechanisms will interact. Enumeration of:
|
Static |
2.12 |
|
IPv6Prefix |
string(:49) |
W |
[IPv6Prefix] The Rule IPv6 prefix. The Rule IPv6 prefix is a leading part of the end-user IPv6Prefix, i.e. its length MUST be less than or equal to the length of the end-user IPv6Prefix, and it MUST match the end-user IPv6Prefix. Corresponds to the [RFC7598] S46_RULE option's ipv6-prefix field. |
/0 |
2.12 |
|
IPv4Prefix |
string(:49) |
W |
[IPv4Prefix] {{div|{{classes}}|The Rule IPv4 prefix. Corresponds to the {{bibref|RFC7598}} S46_RULE option's ipv4-prefix field.}} The Rule IPv4 prefix. Corresponds to the [RFC7598] S46_RULE option's ipv4-prefix field. |
/0 |
2.12 |
|
EABitsLength |
unsignedInt(0:48) |
W |
{{div|{{classes}}|The length in {{units}} of the Embedded Address (EA) bits in the end-user {{param|#.IPv6Prefix}}. Corresponds to the {{bibref|RFC7598}} S46_RULE option's ea-len field.}} The length in bits of the Embedded Address (EA) bits in the end-user IPv6Prefix. Corresponds to the [RFC7598] S46_RULE option's ea-len field. |
0 |
2.12 |
|
IsFMR |
boolean |
W |
{{div|{{classes}}|Indicates whether this rule is a Forwarding Mapping Rule (FMR), i.e. can be used for forwarding. Corresponds to the {{bibref|RFC7598}} S46_RULE option's flags field's F-Flag.}} Indicates whether this rule is a Forwarding Mapping Rule (FMR), i.e. can be used for forwarding. Corresponds to the [RFC7598] S46_RULE option's flags field's F-Flag. |
false |
2.12 |
|
PSIDOffset |
unsignedInt(0:15) |
W |
{{div|{{classes}}|Port-set ID (PSID) offset in {{units}}. The number of Port-sets is 2^{{param}}. Corresponds to the {{bibref|RFC7598}} S46_PORTPARAMS (Port Parameters) option's offset field.}} 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 |
{{div|{{classes}}|The length in {{units}} of the Port-set id (PSID) configured in the {{param|PSID}} parameter. Corresponds to the {{bibref|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 |
|
IncludeSystemPorts |
boolean |
W |
Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range [0:2^(16-PSIDOffset)-1] are excluded, e.g. for the default PSIDOffset value of 6, ports [0:1023] are not included in the Port-sets. This parameter is related to [RFC7597]'s N, which is defined as the number of ports (e.g., 1024) excluded from the lower end of the range. The parameter is relevant only when PSIDOffset is 0; false corresponds to N=1024 and true corresponds to N=0. |
false |
2.15 |
|
Device.MAP.Domain.{i}.Interface. |
object |
R |
MAP interface (a stackable interface object as described in [Section 4.2/TR-181i2]). This models the LAN side MAP domain interface. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the interface. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
LowerLayers |
string[](:1024) |
W |
{{div|{{classes}}|{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since this interface object is a MAP domain interface, it is expected that {{param}} will not be used.}} Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since this interface object is a MAP domain interface, it is expected that LowerLayers will not be used. |
- |
2.12 |
|
Device.MAP.Domain.{i}.Interface.Stats. |
object |
R |
{{div|{{classes}}|Throughput statistics for this MAP domain interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} Throughput statistics for this MAP domain interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.12 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.}} The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. |
- |
2.12 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] {{div|{{classes}}|The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.}} The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. |
- |
2.12 |
|
Device.CaptivePortal. |
object |
R |
This object contains parameters relating to the captive portal configuration on the CPE. The captive portal configuration defines the CPE's upstream HTTP (port 80) traffic redirect behavior. When the captive portal is disabled, upstream HTTP (port 80) traffic MUST be permitted to all destinations. When the captive portal is enabled, upstream HTTP (port 80) traffic MUST be permitted only to destinations listed in the AllowedList; traffic to all other destinations MUST be redirected to the URL. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|Indicates the status of the captive portal. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} |
- |
2.12 |
|
AllowedList |
string[:10000]() |
W |
Comma-separated list (up to 10000 items) (length ) of strings. List items represent Fully Qualified Domain Names (FQDNs) or IP addresses to which HTTP (port 80) traffic MUST always be permitted, regardless of whether the captive portal is enabled. Each entry in the list MUST be either an FQDN, 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:
Changes since 2.14:
|
- |
2.12 |
|
URL |
string(:2048) |
W |
Captive portal [URL] to which upstream HTTP (port 80) traffic to destinations not listed in the AllowedList will be redirected. The captive portal URL MUST be an HTTP (not HTTPS) URL. The CPE MUST permit the captive portal URL to be set to an empty string, which has the effect of disabling the captive portal (if Enable is true and the captive portal URL is an empty string, Status MUST be Error_URLEmpty). |
- |
2.12 |
|
Device.Routing. |
object |
R |
Routing object that contains the Router table and RIP protocol object. Changes since 2.14:
|
- |
2.12 |
|
Device.Routing.Router.{i}. |
object(0:) |
W |
This object allows the handling of the routing and forwarding configuration of the device. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this Router entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this Router entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
Device.Routing.Router.{i}.IPv4Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
At most one entry in this table can exist with a given value for Alias, or with the same values for all of DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of the forwarding entry. Enumeration of:
|
Disabled |
2.12 |
|
DestIPAddress |
string(:45) |
W |
[IPv4Address] {{div|{{classes}}|Destination IPv4 address. {{empty}} indicates no destination address is specified. A Forwarding table entry for which {{param}} and {{param|DestSubnetMask}} are both {{empty}} is a default route.}} Destination IPv4 address. An empty string indicates no destination address is specified. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string is a default route. |
<Empty> |
2.12 |
|
DestSubnetMask |
string(:45) |
W |
[IPv4Address] Destination subnet mask. An empty string indicates no destination subnet mask is specified. If a destination subnet mask is specified, the DestSubnetMask is ANDed with the destination address before comparing with the DestIPAddress. Otherwise, the full destination address is used as is. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string is a default route. |
<Empty> |
2.12 |
|
ForwardingPolicy |
int(-1:) |
W |
Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the Device.QoS object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows. |
-1 |
2.12 |
|
GatewayIPAddress |
string(:45) |
W |
[IPv4Address] IPv4 address of the gateway. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. |
<Empty> |
2.12 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the egress layer 3 interface associated with this entry. Example: Device.IP.Interface.1. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. For a route that was configured by setting GatewayIPAddress but not Interface, read access to Interface MUST return the full hierarchical parameter name for the routes egress interface. |
<Empty> |
2.12 |
|
Device.Routing.Router.{i}.IPv6Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv6 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, and RA. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
At most one entry in this table can exist with a given value for Alias, or with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of the forwarding entry. Enumeration of:
|
Disabled |
2.12 |
|
DestIPPrefix |
string(:49) |
W |
[IPv6Prefix] {{div|{{classes}}|Destination IPv6 prefix. {{empty}} indicates that it matches all destination prefixes (i.e. equivalent to "::/0"). All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 destination, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128.}} Destination IPv6 prefix. An empty string indicates that it matches all destination prefixes (i.e. equivalent to "::/0"). All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 destination, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128. |
<Empty> |
2.12 |
|
ForwardingPolicy |
int(-1:) |
W |
Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the QoS object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows. |
-1 |
2.12 |
|
NextHop |
string(:45) |
W |
[IPv6Address] IPv6 address of the next hop. Only one of NextHop and Interface SHOULD be configured for a route. An empty string indicates no NextHop is specified. If both are configured, NextHop and Interface MUST be consistent with each other. |
<Empty> |
2.12 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the egress layer 3 interface associated with this entry. Example: Device.IP.Interface.1. Only one of NextHop and Interface SHOULD be configured for a route. An empty string indicates no Interface is specified. If both are configured, NextHop and Interface MUST be consistent with each other. For a route that was configured by setting NextHop but not Interface, read access to Interface MUST return the full hierarchical parameter name for the route's egress interface. |
<Empty> |
2.12 |
|
ExpirationTime |
dateTime |
R |
{{div|{{classes}}|The time at which the route will expire, or {{null}} if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. {{param}} is provided by an underlying dynamic routing protocol, e.g. by an {{bibref|RFC4191}} route information option.}} The time at which the route will expire, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. ExpirationTime is provided by an underlying dynamic routing protocol, e.g. by an [RFC4191] route information option. |
9999-12-31T23:59:59Z |
2.12 |
|
Device.Routing.RIP. |
object |
R |
Routing Information Protocol (RIP) object. |
- |
2.12 |
|
Device.Routing.RIP.InterfaceSetting.{i}. |
object(0:) |
W |
IP Interface RIP configuration table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. Note: This object only applies to RIP2; i.e. version 2 of the RIP protocol is used to accept or send over the specified Interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
AcceptRA |
boolean |
W |
{{div|{{classes}}|When set to {{true}}, RIP route advertisements received over {{param|Interface}} are accepted. When set to {{false}}, RIP route advertisements received over {{param|Interface}} are rejected.}} |
- |
2.12 |
|
SendRA |
boolean |
W |
{{div|{{classes}}|When set to {{true}}, RIP route advertisements are to be sent over {{param|Interface}}. When set to {{false}}, no RIP route advertisements will be sent over {{param|Interface}}.}} |
- |
2.12 |
|
Device.Routing.RouteInformation. |
object |
R |
Received Router Advertisement (RA) route information [RFC4191]. |
- |
2.12 |
|
Device.Routing.RouteInformation.InterfaceSetting.{i}. |
object(0:) |
R |
IP Interface RA route information table. Contains received RA route information [RFC4191]. As such, the data in this table cannot be modified. At most one entry in this table can exist with a given value for Interface. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
PreferredRouteFlag |
string |
R |
{{div|{{classes}}|Flag included in a specific Route Information Option within an RA message (Prf flag), as defined in {{bibref|RFC4191|Section 2.3}}. {{enum}} Note that this is not the Prf flag included in the base RA message. Also see {{bibref|RFC4191|Section 2.1}} which discusses how this flag is encoded on the wire.}} Flag included in a specific Route Information Option within an RA message (Prf flag), as defined in [Section 2.3/RFC4191]. Enumeration of:
Note that this is not the Prf flag included in the base RA message. Also see [Section 2.1/RFC4191] which discusses how this flag is encoded on the wire. |
- |
2.12 |
|
RouteLifetime |
dateTime |
R |
{{div|{{classes}}|The time at which {{param|Prefix}} will cease to be usable for use as a forwarding entry, or {{null}} if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. {{param}} is received in an instance of the Route Information Option of a RA message.}} The time at which Prefix will cease to be usable for use as a forwarding entry, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. RouteLifetime is received in an instance of the Route Information Option of a RA message. |
- |
2.12 |
|
Device.Routing.Babel. |
object |
R |
This object provides parameters for configuration, troubleshooting, and monitoring of the Babel routing protocol [RFC8966]. This data model is based on the Babel information model defined in [RFC9046]. |
- |
2.15 |
|
Enable |
boolean |
W |
Enables or disables Babel on the device. |
- |
2.15 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the device to indicate a locally defined error condition. |
- |
2.15 |
|
ImplementationVersion |
string(:32) |
R |
The name and version of this implementation of the Babel protocol. This is not the same as the version of the Babel protocol that has been implemented. The method of naming and identifying implementation versions will be specific to the implementation. |
- |
2.15 |
|
SelfRouterID |
hexBinary |
R |
The router-id used by this instance of the Babel protocol to identify itself. [RFC8966] describes this as an arbitrary string of 8 octets. |
- |
2.15 |
|
SelfSeqno |
unsignedInt(:65535) |
R |
The current sequence number included in route updates for routes originated by this node. |
- |
2.15 |
|
SupportedMetricCompAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported cost computation algorithms. Each list item is an enumeration of:
|
- |
2.15 |
|
SupportedSecurityMechanisms |
string[] |
R |
Comma-separated list of strings. Supported security mechanisms. Each list item is an enumeration of: |
- |
2.15 |
|
SupportedMACAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported MAC computation algorithms. Each list item is an enumeration of: |
- |
2.15 |
|
SupportedDTLSCertTypes |
string[] |
R |
Comma-separated list of strings. Supported DTLS certificate types. Each list item is an enumeration of: |
- |
2.15 |
|
StatsEnable |
boolean |
W |
Enables or disables collection of statistics on all InterfaceSetting. instances. Statistics are provided in InterfaceSetting.{i}.Stats.. When enabled, existing statistics values are not cleared and will be incremented as new packets are counted. |
- |
2.15 |
|
InterfaceSettingNumberOfEntries |
unsignedInt |
R |
The number of entries in the InterfaceSetting table. |
- |
2.15 |
|
RouteNumberOfEntries |
unsignedInt |
R |
The number of entries in the Route table. |
- |
2.15 |
|
MACKeySetNumberOfEntries |
unsignedInt |
R |
The number of entries in the MACKeySet table. |
- |
2.15 |
|
DTLSCertSetNumberOfEntries |
unsignedInt |
R |
The number of entries in the DTLSCertSet table. |
- |
2.15 |
|
StatsReset() |
command |
- |
This command represents a request to reset all statistics counters to zero. Statistics are provided in InterfaceSetting.{i}.Stats.. |
- |
2.15 |
|
Device.Routing.Babel.Constants. |
object |
R |
This object represents the constants used by the Babel protocol. |
- |
2.12 |
|
UDPPort |
unsignedInt(1:65535) |
W |
The UDP port number used by the Babel implementation to send and receive Babel packets. The UDP port number assigned by IANA is 6696. |
- |
2.12 |
|
MulticastGroup |
string(:45) |
W |
[IPv6Address] The multicast group for sending and listening to multicast announcements on IPv6. The multicast group assigned by IANA is ff02::1:6. |
- |
2.12 |
|
Device.Routing.Babel.InterfaceSetting.{i}. |
object(0:) |
W |
This object provides parameters related to the interfaces the Babel protocol is operating over and can act as a routing protocol for. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
Enables or disables Babel on this interface. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
InterfaceReference |
string |
R |
The value MUST be the Path Name of a row in the Device.IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Device.IP.Interface. object instance this Babel implementation is running over. The referenced interface object MUST have Device.IP.Interface.{i}.IPv6Enable set to true. |
- |
2.12 |
|
InterfaceMetricAlgorithm |
string |
R |
The value MUST be a member of the list reported by the SupportedMetricCompAlgorithms parameter. Indicates the metric computation algorithm used on this interface, from among the supported metric computation algorithms listed in SupportedMetricCompAlgorithms. |
- |
2.12 |
|
SplitHorizonEnabled |
boolean |
W |
Enables or disables the use of split horizon optimization when calculating metrics on this interface. Split horizon optimization is described in [Section 3.7.4/RFC8966]. |
- |
2.12 |
|
McastHelloSeqno |
unsignedInt(:65535) |
R |
The current sequence number in use for multicast Hellos sent on this interface. |
- |
2.12 |
|
McastHelloInterval |
unsignedInt(:65535) |
R |
The current interval (time in centiseconds) used for multicast Hellos sent on this interface. |
- |
2.12 |
|
UpdateInterval |
unsignedInt(:65535) |
R |
The current interval (time in centiseconds) used for all updates (multicast or unicast) sent on this interface. |
- |
2.12 |
|
MACEnabled |
boolean |
W |
Enables or disables the MAC security mechanism. |
- |
2.12 |
|
InterfaceMACKeySets |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the MACKeySet. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. MACKeySet. instances that apply to this InterfaceSetting instance. When an InterfaceSetting is created, all MACKeySet. instances with MACKeySet.{i}.DefaultApply of true will be included in this list. |
- |
2.12 |
|
MACVerify |
boolean |
W |
A Boolean flag indicating whether MACs in incoming Babel packets are required to be present and are verified. If this parameter is true, incoming packets are required to have a valid MAC. |
- |
2.12 |
|
DTLSEnabled |
boolean |
W |
Enables or disables the DTLS security mechanism. |
- |
2.12 |
|
InterfaceDTLSCertSets |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DTLSCertSet. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. DTLSCertSet. instances that apply to this InterfaceSetting instance. When an InterfaceSetting is created, all DTLSCertSet. instances with DTLSCertSet.{i}.DefaultApply of true will be included in this list. |
- |
2.12 |
|
CachedInfoEnabled |
boolean |
W |
A Boolean flag indicating whether the cached_info extension is included in ClientHello and ServerHello packets (see [Appendix A/RFC8968]. The extension is included if true. |
- |
2.12 |
|
DTLSCertPrefer |
string |
W |
The value MUST be a member of the list reported by the SupportedDTLSCertTypes parameter. Supported certificate types (from SupportedDTLSCertTypes), listed in order of preference. This list is used to populate the server_certificate_type extension in a ClientHello (see [Appendix A/RFC8968]). Values that are present with a non-empty DTLSCertSet.{i}.DTLSCert.{i}.CertPrivateKey in at least one instance of DTLSCertSet.{i}.DTLSCert. included in a DTLSCertSet. instance referenced by InterfaceDTLSCertSets will be used to populate the client_certificate_type extension in a Client Hello. |
- |
2.12 |
|
PacketLogEnable |
boolean |
W |
Enables or disables the logging of Babel packets into the PacketLog on this interface. |
- |
2.12 |
|
PacketLog |
string |
R |
The value MUST be the Path Name of a row in the Device.DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to a DeviceInfo.VendorLogFile instance that contains a timestamped log of packets received and sent on Constants.UDPPort on this interface. The [LIBPCAP] file format with .pcap file extension SHOULD be supported for packet log files. Logging is enabled/disabled by PacketLogEnable. |
- |
2.12 |
|
NeighborNumberOfEntries |
unsignedInt |
R |
The number of entries in the Neighbor table. |
- |
2.12 |
|
Device.Routing.Babel.InterfaceSetting.{i}.Stats. |
object |
R |
This object provides statistics parameters for this interface. |
- |
2.12 |
|
SentMcastHello |
unsignedLong |
R |
[StatsCounter64] A count of the number of multicast Hello packets sent on this interface. |
- |
2.12 |
|
SentMcastUpdate |
unsignedLong |
R |
[StatsCounter64] A count of the number of multicast update packets sent on this interface. |
- |
2.12 |
|
SentUcastHello |
unsignedLong |
R |
[StatsCounter64] A count of the number of unicast Hello packets sent on this interface. |
- |
2.12 |
|
SentUcastUpdate |
unsignedLong |
R |
[StatsCounter64] A count of the number of unicast update packets sent on this interface. |
- |
2.12 |
|
SentIHU |
unsignedLong |
R |
[StatsCounter64] A count of the number of IHU ("I Heard You") packets sent on this interface. |
- |
2.12 |
|
ReceivedPackets |
unsignedLong |
R |
[StatsCounter64] A count of the number of Babel packets received on this interface. |
- |
2.12 |
|
Device.Routing.Babel.InterfaceSetting.{i}.Neighbor.{i}. |
object(0:) |
R |
This object provides parameters related to neighbor devices that Babel packets are received from and sent to. At most one entry in this table can exist with a given value for NeighborAddress. |
- |
2.12 |
|
NeighborAddress |
string(:45) |
R |
[IPAddress] IP address the neighbor sends packets from. |
- |
2.12 |
|
HelloMCastHistory |
hexBinary |
R |
The multicast Hello history of whether or not the multicast Hello packets prior to ExpectedMCastHelloSeqno were received. This is a binary sequence where the most recently received Hello is expressed as a "1" placed in the left-most bit, with prior bits shifted right (and "0" bits placed between prior Hello bits and the most recent Hello bit for any not-received Hellos). This value is displayed using hex digits. See [Section A.1/RFC8966]. |
- |
2.12 |
|
HelloUCastHistory |
hexBinary |
R |
The unicast Hello history of whether or not the unicast Hello packets prior to ExpectedUCastHelloSeqno were received. This is a binary sequence where the most recently received Hello is expressed as a "1" placed in the left-most bit, with prior bits shifted right (and "0" bits placed between prior Hello bitss and the most recent Hello bit for any not-received Hellos). This value is displayed using hex digits. See [Section A.1/RFC8966]. |
- |
2.12 |
|
TXCost |
unsignedInt(:65535) |
R |
Transmission cost value from the last IHU ("I Heard You") packet received from this neighbor, or maximum value (as defined in [Section 3.4.2/RFC8966]) to indicate the IHU hold timer for this neighbor has expired. |
- |
2.12 |
|
ExpectedMCastHelloSeqno |
int(-1:65535) |
R |
Expected multicast Hello sequence number of next Hello to be received from this neighbor. If multicast Hello packets are not expected, or processing of multicast packets is not enabled, this MUST be -1. Note [RFC9046] specifies a 16-bit unsigned integer with NULL value to represent no processed or expected multicast Hello packets. |
- |
2.12 |
|
ExpectedUCastHelloSeqno |
int(-1:65535) |
R |
Expected unicast Hello sequence number of next Hello to be received from this neighbor. If unicast Hello packets are not expected, or processing of unicast packets is not enabled, this MUST be -1. |
- |
2.12 |
|
UnicastHelloSeqno |
int(-1:65535) |
R |
The current sequence number in use for unicast Hellos sent to this neighbor. If unicast Hello packets are not being sent, this MUST be -1. |
- |
2.12 |
|
UnicastHelloInterval |
unsignedInt(:65535) |
R |
The current interval in centiseconds used for unicast Hellos sent to this neighbor. |
- |
2.12 |
|
RXCost |
unsignedInt(:65535) |
R |
Reception cost calculated for this neighbor. This value is usually derived from the Hello history, which may be combined with other data, such as statistics maintained by the link layer. The RXCost is sent to a neighbor in each IHU ("I Heard You") packet. See [Section 3.4.3/RFC8966]. |
- |
2.12 |
|
Cost |
unsignedInt(:65535) |
R |
Link cost is computed from the values maintained by a Babel implementation in its neighbor table as defined in [Section3.2.4/RFC8966]: the statistics kept about the reception of Hellos and the transmission cost computed from received IHU packets. See [Section 3.4.3/RFC8966]. |
- |
2.12 |
|
Device.Routing.Babel.Route.{i}. |
object(0:) |
R |
This object provides parameters for routes recieved from neighbors and internal routes. At most one entry in this table can exist with the same values for both RoutePrefix and SourceRouterID. |
- |
2.12 |
|
RoutePrefix |
string(:49) |
R |
[IPPrefix] IP prefix for which this route is advertised. |
- |
2.12 |
|
SourceRouterID |
hexBinary |
R |
Router-id of the router that originated this route. |
- |
2.12 |
|
Neighbor |
string |
R |
The value MUST be the Path Name of a row in the InterfaceSetting.{i}.Neighbor. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the InterfaceSetting.{i}.Neighbor entry for the neighbor that advertised this route. |
- |
2.12 |
|
ReceivedMetric |
int(-1:65535) |
R |
The metric with which this route was advertised by the neighbor, or maximum value (as defined in [RFC8966]) to indicate the route was recently retracted and is temporarily unreachable (see [Section 3.5.5/RFC8966]). This metric will be -1 if the route was not received from a neighbor but was generated through other means. At least one of ReceivedMetric and CalculatedMetric MUST have a value other than -1. Having both be other than -1 is expected for a route that is received and subsequently advertised. |
- |
2.12 |
|
CalculatedMetric |
int(-1:65535) |
R |
A calculated metric for this route. How the metric is calculated is implementation-specific. Maximum value (as defined in [RFC8966]) indicates the route was recently retracted and is temporarily unreachable ([Section 3.5.5/RFC8966]). At least one of ReceivedMetric and CalculatedMetric MUST have a value other than -1. Having both be other than -1 is expected for a route that is received and subsequently advertised. |
- |
2.12 |
|
RouteSeqno |
unsignedInt(:65535) |
R |
The sequence number with which this route was advertised. |
- |
2.12 |
|
NextHop |
string(:45) |
R |
[IPAddress] The next-hop address of this route. This will be empty if this route has no next-hop address. |
- |
2.12 |
|
RouteFeasible |
boolean |
R |
A Boolean flag indicating whether this route is feasible, as defined in [Section 3.5.1/RFC8966]. |
- |
2.12 |
|
RouteSelected |
boolean |
R |
A Boolean flag indicating whether this route is selected (i.e., whether it is currently being used for forwarding and is being advertised). |
- |
2.12 |
|
Device.Routing.Babel.MACKeySet.{i}. |
object(0:) |
W |
This object provides parameters related to use of the HMAC security mechanism [RFC8967] to sign and verify Babel packets. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DefaultApply |
boolean |
W |
A Boolean flag indicating whether this MACKeySet instance is to be applied to all new InterfaceSetting. instances. If true, this MACKeySet instance applies to all new InterfaceSetting. instances at the time they are created and a reference to this MACKeySet is included in the InterfaceSetting.{i}.InterfaceMACKeySets parameter. If false, this MACKeySet is not applied to new InterfaceSetting. instances when they are created. |
- |
2.12 |
|
MACKeyNumberOfEntries |
unsignedInt |
R |
The number of entries in the MACKey table. |
- |
2.12 |
|
Device.Routing.Babel.MACKeySet.{i}.MACKey.{i}. |
object(0:) |
W |
This object provides the MAC keys used to calculate MACs for verification and sending by the MACKeySet instance. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
KeyUseSend |
boolean |
W |
Indicates whether this KeyValue is used to compute a MAC and include that MAC in the sent Babel packet. A MAC for sent packets is computed using this key if the value is true. If the value is false, this key is not used to compute a MAC to include in sent Babel packets. |
- |
2.12 |
|
KeyUseVerify |
boolean |
W |
Indicates whether the KeyValue is used to verify incoming Babel packets. Incoming packets are verified using this key if true. If false no MAC is computed from KeyValue for comparing with the MAC in an incoming Babel packet. |
- |
2.12 |
|
KeyValue |
hexBinary |
WO |
The value of the MAC key. This value is immutable, once written. This value is of a length suitable for the associated MACKeyAlgorithm. If the algorithm is based on the HMAC construction [RFC2104], the length MUST be between 0 and an upper limit that is at least the size of the output length (where "HMAC-SHA256" output length is 32 octets as described in [RFC4868]). Longer lengths MAY be supported but are not necessary if the management system has the ability to generate a suitably random value (e.g., by randomly generating a value or by using a key derivation technique as recommended in [Security Considerations/RFC8967]). If the algorithm is "BLAKE2s-128", the length MUST be between 0 and 32 bytes inclusive, as specified in [RFC7693]. Once it's been set, this parameter is immutable. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
MACKeyAlgorithm |
string |
W |
The value MUST be a member of the list reported by the SupportedMACAlgorithms parameter. The name of the MAC algorithm used with this key. The value MUST be the same as one of the enumerations listed in the SupportedMACAlgorithms parameter. |
- |
2.12 |
|
MACTest() |
command |
- |
This command allows the MAC key and MAC algorithm to be tested to see if they produce an expected outcome. The command calculates a MAC for InputString using the KeyValue and MACKeyAlgorithm and compares that to the value of InputMAC. If the values match, the output Match is true. |
- |
2.12 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ InputString |
hexBinary |
W |
[MANDATORY] The command calculates a MAC of InputString using the KeyValue and MACKeyAlgorithm. |
- |
2.12 |
|
⇒ InputMAC |
hexBinary |
W |
[MANDATORY] The command compares the calculated MAC to InputMAC. |
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Match |
boolean |
R |
Match is true if the calculated MAC and InputMAC are the same. |
- |
2.12 |
|
Device.Routing.Babel.DTLSCertSet.{i}. |
object(0:) |
W |
This object provides parameters related to use of the DTLS security mechanism [RFC8968] to encrypt Babel packets. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DefaultApply |
boolean |
W |
A Boolean flag indicating whether this DTLSCertSet instance is to be applied to all new InterfaceSetting. instances. If true, this DTLSCertSet instance applies to all new InterfaceSetting. instances at the time they are created and a reference to this DTLSCertSet is included in the InterfaceSetting.{i}.InterfaceDTLSCertSets parameter. If false, this DTLSCertSet is not applied to new InterfaceSetting. instances when they are created. |
- |
2.12 |
|
DTLSCertNumberOfEntries |
unsignedInt |
R |
The number of entries in the DTLSCert table. |
- |
2.12 |
|
Device.Routing.Babel.DTLSCertSet.{i}.DTLSCert.{i}. |
object(0:) |
W |
This object provides the certificates used for verification and signing by the DTLSCertSet instance with DTLS. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
CertValue |
string(:256) |
WO |
The DTLS certificate in PEM format [RFC7468]. This value is immutable, once written. Once it's been set, this parameter is immutable. |
- |
2.12 |
|
CertType |
string |
W |
The value MUST be a member of the list reported by the SupportedDTLSCertTypes parameter. The certificate type of CertValue (from among the supported types in SupportedDTLSCertTypes). This value is immutable, once written. |
- |
2.12 |
|
CertPrivateKey |
hexBinary |
WO |
The private key of the certificate. CertPrivateKey is only given a value if the certificate belongs to this device. If CertPrivateKey is non-empty, this certificate can be supplied during DTLS handshaking. This value is immutable, once written. Once it's been set, this parameter is immutable. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
Device.NeighborDiscovery. |
object |
R |
The Neighbor Discovery Protocol (NDP) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. |
- |
2.12 |
|
Device.NeighborDiscovery.InterfaceSetting.{i}. |
object(0:) |
W |
Per-interface Neighbor Discovery Protocol (NDP) configuration [RFC4861]. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
DADTransmits |
unsignedInt |
W |
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see[Section 5.1/RFC4862]). A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions. If the value is greater than 1, RetransTimer defines the delay between consecutive messages. |
1 |
2.13 |
|
Device.RouterAdvertisement. |
object |
R |
{{div|{{classes}}|The Router Advertisement (RA) object {{bibref|RFC4861}}. This object applies only to IPv6. It contains an {{object|InterfaceSetting}} table that defines the RA configuration for individual IP interfaces. Information received via router advertisement messages is automatically propagated to the relevant {{object|.IP.Interface}} sub-objects, e.g. to the {{object|.IP.Interface.{i}.IPv6Address}} and {{object|.IP.Interface.{i}.IPv6Prefix}} tables.}} The Router Advertisement (RA) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the RA configuration for individual IP interfaces. Information received via router advertisement messages is automatically propagated to the relevant IP.Interface sub-objects, e.g. to the IP.Interface.{i}.IPv6Address and IP.Interface.{i}.IPv6Prefix tables. |
- |
2.12 |
|
Device.RouterAdvertisement.InterfaceSetting.{i}. |
object(0:) |
W |
Per-interface Router Advertisement (RA) configuration [RFC4861]. Table entries are created for use in sending Router Advertisements. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} entry. Defines the value of the IsRouter and AdvSendAdvertisements flags from {{bibref|RFC4861|Section 4.2}}}} Enables or disables this InterfaceSetting entry. Defines the value of the IsRouter and AdvSendAdvertisements flags from [Section 4.2/RFC4861] |
false |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
ManualPrefixes |
string[:8]() |
W |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes that will be sent in Router Advertisement messages. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. Router Advertisement messages MUST include Prefix Information Options [RFC4861] for all Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) prefixes in this list. Prefixes MUST be associated with the interface instance referenced by Interface. |
<Empty> |
2.12 |
|
Prefixes |
string[:8]() |
R |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes that will be included in Router Advertisement (RA) messages sent out this interface. This list can include:
|
- |
2.12 |
|
MinRtrAdvInterval |
unsignedInt(3:1350) |
W |
The minimum time allowed between sending unsolicited multicast Router Advertisements from the interface, in seconds (see [Section 4.2/RFC4861]). The value MUST be no greater than 3/4 * MaxRtrAdvInterval. Note: The 1350 maximum was derived from the RFC, based on 3/4 times the maximum value of MaxRtrAdvInterval. Similarly, the 200 default was derived from the RFC, based on 1/3 times the default value of MaxRtrAdvInterval. |
200 |
2.12 |
|
AdvDefaultLifetime |
unsignedInt(:65535) |
W |
The value placed in the "Router Lifetime" field of Router Advertisement messages on this interface, in seconds (see [Section 4.2/RFC4861]). The value can be zero or between MaxRtrAdvInterval and 9000 seconds, but these limits can be overridden by specific documents that describe how IPv6 operates over different link layers. A value of zero indicates that the router is not to be used as a default router. Note: The 1800 default was derived from the RFC, based on 3 times the default value of MaxRtrAdvInterval. |
1800 |
2.12 |
|
AdvPreferredRouterFlag |
string |
W |
{{div|{{classes}}|The value placed in the "Default Router Preference" (Prf) field of Router Advertisement messages on this interface, as defined in {{bibref|RFC4191|Section 2.2}}. {{enum}} Also see {{bibref|RFC4191|Section 2.1}} which discusses how this flag is encoded on the wire.}} The value placed in the "Default Router Preference" (Prf) field of Router Advertisement messages on this interface, as defined in [Section 2.2/RFC4191]. Enumeration of:
Also see [Section 2.1/RFC4191] which discusses how this flag is encoded on the wire. |
Medium |
2.12 |
|
AdvReachableTime |
unsignedInt(:3600000) |
W |
{{div|{{classes}}|The value placed in the "Reachable Time" field of Router Advertisement messages on this interface, in {{units}} (see {{bibref|RFC4861|Section 4.2}}). The value zero means unspecified (by the router).}} The value placed in the "Reachable Time" field of Router Advertisement messages on this interface, in milliseconds (see [Section 4.2/RFC4861]). The value zero means unspecified (by the router). |
0 |
2.12 |
|
AdvRetransTimer |
unsignedInt |
W |
{{div|{{classes}}|The value placed in the "Retrans Timer" field of Router Advertisement messages on this interface (see {{bibref|RFC4861|Section 4.2}}). The value zero means unspecified (by the router).}} The value placed in the "Retrans Timer" field of Router Advertisement messages on this interface (see [Section 4.2/RFC4861]). The value zero means unspecified (by the router). |
0 |
2.12 |
|
AdvCurHopLimit |
unsignedInt(:255) |
W |
The value placed in the "Cur Hop Limit" field of Router Advertisement messages on this interface (see [Section 4.2/RFC4861]). The value zero means unspecified (by the router). Note: The default can be overridden with the value specified in [RFC3232] that was in effect at the time of implementation. |
0 |
2.12 |
|
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}. |
object(0:) |
W |
{{div|{{classes}}|This object specifies the options in a Router Advertisement (RA) message {{bibref|RFC4861|Section 4.6}}. {{object}} entries are created for use in sending Router Advertisements (enabled options MUST be included in RA messages sent). This includes support for sending DNS information in the RA message as described in {{bibref|RFC6106}}. This table is intended only for options that are not modeled elsewhere. For example, it is not appropriate for the MTU option (which is modeled via {{param|#.AdvLinkMTU}}).}} This object specifies the options in a Router Advertisement (RA) message [Section 4.6/RFC4861]. Option entries are created for use in sending Router Advertisements (enabled options MUST be included in RA messages sent). This includes support for sending DNS information in the RA message as described in [RFC6106]. This table is intended only for options that are not modeled elsewhere. For example, it is not appropriate for the MTU option (which is modeled via AdvLinkMTU). At most one entry in this table can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.IPv6rd. |
object |
R |
{{div|{{classes}}|Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in {{bibref|RFC5969}}. The 6rd mechanism is intended to be implemented only on what {{bibref|RFC5969}} refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. See the 6rd Theory of Operation {{bibref|TR-181i2|Appendix VI}} for a description of the working of this 6rd data model.}} Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in [RFC5969]. The 6rd mechanism is intended to be implemented only on what [RFC5969] refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. See the 6rd Theory of Operation [Appendix VI/TR-181i2] for a description of the working of this 6rd data model. |
- |
2.12 |
|
Device.IPv6rd.InterfaceSetting.{i}. |
object(0:) |
R |
6rd [RFC5969] settings. A 6rd delegated prefix is expected to be of maximum length 64 bits, and is the concatenation of the following two items:
At most one entry in this table can exist with a given value for Alias. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
IPv4MaskLength |
unsignedInt(0:32) |
W |
The number of high-order bits that are identical across all IPv4 addresses within a given 6rd domain. This number of bits MUST be removed from the start of the IPv4 address when generating the 6rd delegated prefix. For example, if this value is 8, only the final 24 bits of the subscriber IPv4 prefix will be used when creating the IPv6 delegated prefix, determining the destination IPv4 encapsulation address, etc. If the value is 0, then the whole 32 bits of the IPv4 address are used in the encoding. |
- |
2.12 |
|
TunnelInterface |
string(:256) |
R |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunnel that is logically the tunnel entry point for upstream IPv6 traffic and is also logically the tunnel exit point for downstream IPv6 traffic (i.e. the entry point for non-tunneled upstream IPv6 traffic to enter a tunnel and become tunneled, or conversely, the exit point for downstream IPv6 traffic leaving a tunnel after being un-tunneled). IPv6 traffic that enters TunnelInterface from the LAN is expected to continue on through TunneledInterface, and traffic from the WAN is expected to come from TunneledInterface into TunnelInterface. TunnelInterface is a logical interface that can allow for classification, marking (of IPv6 headers), and policing of IPv6 traffic that will be going over a 6rd tunnel. These functions are modeled in the QoS. object. TunnelInterface can be used also to represent the 6rd virtual interface defined in [RFC5969]. Note: In 6rd, IPv6 packets arriving over one or more device LAN IP interfaces are logically fed into this TunnelInterface. Likewise, 6rd traffic from the WAN gets logically sent from this TunnelInterface to LAN IP interfaces. |
- |
2.12 |
|
TunneledInterface |
string(:256) |
R |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunneled that provides information about the IPv4 headers used to encapsulate the IPv6 packets. Encapsulated IPv6 traffic that enters TunneledInterface from the WAN is expected to continue on through TunnelInterface, and traffic from the LAN is expected to come from TunnelInterface into TunneledInterface. TunneledInterface is a logical interface that can allow for classification, marking (of IPv4 headers and VLAN tags), and policing of IPv4 packets that encapsulate IPv6 packets in 6rd traffic. These functions are modeled in the QoS. object. Note: In 6rd, TunneledInterface traffic originating from the LAN logically feeds into a WAN-side IPv4 capable IP interface that the "IPv6 6rd tunnel" goes over. 6rd traffic that enters over this IPv4 WAN interface gets logically sent to this TunneledInterface. |
- |
2.12 |
|
Device.DSLite. |
object |
R |
{{div|{{classes}}|Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in {{bibref|DSLite}}. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. See the Dual-Stack Lite Theory of Operation {{bibref|TR-181i2|Appendix VII}} for a description of the working of this DS-Lite data model.}} Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in [DSLite]. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. See the Dual-Stack Lite Theory of Operation [Appendix VII/TR-181i2] for a description of the working of this DS-Lite data model. |
- |
2.12 |
|
Device.DSLite.InterfaceSetting.{i}. |
object(0:) |
R |
DSLite [DSLite] settings. At most one entry in this table can exist with a given value for Alias. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
EndpointAddressInUse |
string(:45) |
R |
[IPv6Address] {{div|{{classes}}|Indicates the address currently in use for the tunnel concentrator (remote endpoint). It is derived from the values of the {{param|EndpointAssignmentPrecedence}}, {{param|EndpointAddressTypePrecedence}}, {{param|EndpointName}} and {{param|EndpointAddress}} parameters. It is {{empty}} if no endpoint address is currently known.}} Indicates the address currently in use for the tunnel concentrator (remote endpoint). It is derived from the values of the EndpointAssignmentPrecedence, EndpointAddressTypePrecedence, EndpointName and EndpointAddress parameters. It is an empty string if no endpoint address is currently known. |
- |
2.12 |
|
EndpointName |
string(:256) |
W |
The Fully Qualified Domain Name (FQDN) of the tunnel concentrator (remote endpoint). This parameter is based on OPTION_DS_LITE_NAME from [Section 4/DSLite-options] and can be assigned statically (e.g. present in the factory default configuration or set by the Controller) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then EndpointAssignmentPrecedence indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to EndpointName. Note: EndpointName is only writable when EndpointAssignmentPrecedence is Static; otherwise, EndpointName is automatically configured via the DHCPv6 received option. |
- |
2.12 |
|
EndpointAddress |
string(:45) |
W |
[IPv6Address] {{div|{{classes}}|The address of the tunnel concentrator (remote endpoint). This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the Controller).}} The address of the tunnel concentrator (remote endpoint). This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the Controller). |
- |
2.12 |
|
TunnelInterface |
string(:256) |
R |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunnel that is logically the tunnel entry point for upstream IPv4 traffic and is also logically the tunnel exit point for downstream IPv4 traffic (i.e. the entry point for non-tunneled upstream IPv4 traffic to enter a tunnel and become tunneled, or conversely, the exit point for downstream IPv4 traffic leaving a tunnel after being un-tunneled). IPv4 traffic that enters TunnelInterface is expected to continue on through TunneledInterface from the LAN, and traffic from the WAN is expected to come from TunneledInterface into TunnelInterface. TunnelInterface is a logical interface that can allow for classification, marking (of IPv4 headers), and policing of IPv4 traffic that will be going over a DS-Lite tunnel. These functions are modeled in the Device.QoS object. Note: In DS-Lite, IPv4 packets arriving over one or more device LAN IP interfaces are logically fed into this TunnelInterface. Likewise, DS-Lite traffic from the WAN gets logically sent from this TunnelInterface to LAN IP interfaces. |
- |
2.12 |
|
TunneledInterface |
string(:256) |
R |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunneled that provides information about the IPv6 headers used to encapsulate the IPv4 packets. Encapsulated IPv4 traffic that enters TunneledInterface from the WAN is expected to continue on through TunnelInterface, and traffic from the LAN is expected to come from TunnelInterface into TunneledInterface. TunneledInterface is a logical interface that can allow for classification, marking (of IPv6 headers and VLAN tags), and policing of IPv6 packets that encapsulate IPv4 packets in DS-Lite traffic. These functions are modeled in the QoS. object. Note: In DS-Lite, TunneledInterface traffic originating from the LAN logically feeds into a WAN-side IPv6 capable IP interface that the "DSLite IPv4-in-IPv6 tunnel" goes over. DS-Lite traffic that enters over this IPv6 WAN interface gets logically sent to this TunneledInterface. |
- |
2.12 |
|
Device.QoS. |
object |
R |
Queue management configuration object. |
- |
2.12 |
|
DefaultPolicer |
string(:256) |
W |
{{div|{{classes}}|{{reference}} Indicates the Policer table entry for traffic not associated with any specified classifier. {{empty}} indicates a null policer.}} The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic not associated with any specified classifier. An empty string indicates a null policer. |
- |
2.12 |
|
DefaultDSCPMark |
int(-2:) |
W |
DSCP to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. |
- |
2.12 |
|
DefaultEthernetPriorityMark |
int(-2:) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
- |
2.12 |
|
DefaultInnerEthernetPriorityMark |
int(-2:) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic of the inner VLAN Tag as defined in 802.1Q, when the PDU is not associated with any specified classifier. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
- |
2.12 |
|
Device.QoS.Classification.{i}. |
object(0:) |
W |
Classification table. 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. Several of this object's parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as classification criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this classifier. Enumeration of:
|
Disabled |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the Classification 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 classification 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 Classification table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). |
- |
2.12 |
|
DHCPType |
string |
W |
{{div|{{classes}}|The DHCP protocol associated with the {{object}} instance. Affects only parameters that specify DHCP option values as classification criteria (all such parameter descriptions note this fact). {{enum}} If {{param}} is {{enum|DHCPv4}}, then {{object}} parameters that are DHCPv6-specific are ignored. If {{param}} is {{enum|DHCPv6}}, then {{object}} parameters that are DHCPv4-specific are ignored.}} The DHCP protocol associated with the Classification instance. Affects only parameters that specify DHCP option values as classification criteria (all such parameter descriptions note this fact). Enumeration of:
If DHCPType is DHCPv4, then Classification parameters that are DHCPv6-specific are ignored. If DHCPType is DHCPv6, then Classification parameters that are DHCPv4-specific are ignored. |
DHCPv4 |
2.12 |
|
Interface |
string(:256) |
W |
Classification criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Classifications can be instantiated is a local matter to the CPE. Note that this parameter is permitted to reference Tunnel instances in order to classify upstream packets that have just been encapsulated (such packets are conceptually similar to locally-generated traffic). For example, this parameter might reference a GRE.Tunnel or a MAP.Domain instance. |
<Empty> |
2.12 |
|
DestIP |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|Classification criterion. Destination IP address. {{empty}} indicates this criterion is not used for classification.}} Classification criterion. Destination IP address. An empty string indicates this criterion is not used for classification. |
<Empty> |
2.12 |
|
DestIPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the (masked) DestIP entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) DestIP entry, if specified.}} If false, the class includes only those packets that match the (masked) DestIP entry, if specified. If true, the class includes all packets except those that match the (masked) DestIP entry, if specified. |
false |
2.12 |
|
SourceIP |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|Classification criterion. Source IP address. {{empty}} indicates this criterion is not used for classification.}} Classification criterion. Source IP address. An empty string indicates this criterion is not used for classification. |
<Empty> |
2.12 |
|
SourceIPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the (masked) {{param|SourceIP}} entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) {{param|SourceIP}} entry, if specified.}} |
false |
2.12 |
|
Protocol |
int(-1:255) |
W |
{{div|{{classes}}|Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
ProtocolExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|Protocol}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|Protocol}} entry, if specified.}} |
false |
2.12 |
|
DestPort |
int(-1:65535) |
W |
{{div|{{classes}}|Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
DestPortRangeMax |
int(-1:65535) |
W |
Classification criterion. If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. |
-1 |
2.12 |
|
DestPortExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|DestPort}} entry (or port range), if specified. If {{true}}, the class includes all packets except those that match the {{param|DestPort}} entry (or port range), if specified.}} |
false |
2.12 |
|
SourcePort |
int(-1:65535) |
W |
{{div|{{classes}}|Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
SourcePortRangeMax |
int(-1:65535) |
W |
Classification criterion. If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. |
-1 |
2.12 |
|
SourcePortExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|SourcePort}} entry (or port range), if specified. If {{true}}, the class includes all packets except those that match the {{param|SourcePort}} entry (or port range), if specified.}} If false, the class includes only those packets that match the SourcePort entry (or port range), if specified. If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified. |
false |
2.12 |
|
SourceMACAddress |
string(:17) |
W |
[MACAddress] {{div|{{classes}}|Classification criterion. Source MAC Address. {{empty}} indicates this criterion is not used for classification.}} Classification criterion. Source MAC Address. An empty string indicates this criterion is not used for classification. |
<Empty> |
2.12 |
|
SourceMACExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the (masked) {{param|SourceMACAddress}} entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) {{param|SourceMACAddress}} entry, if specified.}} If false, the class includes only those packets that match the (masked) SourceMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) SourceMACAddress entry, if specified. |
false |
2.12 |
|
DestMACAddress |
string(:17) |
W |
[MACAddress] Classification criterion. Destination MAC Address. An empty string indicates this criterion is not used for classification. The use of destination MAC address as a classification criterion is primarily useful only for bridged traffic. |
<Empty> |
2.12 |
|
DestMACExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the (masked) {{param|DestMACAddress}} entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) {{param|DestMACAddress}} entry, if specified.}} If false, the class includes only those packets that match the (masked) DestMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) DestMACAddress entry, if specified. |
false |
2.12 |
|
Ethertype |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. Ethertype as indicated in either the Ethernet or SNAP Type header. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Ethertype as indicated in either the Ethernet or SNAP Type header. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
EthertypeExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|Ethertype}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|Ethertype}} entry, if specified.}} |
false |
2.12 |
|
SSAP |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
SSAPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|SSAP}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|SSAP}} entry, if specified.}} |
false |
2.12 |
|
DSAP |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. DSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. DSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
DSAPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|DSAP}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|DSAP}} entry, if specified.}} |
false |
2.12 |
|
LLCControl |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. Control element in the LLC header. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Control element in the LLC header. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
LLCControlExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|LLCControl}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|LLCControl}} entry, if specified.}} If false, the class includes only those packets that match the LLCControl entry, if specified. If true, the class includes all packets except those that match the LLCControl entry, if specified. |
false |
2.12 |
|
SNAPOUI |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. OUI element in the SNAP header. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. OUI element in the SNAP header. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
SNAPOUIExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|SNAPOUI}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|SNAPOUI}} entry, if specified.}} |
false |
2.12 |
|
SourceVendorClassID |
string(:255) |
W |
Classification criterion. Used to identify one or more LAN devices, value of the DHCPv4 Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in SourceVendorClassIDMode. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. an empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. |
<Empty> |
2.12 |
|
SourceVendorClassIDv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in [RFC3315]. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.12 |
|
SourceVendorClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets sourced from LAN devices that match the {{param|SourceVendorClassID}} entry (for {{enum|DHCPv4|DHCPType}}) or the {{param|SourceVendorClassIDv6}} entry (for {{enum|DHCPv6|DHCPType}}), if specified. If {{true}}, the class includes all packets except those sourced from LAN devices that match the {{param|SourceVendorClassID}} entry (for {{enum|DHCPv4|DHCPType}}) or the {{param|SourceVendorClassIDv6}} entry (for {{enum|DHCPv6|DHCPType}}), if specified.}} If false, the class includes only those packets sourced from LAN devices that match the SourceVendorClassID entry (for DHCPv4) or the SourceVendorClassIDv6 entry (for DHCPv6), if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorClassID entry (for DHCPv4) or the SourceVendorClassIDv6 entry (for DHCPv6), if specified. |
false |
2.12 |
|
SourceVendorClassIDMode |
string |
W |
{{div|{{classes}}|SourceVendorClassID pattern match criterion. {{enum}} For example, if {{param|SourceVendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.}} SourceVendorClassID pattern match criterion. Enumeration of:
For example, if SourceVendorClassID is "Example" then an Option 60 value of "Example device" will match with SourceVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix. |
Exact |
2.12 |
|
DestVendorClassID |
string(:255) |
W |
Classification criterion. Used to identify one or more LAN devices, value of the DHCPv4 Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in DestVendorClassIDMode. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. an empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. |
<Empty> |
2.12 |
|
DestVendorClassIDv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in [RFC3315]. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.12 |
|
DestVendorClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets destined for LAN devices that match the {{param|DestVendorClassID}} entry (for {{enum|DHCPv4|DHCPType}}) or the {{param|DestVendorClassIDv6}} entry (for {{enum|DHCPv6|DHCPType}}), if specified. If {{true}}, the class includes all packets except those destined for LAN devices that match the {{param|DestVendorClassID}} entry (for {{enum|DHCPv4|DHCPType}}) or the {{param|DestVendorClassIDv6}} entry (for {{enum|DHCPv6|DHCPType}}), if specified.}} If false, the class includes only those packets destined for LAN devices that match the DestVendorClassID entry (for DHCPv4) or the DestVendorClassIDv6 entry (for DHCPv6), if specified. If true, the class includes all packets except those destined for LAN devices that match the DestVendorClassID entry (for DHCPv4) or the DestVendorClassIDv6 entry (for DHCPv6), if specified. |
false |
2.12 |
|
DestVendorClassIDMode |
string |
W |
{{div|{{classes}}|{{param|DestVendorClassID}} pattern match criterion. {{enum}} For example, if {{param|DestVendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.}} DestVendorClassID pattern match criterion. Enumeration of:
For example, if DestVendorClassID is "Example" then an Option 60 value of "Example device" will match with DestVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix. |
Exact |
2.12 |
|
SourceClientID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.12 |
|
SourceClientIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets sourced from LAN devices that match the {{param|SourceClientID}} entry, if specified. If {{true}}, the class includes all packets except those sourced from LAN devices that match the {{param|SourceClientID}} entry, if specified.}} If false, the class includes only those packets sourced from LAN devices that match the SourceClientID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceClientID entry, if specified. |
false |
2.12 |
|
DestClientID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.12 |
|
DestClientIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets destined for LAN devices that match the {{param|DestClientID}} entry, if specified. If {{true}}, the class includes all packets except those destined for LAN devices that match the {{param|DestClientID}} entry, if specified.}} If false, the class includes only those packets destined for LAN devices that match the DestClientID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestClientID entry, if specified. |
false |
2.12 |
|
SourceUserClassID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.12 |
|
SourceUserClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets sourced from LAN devices that match the {{param|SourceUserClassID}} entry, if specified. If {{true}}, the class includes all packets except those sourced from LAN devices that match the {{param|SourceUserClassID}} entry, if specified.}} If false, the class includes only those packets sourced from LAN devices that match the SourceUserClassID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceUserClassID entry, if specified. |
false |
2.12 |
|
DestUserClassID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.12 |
|
DestUserClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets destined for LAN devices that match the {{param|DestUserClassID}} entry, if specified. If {{true}}, the class includes all packets except those destined for LAN devices that match the {{param|DestUserClassID}} entry, if specified.}} If false, the class includes only those packets destined for LAN devices that match the DestUserClassID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestUserClassID entry, if specified. |
false |
2.12 |
|
SourceVendorSpecificInfo |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in SourceVendorSpecificInfoEnterprise and SourceVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in [RFC3315]) for DHCPv6. an empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.12 |
|
SourceVendorSpecificInfoExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets sourced from LAN devices that match the {{param|SourceVendorSpecificInfo}} entry, if specified. If {{true}}, the class includes all packets except those sourced from LAN devices that match the {{param|SourceVendorSpecificInfo}} entry, if specified.}} If false, the class includes only those packets sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. |
false |
2.12 |
|
SourceVendorSpecificInfoEnterprise |
unsignedInt |
W |
{{div|{{classes}}|{{param|SourceVendorSpecificInfo}} Enterprise Number as defined in {{bibref|RFC3925}}. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number.}} SourceVendorSpecificInfo Enterprise Number as defined in [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. |
0 |
2.12 |
|
DestVendorSpecificInfo |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in DestVendorSpecificInfoEnterprise and DestVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in [RFC3315]) for DHCPv6. an empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.12 |
|
DestVendorSpecificInfoExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets destined for LAN devices that match the {{param|DestVendorSpecificInfo}} entry, if specified. If {{true}}, the class includes all packets except those destined for LAN devices that match the {{param|DestVendorSpecificInfo}} entry, if specified.}} If false, the class includes only those packets destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. |
false |
2.12 |
|
DestVendorSpecificInfoEnterprise |
unsignedInt |
W |
{{div|{{classes}}|{{param|DestVendorSpecificInfo}} Enterprise Number as defined in {{bibref|RFC3925}}. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number.}} DestVendorSpecificInfo Enterprise Number as defined in [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. |
0 |
2.12 |
|
TCPACK |
boolean |
W |
Classification criterion. If false, this criterion is not used for classification. If true, this criterion matches with all TCP segments that have the ACK control bit set. |
false |
2.12 |
|
TCPACKExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|TCPACK}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|TCPACK}} entry, if specified.}} |
false |
2.12 |
|
IPLengthMin |
unsignedInt |
W |
{{div|{{classes}}|Classification criterion. Minimum IP Packet Length (including header) in bytes.}} Classification criterion. Minimum IP Packet Length (including header) in bytes. |
0 |
2.12 |
|
IPLengthMax |
unsignedInt |
W |
Classification criterion. Maximum IP Packet Length (including header) in bytes. A value of zero indicates that no maximum is specified (an umlimited maximum length). |
0 |
2.12 |
|
IPLengthExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets whose length (including header) falls within the inclusive range {{param|IPLengthMin}} through {{param|IPLengthMax}}. A value of zero for both {{param|IPLengthMin}} and {{param|IPLengthMax}} allows any length packet. An equal non-zero value of {{param|IPLengthMin}} and {{param|IPLengthMax}} allows only a packet with the exact length specified. If {{true}}, the class includes all packets except those whose length (including header) falls within the inclusive range {{param|IPLengthMin}} through {{param|IPLengthMax}}.}} If false, the class includes only those packets whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. A value of zero for both IPLengthMin and IPLengthMax allows any length packet. An equal non-zero value of IPLengthMin and IPLengthMax allows only a packet with the exact length specified. If true, the class includes all packets except those whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. |
false |
2.12 |
|
DSCPCheck |
int(-1:63) |
W |
Classification criterion. DiffServ codepoint (defined in [RFC2474]). If set to a Class Selector Codepoint (defined in [RFC2474]), all DSCP values that match the first 3 bits will be considered a valid match. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
DSCPExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|DSCPCheck}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|DSCPCheck}} entry, if specified.}} |
false |
2.12 |
|
DSCPMark |
int(-2:) |
W |
Classification result. DSCP to mark traffic with that falls into this classification entry. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
EthernetPriorityCheck |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. Current Ethernet priority of a VLAN Tag as defined in {{bibref|802.1Q-2011}} or Ethernet Priority field as defined in 802.1D. If more than 1 VLAN tag is present, then this parameter represents the outer VLAN Tag. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Current Ethernet priority of a VLAN Tag as defined in [802.1Q-2011] or Ethernet Priority field as defined in 802.1D. If more than 1 VLAN tag is present, then this parameter represents the outer VLAN Tag. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
EthernetPriorityExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|EthernetPriorityCheck}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|EthernetPriorityCheck}} entry, if specified.}} If false, the class includes only those packets that match the EthernetPriorityCheck entry, if specified. If true, the class includes all packets except those that match the EthernetPriorityCheck entry, if specified. |
false |
2.12 |
|
EthernetPriorityMark |
int(-2:) |
W |
Classification result. Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic with that falls into this classification entry associated with the EthernetPriorityCheck. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
InnerEthernetPriorityCheck |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. Current Ethernet priority of the inner VLAN Tag as defined in 802.1Q. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Current Ethernet priority of the inner VLAN Tag as defined in 802.1Q. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
InnerEthernetPriorityExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|InnerEthernetPriorityCheck}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|InnerEthernetPriorityCheck}} entry, if specified.}} If false, the class includes only those packets that match the InnerEthernetPriorityCheck entry, if specified. If true, the class includes all packets except those that match the InnerEthernetPriorityCheck entry, if specified. |
false |
2.12 |
|
InnerEthernetPriorityMark |
int(-2:) |
W |
Classification result. Ethernet priority code to mark traffic with that falls into this classification entry associated with the InnerEthernetPriorityCheck. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
EthernetDEICheck |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. Current Ethernet Drop eligible Indication (DEI) of the VLAN tag as defined in 802.1Q. If 2 VLAN Tags are present, then this parameter represents the outer VLAN tag. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Current Ethernet Drop eligible Indication (DEI) of the VLAN tag as defined in 802.1Q. If 2 VLAN Tags are present, then this parameter represents the outer VLAN tag. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
EthernetDEIExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|EthernetDEICheck}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|EthernetDEICheck}} entry, if specified.}} If false, the class includes only those packets that match the EthernetDEICheck entry, if specified. If true, the class includes all packets except those that match the EthernetDEICheck entry, if specified. |
false |
2.12 |
|
VLANIDCheck |
int(-1:) |
W |
{{div|{{classes}}|Classification criterion. Current Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for classification.}} Classification criterion. Current Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
VLANIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, the class includes only those packets that match the {{param|VLANIDCheck}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|VLANIDCheck}} entry, if specified.}} If false, the class includes only those packets that match the VLANIDCheck entry, if specified. If true, the class includes all packets except those that match the VLANIDCheck entry, if specified. |
false |
2.12 |
|
OutOfBandInfo |
int(-1:) |
W |
Classification criterion. Allows traffic to be distinguished based on out-of-band information such as physical port or application ID. Primarily intended for, but not restricted to, locally sourced traffic. If specified, this entry applies to traffic with matching out-of-band information. A value of -1 indicates this criterion is not used for classification. |
-1 |
2.12 |
|
ForwardingPolicy |
unsignedInt |
W |
{{div|{{classes}}|Classification result. Identifier of the forwarding policy associated with traffic that falls in this classification.}} Classification result. Identifier of the forwarding policy associated with traffic that falls in this classification. |
0 |
2.12 |
|
TrafficClass |
int(-1:) |
W |
Classification result. Identifier of the traffic class associated with traffic that falls in this classification. If specified, at least one Queue table entry MUST include this traffic class in its Queue.{i}.TrafficClasses parameter (which is a comma-separated list). A value of -1 indicates a null traffic class. TrafficClass and App are mutually exclusive and one of the two MUST be specified. If TrafficClass is -1, App MUST be specified, and vice versa. |
-1 |
2.12 |
|
Policer |
string(:256) |
W |
Classification result. The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic that falls in this classification. an empty string indicates a null policer. Policer MAY optionally be specified in conjunction with TrafficClass. Policer and App are mutually exclusive. |
<Empty> |
2.12 |
|
App |
string(:256) |
W |
Classification result. The value MUST be the Path Name of a row in the App. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the App table entry for traffic that falls in this classification. an empty string indicates a null App. TrafficClass and App are mutually exclusive and one of the two MUST be specified. If TrafficClass is null, App MUST be specified, and vice versa. |
<Empty> |
2.12 |
|
Device.QoS.App.{i}. |
object(0:) |
W |
Application table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this App table entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this App table entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
DefaultPolicer |
string(:256) |
W |
{{div|{{classes}}|{{reference}} Indicates the Policer table entry for traffic associated with this {{object}} table entry, but not associated with any specified flow. {{empty}} indicates a null policer.}} The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic associated with this App table entry, but not associated with any specified flow. An empty string indicates a null policer. |
<Empty> |
2.12 |
|
DefaultDSCPMark |
int(-2:) |
W |
DSCP to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
DefaultEthernetPriorityMark |
int(-2:) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
DefaultInnerEthernetPriorityMark |
int(-2:) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark the inner VLAN Tags as defined in 802.1Q with this App table entry where the packet is not associated with any specified flow. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
- |
2.12 |
|
Device.QoS.Flow.{i}. |
object(0:) |
W |
Flow table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this Flow table entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this Flow table entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
Policer |
string(:256) |
W |
{{div|{{classes}}|{{reference}} Indicates the Policer table entry for traffic that falls in this flow. {{empty}} indicates a null policer.}} The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic that falls in this flow. An empty string indicates a null policer. |
<Empty> |
2.12 |
|
DSCPMark |
int(-2:) |
W |
DSCP to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
EthernetPriorityMark |
int(-2:) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
InnerEthernetPriorityMark |
int(-2:) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark the inner VLAN Tags with for traffic that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. |
-1 |
2.12 |
|
Device.QoS.Policer.{i}. |
object(0:) |
W |
Policer table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this policer. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this policer. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
ExcessBurstSize |
unsignedInt |
W |
{{div|{{classes}}|Excess Burstsize in bytes. Applied for a {{enum|SingleRateThreeColor|MeterType}} meter.}} Excess Burstsize in bytes. Applied for a SingleRateThreeColor meter. |
0 |
2.12 |
|
PeakRate |
unsignedInt |
W |
{{div|{{classes}}|Peak rate allowed for this Meter in {{units}}. Applied for {{enum|TwoRateThreeColor|MeterType}} meters.}} Peak rate allowed for this Meter in bits per second. Applied for TwoRateThreeColor meters. |
0 |
2.12 |
|
PeakBurstSize |
unsignedInt |
W |
{{div|{{classes}}|Peak Burstsize in bytes. Applied for {{enum|TwoRateThreeColor|MeterType}} meters.}} Peak Burstsize in bytes. Applied for TwoRateThreeColor meters. |
0 |
2.12 |
|
MeterType |
string |
W |
The value MUST be a member of the list reported by the PossibleMeterTypes parameter. Identifies the method of traffic measurement to be used for this policer. SimpleTokenBucket makes use of CommittedRate and CommittedBurstSize. SingleRateThreeColor makes use of CommittedRate, CommittedBurstSize, and ExcessBurstSize as defined in [RFC2697]. TwoRateThreeColor makes use of CommittedRate, CommittedBurstSize, PeakRate, and PeakBurstSize as defined in [RFC2698]. |
SimpleTokenBucket |
2.12 |
|
ConformingAction |
string |
W |
Instructions for how to handle traffic that is conforming. Possible patterns:
|
Null |
2.12 |
|
PartialConformingAction |
string |
W |
Instructions for how to handle traffic that is partially conforming (colored yellow). Possible patterns:
|
Drop |
2.12 |
|
NonConformingAction |
string |
W |
Instructions for how to handle traffic that is non-conforming. Possible patterns:
|
Drop |
2.12 |
|
Device.QoS.Queue.{i}. |
object(0:) |
W |
{{div|{{classes}}|Queue table. Each entry is associated with a set of traffic classes, which are specified via the {{param|TrafficClasses}} parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. For enabled table entries, if {{param|Interface}} is not a valid reference and {{param|AllInterfaces}} is {{false}}, then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}.}} Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this queue. Enumeration of:
|
Disabled |
2.12 |
|
TrafficClasses |
unsignedInt[](:256) |
W |
Comma-separated list (maximum number of characters 256) of unsigned integers. Each list item identifies the set of traffic classes associated with this queue. Traffic is sent to this queue if a Classification, App or Flow table entry specifies a traffic class, e.g. via the Classification.{i}.TrafficClass parameter. If more than one queue on a given egress interface is associated with a given traffic class, the implementation will choose which queue to send traffic of this class to. |
<Empty> |
2.12 |
|
Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} Specifies the egress interface for which the specified queue MUST exist. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Queues can be instantiated is a local matter to the CPE.}} The value MUST be the Path Name of a table row. Specifies the egress interface for which the specified queue MUST exist. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Queues can be instantiated is a local matter to the CPE. |
<Empty> |
2.12 |
|
BufferLength |
unsignedInt |
R |
{{div|{{classes}}|Number of bytes in the buffer. Queue buffer size for all egress interfaces for which this queue exists. If the buffer size is not the same for all such egress interfaces, this parameter MUST be 0.}} Number of bytes in the buffer. Queue buffer size for all egress interfaces for which this queue exists. If the buffer size is not the same for all such egress interfaces, this parameter MUST be 0. |
- |
2.12 |
|
REDThreshold |
unsignedInt(:100) |
W |
Random Early Detection threshold, used only when DropAlgorithm is RED. This is the minimum threshold (min_th) and is measured as a percentage of the queue size. If the value is set to zero, the CPE MUST choose a sensible value, e.g. 5 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the maximum threshold (max_th). The CPE MUST choose a sensible value, e.g. three times the minimum threshold. In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. |
0 |
2.12 |
|
REDPercentage |
unsignedInt(:100) |
W |
Random Early Detection percentage, used only when DropAlgorithm is RED. This is the maximum value of the packet marking probability (max_p). If the value is set to zero, the CPE MUST choose a sensible value, e.g. 10 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. |
0 |
2.12 |
|
ShapingRate |
int(-1:) |
W |
Rate to shape this queue's traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the egress will be on a PPP or IP link with a specified ShapingRate, the percentage is calculated relative to this rate. Otherwise, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. |
-1 |
2.12 |
|
Device.QoS.QueueStats.{i}. |
object(0:) |
W |
{{div|{{classes}}|Queue statistics table. This table is managed by the Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The {{object}} table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending {{object}} row.}} Queue statistics table. This table is managed by the Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The QueueStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated QueueStats row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending QueueStats row. At most one entry in this table can exist with a given value for Alias, or with the same values for both Queue and Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} Specifies the egress interface for which this object contains statistics. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which QueueStats can be instantiated is a local matter to the CPE.}} The value MUST be the Path Name of a table row. Specifies the egress interface for which this object contains statistics. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which QueueStats can be instantiated is a local matter to the CPE. |
<Empty> |
2.12 |
|
Device.QoS.Shaper.{i}. |
object(0:) |
W |
Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that 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 Shaper 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 Shaper 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 Shaper row. At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this shaper. Enumeration of:
|
Disabled |
2.12 |
|
ShapingRate |
int(-1:) |
W |
Rate to shape the associated interface connection's egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. |
-1 |
2.12 |
|
Device.LANConfigSecurity. |
object |
R |
This object contains generic device configuration information. |
- |
2.12 |
|
ConfigPassword |
string(:64) |
W |
A password to allow LAN access to protected auto-configuration services. If the CPE supports TR-064 (LAN-side DSL CPE Configuration Protocol), this parameter is to be used as the dslf-config password (as defined in TR-064). If the CPE has a user interface with password protection enabled, this parameter is also to be used as the user password for password-protected operations. However, this parameter MUST NOT be used to set the user password if the parameter UserInterface.PasswordUserSelectable is true. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
Device.Hosts. |
object |
R |
This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. |
- |
2.12 |
|
Device.Hosts.Host.{i}. |
object(0:) |
R |
Host table. At most one entry in this table can exist with a given value for PhysAddress. Changes since 2.14:
|
- |
2.12 |
|
Alias |
string(:64) |
W |
[Alias] ::::::: hide 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:
This parameter was DEPRECATED in 2.11.because {{object}}Host is a transient object. This parameter is OBSOLETED in 2.14.object This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
IPAddress |
string(:45) |
R |
[IPAddress] {{div|{{classes}}|Current IP Address of the host. {{empty}} if no address is available. If more than one IP address for this host is known, the CPE will choose a primary address. All known IP addresses can be listed in the {{object|IPv4Address}} and {{object|IPv6Address}} tables.}} Current IP Address of the host. An empty string if no address is available. If more than one IP address for this host is known, the CPE will choose a primary address. All known IP addresses can be listed in the IPv4Address and IPv6Address tables. |
- |
2.12 |
|
AddressSource |
string |
R |
Indicates whether the IP address of the host was allocated by the CPE using DHCP, was assigned to the host statically, or was assigned using automatic IP address allocation. Enumeration of:
This parameter was DEPRECATED in 2.11.because only {{enum|**{{enum: only valid as argument}}**None}} and {{enum|**{{enum: only valid as argument}}**DHCP}} made sense (the CPE doesn't know whether the address is {{enum|**{{enum: only valid as argument}}**Static}} or {{enum|**{{enum: only valid as argument}}**AutoIP}}). The {{enum|**{{enum: only valid as argument}}**DHCP}} case is now handled via the {{param|AddressSourceDHCPClient}} reference. This parameter is OBSOLETED in 2.14.reference This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
LeaseTimeRemaining |
int(-1:) |
R |
DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease. The value MUST be 0 (zero) if the AddressSource is not DHCP. This parameter was DEPRECATED This parameter was DEPRECATED in 2.11.because DHCP lease/lifetime information can be accessed via the {{param|LeaseTimeRemainingDHCPClient}} reference. This parameter is OBSOLETED in 2.14.reference This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
AssociatedDevice |
string(:256) |
R |
{{div|{{classes}}|{{noreference}}The value MUST be the path name of the AssociatedDevice (or equivalent) table row that models the host, or {{null}} if either there is no such table or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point). For example: Device.WiFi.AccessPoint.1.AssociatedDevice.2}} The value MUST be the path name of the AssociatedDevice (or equivalent) table row that models the host, or an empty string if either there is no such table or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point). For example: Device.WiFi.AccessPoint.1.AssociatedDevice.2 |
- |
2.12 |
|
Layer1Interface |
string(:256) |
R |
{{div|{{classes}}|{{noreference}}The value MUST be the path name of a row in a layer 1 interface table. If either the layer 1 interface isn't known or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point), then {{param}} will be {{null}}. For example: Device.Ethernet.Interface.2}} The value MUST be the path name of a row in a layer 1 interface table. If either the layer 1 interface isn't known or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point), then Layer1Interface will be an empty string. For example: Device.Ethernet.Interface.2 |
- |
2.12 |
|
VendorClassID |
string(:255) |
R |
Vendor Class Identifier DHCP option (Option 60) of the host. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter was DEPRECATED This parameter was DEPRECATED in 2.11.because host-supplied DHCP options can be accessed via the {{param|VendorClassIDDHCPClient}} reference. This parameter is OBSOLETED in 2.14.reference This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
ClientID |
hexBinary(:65535) |
R |
A hexbinary string, Client Identifier DHCP option (Option 61) for the specific IP connection of the client. The option value is binary, so an exact match is REQUIRED. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter was DEPRECATED This parameter was DEPRECATED in 2.11.because host-supplied DHCP options can be accessed via the {{param|ClientIDDHCPClient}} reference. This parameter is OBSOLETED in 2.14.reference This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. Changes since 2.14:
|
- |
2.12 |
|
UserClassID |
hexBinary(:65535) |
R |
A hexbinary string, User Class Identifier DHCP option (Option 77) of the host. It MAY be defined when {{param: non-existent AddressSource{{inserted: unexpected argument deleted after: []}}}} is {{enum: reference to deleted enumeration Device.Hosts.Host.{i}.AddressSource.DHCP}}. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter is DEPRECATED This parameter was DEPRECATED in 2.11.because host-supplied DHCP options can be accessed via the {{param|UserClassIDDHCPClient}} reference.reference This parameter was OBSOLETED in 2.15. |
- |
2.12 |
|
Active |
boolean |
R |
Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, Active MUST be set to false for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days. |
- |
2.12 |
|
ActiveLastChange |
dateTime |
R |
The datetime when Active last changed from true to false or from false to true. The initial detection of a host SHOULD be treated as a transition from false to true, showing the datetime when the host was first detected. The ability to list inactive hosts is OPTIONAL. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days. |
- |
2.12 |
|
Device.Hosts.AccessControl.{i}. |
object(0:) |
W |
{{div|{{classes}}|Every instance of this object provides access control for a LAN device. Access is allowed if no instance of {{object}} is defined for a device.}} Every instance of this object provides access control for a LAN device. Access is allowed if no instance of AccessControl is defined for a device. If access is not allowed, then the LAN device cannot access the broadband network. At most one entry in this table can exist with a given value for Alias, or with a given value for PhysAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and PhysAddress such that the new entry does not conflict with any existing entries. |
- |
2.14 |
|
AccessPolicy |
string |
W |
Allows or denies access for a device. If AccessPolicy is set to "Allow", device access is allowed based on the Schedule objects. Access is enabled if there is no Schedule object defined. If AccessPolicy is set to "Deny", defined Schedule objects are ignored and no access is allowed for the device. Enumeration of:
|
Allow |
2.14 |
|
Device.Hosts.AccessControl.{i}.Schedule.{i}. |
object(0:) |
W |
Each instance of this object provides a schedule where access is enabled. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.14 |
|
Day |
string[] |
W |
Comma-separated list ofComma-separated list of strings, the. days for which access is enabled.enabled Each list item is an enumeration of:
|
- |
2.14 |
|
StartTime |
string(:5) |
W |
{{div|{{classes}}|Start time of the enable schedule in hh:mm format. [hh] refers to a zero-padded hour between 00 and 23. [mm] refers to a zero-padded minute between 00 and 59. Start time is in local time zone.}} Start time of the enable schedule in hh:mm format. [hh] refers to a zero-padded hour between 00 and 23. [mm] refers to a zero-padded minute between 00 and 59. Start time is in local time zone. Possible patterns:
|
- |
2.14 |
|
Duration |
unsignedInt(1:) |
W |
The duration, in seconds, which the access is enabled. If the StartTime is not defined, duration is the total time access is allowed during a calendar day. If a StartTime is defined, access is allowed for the Duration period starting from StartTime. |
- |
2.14 |
|
Device.DNS. |
object |
R |
Properties for Domain Name Service (DNS). |
- |
2.12 |
|
Device.DNS.Client. |
object |
R |
Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the DNS client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the DNS client. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
Device.DNS.Client.Server.{i}. |
object(0:) |
W |
This table contains the DNS Server IP address to be used by the DHCPDNS Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. At most one entry in this table can exist with a given value for DNSServer, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for DNSServer and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
DNSServer |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|DNS server IP address. Note: {{param}} is only writable when {{param|Type}} is {{enum|Static|Type}}; otherwise, {{param}} is automatically configured as result of DHCP, IPCP, or RA received DNS server information.}} DNS server IP address. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter specifies the IP interface over which the DNS query is sent. If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP, IPCP, or RA received DNS server information. |
<Empty> |
2.12 |
|
Type |
string |
R |
{{div|{{classes}}|Method used to assign the {{param|DNSServer}} address. {{enum}} Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have {{param}} set to {{enum|DHCPv4}}, {{enum|DHCPv6}}, {{enum|IPCP}}, or {{enum|RouterAdvertisement}}, as the case may be. Manually created table entires will have their {{param}} set to {{enum|Static}}.}} Method used to assign the DNSServer address. Enumeration of:
Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entires will have their Type set to Static. |
Static |
2.12 |
|
Device.DNS.Relay. |
object |
R |
DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the DNS relay. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the DNS relay. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
ForwardNumberOfEntries |
unsignedInt |
R |
The number of entries in the Forwarding table. Changes since 2.14:
|
- |
2.12 |
|
Device.DNS.Relay.Forwarding.{i}. |
object(0:) |
W |
{{div|{{classes}}|DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.}} DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification. At most one entry in this table can exist with a given value for DNSServer, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for DNSServer and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of this entry. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
DNSServer |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|DNS server IP address. Note: {{param}} is only writable when {{param|Type}} is {{enum|Static|Type}}; otherwise, {{param}} is automatically configured as result of DHCP, IPCP, or RA received DNS server information.}} DNS server IP address. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the IP interface over which the DNS query is sent. If an empty string is specified, the CPE MUST use its routing policy (IP Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP, IPCP, or RA received DNS server information. |
<Empty> |
2.12 |
|
Type |
string |
R |
{{div|{{classes}}|Method used to assign the {{param|DNSServer}} address. {{enum}} Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have {{param}} set to {{enum|DHCPv4}}, {{enum|DHCPv6}}, {{enum|IPCP}}, or {{enum|RouterAdvertisement}}, as the case may be. Manually created table entires will have their {{param}} set to {{enum|Static}}.}} Method used to assign the DNSServer address. Enumeration of:
Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entires will have their Type set to Static. |
Static |
2.12 |
|
Device.DNS.Diagnostics. |
object |
R |
The DNS Diagnostics object containing the {{object: referenced NSLookupDiagnostics() is command, not object}} test. |
- |
2.12 |
|
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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Interface |
string(:256) |
W |
{{div|{{classes}}|{{reference}} The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If {{empty}} is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface.}} The value MUST be the Path Name of a table row. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. |
- |
2.12 |
|
⇒ HostName |
string(:256) |
W |
[MANDATORY] Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name. Changes since 2.14:
|
- |
2.12 |
|
⇒ DNSServer |
string(:256) |
W |
{{div|{{classes}}|Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If {{empty}} is specified, the device's default DNS server will be used.}} Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If an empty string is specified, the device's default DNS server will be used. |
- |
2.12 |
|
⇒ Timeout |
unsignedInt |
W |
[MANDATORY] Timeout in milliseconds that indicates that a request has failed. Changes since 2.14:
|
- |
2.12 |
|
⇒ NumberOfRepetitions |
unsignedInt |
W |
[MANDATORY] {{div|{{classes}}|The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data.}} The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data. Changes since 2.14:
|
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
{{div|{{classes}}|Indicates the availability of diagnostics data. {{enum}} If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.}} Indicates the availability of diagnostics data. Enumeration of:
If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate. |
- |
2.13 |
|
Device.DNS.SD. |
object |
R |
{{div|{{classes}}|This object contains the DNS Service Discovery {{bibref|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.}} 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.12 |
|
AdvertisedInterfaces |
string[] |
W |
Comma-separated list of strings. {{div|{{classes}}|{{reference|the {{object|##.IP.Interface}} object instance from which DNS-SD services are advertised}} If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces.}} 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.DNS.SD.Service.{i}. |
object(0:) |
R |
The Service table contains discovered DNS-SD services. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form: Service Instance Name = At most one entry in this table can exist with the same values for all of InstanceName, ApplicationProtocol, TransportProtocol and Domain. |
- |
2.12 |
|
Status |
string |
R |
The status of the discovered Service at LastUpdate time. Enumeration of:
|
- |
2.12 |
|
Device.DNS.SD.Service.{i}.TextRecord.{i}. |
object(0:) |
R |
{{div|{{classes}}|This object maintains an instance of a (key/value pairs) of the service. The information is extracted from DNS TXT records {{bibref|RFC1035}} of the discovered service. When multiple instances of the {{object}} table have the same value for the {{param|Key}} parameter, the implementation is CPE specific.}} |
- |
2.12 |
|
Device.NAT. |
object |
R |
{{div|{{classes}}|Properties for Network Address Translation (NAT). The entire {{object}} object only applies to IPv4.}} Properties for Network Address Translation (NAT). The entire NAT object only applies to IPv4. |
- |
2.12 |
|
Device.NAT.InterfaceSetting.{i}. |
object(0:) |
W |
NAT settings for an associated IP Interface on which NAT is enabled. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Device.NAT.PortMapping.{i}. |
object(0:) |
W |
Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table can exist with a given value for Alias, or with the same values for all of RemoteHost, ExternalPort and Protocol. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, ExternalPort and Protocol such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Alias |
string(:64) |
W |
{{div|{{classes}}|{{datatype|expand}} Note: There is no guarantee that the {{param}} value on automatically-created {{object}} instances will be retained. This is because automatically-created {{object}} instances can be transitory.}} [Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
Note: There is no guarantee that the Alias value on automatically-created PortMapping instances will be retained. This is because automatically-created PortMapping instances can be transitory. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LeaseDuration |
unsignedInt |
W |
Determines the time to live, in seconds, of a port mapping lease, where "time to live" means the number of seconds before the port mapping expires. A value of 0 means the port mapping is static. Support for dynamic (non-static) port mappings is OPTIONAL. That is, the only value for LeaseDuration that MUST be supported is 0. For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time remaining on the port mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port mapping lease expires, the CPE MUST automatically terminate that port mapping, and MUST automatically delete the corresponding PortMapping table entry. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
RemoteHost |
string |
W |
This parameter is the IP address of the source of inbound packets. An empty string indicates a "wildcard", i.e. any IP address (this will be an empty string in most cases). CPE are REQUIRED only to support an empty string. When RemoteHost is an empty string, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the IP.Interface associated with the InternalClient on the InternalPort. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped. If a CPE supports non-empty values for RemoteHost, it MAY additionally support the ability to have more than one port mapping with the same ExternalPort and Protocol, but with differing values of RemoteHost. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
|
<Empty> |
2.12 |
|
ExternalPort |
unsignedInt(0:65535) |
W |
The external port (or the first port of a range of external ports) that the NAT gateway would listen on for traffic to a corresponding InternalPort. Inbound packets to this external port on the WAN interface SHOULD be forwarded to the IP.Interface associated with the InternalClient on the InternalPort. A value of zero (0) represents a "wildcard", i.e. any port number. If this value is 0, traffic on all external ports (that are not otherwise mapped) will be forwarded to InternalClient, and the value(s) of InternalPort on InternalClient are ignored. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Protocol) doesn't conflict with any existing entries. |
- |
2.12 |
|
ExternalPortEndRange |
unsignedInt(0:65535) |
W |
Indicates the last port of the external port range that starts with ExternalPort. If an external port range is specified, then the behavior described for ExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of ExternalPort. If ExternalPort is zero (wildcard), the value of this parameter MUST be ignored. If specified, the value of this parameter MUST be greater than or equal to the value of ExternalPort. |
0 |
2.12 |
|
InternalClient |
string(:256) |
W |
The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the Controller can learn the host name associated with a given LAN device via the Hosts.Host. table. Read access to this parameter MUST always return the exact value that was last set by the Controller. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. |
<Empty> |
2.12 |
|
Device.PCP. |
object |
R |
{{div|{{classes}}|Properties for Port Control Protocol (PCP) {{bibref|RFC6887}}. See the PCP Theory of Operation {{bibref|TR-181i2|Appendix XIV}} for a description of the working of this PCP data model.}} Properties for Port Control Protocol (PCP) [RFC6887]. See the PCP Theory of Operation [Appendix XIV/TR-181i2] for a description of the working of this PCP data model. |
- |
2.12 |
|
SupportedVersions |
unsignedInt(0:65535)[] |
R |
{{div|{{classes}}|{{list}} Each list item denotes a PCP version supported by the PCP Client. Currently known versions are 0, 1 and 2. This parameter is based on Version from {{bibref|RFC6887}}.}} Comma-separated list of unsigned integers (0 to 65535). Each list item denotes a PCP version supported by the PCP Client. Currently known versions are 0, 1 and 2. This parameter is based on Version from [RFC6887]. |
- |
2.12 |
|
PreferredVersion |
unsignedInt(0:65535) |
W |
{{div|{{classes}}|This is the version to be used in the first exchange with a new PCP Server. The factory default MUST be the highest supported version, as described in {{bibref|RFC6887|Section 9}}.}} This is the version to be used in the first exchange with a new PCP Server. The factory default MUST be the highest supported version, as described in [Section 9/RFC6887]. |
- |
2.12 |
|
Device.PCP.Client.{i}. |
object(0:) |
W |
Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in [RFC6887] for internal device applications or LAN device applications via Interworking functions. At most one entry in this table can exist with a given value for Alias, or with a given value for WANInterface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and WANInterface such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the PCP Client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the PCP Client. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
ANNOUNCEEnable |
boolean |
W |
{{div|{{classes}}|Enables or disables the ANNOUNCE OpCode. When {{false}} the PCP Client does not support unsolicited ANNOUNCE messages.}} Enables or disables the ANNOUNCE OpCode. When false the PCP Client does not support unsolicited ANNOUNCE messages. |
- |
2.12 |
|
THIRDPARTYStatus |
string |
R |
{{div|{{classes}}|Indicates whether THIRD_PARTY Option is enabled or not. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} Indicates whether THIRD_PARTY Option is enabled or not. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
Device.PCP.Client.{i}.PCPProxy. |
object |
R |
Properties for the Port Control Protocol (PCP) Proxy, as specified in [PCPProxy]. |
- |
2.12 |
|
HighestVersion |
unsignedInt(0:65535) |
R |
{{div|{{classes}}|A string identifying the highest version of PCP that the proxy supports. This parameter is based on Version from {{bibref|RFC6887}}.}} A string identifying the highest version of PCP that the proxy supports. This parameter is based on Version from [RFC6887]. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the PCP Proxy for this PCP Client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the PCP Proxy for this PCP Client. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
Device.PCP.Client.{i}.UPnPIWF. |
object |
R |
Properties for the interworking function between UPnP IGD (Internet Gateway Device) and PCP, as specified in [RFC6970]. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the UPnP IGD-PCP Interworking Function for this PCP Client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the UPnP IGD-PCP Interworking Function for this PCP Client. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
Device.PCP.Client.{i}.Server.{i}. |
object(0:) |
W |
{{div|{{classes}}|This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per {{bibref|RFC7291}}. Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a {{object}} instance. If an option returns multiple addresses then that {{object}} instance has multiple addresses.}} This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per [RFC7291]. Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a Server instance. If an option returns multiple addresses then that Server instance has multiple addresses. At most one entry in this table can exist with a given value for Alias, or with a given value for ServerNameOrAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and ServerNameOrAddress such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the PCP Server. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the PCP Server. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
Disabled |
2.12 |
|
Origin |
string |
R |
{{div|{{classes}}|Method used to assign {{param|ServerNameOrAddress}} and create this table entry. {{enum}} Note: In the {{enum|DHCPv4}} and {{enum|DHCPv6}} cases, if more than one IP address is received {{param|ServerNameOrAddress}} will be the first address and {{param|AdditionalServerAddresses}} will be the remaining addresses.}} Method used to assign ServerNameOrAddress and create this table entry. Enumeration of:
Note: In the DHCPv4 and DHCPv6 cases, if more than one IP address is received ServerNameOrAddress will be the first address and AdditionalServerAddresses will be the remaining addresses. |
Static |
2.12 |
|
ServerAddressInUse |
string(:45) |
R |
[IPAddress] {{div|{{classes}}|The IP address currently in use for the PCP Server, derived from the value of {{param|ServerNameOrAddress}}. {{empty}} indicates that no PCP Server address is currently known.}} The IP address currently in use for the PCP Server, derived from the value of ServerNameOrAddress. An empty string indicates that no PCP Server address is currently known. |
- |
2.12 |
|
CurrentVersion |
unsignedInt(0:65535) |
R |
{{div|{{classes}}|This is the version of PCP resulting from client-server Version Negotiation. This parameter is based on Version from {{bibref|RFC6887}}.}} This is the version of PCP resulting from client-server Version Negotiation. This parameter is based on Version from [RFC6887]. |
- |
2.12 |
|
PortQuota |
unsignedInt(:65535) |
W |
{{div|{{classes}}|Indicates the maximum number of ports allocated to this PCP Client on this server. A value of 0 means that there is no limitation.}} Indicates the maximum number of ports allocated to this PCP Client on this server. A value of 0 means that there is no limitation. |
0 |
2.12 |
|
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. |
object(0:) |
W |
Inbound Mapping table. This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in [Section 11/RFC6887]. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping. For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. At most one entry in this table can exist with a given value for Alias, or with the same values for all of InternalPort, ProtocolNumber and ThirdPartyAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, InternalPort, ProtocolNumber and ThirdPartyAddress such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Lifetime |
unsignedInt |
W |
Determines the time to live, in seconds, of this Inbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]). When a dynamic Inbound Mapping lease expires, the CPE MUST automatically delete the corresponding InboundMapping table entry. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
SuggestedExternalIPAddress |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|The external IPv4 or IPv6 Address that the PCP-controlled device will listen on for incoming packets to be forwarded to the PCP Client. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP client does not know the external address, or does not have a preference, it MUST use {{empty}}.}} The external IPv4 or IPv6 Address that the PCP-controlled device will listen on for incoming packets to be forwarded to the PCP Client. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP client does not know the external address, or does not have a preference, it MUST use an empty string. |
<Empty> |
2.12 |
|
SuggestedExternalPort |
unsignedInt(0:65535) |
W |
{{div|{{classes}}|The external port (or the first port of a range of external ports) that the PCP-controlled device will listen on for incoming packets. Those inbound packets will be forwarded to {{param|InternalPort}}. If the PCP client does not know the external port, or does not have a preference, it MUST use 0. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0.}} The external port (or the first port of a range of external ports) that the PCP-controlled device will listen on for incoming packets. Those inbound packets will be forwarded to InternalPort. If the PCP client does not know the external port, or does not have a preference, it MUST use 0. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0. |
0 |
2.12 |
|
SuggestedExternalPortEndRange |
unsignedInt(0:65535) |
W |
Indicates the last port of the external port range that starts with SuggestedExternalPort. If an external port range is specified, then the behavior described for SuggestedExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of SuggestedExternalPort. If SuggestedExternalPort is zero (wildcard), the value of SuggestedExternalPortEndRange MUST be ignored. If specified, the value of this parameter MUST be zero or be greater than or equal to the value of SuggestedExternalPort. |
0 |
2.12 |
|
ProtocolNumber |
int(-1:255) |
W |
{{div|{{classes}}|The protocol number of the {{object}}. Values are taken from {{bibref|IANA-protocolnumbers}}. The value -1 means all protocols.}} The protocol number of the InboundMapping. Values are taken from [IANA-protocolnumbers]. The value -1 means all protocols. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with InternalPort and ThirdPartyAddress) doesn't conflict with any existing entries. |
- |
2.12 |
|
ThirdPartyAddress |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in {{bibref|RFC6887|Section 7.3}}. In that case, {{param}} is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, {{param}} SHOULD be {{empty}}.}} Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in [Section 7.3/RFC6887]. In that case, ThirdPartyAddress is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, ThirdPartyAddress SHOULD be an empty string. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with InternalPort, ProtocolNumber) doesn't conflict with any existing entries. |
- |
2.12 |
|
AssignedExternalPortEndRange |
unsignedInt(0:65535) |
R |
Indicates the last port of the external port range that starts with AssignedExternalPort. If an external port range is specified, then the behavior described for AssignedExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of AssignedExternalPort. |
0 |
2.12 |
|
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.Filter.{i}. |
object(0:) |
W |
{{div|{{classes}}|Filter table. This table contains all Filters restricting this Inbound Mapping, as defined in {{bibref|RFC6887|}}.}} Filter table. This table contains all Filters restricting this Inbound Mapping, as defined in [RFC6887]. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
RemotePort |
unsignedInt(0:65535) |
W |
{{div|{{classes}}|Permitted remote peer port number for this filter. The value 0 indicates all ports.}} Permitted remote peer port number for this filter. The value 0 indicates all ports. |
- |
2.12 |
|
RemotePortEndRange |
unsignedInt(0:65535) |
R |
Indicates the last port of the remote port range that starts with RemotePort. If an external port range is specified, then the behavior described for RemotePort applies to all ports within the range. A value of zero (0) indicates that no remote port range is specified, i.e. that the range consists only of RemotePort. |
0 |
2.12 |
|
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. |
object(0:) |
W |
Outbound Mapping table. This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in [Section 12/RFC6887]. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping. For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. At most one entry in this table can exist with a given value for Alias, or with the same values for all of InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Lifetime |
unsignedInt |
W |
Determines the time to live, in seconds, of this Outbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]). When a dynamic Outbound Mapping lease expires, the CPE MUST automatically delete the corresponding OutboundMapping table entry. |
- |
2.12 |
|
SuggestedExternalIPAddress |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|The external IPv4 or IPv6 Address that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external address, or does not have a preference, it MUST use {{empty}}.}} The external IPv4 or IPv6 Address that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external address, or does not have a preference, it MUST use an empty string. |
<Empty> |
2.12 |
|
SuggestedExternalPort |
unsignedInt(0:65535) |
W |
{{div|{{classes}}|The external port that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0.}} The external port that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0. |
0 |
2.12 |
|
ProtocolNumber |
int(-1:255) |
W |
{{div|{{classes}}|The protocol number of the {{object}}. Values are taken from the {{bibref|IANA-protocolnumbers}}. The value -1 means all protocols.}} The protocol number of the OutboundMapping. Values are taken from the [IANA-protocolnumbers]. The value -1 means all protocols. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with InternalPort, ThirdPartyAddress, RemoteHostIPAddress and RemotePort) doesn't conflict with any existing entries. |
- |
2.12 |
|
ThirdPartyAddress |
string(:45) |
W |
[IPAddress] {{div|{{classes}}|Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in {{bibref|RFC6887|Section 7.3}}. In that case, {{param}} is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, {{param}} SHOULD be {{empty}}.}} Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in [Section 7.3/RFC6887]. In that case, ThirdPartyAddress is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, ThirdPartyAddress SHOULD be an empty string. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with InternalPort, ProtocolNumber, RemoteHostIPAddress and RemotePort) doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.DHCPv4. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. |
- |
2.12 |
|
Device.DHCPv4.Client.{i}. |
object(1:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this table entry. Enumeration of:
|
Disabled |
2.12 |
|
DHCPStatus |
string |
R |
{{div|{{classes}}|The DHCP Client status as defined in {{bibref|RFC2131}}. {{enum}} Note: This value is only relevant when the DHCP Client is operationally enabled (i.e. when {{param|Status}} is {{enum|Enabled|Status}}).}} |
- |
2.12 |
|
SubnetMask |
string(:45) |
R |
[IPv4Address] {{div|{{classes}}|Subnet mask option received from the DHCP Server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Value is information received via DHCP Option 1.}} |
<Empty> |
2.12 |
|
IPRouters |
string(:45)[](:256) |
R |
[IPv4Address] {{div|{{classes}}|{{list}} Items represent IP Router IPv4 Address(es) received from the DHCP server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Value is information received via DHCP Options 3, 33 or 121.}} |
<Empty> |
2.12 |
|
DNSServers |
string(:45)[](:256) |
R |
[IPv4Address] {{div|{{classes}}|{{list}} Items represent DNS Server IPv4 Address(es) received from the DHCP server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Value is information received via DHCP Option 6.}} |
<Empty> |
2.12 |
|
PassthroughEnable |
boolean |
W |
{{div|{{classes}}|If {{false}}, the DHCP Client retrieved IP address information is configured on the referenced {{param|Interface}} object. If {{true}}, the DHCP Client retrieved information is propagated to the parameters in the referenced {{param|PassthroughDHCPPool}} object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers).}} If false, the DHCP Client retrieved IP address information is configured on the referenced Interface object. If true, the DHCP Client retrieved information is propagated to the parameters in the referenced PassthroughDHCPPool object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers). |
false |
2.12 |
|
Device.DHCPv4.Client.{i}.ReqOption.{i}. |
object(0:) |
W |
Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed. At most one entry in this table can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the option in the DHCP client request. A value of 1 indicates the first entry. 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 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 ReqOption table entry MUST be one greater than the largest current value. |
- |
2.12 |
|
Value |
hexBinary(0:255) |
R |
A hexbinary encoded, most recently received DHCP option value. If no option value has been received, then the value MUST represent an empty string. Received DHCP option values MAY, but need not, persist across CPE reboots. |
<Empty> |
2.12 |
|
Device.DHCPv4.Server. |
object |
R |
DHCP server configuration. |
- |
2.12 |
|
Device.DHCPv4.Server.Pool.{i}. |
object(0:) |
W |
DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table can exist with a given value for Alias, or with a given value for Order. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Order such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association 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 Pool table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
VendorClassID |
string(:255) |
W |
Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. an empty string indicates this criterion is not used for conditional serving. |
<Empty> |
2.12 |
|
VendorClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|VendorClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|VendorClassID}} entry, if specified.}} If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. |
false |
2.12 |
|
VendorClassIDMode |
string |
W |
{{div|{{classes}}|{{param|VendorClassID}} pattern match criterion. {{enum}} For example, if {{param|VendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.}} VendorClassID pattern match criterion. Enumeration of:
For example, if VendorClassID is "Example" then an Option 60 value of "Example device" will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix. |
Exact |
2.12 |
|
ClientID |
hexBinary(:255) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used for conditional serving. |
<Empty> |
2.12 |
|
ClientIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|ClientID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|ClientID}} entry, if specified.}} |
false |
2.12 |
|
UserClassID |
hexBinary(:255) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. an empty string indicates this criterion is not used for conditional serving. |
<Empty> |
2.12 |
|
UserClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|UserClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|UserClassID}} entry, if specified.}} If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. |
false |
2.12 |
|
Chaddr |
string(:17) |
W |
[MACAddress] Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. an empty string indicates this criterion is not used for conditional serving. |
<Empty> |
2.12 |
|
ChaddrExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the (masked) {{param|Chaddr}} entry, if specified. If {{true}}, matching packets are those that do not match the (masked) {{param|Chaddr}} entry, if specified.}} |
false |
2.12 |
|
AllowedDevices |
string |
W |
Pool association criterion. Determines which devices are allowed, Enumeration of:
|
- |
2.13 |
|
MinAddress |
string(:45) |
W |
[IPv4Address] {{div|{{classes}}|Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}.}} Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. |
- |
2.12 |
|
MaxAddress |
string(:45) |
W |
[IPv4Address] {{div|{{classes}}|Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}.}} Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. |
- |
2.12 |
|
SubnetMask |
string(:45) |
W |
[IPv4Address] {{div|{{classes}}|Specifies the client's network subnet mask. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}.}} Specifies the client's network subnet mask. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. |
- |
2.12 |
|
DNSServers |
string(:45)[:4]() |
W |
[IPv4Address] {{div|{{classes}}|{{list}} List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}.}} Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. |
- |
2.12 |
|
IPRouters |
string(:45)[:4]() |
W |
[IPv4Address] {{div|{{classes}}|{{list}} List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}.}} Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. |
- |
2.12 |
|
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}. |
object(0:) |
W |
DHCP static address table. Entries in this table correspond to what [RFC2131] calls "manual allocation", where a client's IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client. Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client. Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client. At most one entry in this table can exist with a given value for Alias, or with a given value for Chaddr. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the StaticAddress table entry. Disabling an entry does not return the IP address to the pool.}} Enables or disables the StaticAddress table entry. Disabling an entry does not return the IP address to the pool. |
false |
2.12 |
|
Device.DHCPv4.Server.Pool.{i}.Client.{i}. |
object(0:) |
R |
{{div|{{classes}}|DHCPv4 client table. This table lists details of DHCPv4 clients that matched the filter criteria of this {{object|#}} entry.}} DHCPv4 client table. This table lists details of DHCPv4 clients that matched the filter criteria of this Pool entry. At most one entry in this table can exist with a given value for Alias, or with a given value for Chaddr. |
- |
2.12 |
|
Alias |
string(:64) |
W |
{{div|{{classes}}|{{datatype|expand}} Note: There is no guarantee that the {{param}} value on automatically-created {{object}} instances will be retained. This is because automatically-created {{object}} instances can be transitory.}} [Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not the DHCPv4 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv4 clients is OPTIONAL. If the CPE includes inactive DHCPv4 clients in this table, {{param}} MUST be set to {{false}} for each inactive DHCPv4 client. The length of time an inactive DHCPv4 client remains listed in this table is a local matter to the CPE.}} Whether or not the DHCPv4 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv4 clients is OPTIONAL. If the CPE includes inactive DHCPv4 clients in this table, Active MUST be set to false for each inactive DHCPv4 client. The length of time an inactive DHCPv4 client remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.DHCPv4.Relay. |
object |
R |
DHCP Relay Agent (conditional relaying). |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the DHCP relay. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The status of the DHCP relay. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.12 |
|
Device.DHCPv4.Relay.Forwarding.{i}. |
object(0:) |
W |
{{div|{{classes}}|DHCP Relay Agent Forwarding table. For enabled table entries, if {{param|Interface}} is not a valid reference then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}.}} DHCP Relay Agent Forwarding table. 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. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the Forwarding entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association 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 Forwarding table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). |
- |
2.12 |
|
VendorClassID |
string(:255) |
W |
Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. an empty string indicates this criterion is not used as a relay classification criterion. |
<Empty> |
2.12 |
|
VendorClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|VendorClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|VendorClassID}} entry, if specified.}} If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. |
false |
2.12 |
|
VendorClassIDMode |
string |
W |
{{div|{{classes}}|{{param|VendorClassID}} pattern match criterion. {{enum}} For example, if {{param|VendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.}} VendorClassID pattern match criterion. Enumeration of:
For example, if VendorClassID is "Example" then an Option 60 value of "Example device" will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix. |
Exact |
2.12 |
|
ClientID |
hexBinary(:255) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used as a relay classification criterion. |
<Empty> |
2.12 |
|
ClientIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|ClientID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|ClientID}} entry, if specified.}} |
false |
2.12 |
|
UserClassID |
hexBinary(:255) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. an empty string indicates this criterion is not used as a relay classification criterion. |
<Empty> |
2.12 |
|
UserClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|UserClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|UserClassID}} entry, if specified.}} If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. |
false |
2.12 |
|
Chaddr |
string(:17) |
W |
[MACAddress] Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. an empty string indicates this criterion is not used as a relay classification criterion. |
<Empty> |
2.12 |
|
ChaddrExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the (masked) {{param|Chaddr}} entry, if specified. If {{true}}, matching packets are those that do not match the (masked) {{param|Chaddr}} entry, if specified.}} |
false |
2.12 |
|
Device.DHCPv6. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC3315]. This entire object applies to IPv6 only. It contains the Client and Server objects. |
- |
2.12 |
|
Device.DHCPv6.Client.{i}. |
object(1:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this table entry. Enumeration of:
|
Disabled |
2.12 |
|
RequestPrefixes |
boolean |
W |
{{div|{{classes}}|Enables or disables inclusion of the Identity Association (IA) for Prefix Delegation option OPTION_IA_PD(25) {{bibref|RFC3633|Section 10}} in Solicit messages. Note that this is only appropriate for an upstream interface on a requesting router, e.g. for an RG WAN interface.}} Enables or disables inclusion of the Identity Association (IA) for Prefix Delegation option OPTION_IA_PD(25) [Section 10/RFC3633] in Solicit messages. Note that this is only appropriate for an upstream interface on a requesting router, e.g. for an RG WAN interface. |
false |
2.12 |
|
SuggestedT1 |
int(-1:) |
W |
{{div|{{classes}}|T1 value, in {{units}}, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA {{bibref|RFC3315|Section 22.4}} and OPTION_IA_PD {{bibref|RFC3633|Section 10}}. A value of -1 indicates that no T1 value is specified.}} T1 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA [Section 22.4/RFC3315] and OPTION_IA_PD [Section 10/RFC3633]. A value of -1 indicates that no T1 value is specified. |
- |
2.12 |
|
SuggestedT2 |
int(-1:) |
W |
{{div|{{classes}}|T2 value, in {{units}}, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA {{bibref|RFC3315|Section 22.4}} and OPTION_IA_PD {{bibref|RFC3633|Section 10}}. A value of -1 indicates that no T2 value is specified.}} T2 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA [Section 22.4/RFC3315] and OPTION_IA_PD [Section 10/RFC3633]. A value of -1 indicates that no T2 value is specified. |
- |
2.12 |
|
RequestedOptions |
unsignedInt[] |
W |
Comma-separated list of unsigned integers. An ordered list of the top-level options (i.e. not encapsulated options) that the client will explicitly request from the server. This parameter is intended only for options that are not necessary for the basic operation of the protocol, and are not modeled elsewhere. For example, it is appropriate for OPTION_DNS_SERVERS [RFC3646] but is not appropriate for OPTION_SERVERID (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_IA_PD (which is modeled via RequestPrefixes). However, the CPE MUST NOT reject an attempt to set this parameter to a value that includes options that it regards as inappropriate; instead, it MUST accept the requested options and handle them as best it can. Loosely speaking, these are the options that the client will include in OPTION_ORO [RFC3315] but the client is free to decide (in accordance with [RFC3315]) in which messages to request which option, whether also to request additional options, whether not to request inappropriate options, and in which order to request any options that are also in SupportedOptions. |
- |
2.12 |
|
Device.DHCPv6.Client.{i}.SentOption.{i}. |
object(0:) |
W |
{{div|{{classes}}|The top-level options and option values (including any encapsulated options) that the client will send to the server. This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via {{param|#.RequestAddresses}}) or OPTION_RAPID_COMMIT (which is modeled via {{param|#.RapidCommit}}).}} The top-level options and option values (including any encapsulated options) that the client will send to the server. This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit). At most one entry in this table can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Value |
hexBinary(0:65535) |
W |
{{div|{{classes}}|A hexbinary encoded option data {{bibref|RFC3315|Section 22.1}}. Note: The length of the option data is option-len octets, as specified in {{bibref|RFC3315|Section 22.1}}.}} A hexbinary encoded option data [Section 22.1/RFC3315]. Note: The length of the option data is option-len octets, as specified in [Section 22.1/RFC3315]. |
<Empty> |
2.12 |
|
Device.DHCPv6.Client.{i}.ReceivedOption.{i}. |
object(0:) |
R |
{{div|{{classes}}|This is a transitory table that lists all the options received from all servers. Table entries are automatically created to correspond with received options. However, it is a local matter to the CPE when to delete old table entries. If the same option is received multiple times, whether from one or more servers, it is up to the CPE to decide which entries to include (i.e. whether the same option will be present multiple times). In order to allow for the same option to be present multiple times within the table, this table has no unique key defined.}} This is a transitory table that lists all the options received from all servers. Table entries are automatically created to correspond with received options. However, it is a local matter to the CPE when to delete old table entries. If the same option is received multiple times, whether from one or more servers, it is up to the CPE to decide which entries to include (i.e. whether the same option will be present multiple times). In order to allow for the same option to be present multiple times within the table, this table has no unique key defined. |
- |
2.12 |
|
Device.DHCPv6.Server. |
object |
R |
DHCPv6 server configuration. |
- |
2.12 |
|
Device.DHCPv6.Server.Pool.{i}. |
object(0:) |
W |
DHCPv6 server pool table. Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table can exist with a given value for Alias, or with a given value for Order. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Order such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
|
Disabled |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCPv6 request, the highest ordered entry that matches the association 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 Pool table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
DUID |
hexBinary(:130) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Client Identifier (Option 1) [Section 22.2/RFC3315]. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used. Note: DHCPv6 Option 1 (DUID) is sometimes referred to as Client Identifier. |
<Empty> |
2.12 |
|
DUIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|DUID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|DUID}} entry, if specified.}} |
false |
2.12 |
|
VendorClassID |
hexBinary(:65535) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) [Section 22.16/RFC3315]. The option value is binary, so an exact match is REQUIRED. an empty string indicates this criterion is not used. |
<Empty> |
2.12 |
|
VendorClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|VendorClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|VendorClassID}} entry, if specified.}} If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. |
false |
2.12 |
|
UserClassID |
hexBinary(:65535) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 User Class Identifier (Option 15) [Section 22.15/RFC3315]. an empty string indicates this criterion is not used. |
<Empty> |
2.12 |
|
UserClassIDExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the {{param|UserClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|UserClassID}} entry, if specified.}} If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. |
false |
2.12 |
|
SourceAddress |
string(:45) |
W |
[IPv6Address] Pool association criterion. Source address (link-layer address) of DHCPv6 messages sent from the DHCPv6 client. This criterion is only likely to be useful if this is a link-layer address. an empty string indicates this criterion is not used for serving. |
<Empty> |
2.12 |
|
SourceAddressExclude |
boolean |
W |
{{div|{{classes}}|If {{false}}, matching packets are those that match the (masked) {{param|SourceAddress}} entry, if specified. If {{true}}, matching packets are those that do not match the (masked) {{param|SourceAddress}} entry, if specified.}} If false, matching packets are those that match the (masked) SourceAddress entry, if specified. If true, matching packets are those that do not match the (masked) SourceAddress entry, if specified. |
false |
2.12 |
|
IANAManualPrefixes |
string[:8]() |
W |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes from which IA_NA addresses will be assigned. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. All clients that request IA_NA and match filter criteria on this Interface MUST be offered IA_NA addresses from all of the Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) /64 prefixes in this list. Prefixes MUST be associated with the interface instance referenced by Interface. |
<Empty> |
2.12 |
|
IANAPrefixes |
string[:8]() |
R |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes from which IA_NA addresses will be assigned. This list can include:
|
- |
2.12 |
|
IAPDManualPrefixes |
string[:8]() |
W |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes from which IA_PD prefixes will be derived. This list can include:
|
<Empty> |
2.12 |
|
IAPDPrefixes |
string[:8]() |
R |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes for which IA_PD prefixes will be assigned. This list can include:
|
- |
2.12 |
|
Device.DHCPv6.Server.Pool.{i}.Client.{i}. |
object(0:) |
R |
{{div|{{classes}}|DHCPv6 client table. This table lists details of DHCPv6 clients that matched the filter criteria of this {{object|#}} entry.}} DHCPv6 client table. This table lists details of DHCPv6 clients that matched the filter criteria of this Pool entry. At most one entry in this table can exist with a given value for Alias, or with a given value for SourceAddress. |
- |
2.12 |
|
Alias |
string(:64) |
W |
{{div|{{classes}}|{{datatype|expand}} Note: There is no guarantee that the {{param}} value on automatically-created {{object}} instances will be retained. This is because automatically-created {{object}} instances can be transitory.}} [Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Active |
boolean |
R |
{{div|{{classes}}|Whether or not the DHCPv6 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv6 clients is OPTIONAL. If the CPE includes inactive DHCPv6 clients in this table, {{param}} MUST be set to {{false}} for each inactive DHCPv6 client. The length of time an inactive DHCPv6 client remains listed in this table is a local matter to the CPE.}} Whether or not the DHCPv6 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv6 clients is OPTIONAL. If the CPE includes inactive DHCPv6 clients in this table, Active MUST be set to false for each inactive DHCPv6 client. The length of time an inactive DHCPv6 client remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
Device.DHCPv6.Server.Pool.{i}.Option.{i}. |
object(0:) |
W |
This object specifies the DHCPv6 options that MUST, if enabled, be offered to clients whose DHCPv6 requests are associated with this pool. If PassthroughClient is specified, and the referenced client has a value for a given option then the PassthroughClient option value will be sent instead of Value. Otherwise, Value will be sent. At most one entry in this table can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
PassthroughClient |
string(:256) |
W |
The value MUST be the Path Name of a row in the Client. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates whether this Option entry is configured for passthrough. If PassthroughClient is specified, and the referenced client (since boot) has received a value from an associated upstream DHCPv6 server for the given Tag option, then the referenced client's option value will be sent instead of Value. Otherwise, Value will be sent. an empty string indicates that passthrough is not configured for this Option entry. |
<Empty> |
2.12 |
|
Device.IEEE8021x. |
object |
R |
IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. |
- |
2.12 |
|
Device.IEEE8021x.Supplicant.{i}. |
object(1:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The current operational status of this 802.1x supplicant. Enumeration of:
|
Disabled |
2.12 |
|
MaxStart |
unsignedInt(1:10) |
W |
{{div|{{classes}}|The maximum number of times the device will attempt to send an EAP start message before authentication fails as defined in {{bibref|802.1x-2004|9.5.1}}, maxStart. This is in support of {{bibref|802.1x-2004|Section 8.4.6}}, Migration Considerations.}} The maximum number of times the device will attempt to send an EAP start message before authentication fails as defined in [Section 9.5.1/802.1x-2004], maxStart. This is in support of [Section 8.4.6/802.1x-2004], Migration Considerations. |
- |
2.12 |
|
StartFailurePolicy |
string |
W |
{{div|{{classes}}|The action to be taken when authentication has failed, when the network fails to respond to the supplicant's start message, and the retries have been exceeded (since network does not yet support 802.1x). {{enum}} This is in support of {{bibref|802.1x-2004|Section 8.4.6}}, Migration Considerations.}} The action to be taken when authentication has failed, when the network fails to respond to the supplicant's start message, and the retries have been exceeded (since network does not yet support 802.1x). Enumeration of:
This is in support of [Section 8.4.6/802.1x-2004], Migration Considerations. |
- |
2.12 |
|
Reset() |
command |
- |
{{div|{{classes}}|On a reset the device MUST reset the session by performing an initial authentication attempt as defined in {{bibref|802.1x-2004|9.6.1.3}}, 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.}} 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 |
- |
{{div|{{classes}}|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.}} 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.Users. |
object |
R |
Users object that contains the User, table.Group, and Role tables. Changes since 2.14:
|
- |
2.12 |
|
GroupNumberOfEntries |
unsignedInt |
R |
The number of entries in the Group table. |
- |
2.12 |
|
RoleNumberOfEntries |
unsignedInt |
R |
The number of entries in the Role table. |
- |
2.12 |
|
SupportedShellNumberOfEntries |
unsignedInt |
R |
The number of entries in the SupportedShell table. |
- |
2.12 |
|
CheckCredentialsDiagnostics() |
command |
- |
[ASYNC] Checks whether the input Username and Password are valid for allowing access to the user interface on the device. If not valid, then an indication of why they are not valid is output. |
- |
2.15 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ Username |
string |
W |
The user name for logging in to the user interface on the device. |
- |
2.15 |
|
⇒ Password |
string |
W |
The password for logging in to the user interface on the device. |
- |
2.15 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ Status |
string |
R |
Indicates the response to request to check whether the credentials are valid and, if not, why not. Enumeration of:
|
- |
2.15 |
|
Device.Users.User.{i}. |
object(0:) |
W |
This object contains parameters relating to the user characteristics. At most one entry in this table can exist with a given value for Username, or with a given value for Alias, or with a given value for UserID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and UserID such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables/disables this user object instance. If the User being configured is currently accessing the device then a disable MUST apply to the next user session and the current user session MUST NOT be abruptly terminated.}} Enables/disables this user object instance. If the User being configured is currently accessing the device then a disable MUST apply to the next user session and the current user session MUST NOT be abruptly terminated. |
false |
2.12 |
|
UserID |
unsignedInt |
W |
Unique Identifier of the user. Depending on the implementation this can be the unique identifier assigned by the underlying system. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.15 |
|
GroupParticipation |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Group. table. The Groups of which this User is a member. |
<Empty> |
2.12 |
|
RoleParticipation |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Role. table. The Roles which are assigned to this User. |
<Empty> |
2.12 |
|
StaticUser |
boolean |
R |
A static user is a fixed user that is always available in the system. When set to true, the user cannot be removed. |
false |
2.12 |
|
Language |
string(:16) |
W |
{{div|{{classes}}|String describing the default language for the local configuration interface, specified according to {{bibref|RFC3066}}. If {{empty}}, {{param|.UserInterface.CurrentLanguage}} is used.}} String describing the default language for the local configuration interface, specified according to [RFC3066]. If an empty string, UserInterface.CurrentLanguage is used. |
<Empty> |
2.12 |
|
Shell |
string |
W |
The value MUST be the Path Name of a row in the SupportedShell. table. An empty string means Shell access disabled. |
<Empty> |
2.12 |
|
Device.Users.Group.{i}. |
object(0:) |
W |
This object contains parameters relating to the characteristics of a user group. At most one entry in this table can exist with a given value for Groupname, or with a given value for Alias, or with a given value for GroupID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and GroupID such that the new entry does not conflict with any existing entries. |
- |
2.15 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.15 |
|
Enable |
boolean |
W |
Enables/disables this group object instance. If any User which belongs to a Group which becomes disabled is currently accessing the device then the effect on that User should be as if the Group were removed from that User's GroupParticipation list. |
false |
2.15 |
|
GroupID |
unsignedInt |
W |
Unique Identifier of the group. Depending on the implementation this can be the unique identifier assigned by the underlying system. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.15 |
|
Groupname |
string(:64) |
W |
Name of the Group. MUST NOT be an empty string for an enabled entry. |
<Empty> |
2.15 |
|
RoleParticipation |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Role. table. These Roles are assigned to any User which is member of this Group, for so long as they remain a member of the Group. |
<Empty> |
2.15 |
|
StaticGroup |
boolean |
R |
A static group is a fixed group that is always available in the system. When set to true, the group cannot be removed. |
false |
2.15 |
|
Device.Users.SupportedShell.{i}. |
object(0:) |
W |
This table provides a list of user accessible shells which can be used as a reference in Users.User.{i}.Shell At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.15 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.15 |
|
Enable |
boolean |
W |
Enables/disables this SupportedShell object instance. |
false |
2.15 |
|
Name |
string(:64) |
R |
Name of the Shell The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.15 |
|
Device.Users.Role.{i}. |
object(0:) |
W |
This object contains parameters relating to the role characteristics. At most one entry in this table can exist with a given value for RoleName, or with a given value for Alias, or with a given value for RoleID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and RoleID such that the new entry does not conflict with any existing entries. |
- |
2.15 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced:
If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. Value Change Notification requests for this parameter MAY be denied. |
- |
2.15 |
|
Enable |
boolean |
W |
Enables/disables this role object instance. |
false |
2.15 |
|
RoleID |
unsignedInt |
W |
Unique Identifier of the role. Depending on the implementation this can be the unique identifier assigned by the underlying system. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.15 |
|
RoleName |
string(:64) |
W |
Name of the current Role. MUST NOT be an empty string for an enabled entry. |
<Empty> |
2.15 |
|
StaticRole |
boolean |
R |
A static role is a fixed role that is always available in the system. When set to true, the role cannot be removed. |
false |
2.15 |
|
Device.SmartCardReaders. |
object |
R |
SmartCardReaders object that contains the SmartCardReader table. |
- |
2.12 |
|
Device.SmartCardReaders.SmartCardReader.{i}. |
object(0:) |
R |
This object describes the characteristics of the smart card reader. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.12 |
|
ResetTime |
dateTime |
R |
The time at which this SmartCard Reader was reset. Reset can be caused by:
|
- |
2.12 |
|
DecryptionFailedCounter |
unsignedInt |
R |
Counter incremented once each time decryption cannot be carried out. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the {{param|**{{template: non-existent }}**Reset}} parameter is used and not when a Smart Card is inserted or removed. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
DecryptionFailedNoKeyCounter |
unsignedInt |
R |
Counter incremented once each time the key is not available to decrypt it. This is a subset of the more general DecryptionFailedCounter within the same object and thus will always be less than that parameter. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the {{param|**{{template: non-existent }}**Reset}} parameter is used and not when a Smart Card is inserted or removed. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.SmartCardReaders.SmartCardReader.{i}.SmartCard. |
object |
R |
Status of currently associated smart card. |
- |
2.12 |
|
Type |
string |
R |
{{div|{{classes}}|Smart Card Type. {{enum}} Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.}} Smart Card Type. Enumeration of:
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to. |
- |
2.12 |
|
Application |
string[] |
R |
{{div|{{classes}}|{{list}} Indicates Smart Card Application(s). {{param}} is only relevant when {{param|Type}} has a value of UICC, otherwise it is {{empty}}. {{enum}} Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.}} Comma-separated list of strings. Indicates Smart Card Application(s). Application is only relevant when Type has a value of UICC, otherwise it is an empty string. Each list item is an enumeration of:
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to. |
- |
2.12 |
|
Device.UPnP. |
object |
R |
This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. |
- |
2.12 |
|
Device.UPnP.Device. |
object |
R |
This object defines the UPnP devices and UPnP services that are implemented by the CPE. |
- |
2.12 |
|
Device.UPnP.Device.Capabilities. |
object |
R |
This object defines what UPnP capabilities this device has. |
- |
2.12 |
|
UPnPArchitecture |
unsignedInt |
R |
Numeric value indicating the major version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 2. A value of 0 indicates no UPnP support. |
- |
2.12 |
|
UPnPArchitectureMinorVer |
unsignedInt |
R |
Numeric value indicating the minor version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 0. If UPnPArchitecture is 0 then this parameter SHOULD be ignored. |
- |
2.12 |
|
UPnPMediaServer |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP Media Server. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP Media Server. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPMediaRenderer |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP Media Renderer. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP Media Renderer. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPWLANAccessPoint |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP Wireless Access Point. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP Wireless Access Point. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPBasicDevice |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP Basic Device. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP Basic Device. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPQoSDevice |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP Qos Device. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP Qos Device. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPQoSPolicyHolder |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP Qos Policy Holder. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP Qos Policy Holder. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPIGD |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP IGD. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP IGD. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPDMBasicMgmt |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP-DM Basic Management. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP-DM Basic Management. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPDMConfigurationMgmt |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP-DM Configuration Management. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP-DM Configuration Management. A value of 0 indicates no support. |
- |
2.12 |
|
UPnPDMSoftwareMgmt |
unsignedInt |
R |
{{div|{{classes}}|Numeric value indicating the supported revision for UPnP-DM Software Management. A value of 0 indicates no support.}} Numeric value indicating the supported revision for UPnP-DM Software Management. A value of 0 indicates no support. |
- |
2.12 |
|
Device.UPnP.Discovery. |
object |
R |
{{div|{{classes}}|UPnP {{bibref|UPnP-DAv1}} SSDP discovered root devices, embedded devices and embedded services. The CPE MAY, but need not, retain some or all of the information in this object across reboots.}} UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services. The CPE MAY, but need not, retain some or all of the information in this object across reboots. |
- |
2.12 |
|
Device.UPnP.Discovery.RootDevice.{i}. |
object(0:) |
R |
UPnP root device table. This table contains an entry for each UPnP root device that has been discovered via SSDP. At most one entry in this table can exist with a given value for UUID. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the UPnP root device. {{enum}} The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.}} The status of the UPnP root device. Enumeration of:
The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
UUID |
string(:36) |
R |
This UPnP root device's UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:
Possible patterns:
|
- |
2.12 |
|
USN |
string(:256) |
R |
The value of the USN (Unique Service Name) header for this UPnP root device. Three discovery messages are sent for root devices, and this SHOULD be the value of the USN header of the following form:
|
- |
2.12 |
|
Server |
string(:256) |
R |
The value of the SERVER header for this UPnP root device, which is a string of the following form:
|
- |
2.12 |
|
Host |
string(:256)[](:1024) |
R |
{{div|{{classes}}|{{list}} Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.}} Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. |
- |
2.12 |
|
Device.UPnP.Discovery.Device.{i}. |
object(0:) |
R |
UPnP embedded device table. This table contains an entry for each UPnP embedded device that has been discovered via SSDP. At most one entry in this table can exist with a given value for UUID. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the UPnP embedded device. {{enum}} The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.}} The status of the UPnP embedded device. Enumeration of:
The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
UUID |
string(:36) |
R |
This UPnP embedded device's UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:
Possible patterns:
|
- |
2.12 |
|
USN |
string(:256) |
R |
The value of the USN (Unique Service Name) header for this UPnP embedded device. Two discovery messages are sent for embedded devices, and this SHOULD be the value of the USN header of the following form:
|
- |
2.12 |
|
Server |
string(:256) |
R |
The value of the SERVER header for this UPnP embedded device, which is a string of the following form:
|
- |
2.12 |
|
Host |
string(:256)[](:1024) |
R |
{{div|{{classes}}|{{list}} Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.}} Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. |
- |
2.12 |
|
Device.UPnP.Discovery.Service.{i}. |
object(0:) |
R |
UPnP embedded service table. This table contains an entry for each UPnP embedded service that has been discovered via SSDP. At most one entry in this table can exist with a given value for USN. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|The status of the UPnP embedded service. {{enum}} The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.}} The status of the UPnP embedded service. Enumeration of:
The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE. |
- |
2.12 |
|
USN |
string(:256) |
R |
{{replaced: missing new argument}}****{{div: unexpected argument [div([classes()], The value of the USN (Unique Service Name) header for this UPnP embedded service. This is of the following form:), div([classes()], [li(>), 'uuid:device-UUID::urn:domain-name:service:serviceType:v'])] after: [classes()], {{li|>}}uuid:device-UUID::urn:domain-name:service:serviceType:v}}}} |
- |
2.12 |
|
Server |
string(:256) |
R |
The value of the SERVER header for this UPnP embedded service, which is a string of the following form:
|
- |
2.12 |
|
Host |
string(:256)[](:1024) |
R |
{{div|{{classes}}|{{list}} Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.}} Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. |
- |
2.12 |
|
Device.UPnP.Description. |
object |
R |
This object contains information from the Description Document discovered from the UPnP Devices and Services. |
- |
2.12 |
|
Device.UPnP.Description.DeviceDescription.{i}. |
object(0:) |
R |
This table contains information read from the Device Description Document of discovered root devices. The CPE MAY, but need not, retain some or all of the information in this table after the associated SSDP advertisement (objects in the UPnP.Discovery. object tables) expires. In case the SSDP advertisement expires and the CPE deletes the related instances from the tables in UPnP.Discovery., the reference to such instances MUST be set to the empty string. At most one entry in this table can exist with a given value for URLBase. |
- |
2.12 |
|
URLBase |
string(:2048) |
R |
{{div|{{classes}}|The value extracted from the URLBase element in the Device Description Document of the discovered root device. If the URLBase element in the root device's Device Description Document is empty or absent, the {{datatype}} from which the device description was retrieved (e.g. the LOCATION from the SSDP message) is utilized as the URLBase. Note: the URLBase element is not recommended by {{bibref|UPnP-DAv1}} and is not permitted by {{bibref|UPnP-DAv11}}, so the value of {{param}} will usually be the URL from which the device description was retrieved.}} The value extracted from the URLBase element in the Device Description Document of the discovered root device. If the URLBase element in the root device's Device Description Document is empty or absent, the [URL] from which the device description was retrieved (e.g. the LOCATION from the SSDP message) is utilized as the URLBase. Note: the URLBase element is not recommended by [UPnP-DAv1] and is not permitted by [UPnP-DAv11], so the value of URLBase will usually be the URL from which the device description was retrieved. |
- |
2.12 |
|
Device.UPnP.Description.DeviceInstance.{i}. |
object(0:) |
R |
This table contains the information from Device Description Document retrieved for a discovered UPnP root or embedded device. At most one entry in this table can exist with a given value for UDN. |
- |
2.12 |
|
UDN |
string(36) |
R |
[UUID] {{div|{{classes}}|Unique Device Name of this device represented as a UUID for the device. This value is extracted from the UDN element in the Device Description Document with the leading uuid: removed.}} Unique Device Name of this device represented as a UUID for the device. This value is extracted from the UDN element in the Device Description Document with the leading uuid: removed. |
- |
2.12 |
|
DiscoveryDevice |
string(:256) |
R |
{{div|{{classes}}|{{reference|a {{object|##.Discovery.RootDevice}} table entry (if this is a root device) or a {{object|##.Discovery.Device}} table entry (if this is an embedded device)}} This {{param}} value can be {{empty}} because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this {{object}} or use {{empty}} is implementation specific.}} The value MUST be the Path Name of a Discovery.RootDevice table entry (if this is a root device) or a Discovery.Device table entry (if this is an embedded device). If the referenced object is deleted, the parameter value MUST be set to an empty string. This DiscoveryDevice value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this DeviceInstance or use an empty string is implementation specific. |
- |
2.12 |
|
DeviceCategory |
string[] |
R |
Comma-separated list of strings. Each list item is the value of an element in the Device Description Document for this DeviceInstance that indicates a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device. Note: It is assumed that the htip:X_DeviceCategory Device Description Document element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories. Note: DeviceCategory is different from DeviceType and is included here for the purpose of HTIP usage. |
- |
2.12 |
|
ManufacturerOUI |
string(0:6) |
R |
The value of an element in the Device Description Document for this DeviceInstance that indicates the manufacturer OUI if this value is provided by the device; or an empty string if this value is not provided by the device. Possible patterns: |
- |
2.12 |
|
PresentationURL |
string(:2048) |
R |
[URL] The value of the UPnP presentationURL element in the Device Description Document for this DeviceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the presentationURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the presentationURL is not provided by the device then this value MUST be an empty string. |
- |
2.12 |
|
Device.UPnP.Description.ServiceInstance.{i}. |
object(0:) |
R |
This table contains the information from Device Description Document retrieved for a discovered UPnP service. At most one entry in this table can exist with the same values for both ParentDevice and ServiceId. |
- |
2.12 |
|
ServiceId |
string(:256) |
R |
{{div|{{classes}}|The value of the UPnP serviceId element in the Device Description Document for this {{object}}, or {{empty}} if this value is not provided by the service. If the UPnP serviceId is not provided by the UPnP service, this {{object}} MUST be deleted.}} The value of the UPnP serviceId element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service. If the UPnP serviceId is not provided by the UPnP service, this ServiceInstance MUST be deleted. |
- |
2.12 |
|
ServiceDiscovery |
string(:256) |
R |
{{div|{{classes}}|{{reference|a {{object|##.Discovery.Service}} table entry}} This {{param}} value can be {{empty}} because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this {{object}} or use {{empty}} is implementation specific.}} The value MUST be the Path Name of a Discovery.Service table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. This ServiceDiscovery value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this ServiceInstance or use an empty string is implementation specific. |
- |
2.12 |
|
SCPDURL |
string(:2048) |
R |
The value of the UPnP SCPDURL element in the Device Description Document for this ServiceInstance and MUST be an absolute [URL]. The way to obtain an absolute URL from the SCPDURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the SCPDURL is not provided by the device then this value MUST be an empty string. |
- |
2.12 |
|
ControlURL |
string(:2048) |
R |
The value of the UPnP controlURL element in the Device Description Document for this ServiceInstance and MUST be an absolute [URL]. The way to obtain an absolute URL from the controlURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the controlURL is not provided by the device then this value MUST be an empty string |
- |
2.12 |
|
EventSubURL |
string(:2048) |
R |
The value of the UPnP eventSubURL element in the Device Description Document for this ServiceInstance and MUST be an absolute [URL]. The way to obtain an absolute URL from the eventSubURLL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the eventSubURL is not provided by the device then this value MUST be an empty string |
- |
2.12 |
|
Device.Firewall. |
object |
R |
Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. See [Appendix VIII/TR-181i2] for an example Advanced configuration. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables the Firewall. Firewalls often implement additional Denial of Service and other vulnerability protections, such as those described in {{bibref|ICSA-Baseline}}. If a {{enum|Stateful|Type}} Firewall is enabled, then it is assumed that all implemented stateful protections are enabled, unless they are overridden by some other part of the data model.}} Enables or disables the Firewall. Firewalls often implement additional Denial of Service and other vulnerability protections, such as those described in [ICSA-Baseline]. If a Stateful Firewall is enabled, then it is assumed that all implemented stateful protections are enabled, unless they are overridden by some other part of the data model. |
- |
2.12 |
|
Config |
string |
W |
{{div|{{classes}}|How this firewall is configured. {{enum}} Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.}} How this firewall is configured. Enumeration of:
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to. |
- |
2.12 |
|
AdvancedLevel |
string |
W |
The value MUST be the Path Name of a row in the Firewall.Level. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. {{div|{{classes}}|Selects the currently active Firewall Level. {{param}} only applies when {{param|Config}} is {{enum|Advanced|Config}}.}} |
- |
2.12 |
|
Type |
string |
R |
Firewall Type. Enumeration of:
|
- |
2.12 |
|
Device.Firewall.Level.{i}. |
object(0:) |
W |
Firewall Level table. When an Advanced configuration is selected, AdvancedLevel selects the currently active entry in this table. Each Level table entry references the Chain that contains the rules for this level. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the Level entry for user interface display; levels can be presented according to an increasing or decreasing level of security. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all greater-valued Order entries is incremented 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 Level table entry MUST be one greater than the largest current value. |
- |
2.12 |
|
Chain |
string |
R |
The value MUST be the Path Name of a row in the Firewall.Chain. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. {{div|{{classes}}|The Chain containing Firewall Level Rules associated with this {{object}} entry. On creation of a new {{object}} entry, the device will automatically create a new {{object|#.Chain}} table entry that this {{param}} parameter will reference.}} |
- |
2.12 |
|
PortMappingEnabled |
boolean |
W |
{{div|{{classes}}|Indicates whether NAT port mapping is enabled or disabled when this is the active Level. For a {{enum|Stateless|#.Type}} Firewall this can be set to {{false}} to force any port mappings to be operationally disabled (for a {{enum|Stateful|#.Type}} Firewall this is not necessary because the same effect can be achieved via Firewall rules). This parameter affects all the interfaces on which NAT is enabled. It operationally enables or disables port mapping functionality and therefore does not affect the individual {{param|##.NAT.PortMapping.{i}.Enable}} settings. Note that the current NAT status and NAT port mapping status are indicated by the {{param|##.NAT.InterfaceSetting.{i}.Status}} parameter.}} Indicates whether NAT port mapping is enabled or disabled when this is the active Level. For a Stateless Firewall this can be set to false to force any port mappings to be operationally disabled (for a Stateful Firewall this is not necessary because the same effect can be achieved via Firewall rules). This parameter affects all the interfaces on which NAT is enabled. It operationally enables or disables port mapping functionality and therefore does not affect the individual NAT.PortMapping.{i}.Enable settings. Note that the current NAT status and NAT port mapping status are indicated by the NAT.InterfaceSetting.{i}.Status parameter. |
true |
2.12 |
|
Device.Firewall.Chain.{i}. |
object(0:) |
W |
{{div|{{classes}}|Firewall Chain table. Each entry contains an ordered list of {{object|Rule}} objects which can themselves reference other {{object}} instances. A hierarchy of rules can therefore be created. A given Firewall Chain's rules are all created by the same entity, as indicated by the {{param|Creator}} parameter.}} Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other Chain instances. A hierarchy of rules can therefore be created. A given Firewall Chain's rules are all created by the same entity, as indicated by the Creator 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Creator |
string |
R |
{{div|{{classes}}|Creator of this {{object}} entry and of its {{object|Rule}}s. {{enum}} Note that this is the entity that originally created the {{object}} entry. The value of this parameter does not change if the {{object}} entry or one of its rules is subsequently changed by another entity.}} Creator of this Chain entry and of its Rules. Enumeration of:
Note that this is the entity that originally created the Chain entry. The value of this parameter does not change if the Chain entry or one of its rules is subsequently changed by another entity. |
ACS |
2.12 |
|
Device.Firewall.Chain.{i}.Rule.{i}. |
object(0:) |
W |
Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain. This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions. All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE. Some of this object's parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified. For enabled table entries, if SourceInterface is not a valid reference and SourceAllInterfaces is false, or if DestInterface is not a valid reference and DestAllInterfaces 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this Rule entry. Enumeration of:
|
Disabled |
2.12 |
|
Order |
unsignedInt(1:) |
W |
Position of the Rule 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 rule 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 Rule table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). |
- |
2.12 |
|
Target |
string |
W |
{{div|{{classes}}|Action to perform for traffic matching this {{object}} entry. {{enum}} This parameter can only be modified if the {{object}} is Static (as explained in the object description).}} Action to perform for traffic matching this Rule entry. Enumeration of:
This parameter can only be modified if the Rule is Static (as explained in the object description). |
Drop |
2.12 |
|
TargetChain |
string |
W |
The value MUST be the Path Name of a row in the Firewall.Chain. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the chain to process when Target equals TargetChain. If there are no matching rules in the referenced chain, processing continues with the next rule in this chain (if any). In other words, TargetChain behaves like a subroutine call. an empty string indicates no TargetChain is specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.12 |
|
Log |
boolean |
W |
{{div|{{classes}}|Enable or disable logging, in a {{object|###.DeviceInfo.VendorLogFile}}, of packets matching this {{object}}. If the {{object}} is not Static (as explained in the object description), whether changes to this parameter persist across re-boot is a local matter to the CPE.}} Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Rule. If the Rule is not Static (as explained in the object description), whether changes to this parameter persist across re-boot is a local matter to the CPE. |
false |
2.12 |
|
ExpiryDate |
dateTime |
W |
The time at which this Rule entry will expire, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. The only value that MUST be supported is 9999-12-31T23:59:59Z (i.e. support for rules that expire is OPTIONAL). When a rule expires, the CPE MUST automatically terminate that rule and MUST automatically delete the corresponding Rule table entry. This parameter can only be modified if the Rule is Static (as explained in the object description). |
9999-12-31T23:59:59Z |
2.12 |
|
SourceInterface |
string(:256) |
W |
Rule criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Rules can be instantiated is a local matter to the CPE. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.12 |
|
SourceInterfaceExclude |
boolean |
W |
If false, the rule matches only those packets that match the SourceInterface entry, if specified. If true, the rule matches all packets except those that match the SourceInterface entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
SourceAllInterfaces |
boolean |
W |
{{div|{{classes}}|{{object}} criterion. This specifies that all ingress interfaces are associated with the entry. If {{true}}, the values of {{param|SourceInterface}} and {{param|SourceInterfaceExclude}} are ignored since all ingress interfaces are indicated. This parameter can only be modified if the {{object}} is Static (as explained in the object description).}} Rule criterion. This specifies that all ingress interfaces are associated with the entry. If true, the values of SourceInterface and SourceInterfaceExclude are ignored since all ingress interfaces are indicated. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
DestInterface |
string(:256) |
W |
Rule criterion. The value MUST be the Path Name of a table row. This specifies the egress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Rules can be instantiated is a local matter to the CPE. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.12 |
|
DestInterfaceExclude |
boolean |
W |
If false, the rule matches only those packets that match the DestInterface entry, if specified. If true, the rule matches all packets except those that match the DestInterface entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
DestAllInterfaces |
boolean |
W |
{{div|{{classes}}|{{object}} criterion. This specifies that all egress interfaces are associated with the entry. If {{true}}, the values of {{param|DestInterface}} and {{param|DestInterfaceExclude}} are ignored since all ingress interfaces are indicated. This parameter can only be modified if the {{object}} is Static (as explained in the object description).}} Rule criterion. This specifies that all egress interfaces are associated with the entry. If true, the values of DestInterface and DestInterfaceExclude are ignored since all ingress interfaces are indicated. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
IPVersion |
int(-1:15) |
W |
Rule criterion. IP Protocol Version (e.g. 4 for IPv4 and 6 for IPv6). A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
DestIP |
string(:45) |
W |
[IPAddress] Rule criterion. Destination IP address. An empty string indicates this criterion is not used for matching. Note that Firewall rules are applied after any NAT processing, so if NAT is enabled on the source interface this is always the translated address. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.12 |
|
DestIPExclude |
boolean |
W |
If false, the rule matches only those packets that match the (masked) DestIP entry, if specified. If true, the rule matches all packets except those that match the (masked) DestIP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
SourceIP |
string(:45) |
W |
[IPAddress] Rule criterion. Source IP address. An empty string indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.12 |
|
SourceIPExclude |
boolean |
W |
If false, the rule matches only those packets that match the (masked) SourceIP entry, if specified. If true, the rule matches all packets except those that match the (masked) SourceIP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
Protocol |
int(-1:255) |
W |
Rule criterion. Protocol number. A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
ProtocolExclude |
boolean |
W |
If false, the rule matches only those packets that match the Protocol entry, if specified. If true, the rule matches all packets except those that match the Protocol entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
DestPort |
int(-1:65535) |
W |
Rule criterion. Destination port number. A value of -1 indicates this criterion is not used for matching. Note that Firewall rules are applied after any NAT processing, so if NAT is enabled on the source interface this is always the translated port number. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
DestPortRangeMax |
int(-1:65535) |
W |
Rule criterion. If specified, indicates the Rule criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. Note that Firewall rules are applied after any NAT processing, so if NAT is enabled on the source interface this is always the translated port number. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
DestPortExclude |
boolean |
W |
If false, the rule matches only those packets that match the DestPort entry (or port range), if specified. If true, the rule matches all packets except those that match the DestPort entry (or port range), if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
SourcePort |
int(-1:65535) |
W |
Rule criterion. Source port number. A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
SourcePortRangeMax |
int(-1:65535) |
W |
Rule criterion. If specified, indicates the Rule criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
SourcePortExclude |
boolean |
W |
If false, the rule matches only those packets that match the SourcePort entry (or port range), if specified. If true, the rule matches all packets except those that match the SourcePort entry (or port range), if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
DSCP |
int(-1:63) |
W |
Rule criterion. DiffServ codepoint (defined in [RFC2474]). If set to a Class Selector Codepoint (defined in [RFC2474]), all DSCP values that match the first 3 bits will be considered a valid match. A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). |
-1 |
2.12 |
|
DSCPExclude |
boolean |
W |
If false, the rule matches only those packets that match the DSCP entry, if specified. If true, the rule matchess all packets except those that match the DSCP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.12 |
|
Device.PeriodicStatistics. |
object |
R |
This object configures collection of periodic statistics for the device. Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the Controller as a comma-separated list of the most recent |
- |
2.12 |
|
MinSampleInterval |
unsignedInt |
R |
{{div|{{classes}}|Minimum sample interval in {{units}} that the CPE is able to support. A value of 0 indicates no specific minimum sample interval.}} Minimum sample interval in seconds that the CPE is able to support. A value of 0 indicates no specific minimum sample interval. |
- |
2.12 |
|
MaxReportSamples |
unsignedInt |
R |
{{div|{{classes}}|Maximum number of samples of each statistic that the CPE is able to store and report. A value of 0 indicates no specific maximum number of samples.}} Maximum number of samples of each statistic that the CPE is able to store and report. A value of 0 indicates no specific maximum number of samples. |
- |
2.12 |
|
Device.PeriodicStatistics.SampleSet.{i}. |
object(0:) |
W |
Periodic statistics sample set table. Each sample set has its own sample interval etc. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables collection of periodic statistics for this sample set. When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.}} Enables or disables collection of periodic statistics for this sample set. When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. |
false |
2.12 |
|
Status |
string |
R |
Indicates availability of Sample statistics. Enumeration of:
|
Disabled |
2.12 |
|
Controller |
string |
R |
The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created SampleSet. 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 SampleSet creation using the reference to the USP Controller that created the instance. The USP Controller referenced by this parameter defines the set of permissions to use when updating the Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. table. Furthermore, only the USP Controller referenced by this parameter will have access to the Parameter.{i}.Values, Parameter.{i}.SampleSeconds, Parameter.{i}.SuspectData and Parameter.{i}.Failures parameters. |
- |
2.15 |
|
SampleInterval |
unsignedInt(1:) |
W |
The sample interval in seconds. Each statistic is measured over this sample interval. The CPE MAY reject a request to set SampleInterval to less than PeriodicStatistics.MinSampleInterval. Sample intervals MUST begin every SampleInterval seconds, with no delay between samples. If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic. |
3600 |
2.12 |
|
ReportSamples |
unsignedInt(1:) |
W |
The number of samples that the CPE will store and report for each statistic. The CPE MUST permit ReportSamples to be set to at least PeriodicStatistics.MaxReportSamples. If ReportSamples is changed while collection of periodic statistics is enabled, the CPE will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic. |
24 |
2.12 |
|
TimeReference |
dateTime |
W |
An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval. TimeReference is used only to set the "phase" of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future. This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval). If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. The Unknown Time value defined in [TR-106] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight. Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start. |
0001-01-01T00:00:00Z |
2.12 |
|
FetchSamples |
unsignedInt |
W |
The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled. If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur. For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the Controller could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}Device.PeriodicStatistics.SampleSet.{i}.ForceSample()). To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples. |
0 |
2.12 |
|
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 {{param: empty ref only valid in parameter descriptions}} 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 |
|
ReportEndTime |
dateTime |
R |
The absolute time at which the sample interval for the last stored sample (for each statistic) ended. If {{param|ForceSample}}Device.PeriodicStatistics.SampleSet.{i}.ForceSample() has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected. |
<Empty> |
2.12 |
|
SampleSeconds |
unsignedInt[] |
R |
Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval. Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:
Value Change Notification requests for this parameter MAY be denied. |
<Empty> |
2.12 |
|
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. |
object(0:) |
W |
Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled. Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSampleDevice.PeriodicStatistics.SampleSet.{i}.ForceSample() is set to true (a "sneak preview" of the current sample), or (c) at the end of the sample interval. At most one entry in this table can exist with a given value for Reference, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
SampleMode |
string |
W |
{{div|{{classes}}|Controls how this parameter's value is sampled. {{enum}} Parameters of non-numeric types can only support {{enum|Current}}. The value of the {{param}} MUST be ignored for such parameters.}} Controls how this parameter's value is sampled. Enumeration of:
Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters. |
Current |
2.12 |
|
CalculationMode |
string |
W |
Controls how this parameter's statistic is calculated from the sampled value(s). Enumeration of:
|
Latest |
2.12 |
|
LowThreshold |
int |
W |
The low threshold value that controls the calculation of Failures. A value equal to HighThreshold disables the threshold/failure mechanism. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. |
0 |
2.12 |
|
HighThreshold |
int |
W |
The high threshold value that controls the calculation of Failures. A value equal to LowThreshold disables the threshold/failure mechanism. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. |
0 |
2.12 |
|
SampleSeconds |
unsignedInt[] |
R |
Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval. Individual SampleSeconds values can be less than PeriodicStatistics.SampleSet.{i}.SampleInterval, for several reasons, including:
Value Change Notification requests for this parameter MAY be denied. |
<Empty> |
2.12 |
|
SuspectData |
unsignedInt(:1)[] |
R |
{{div|{{classes}}|{{list}} Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval. For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set {{param}} to 1.}} Comma-separated list of unsigned integers (up to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval. For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1. Value Change Notification requests for this parameter MAY be denied. |
<Empty> |
2.12 |
|
Values |
string[] |
R |
Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval. The statistics values in this comma-separated listslist MUST be in time order, with the oldest one first and the most recent one last. If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode. Value Change Notification requests for this parameter MAY be denied. |
<Empty> |
2.12 |
|
Failures |
unsignedInt |
R |
Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the "in range" state to the "out of range" state, or between the "out of range (low)" and "out of range (high)" states. The states are defined as follows:
|
0 |
2.12 |
|
Device.FaultMgmt. |
object |
R |
This object contains parameters relating to Fault/Alarm Management. |
- |
2.12 |
|
Device.FaultMgmt.SupportedAlarm.{i}. |
object(0:) |
R |
{{div|{{classes}}|Supported Alarm Entries which can be raised by the device. The instance numbers for this table SHOULD be maintained across firmware upgrades of the device.}} Supported Alarm Entries which can be raised by the device. The instance numbers for this table SHOULD be maintained across firmware upgrades of the device. At most one entry in this table can exist with the same values for all of EventType, ProbableCause, SpecificProblem and PerceivedSeverity. |
- |
2.12 |
|
SpecificProblem |
string(:128) |
R |
Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn't support unique indexing of the table using SpecificProblem. The string can be set to "*" to indicate the default case if only a subset of SpecificProblem are to be contained within the table. |
- |
2.12 |
|
PerceivedSeverity |
string |
R |
Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:
|
- |
2.12 |
|
Device.FaultMgmt.CurrentAlarm.{i}. |
object(0:) |
R |
Contains all currently active alarms (whose FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity is not Cleared). Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table. If maximum entries as indicated by FaultMgmt.MaxCurrentAlarmEntries is reached, the next event overrides the object with the oldest AlarmChangedTime. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). At most one entry in this table can exist with a given value for AlarmIdentifier, or with the same values for all of EventType, ProbableCause and SpecificProblem. |
- |
2.12 |
|
SpecificProblem |
string(:128) |
R |
{{div|{{classes}}|Provides further qualification on the alarm beyond {{param|EventType}} and {{param|ProbableCause}}. This is vendor defined and will be {{empty}} if the device doesn't support inclusion of this information.}} Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
AdditionalText |
string(:256) |
R |
{{div|{{classes}}|This provides a textual string which is vendor defined. This will be {{empty}} if the device doesn't support inclusion of this information.}} This provides a textual string which is vendor defined. This will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
Device.FaultMgmt.HistoryEvent.{i}. |
object(0:) |
R |
Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table. This table also contains alarm clearing events. Active alarms at the time of a power failure or reboot might not get an alarm clearing event. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.HistoryEventNumberOfEntries. If maximum instance number FaultMgmt.HistoryEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. At most one entry in this table can exist with the same values for both EventTime and AlarmIdentifier. |
- |
2.12 |
|
SpecificProblem |
string(:128) |
R |
{{div|{{classes}}|Provides further qualification on the alarm beyond {{param|EventType}} and {{param|ProbableCause}}. This is vendor defined and will be {{empty}} if the device doesn't support inclusion of this information.}} Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
AdditionalText |
string(:256) |
R |
{{div|{{classes}}|This provides a textual string which is vendor defined. This will be {{empty}} if the device doesn't support inclusion of this information.}} This provides a textual string which is vendor defined. This will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
Device.FaultMgmt.ExpeditedEvent.{i}. |
object(0:) |
R |
Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 0 Expedited. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.ExpeditedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106]. If maximum instance number FaultMgmt.ExpeditedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). At most one entry in this table can exist with a given value for AlarmIdentifier. |
- |
2.12 |
|
EventTime |
dateTime |
R |
{{div|{{classes}}|Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106}}.}} Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in [TR-106]. |
- |
2.12 |
|
AlarmIdentifier |
string(:64) |
R |
{{div|{{classes}}|Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is {{empty}}.}} Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is an empty string. |
- |
2.12 |
|
SpecificProblem |
string(:128) |
R |
{{div|{{classes}}|Provides further qualification on the alarm beyond {{param|EventType}} and {{param|ProbableCause}}. This is vendor defined and will be {{empty}} if the device doesn't support inclusion of this information.}} Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
AdditionalText |
string(:256) |
R |
{{div|{{classes}}|This provides a textual string which is vendor defined. This will be {{empty}} if the device doesn't support inclusion of this information.}} This provides a textual string which is vendor defined. This will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
Device.FaultMgmt.QueuedEvent.{i}. |
object(0:) |
R |
Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 1 Queued. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.QueuedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106]. If maximum instance number FaultMgmt.QueuedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). At most one entry in this table can exist with a given value for AlarmIdentifier. |
- |
2.12 |
|
EventTime |
dateTime |
R |
{{div|{{classes}}|Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106}}.}} Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in [TR-106]. |
- |
2.12 |
|
AlarmIdentifier |
string(:64) |
R |
{{div|{{classes}}|Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is {{empty}}.}} Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is an empty string. |
- |
2.12 |
|
SpecificProblem |
string(:128) |
R |
{{div|{{classes}}|Provides further qualification on the alarm beyond {{param|EventType}} and {{param|ProbableCause}}. This is vendor defined and will be {{empty}} if the device doesn't support inclusion of this information.}} Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
AdditionalText |
string(:256) |
R |
{{div|{{classes}}|This provides a textual string which is vendor defined. This will be {{empty}} if the device doesn't support inclusion of this information.}} This provides a textual string which is vendor defined. This will be an empty string if the device doesn't support inclusion of this information. |
- |
2.12 |
|
Device.Security. |
object |
R |
This object contains general information related to managing security features on the device. |
- |
2.12 |
|
Device.Security.Certificate.{i}. |
object(0:) |
R |
This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280]. At most one entry in this table can exist with the same values for both SerialNumber and Issuer. |
- |
2.12 |
|
SubjectAlt |
string[](:256) |
R |
{{div|{{classes}}|{{list}} Each item is a DNS Name. The Subject Alternative Names extension field in an X.509 certificate, see {{bibref|RFC5280}}.}} Comma-separated list (maximum number of characters 256) of strings. Each item is a DNS Name. The Subject Alternative Names extension field in an X.509 certificate, see [RFC5280]. |
- |
2.12 |
|
Device.FAP. |
object |
R |
This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. |
- |
2.12 |
|
Device.FAP.GPS. |
object |
R |
This object contains the parameters relating to the GPS scan. |
- |
2.12 |
|
PeriodicTime |
dateTime |
W |
An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the PeriodicInterval. PeriodicTime is used only to set the "phase" of the GPS scan. The actual value of PeriodicTime can be arbitrarily far into the past or future. For example, if PeriodicInterval is 86400 (a day) and if PeriodicTime is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval. If absolute time is not available to the CPE, its periodic GPS scan behavior MUST be the same as if PeriodicTime parameter was set to the Unknown Time value. |
- |
2.12 |
|
LastSuccessfulScanTime |
dateTime |
R |
{{div|{{classes}}|Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboot and is only reset after another scan completes successfully or {{param|GPSReset}} is set to {{true}}. The values for {{param|LockedLatitude}}, {{param|LockedLongitude}} and {{param|NumberOfSatellites}} correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in {{bibref|TR-106|Section 3.2}}.}} Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset() is invoked. The values for LockedLatitude, LockedLongitude and NumberOfSatellites correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in [Section 3.2/TR-106]. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LockedLatitude |
int(-90000000:90000000) |
R |
This parameter specifies the latitude of the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90d00.00' South (-90,000,000) to 90d00.00' North (90,000,000). Example: A latitude of 13d19.43' N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00' S would be represented as value -50,000,000. This value is retained across reboots and is only reset after another scan completes successfully or {{param|GPSReset}} is set to {{true}}. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset() is invoked.If a scan has never succeeded before, the value 0 is reported. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LockedLongitude |
int(-180000000:180000000) |
R |
This parameter specifies the longitude of the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East (180,000,000). Example: A longitude of 13d19.43' E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00.00' W would be represented as value -50,000,000. This value is retained across reboots and is only reset after another scan completes successfully or {{param|GPSReset}} is set to {{true}}. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset() is invoked.If a scan has never succeeded before, the value 0 is reported. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
NumberOfSatellites |
unsignedInt |
R |
{{div|{{classes}}|The number of satellites that were locked during the test execution. The greater the number of satellites the better the precision of the results. This value is retained across reboots and is only reset after another scan completes successfully or {{param|GPSReset}} is set to {{true}}. If a scan has never succeeded before, the value 0 is reported.}} The number of satellites that were locked during the test execution. The greater the number of satellites the better the precision of the results. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset() is invoked. If a scan has never succeeded before, the value 0 is reported. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.FAP.GPS.ContinuousGPSStatus. |
object |
R |
{{div|{{classes}}|When {{param|#.ContinuousGPS}} is {{true}}, the parameters in this object contain the GPS status as it is continuously monitored. When {{param|#.ContinuousGPS}} is {{false}}, the parameters in this object are not being updated and their values are not accurate.}} When ContinuousGPS is true, the parameters in this object contain the GPS status as it is continuously monitored. When ContinuousGPS is false, the parameters in this object are not being updated and their values are not accurate. |
- |
2.12 |
|
GotFix |
boolean |
R |
{{div|{{classes}}|The value is {{true}} if {{param|CurrentFix}} has transitioned to {{true}} at least once since {{param|#.ContinuousGPS}} was enabled, otherwise it is {{false}}. After a reboot the value is {{false}} until {{param|CurrentFix}} has transitioned to {{true}} again. The GPS coordinates ({{param|Latitude}}, {{param|Longitude}}, and {{param|Elevation}}) are not valid until {{param}} has a value of {{true}}.}} The value is true if CurrentFix has transitioned to true at least once since ContinuousGPS was enabled, otherwise it is false. After a reboot the value is false until CurrentFix has transitioned to true again. The GPS coordinates (Latitude, Longitude, and Elevation) are not valid until GotFix has a value of true. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Latitude |
int(-90000000:90000000) |
R |
This parameter represents the most recent latitude reading for the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90 deg 00.00' South (-90,000,000) to 90 deg 00.00' North (90,000,000). Example: A latitude of 13 deg 19.43' N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50 deg 00.00' S would be represented as value -50,000,000. Latitude is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Longitude |
int(-180000000:180000000) |
R |
This parameter represents the most recent longitude reading for the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East (180,000,000). Example: A longitude of 13d19.43' E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00.00' W would be represented as value -50,000,000. Longitude is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Elevation |
int(-5000000:25000000) |
R |
This parameter represents the most recent elevation reading for the device's position in millimeters, relative to the WGS84 ellipsoid. The positive value signifies the direction, above sea level. The negative value signifies the direction, below sea level. Range is from: 5,000.000 meters below sea level (-5,000,000) to 25,000.000 meters above sea level (25,000,000). Elevation is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
LastFixTime |
dateTime |
R |
{{div|{{classes}}|Represents the date and time when the last GPS Fix was acquired. The Unknown Time value defined in {{bibref|TR-106|Section 3.2}} is used when {{param|GotFix}} is {{false}}. This applies too after a reboot of the device until a valid location is determined and {{param|GotFix}} transsitions to {{true}}.}} Represents the date and time when the last GPS Fix was acquired. The Unknown Time value defined in [Section 3.2/TR-106] is used when GotFix is false. This applies too after a reboot of the device until a valid location is determined and GotFix transsitions to true. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
FirstFixTimeout |
int(-1:) |
W |
{{div|{{classes}}|Number of {{units}} to wait for first GPS fix before declaring a GPS fault. A value of -1 means that there is no timeout and no fault logging.}} Number of seconds to wait for first GPS fix before declaring a GPS fault. A value of -1 means that there is no timeout and no fault logging. |
- |
2.12 |
|
Device.FAP.GPS.AGPSServerConfig. |
object |
R |
This object contains parameters for the configuration of the Assisted Global Positioning System (A-GPS) server. See also [Section 3.2/3GPP-TS.25.171] |
- |
2.12 |
|
ReferenceLatitude |
int(-90000000:90000000) |
W |
This parameter specifies the reference latitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90d00.00' South (-90,000,000) to 90d00.00' North (90,000,000). Example: A latitude of 13d19.43' N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00' S would be represented as value -50,000,000. |
- |
2.12 |
|
ReferenceLongitude |
int(-180000000:180000000) |
W |
This parameter specifies the reference longitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East (180,000,000). Example: A longitude of 13d19.43' E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00'00* W would be represented as value -50,000,000. |
- |
2.12 |
|
ServerInUse |
boolean |
R |
{{div|{{classes}}|The value is {{true}} if the device has successfully contacted and received A-GPS info from the A-GPS server, otherwise the value is {{false}}. After a reboot the value is {{false}} until the server could be contacted again.}} The value is true if the device has successfully contacted and received A-GPS info from the A-GPS server, otherwise the value is false. After a reboot the value is false until the server could be contacted again. |
- |
2.12 |
|
Device.FAP.PerfMgmt. |
object |
R |
This object contains parameters relating to Performance Management in a Femto-related environment. |
- |
2.12 |
|
Device.FAP.PerfMgmt.Config.{i}. |
object(0:) |
W |
This object contains parameters relating to File Management configuration for uploading of Performance Files to a designated File Server. Each table entry can be referenced by zero or more radio-specific objects contained in the FAPService instances. The periodic upload will upload data for all of the radio-specific objects that reference it. At most one entry in this table can exist with a given value for Alias, or with the same values for all of URL, PeriodicUploadInterval and PeriodicUploadTime. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, URL, PeriodicUploadInterval and PeriodicUploadTime such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
URL |
string(:2048) |
W |
{{div|{{classes}}|{{datatype}} specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.}} [URL] specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with PeriodicUploadInterval and PeriodicUploadTime) doesn't conflict with any existing entries. |
- |
2.12 |
|
PeriodicUploadTime |
dateTime |
W |
An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the PeriodicUploadInterval. PeriodicUploadTime is used only to set the "phase" of the periodic uploads. The actual value of PeriodicUploadTime can be arbitrarily far into the past or future. For example, if PeriodicUploadInterval is 86400 (a day) and if PeriodicUploadTime is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicUploadTime refers to a day in the future. The Unknown Time value as defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. That is, the device MAY locally choose the time reference, and is REQUIRED only to adhere to the specified PeriodicUploadInterval. If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the PeriodicUploadTime parameter was set to the Unknown Time value. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with URL, PeriodicUploadInterval) doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.FAP.ApplicationPlatform. |
object |
R |
This object defines the data model for the following Femtozone APIs.
|
- |
2.12 |
|
Device.FAP.ApplicationPlatform.Capabilities. |
object |
R |
This object contains parameters related to the capabilities of the Femtozone Application Platform and the Femtozone APIs. |
- |
2.12 |
|
AuthenticationMethodsSupported |
string[] |
R |
Comma-separated list of strings. Specifies the supported methods that 3rd Party Applications can use to authenticate with the Femto Application Platform at initialization. Comma separated list of strings. Each list item is an enumeration of:
|
- |
2.12 |
|
Device.FAP.ApplicationPlatform.Control. |
object |
R |
This object contains parameters related to the operation of the Femtozone APIs. |
- |
2.12 |
|
AuthenticationMethod |
string(:256) |
W |
{{div|{{classes}}|Specifies how 3rd Party Applications have to authenticate against Femto APIs in order to use it. {{reference}} Note: The credentials are not part of the data model and have to be supplied externally.}} Specifies how 3rd Party Applications have to authenticate against Femto APIs in order to use it. The value MUST be a member of the list reported by the Capabilities.AuthenticationMethodsSupported parameter. Note: The credentials are not part of the data model and have to be supplied externally. |
- |
2.12 |
|
TunnelInst |
string(:256) |
W |
This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic. The TunnelInst MUST point to a tunnel instance defined in the data model. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.12 |
|
Device.BulkData. |
object |
R |
This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in [TR-232]. The HTTP solution is based on transfer mechanisms described in [Annex A/TR-369]. The USPEventNotif solution is based on sending a Profile.{i}.Push! Event Notification via USP [TR-369]. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables all collection profiles. If {{false}}, bulk data will not be collected or reported.}} Enables or disables all collection profiles. If false, bulk data will not be collected or reported. |
- |
2.12 |
|
MinReportingInterval |
unsignedInt |
R |
{{div|{{classes}}|Minimum reporting interval in {{units}} that the CPE is capable of supporting. A value of 0 indicates no minimum reporting interval.}} Minimum reporting interval in seconds that the CPE is capable of supporting. A value of 0 indicates no minimum reporting interval. |
- |
2.12 |
|
Protocols |
string[] |
R |
Comma-separated list of strings. Represents the IPDR and transport protocols that this device is capable of supporting. Each list item is an enumeration of:
IPDR Streaming Protocol [IPDR-SP] This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
)
IPDR File Transfer Protocol [IPDR-FTP] This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
)
Changes since 2.14:
|
- |
2.5 |
|
EncodingTypes |
string[] |
R |
Comma-separated list of strings. Represents the Encoding Types for the protocols that this device is capable of supporting. Each list item is an enumeration of:
Used with the IPDR Streaming and File Protocols. [IPDR-XML] This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
)
Used with the IPDR Streaming and File Protocols. [IPDR-XDR] This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
) |
- |
2.5 |
|
MaxNumberOfProfiles |
int(-1:) |
R |
{{div|{{classes}}|The maximum number of profiles that can exist at any given time. Specifically, the maximum number of {{object|Profile.{i}.}} instances that the Controller can create. If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of profiles that can exist.}} The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the Controller can create. If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of profiles that can exist. |
- |
2.12 |
|
MaxNumberOfParameterReferences |
int(-1:) |
R |
{{div|{{classes}}|The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via {{param|Profile.{i}.Parameter.{i}.Reference}} across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter). If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of parameter that can be referenced via the bulk data collection mechanism.}} The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via Profile.{i}.Parameter.{i}.Reference across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter). If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of parameter that can be referenced via the bulk data collection mechanism. |
- |
2.12 |
|
Device.BulkData.Profile.{i}. |
object(0:) |
W |
{{div|{{classes}}|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 Controller to configure multiple reports to be generated at different times for different sets of data.}} 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 Controller to configure multiple reports to be generated at different times for different sets of data. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this specific bulk data profile. If {{false}}, this profile will not be collected or reported.}} Enables or disables this specific bulk data profile. If false, this profile will not be collected or reported. |
false |
2.12 |
|
Controller |
string |
R |
The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created or last updated this Profile{{inserted: unexpected argument delete after: []}}. 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 valueUSP ofController referenced by this parameter isalso automatically updated bydefines the USPset Agentof uponpermissions {{object}}to alterationuse usingwhen generating the referenceBulk toData report. Furthermore, only the USP Controller thatreferenced changedby this parameter will receive a Push! Event (assuming it has an associated Subscription) when the instance.Profile has Protocol configured to USPEventNotif, even if another USP Controller has an associated Subscription. |
- |
2.12 |
|
NumberOfRetainedFailedReports |
int(-1:) |
W |
The number of failed reports to be retained and transmitted (in addition to the current report) at the end of the current reporting interval. If the value of the EncodingType parameter is modified any outstanding failed reports are deleted. If the CPE cannot retain the number of failed reports from previous reporting intervals while transmitting the report of the current reporting interval, then the oldest failed reports are deleted until the CPE is able to transmit the report from the current reporting interval. A value of 0 indicates that failed reports are not to be retained for transmission in the next reporting interval. A value of -1 indicates that the CPE will retain as many failed reports as possible. |
0 |
2.12 |
|
ReportingInterval |
unsignedInt(1:) |
W |
The reporting interval in seconds. Each report is generated based on this interval and TimeReference. The CPE MAY reject a request to set ReportingInterval to less than MinReportingInterval. Reporting intervals MUST begin every ReportingInterval seconds. If ReportingInterval is changed while collection is enabled, the first reporting interval begins immediately. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if the {{param|Protocol}} parameter is set to {{enum|Streaming|#.Protocols}})transmit) its report at midnight every 24 hours. |
86400 |
2.12 |
|
TimeReference |
dateTime |
W |
An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations. TimeReference is used only to set the "phase" of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future. If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately. The Unknown Time value as defined in [TR-106] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a "ITPush" mode) its report at midnight every 24 hours. Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start. |
0001-01-01T00:00:00Z |
2.12 |
|
StreamingHost |
string(:256) |
W |
This is the host name or IP Address of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
|
- |
2.12 |
|
StreamingPort |
unsignedInt(0:65535) |
W |
This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
|
4737 |
2.12 |
|
StreamingSessionID |
unsignedInt(48:57,65:90) |
W |
This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). A Controller MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single 'char', but we are restricting the range even further (ASCII values of '0' - '9' and 'A' - 'Z'.'Z'). This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
|
- |
2.12 |
|
FileTransferURL |
string(:2048) |
W |
This is the [URL] within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
|
- |
2.12 |
|
FileTransferUsername |
string(:64) |
W |
{{div|{{classes}}|Username used for authentication of the {{param|FileTransferURL}}. This is the {{param}} that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a value of {{enum|File|#.Protocols}}).}} Username used for authentication of the FileTransferURL. This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. :::::::: Changes since 2.14:
|
- |
2.12 |
|
FileTransferPassword |
string(:64) |
W |
{{div|{{classes}}|Password used for authentication of the {{param|FileTransferURL}}. This is the {{param}} that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a value of {{enum|File|#.Protocols}}).}} Password used for authentication of the FileTransferURL. This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. :::::::: When read, this parameter returns an empty string, regardless of the actual value. Changes since 2.14:
|
- |
2.12 |
|
ControlFileFormat |
string(:128) |
W |
If this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File) then the control file names will be of the following format:
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP. Changes since 2.14:
|
- |
2.12 |
|
ForceCollection() |
command |
- |
Start the bulk data collection and transmission as defined in this profile immediately, regardless of the current values of the Enable and ReportingInterval parameters. This command can be used for testing of the bulk data collection mechanism and profile but also to preempt any regular schedule without affecting it. |
- |
2.15 |
|
Device.BulkData.Profile.{i}.Parameter.{i}. |
object(0:) |
W |
{{div|{{classes}}|Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported.}} Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported. |
- |
2.12 |
|
Name |
string(:64) |
W |
Name of the parameter in the report body. If the value of this parameter is an empty string, then the value of the Reference parameter is used as the name. When the value Reference parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in [Annex A.2.1/TR-369]. |
- |
2.12 |
|
Reference |
string(:256) |
W |
Represents the parameter(s) that are part of this Bulk Data collection profile. The value MUST be a path name of a parameter or an object. When the ParameterWildCardSupported parameter has a value of true, patterns for instance identifiers are permitted with wildcards (an "*" character) in place of instance identifiers; any attempt to set the value otherwise MUST be rejected by the CPE. In the case where aan partialObject parameter pathPath is specified, the sub-objects of the resolved pattern and contained parameters will be part of the bulk data collected and reported. If the path name refers to an object then it MUST end with a '.'. Changes since 2.14:
|
<Empty> |
2.12 |
|
Device.BulkData.Profile.{i}.CSVEncoding. |
object |
R |
This object defines the properties to be used when the Profile object's EncodingType parameter value is CSV. |
- |
2.12 |
|
RowSeparator |
string |
W |
Row separator to use when encoding CSV data. Changes since 2.14:
|
<Empty> |
2.12 |
|
ReportFormat |
string |
W |
{{div|{{classes}}|This parameter describes the formatting used for reports defined by this profile as described in {{template|BULK-DATA-CSV-REF}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}.}} This parameter describes the formatting used for reports defined by this profile as described in [Annex A.2.4/TR-369]. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616]. Enumeration of:
|
ParameterPerColumn |
2.12 |
|
Device.BulkData.Profile.{i}.JSONEncoding. |
object |
R |
This object defines the properties to be used when the Profile object's EncodingType parameter value is JSON. |
- |
2.12 |
|
ReportFormat |
string |
W |
{{div|{{classes}}|This parameter describes the formatting used for the report as described in {{template|BULK-DATA-JSON-REF}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}.}} This parameter describes the formatting used for the report as described in [Annex A.2.5/TR-369]. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616]. Enumeration of:
|
ObjectHierarchy |
2.12 |
|
Device.BulkData.Profile.{i}.HTTP. |
object |
R |
This object defines the properties to be used when transporting bulk data using the HTTP/HTTPS protocol. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the CPE MUST support HTTP Basic and Digest Access Authentication as defined in [RFC2616]. |
- |
2.12 |
|
RetryMinimumWaitInterval |
unsignedInt(1:65535) |
W |
{{div|{{classes}}|Configures the data transfer retry wait interval, in seconds, as specified in {{template|BULK-DATA-HTTP-RETRY-REF}}. The device MUST use a random value between {{param}} and ({{param}} * {{param|RetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.}} Configures the data transfer retry wait interval, in seconds, as specified in [Annex A.1.2.1/TR-369]. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. |
5 |
2.12 |
|
RetryIntervalMultiplier |
unsignedInt(1000:65535) |
W |
Configures the retry interval multiplier as specified in [Annex A.1.2.1/TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. |
2000 |
2.12 |
|
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.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. |
object(0:) |
W |
This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by [Annex A.1.1/TR-369]. |
- |
2.12 |
|
Name |
string(:64) |
W |
{{div|{{classes}}|Name of the Request-URI parameter. If {{param}} is {{empty}}, the name of the Request-URI parameter is the value of {{param|Reference}}.}} Name of the Request-URI parameter. If Name is an empty string, the name of the Request-URI parameter is the value of Reference. |
- |
2.12 |
|
Reference |
string(:256) |
W |
{{div|{{classes}}|The value MUST be the path name of a parameter to be used as the Request-URI parameter. If the value of this parameter is empty, then this object is not encoded in the report header.}} The value MUST be the path name of a parameter to be used as the Request-URI parameter. If the value of this parameter is empty, then this object is not encoded in the report header. |
<Empty> |
2.12 |
|
Device.BulkData.Profile.{i}.MQTT. |
object |
R |
This object defines the properties to be used when transporting bulk data using the MQTT protocol. This object is used when the Protocol parameter has a value of MQTT. |
- |
2.15 |
|
Reference |
string |
W |
The value MUST be the Path Name of a row in the MQTT.Client. table. A reference to the MQTT Client used by this Bulk Data Collection Profile when communicating via the MQTT Protocol. |
<Empty> |
2.15 |
|
PublishTopic |
string(:65535) |
W |
The topic name the Agent MUST use when sending the Bulk Data report. |
- |
2.15 |
|
PublishQoS |
unsignedInt(0:2) |
W |
The Agent MUST use this QoS value when sending the Bulk Data report. If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server. |
- |
2.15 |
|
PublishRetain |
boolean |
W |
If set to true the Agent MUST set the RETAIN flag in MQTT PUBLISH messages carrying the Bulk Data report to 1, unless the MQTT server sent Retain Available = 0 (MQTT 5.0) in its CONNACK (in which case, the Agent MUST set the RETAIN flag to 0). |
false |
2.15 |
|
Device.XMPP. |
object |
R |
The XMPP represents the XMPP capabilities of the device. |
- |
2.12 |
|
Device.XMPP.Connection.{i}. |
object(0:) |
W |
The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device. At most one entry in this table can exist with a given value for Alias, or with the same values for all of Username, Domain and Resource. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Username, Domain and Resource such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}}. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this Connection. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Password |
string(:256) |
W |
{{div|{{classes}}|Password used to authenticate this {{object}} when making a connection to the {{object|Server}} using the procedure outlined in {{bibref|RFC6120|Section 6}}. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If a Controller modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.}} Password used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If a Controller modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of this Connection (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
KeepAliveInterval |
long(-1:) |
W |
The number of seconds that keep alive events as specified in [Section 4.6.1/RFC6120] are sent by this Connection. A value of 0 disables the keep alive functionality. A value of -1 indicates that the keep alive interval is a vendor specific implementation. [Section 4.6.4/RFC6120] recommends not checking more frequently than every 5 minutes (or 300 seconds). |
-1 |
2.12 |
|
ServerConnectAttempts |
unsignedInt |
W |
The number of times that this Connection attempts to connect to a given IP address before moving on to the current server's next IP address, or to the next server if the current server has no more IP addresses. If ServerConnectAttempts, ServerRetryInitialInterval, ServerRetryIntervalMultiplier and ServerRetryMaxInterval all have their default values, the maximum reconnection wait intervals, in minutes, will be {1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, 512, 512, 512, 512}. After the initial attempt there are 15 further attempts, making a total of 16. The maximum reconnection wait interval is reached on the 10th retry, i.e. the 11th attempt. NOTE: If this Connection fails to connect to any of the servers' IP addresses, fallback behavior SHOULD be as specified in [Section 3.2/RFC6120]. NOTE: If the value of this parameter is 0, server connection and reconnection behavior is implementation-dependent. |
16 |
2.12 |
|
ServerRetryInitialInterval |
unsignedInt(1:65535) |
W |
The maximum first reconnection wait interval, in seconds. The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval. NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. |
60 |
2.12 |
|
ServerRetryIntervalMultiplier |
unsignedInt(1000:65535) |
W |
The reconnection interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1). NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. |
2000 |
2.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 Device MUST use the value of this parameter as the next reconnection wait interval. NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. |
30720 |
2.12 |
|
UseTLS |
boolean |
W |
This parameter allows a Controller to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate". If the value of UseTLS is true then the CPE will initiate TLS negotiation if not required to by the XMPP Server. If the value of UseTLS is false then the CPE will not initiate TLS negotiation if not required to by the XMPP Server. |
false |
2.12 |
|
TLSEstablished |
boolean |
R |
This parameter represents the TLS state of this XMPP Connection. If this XMPP Connection is established and is secured by TLS then the value of this parameter is true. If this XMPP Connection is either not established or established but not secured by TLS then the value of this parameter is false. |
- |
2.12 |
|
Device.XMPP.Connection.{i}.Server.{i}. |
object(0:) |
W |
{{div|{{classes}}|The {{object}} represents an XMPP server to be used for a {{object|##.Connection}}. This table is only relevant when {{param|##.Connection.{i}.ServerConnectAlgorithm}} is set to {{enum|ServerTable|##.Connection.{i}.ServerConnectAlgorithm}}. If {{param|##.Connection.{i}.ServerConnectAlgorithm}} is set to {{enum|DNS-SRV|##.Connection.{i}.ServerConnectAlgorithm}} then any instances of this table are ignored by this {{object|##.Connection}}.}} The Server represents an XMPP server to be used for a Connection. This table is only relevant when Connection.{i}.ServerConnectAlgorithm is set to ServerTable. If Connection.{i}.ServerConnectAlgorithm is set to DNS-SRV then any instances of this table are ignored by this Connection. At most one entry in this table can exist with a given value for Alias, or with the same values for both ServerAddress and Port. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and ServerAddress such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}}. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
false |
2.12 |
|
ServerAddress |
string(:256) |
W |
{{div|{{classes}}|Fully Qualified Domain Name (FQDN) or IP address of the XMPP server for this {{object|##.Connection}}. If the value of this Parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attemtped (in an implemnetation-specific order) until a connection can be made or all addresses are exhausted, in which case the next {{object}} instance (based on {{param|Priority}} and {{param|Weight}}) SHOULD be used.}} Fully Qualified Domain Name (FQDN) or IP address of the XMPP server for this Connection. If the value of this Parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attemtped (in an implemnetation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on Priority and Weight) SHOULD be used. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.IEEE1905. |
object |
R |
This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. |
- |
2.12 |
|
Device.IEEE1905.AL. |
object |
R |
This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. |
- |
2.12 |
|
Status |
string |
R |
The current operational state of the 1905 Abstraction Layer. Enumeration of:
|
- |
2.12 |
|
Device.IEEE1905.AL.Interface.{i}. |
object(0:) |
R |
The 1905 interface table (described in [Sub-clause 5 Abstraction Layer Management/IEEE1905.1a]). At most one entry in this table can exist with a given value for InterfaceId. |
- |
2.12 |
|
Status |
string |
R |
This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
Device.IEEE1905.AL.ForwardingTable. |
object |
R |
This object represents the rules to forward PDUs between interfaces within the 1905 Abstraction Layer. |
- |
2.12 |
|
Device.IEEE1905.AL.ForwardingTable.ForwardingRule.{i}. |
object(0:) |
W |
The 1905 fowarding rule for the ALME-SET-FWD-RULE.request and ALME-GET-FWD-RULES.response with classification criteria as defined in [Table 5-9: ClassificationSet elements/IEEE1905.1a]. |
- |
2.12 |
|
MACDestinationAddress |
string(:17) |
W |
[MACAddress] {{div|{{classes}}|Classification criterion. The destination MAC address.}} Classification criterion. The destination MAC address. |
- |
2.12 |
|
MACSourceAddress |
string(:17) |
W |
[MACAddress] {{div|{{classes}}|Classification criterion. The source MAC address.}} Classification criterion. The source MAC address. |
- |
2.12 |
|
EtherType |
unsignedInt |
W |
{{div|{{classes}}|Classification criterion. Ether Type Field in a frame.}} Classification criterion. Ether Type Field in a frame. |
- |
2.12 |
|
Vid |
unsignedInt(0:4095) |
W |
{{div|{{classes}}|Classification criterion. IEEE 802.1Q VLAN ID in a frame.}} Classification criterion. IEEE 802.1Q VLAN ID in a frame. |
- |
2.12 |
|
PCP |
unsignedInt(0:7) |
W |
{{div|{{classes}}|Classification criterion. IEEE 802.1Q Priority Code Point field.}} Classification criterion. IEEE 802.1Q Priority Code Point field. |
- |
2.12 |
|
Device.IEEE1905.AL.NetworkTopology. |
object |
R |
This object represents the 1905 Network Topology capabilities of this device. |
- |
2.12 |
|
Status |
string |
R |
{{div|{{classes}}|When {{param|Enable}} is set to {{true}}, this parameter indicates the transient phase of the discovery of the {{object}}. {{enum}}}} When Enable is set to true, this parameter indicates the transient phase of the discovery of the NetworkTopology. Enumeration of:
|
- |
2.12 |
|
Device.IEEE1905.AL.NetworkTopology.ChangeLog.{i}. |
object(0:) |
R |
This object represents log entries for changes in the 1905 Network Topology. The Change Log is a First In First Out queue where the oldest entries (defined by values of the TimeStamp parameter) are deleted once the log is full. |
- |
2.12 |
|
NeighborId |
string(:17) |
R |
[MACAddress] {{div|{{classes}}|MAC Address of the Neighbor of this event. If the value of the {{param|EventType}} parameter is {{enum|NewNeighbor|EventType}}, then the value of this parameter represents the MAC Address of the new Neighbor that joined the network; if the value of the {{param|EventType}} parameter is {{enum|LostNeighbor|EventType}}, then the value of this parameter represents the MAC Address of the Neighbor that left the network. If value of the {{param|NeighborType}} parameter is {{enum|IEEE1905|NeighborType}}, then the value of this parameter is the 1905 AL MAC Address of the Neighbor.}} MAC Address of the Neighbor of this event. If the value of the EventType parameter is NewNeighbor, then the value of this parameter represents the MAC Address of the new Neighbor that joined the network; if the value of the EventType parameter is LostNeighbor, then the value of this parameter represents the MAC Address of the Neighbor that left the network. If value of the NeighborType parameter is IEEE1905, then the value of this parameter is the 1905 AL MAC Address of the Neighbor. |
- |
2.12 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. |
object(0:) |
R |
This object represents an instance of discovered 1905 Devices in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]). At most one entry in this table can exist with a given value for IEEE1905Id. |
- |
2.12 |
|
AssocWiFiNetworkDeviceRef |
string |
R |
The value MUST be the Path Name of a row in the WiFi.MultiAP.APDevice. or WiFi.DataElements.Network.Device. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.AssocWiFiNetworkDeviceRef is a reference to thea MultiAP.Device or Wi-Fi Network "APDevice".Data Elements Device. Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance's EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. |
- |
2.13 |
|
Device.MQTT. |
object |
R |
MQTT Base object describing all MQTT related parameters and objects. |
- |
2.12 |
|
Device.MQTT.Capabilities. |
object |
R |
Indicates the MQTT capabilities of the device. |
- |
2.12 |
|
ProtocolVersionsSupported |
string[] |
R |
Comma-separated list of strings. Indicates the supported protocol versions. Each list item is an enumeration of: |
- |
2.12 |
|
TransportProtocolSupported |
string[] |
R |
Comma-separated list of strings. Indicates the supported transport protocols. Each list item is an enumeration of:
Unencrypted MQTT connection Changes since 2.14:
)
TLS encrypted MQTT connection Changes since 2.14:
)
Unencrypted MQTT connection over a WebSocket transport Changes since 2.14:
)
Changes since 2.14:
|
- |
2.12 |
|
Device.MQTT.Client.{i}. |
object(0:) |
W |
MQTT client table. Contains a list of configured MQTT clients. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
Allows to enable or disable the MQTT client. If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the Subscription. table. If the ProtocolVersion is set to 3.1 or 3.1.1 and CleanSession is set to false a subscription MUST only be sent for topics which haven't been subscribed before (see [Section 3.1.2.4/MQTT311]). If the ProtocolVersion is set to 5.0 and CleanStart is set to false a subscription MUST only be sent for topics which haven't been subscribed before (see [Section 3.1.2.4/MQTT50]). If a connected MQTT client gets disabled (Status is either Connecting or Connected) then the MQTT client has to send a MQTT DISCONNECT packet to disconnect from the MQTT broker ((see [Section 3.14/MQTT311],{{bibref|MQTT31|section 3.14}}) or [Section 3.14/MQTT50]), before setting the Status to Disabled. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of this MQTT client. Enumeration of:
|
- |
2.12 |
|
EnableEncryption |
boolean |
W |
When true, encryption MUST be used for this MQTT Client instance. This parameter was DEPRECATED in 2.15 because it duplicates the functionality already handled by the TransportProtocol parameter. Changes since 2.14:
|
true |
2.14 |
|
CleanSession |
boolean |
W |
The value of the MQTT clean session flag in the MQTT CONNECT packet (see [Section 3.1/MQTT311] and [Section 3.1.2.4/MQTT311]). If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 3.1 or 3.1.1. |
true |
2.12 |
|
CleanStart |
boolean |
W |
The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50]. If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.. This parameter only applies if ProtocolVersion is set to 5.0. |
true |
2.13 |
|
WillEnable |
boolean |
W |
Enables or disables the will handling (see [Section 3.1/MQTT311], [Section 3.1.2.5/MQTT311]) or [Section 3.1.2.5/MQTT50]). If the connection gets enabled and this parameter is set to true and either the parameter WillTopic or WillValue are an empty string, the CPE MUST set the Status to Error_Misconfigured. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.. |
- |
2.12 |
|
WillQoS |
unsignedInt(0:2) |
W |
The MQTT QoS level assigned with the will message (see [Section 3.1/MQTT311], [Section 3.1.2.6/MQTT311]) or [Section 3.1.2.6/MQTT50]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
- |
2.12 |
|
WillRetain |
boolean |
W |
Indicate to the MQTT broker to retain the Will over a Disconnect (see [Section 3.1/MQTT311], [Section 3.1.2.7/MQTT311]) or [Section 3.1.2.7/MQTT50]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
- |
2.12 |
|
KeepAliveTime |
unsignedInt(:65535) |
W |
Keep Alive Time in seconds defines the maximum wait time after which a packet has to be sent to the MQTT broker (see [Section 3.1/MQTT311], [Section 3.1.2.10/MQTT311]) or [Section 3.1.2.10/MQTT50]). If no regular packet can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive packets are sent and the MQTT client is not disconnected by the server. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
60 |
2.12 |
|
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 |
|
SessionExpiryInterval |
unsignedInt |
W |
{{div|{{classes}}|Session expiry interval in {{units}} defines the wait time before a session expires after the connection has been closed by the MQTT client {{bibref|MQTT50|section 3.1.2.11.2}}). {{template|MQTT50ONLY}}}} Session expiry interval in seconds defines the wait time before a session expires after the connection has been closed by the MQTT client [Section 3.1.2.11.2/MQTT50]). This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
ReceiveMaximum |
unsignedInt |
W |
The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see [Section 3.1.2.11.3/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
MaximumPacketSize |
unsignedInt |
W |
The maximum packet size in byte the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet [Section 3.1.2.11.4/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
TopicAliasMaximum |
unsignedInt(:65535) |
W |
This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see [Section 3.1.2.11.5/MQTT50]). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection. A value of 0 indicates that Topic Alias is not supported. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
RequestResponseInfo |
boolean |
W |
The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see [Section 3.1.2.11.6/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
RequestProblemInfo |
boolean |
W |
This value indicates whether the Reason String or User Properties are sent in the case of failures.(see [Section 3.1.2.11.7/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
AuthenticationMethod |
string(0:256) |
W |
This value defines the extended authentication method to be used (see [Section 3.1.2.11.9/MQTT50]). If the parameter is empty, no extended authentication is performed. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
ClientID |
string(0:65535) |
W |
The MQTT client identifier used in the MQTT CONNECT packet (see [Section 3.1/MQTT311], [Section 3.1.3.1/MQTT311]) or [Section 3.1.3.1/MQTT50]). If ProtocolVersion is set to 3.1 or 3.1.1, this parameter MUST NOT be an empty string. If ProtocolVersion is set to 5.0, an empty string is allowed. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
- |
2.12 |
|
WillDelayInterval |
unsignedInt |
W |
The delay in seconds after the session is disconnected, before sending the Will message [Section 3.1.3.2.2/MQTT50]). A value of 0 indicates that there is no delay. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
5 |
2.13 |
|
WillMessageExpiryInterval |
unsignedInt |
W |
{{div|{{classes}}|The lifetime in {{units}} of a Will Message (see {{bibref|MQTT50|section 3.1.3.2.4}}). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. {{template|MQTT50ONLY}}}} The lifetime in seconds of a Will Message (see [Section 3.1.3.2.4/MQTT50]). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
WillContentType |
string(:256) |
W |
Describes the type of the WillValue [Section 3.1.3.2.5/MQTT50]). A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
WillResponseTopic |
string(:65535) |
W |
Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request [Section 3.1.3.2.6/MQTT50]). If the WillResponseTopic is an empty string the will response topic will not be sent in a MQTT CONNECT packet. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
WillTopic |
string(:65535) |
W |
The Topic sent in the Will Message (see [Section 3.1/MQTT311], [Section 3.1.3.3/MQTT311]) or [Section 3.1.3.3/MQTT50]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
- |
2.12 |
|
WillValue |
string(:65535) |
W |
The value sent in the Will Message (see [Section 3.1/MQTT311], [Section 3.1.2.5/MQTT311]) or [Section 3.1.3.4/MQTT50]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
- |
2.12 |
|
Username |
string(:256) |
W |
Username used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see [Section 3.1/MQTT311], [Section 3.1.3.4/MQTT311] or [Section 3.1.3.5/MQTT50]). For MQTT 3.1 {{bibref|MQTT31|section 3.1}} recommends that the user name has 12 characters or fewer, but this is not required. If this parameter is an empty string no authentication parameters are sent in the MQTT CONNECT packet. |
- |
2.12 |
|
Password |
string(:256) |
W |
Password used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see [Section 3.1/MQTT311], [Section 3.1.3.5/MQTT311] or [Section 3.1.3.6/MQTT50]). This password is only sent in the MQTT CONNECT packet if Username is not an empty string. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
PublishMessageExpiryInterval |
unsignedInt |
W |
{{div|{{classes}}|The lifetime in {{units}} of a PUBLISH Message (see {{bibref|MQTT50|section 3.3.2.3.3}}). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. {{template|MQTT50ONLY}}}} The lifetime in seconds of a PUBLISH Message (see [Section 3.3.2.3.3/MQTT50]). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. This parameter only applies if ProtocolVersion is set to 5.0. |
- |
2.13 |
|
MessageRetryTime |
unsignedInt(1:) |
W |
Message retry time in seconds defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see [Section 4.2/MQTT311]). This parameter only applies if ProtocolVersion is set to 3.1. |
5 |
2.12 |
|
ConnectRetryTime |
unsignedInt(1:) |
W |
Connect retry time in seconds defines the wait time before a failed MQTT broker connection is retried. A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. If the parameter ConnectRetryIntervalMultiplier is defined, the MQTT client MUST use a random value between ConnectRetryTime*(ConnectRetryIntervalMultiplier/1000)^(n-1) and ConnectRetryTime*(ConnectRetryIntervalMultiplier/1000)^n for the connect retry time, with n equals the current retry number. The max number of n is 10, starting with the 11th retry always the value n = 10 is used. If the parameters ConnectRetryIntervalMultiplier and ConnectRetryMaxInterval are defined, the MQTT client MUST use the value of ConnectRetryMaxInterval if the calculated random value exceeds the value of ConnectRetryMaxInterval. |
5 |
2.12 |
|
ConnectRetryIntervalMultiplier |
unsignedInt(1000:65535) |
W |
{{div|{{classes}}|Configures the retry interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.}} Configures the retry interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. |
2000 |
2.13 |
|
Device.MQTT.Client.{i}.Subscription.{i}. |
object(0:) |
W |
{{div|{{classes}}|List of MQTT subscriptions handled by the MQTT client. The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter {{param|Enable}} is set to {{true}}, when it establishes a new connection to the MQTT broker. Disabled subscription instances with {{param|Enable}} set to {{false}} will be ignored during connection establishment.}} List of MQTT subscriptions handled by the MQTT client. The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter Enable is set to true, when it establishes a new connection to the MQTT broker. Disabled subscription instances with Enable set to false will be ignored during connection establishment. At most one entry in this table can exist with a given value for Alias, or with a given value for Topic. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Topic such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|When a MQTT client connects to a MQTT server, it MUST send a SUBSCRIBE message including all instances with {{param}} set to {{true}}. If the MQTT client is already connected with the MQTT server ({{param|#.Status}} is {{enum|Connected|#.Status}}), a MQTT SUBSCRIBE or UNSUBSCRIBE message MUST be sent directly when {{param}} is changed to {{true}} or {{false}}, respectively. The actual status of the subscription is indicated with {{param|Status}}.}} When a MQTT client connects to a MQTT server, it MUST send a SUBSCRIBE message including all instances with Enable set to true. If the MQTT client is already connected with the MQTT server (Status is Connected), a MQTT SUBSCRIBE or UNSUBSCRIBE message MUST be sent directly when Enable is changed to true or false, respectively. The actual status of the subscription is indicated with Status. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of this subscription. Enumeration of:
|
- |
2.12 |
|
Topic |
string(:65535) |
W |
Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in [Section Appendix A/MQTT311], [Section 4.7/MQTT311] or [Section 4.7/MQTT50]. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
QoS |
unsignedInt(0:2) |
W |
The MQTT QoS level assigned with the subscription (see [Section 4.1/MQTT311], [Section 4.3/MQTT311]) or [Section 4.3/MQTT50]. |
- |
2.12 |
|
Device.MQTT.Client.{i}.UserProperty.{i}. |
object(0:) |
W |
{{div|{{classes}}|List of user properties used by the MQTT client. This table only applies if {{param|#.ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}.}} List of user properties used by the MQTT client. This table only applies if ProtocolVersion is set to 5.0. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.13 |
|
Device.MQTT.Client.{i}.Stats. |
object |
R |
{{div|{{classes}}|Contains the MQTT client statistics and usage information. The CPE MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. {{param|#.BrokerAddress}} has changed). The CPE MAY retain the values across a reboot if it reconnects with the same MQTT broker.}} Contains the MQTT client statistics and usage information. The CPE MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. BrokerAddress has changed). The CPE MAY retain the values across a reboot if it reconnects with the same MQTT broker. |
- |
2.12 |
|
Device.MQTT.Broker.{i}. |
object(0:) |
W |
MQTT broker table. Contains a list of configured MQTT brokers. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of the MQTT broker. Enumeration of:
|
- |
2.12 |
|
Username |
string(:256) |
W |
{{div|{{classes}}|User name used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is {{empty}} no authentication is used.}} User name used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is an empty string no authentication is used. |
- |
2.12 |
|
Password |
string(:256) |
W |
{{div|{{classes}}|Password used used to authenticate the MQTT clients, which connect to the MQTT broker. This password is only used if {{param|Username}} is not {{empty}}.}} Password used used to authenticate the MQTT clients, which connect to the MQTT broker. This password is only used if Username is not an empty string. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
Device.MQTT.Broker.{i}.Bridge.{i}. |
object(0:) |
W |
Configures MQTT bridges, which are used to communicate with other MQTT brokers. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of this MQTT Bridge. Enumeration of:
This enumeration was DELETED in 2.11 because it's covered by Connecting and Connected. Changes since 2.14:
)
|
- |
2.12 |
|
CleanSession |
boolean |
W |
The value of the MQTT clean session flag in the MQTT CONNECT packet (see [Section 3.1/MQTT311] and [Section 3.1.2.4/MQTT311]) to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. This parameter only applies if ProtocolVersion is set to 3.1 or 3.1.1. |
true |
2.12 |
|
CleanStart |
boolean |
W |
The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50] to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.. This parameter only applies if ProtocolVersion is set to 5.0. |
true |
2.13 |
|
KeepAliveTime |
unsignedInt(:65535) |
W |
Keep Alive Time in seconds defines the maximum wait time after which a packet has to be sent to the remote MQTT broker (see [Section 3.1/MQTT311], [Section 3.1.2.10/MQTT311]) or [Section 3.1.2.10/MQTT50]). If no regular packet can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive packets are sent and the bridge is not disconnected by the server. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
60 |
2.12 |
|
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 |
|
ClientID |
string(0:65535) |
W |
The MQTT client identifier used in the CONNECT packet (see [Section 3.1/MQTT311], [Section 3.1.3.1/MQTT311]) or [Section 3.1.3.1/MQTT50]). If ProtocolVersion is set to 3.1 or 3.1.1, this parameter MUST NOT be an empty string. If ProtocolVersion is set to 5.0, an empty string is allowed. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed. |
- |
2.12 |
|
Username |
string(:256) |
W |
User name used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see [Section 3.1/MQTT311], [Section 3.1.3.4/MQTT311] or [Section 3.1.3.5/MQTT50]). For MQTT 3.1 {{bibref|MQTT31|section 3.1}} recommends that the user name has 12 characters or fewer, but this is not required. If this parameter is an empty string no authentication parameters are sent in the MQTT CONNECT packet. |
- |
2.12 |
|
Password |
string(:256) |
W |
Password used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see [Section 3.1/MQTT311], [Section 3.1.3.5/MQTT311] or [Section 3.1.3.6/MQTT50]). This password is only sent in the MQTT CONNECT packet if Username is not an empty string. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.12 |
|
MessageRetryTime |
unsignedInt(1:) |
W |
Message retry time in seconds defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see [Section 4.2/MQTT311]. This parameter only applies if ProtocolVersion is set to 3.1. |
5 |
2.12 |
|
ConnectRetryTime |
unsignedInt(1:) |
W |
{{div|{{classes}}|Connect retry time in {{units}} defines the wait time before a failed bridge connection is retried. A failure can either be on the connection level (e.g. the TCP/IP or TLS connection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent.}} Connect retry time in seconds defines the wait time before a failed bridge connection is retried. A failure can either be on the connection level (e.g. the TCP/IP or TLS connection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. |
30 |
2.12 |
|
Device.MQTT.Broker.{i}.Bridge.{i}.Server.{i}. |
object(0:) |
W |
Each Server instance represents a MQTT bridge server to be used for a Bridge. A remote MQTT broker, which is connected by a MQTT bridge can be reachable via several host addresses each represented by its own Server table entry. For an active MQTT bridge at least one enabled entry has to exist. If a MQTT bridge gets enabled by setting the parameter Bridge.{i}.Enable to true, which either has an empty Server table or the Server table only contains instances whose Enable is set to false, the Bridge.{i}.Status has to be set to Error_Misconfigured. Any attempt to delete an instance, which is currently in use (Bridge.{i}.ServerConnection refers to the instance to be deleted), has to be rejected. At most one entry in this table can exist with a given value for Alias, or with the same values for both Address and Port. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Address such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Priority |
unsignedInt(0:65535) |
W |
{{div|{{classes}}|The priority of this {{object}} that is used by the {{object|##.Bridge}} when determining the {{object}} to connect to. The {{object|##.Bridge}} MUST contact the {{object}} with the lowest-numbered priority that the {{object|##.Bridge}} can reach as defined in {{bibref|RFC2782}}. The selection of {{object}}s with the same {{param}} value utilizes the {{param|Weight}} parameter to determine which {{object}} is selected by the {{object|##.Bridge}}. This value is only used if {{param|##.Bridge.{i}.ServerSelectionAlgorithm}} is set to {{enum|Priority|##.Bridge.{i}.ServerSelectionAlgorithm}}.}} The priority of this Server that is used by the Bridge when determining the Server to connect to. The Bridge MUST contact the Server with the lowest-numbered priority that the Bridge can reach as defined in [RFC2782]. The selection of Servers with the same Priority value utilizes the Weight parameter to determine which Server is selected by the Bridge. This value is only used if Bridge.{i}.ServerSelectionAlgorithm is set to Priority. |
- |
2.12 |
|
Weight |
long(-1:65535) |
W |
{{div|{{classes}}|This parameter specifies a relative weight for entries with the same {{param|Priority}}. The mechanism is defined in {{bibref|RFC2782}}. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. This value is only used if {{param|##.Bridge.{i}.ServerSelectionAlgorithm}} is set to {{enum|Priority|##.Bridge.{i}.ServerSelectionAlgorithm}}.}} This parameter specifies a relative weight for entries with the same Priority. The mechanism is defined in [RFC2782]. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. This value is only used if Bridge.{i}.ServerSelectionAlgorithm is set to Priority. |
- |
2.12 |
|
Address |
string(:256) |
W |
{{div|{{classes}}|Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this {{object|##.Bridge}} connects to. If the value of this parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attempted (in an implementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next {{object}} instance (based on rules defined over the selected {{param|##.Bridge.{i}.ServerSelectionAlgorithm}}) SHOULD be used.}} Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this Bridge connects to. If the value of this parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attempted (in an implementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on rules defined over the selected Bridge.{i}.ServerSelectionAlgorithm) SHOULD be used. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}. |
object(0:) |
W |
List of MQTT subscriptions handled over the bridge. At most one entry in this table can exist with a given value for Alias, or with the same values for both Topic and Direction. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Topic and Direction such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Setting Enable to {{true}} activates the handling of this subscription instance. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic is subscribed over the bridge at the remote MQTT broker with a MQTT SUBSCRIBE message if {{param}} is set to {{true}} or unsubscribed from the remote MQTT broker with a MQTT UNSUBSCRIBE message if the value is set to {{false}}. The actual status of the subscription is indicated with {{param|Status}}.}} Setting Enable to true activates the handling of this subscription instance. In case of incoming directions (Direction is either in or both) the topic is subscribed over the bridge at the remote MQTT broker with a MQTT SUBSCRIBE message if Enable is set to true or unsubscribed from the remote MQTT broker with a MQTT UNSUBSCRIBE message if the value is set to false. The actual status of the subscription is indicated with Status. |
- |
2.12 |
|
Status |
string |
R |
Indicates the status of this subscription. Enumeration of:
|
- |
2.12 |
|
Topic |
string(:65535) |
W |
Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in [Section Appendix A/MQTT311], [Section 4.7/MQTT311] or [Section 4.7/MQTT50]. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Direction) doesn't conflict with any existing entries. |
- |
2.12 |
|
QoS |
unsignedInt(0:2) |
W |
The MQTT QoS level assigned with the subscription (see [Section 4.1/MQTT311], [Section 4.3/MQTT311]) or [Section 4.3/MQTT50]. |
- |
2.12 |
|
LocalPrefix |
string(:256) |
W |
The local prefix is used for remapping received topics to the local topics of the MQTT broker and to select the topics to be sent over bridge to the remote MQTT broker.
|
- |
2.12 |
|
RemotePrefix |
string(:256) |
W |
The remote prefix is used for remapping topics to the remote MQTT broker topic lists.
|
- |
2.12 |
|
Device.DynamicDNS. |
object |
R |
Properties for Dynamic DNS. |
- |
2.12 |
|
Device.DynamicDNS.Client.{i}. |
object(0:) |
W |
Client properties for Dynamic DNS. A dynamic DNS client is responsible for verifying IP address changes and updating information from a subscribed account on a Dynamic DNS Server. For enabled table entries, if Server is not a valid reference then the table entry is inoperable and the CPE MUST set the Status to Error_Misconfigured. At most one entry in this table can exist with the same values for both Server and Username, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Server, Username and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
LastError |
string |
R |
{{div|{{classes}}|The last error this Dynamic DNS Client has encountered. The parameter MAY instead indicate a vendor-specific cause, which MUST use the format defined in {{bibref|TR-106}}.}} The last error this Dynamic DNS Client has encountered. The parameter MAY instead indicate a vendor-specific cause, which MUST use the format defined in [TR-106]. Enumeration of:
|
- |
2.12 |
|
Server |
string(:256) |
W |
{{div|{{classes}}|The DynamicDNS server associated with this Dynamic DNS Client. {{reference}}}} The DynamicDNS server associated with this Dynamic DNS Client. The value MUST be the Path Name of a row in the Device.DynamicDNS.Server. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Username) doesn't conflict with any existing entries. |
- |
2.12 |
|
Interface |
string(:256) |
W |
The IP interface over which update queries to the server are sent. The value MUST be the Path Name of a row in the Device.IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), to determine the appropriate interface. |
- |
2.12 |
|
Device.DynamicDNS.Client.{i}.Hostname.{i}. |
object(0:) |
W |
Each table entry represents a fully qualified domain name updated by this Dynamic DNS Client. At most one entry in this table can exist with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Name |
string(:256) |
W |
{{div|{{classes}}|Fully qualified domain name that has to be updated with the IP address. If the name is set to another value, the Client MUST immediately send an update request to the Server.}} Fully qualified domain name that has to be updated with the IP address. If the name is set to another value, the Client MUST immediately send an update request to the Server. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.DynamicDNS.Server.{i}. |
object(0:) |
W |
Table of Dynamic DNS servers available for this CPE. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Name and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
ServiceName |
string(:256) |
W |
{{div|{{classes}}|Dynamic DNS service used to contact this server. {{reference}}}} Dynamic DNS service used to contact this server. The value MUST be a member of the list reported by the Device.DynamicDNS.SupportedServices parameter. |
- |
2.12 |
|
CheckInterval |
unsignedInt |
W |
{{div|{{classes}}|Interval (in {{units}}) between two checks for IP change. A value of zero indicates that the CPE knows when IP changes and doesn’t need to check it periodically.}} Interval (in seconds) between two checks for IP change. A value of zero indicates that the CPE knows when IP changes and doesn’t need to check it periodically. |
- |
2.12 |
|
MaxRetries |
unsignedInt |
W |
{{div|{{classes}}|Maximum number of retries after a failed request. When the maximum number is reached, no further requests are sent until the context changes. A value of 0 means that there are no retries after a failed request.}} Maximum number of retries after a failed request. When the maximum number is reached, no further requests are sent until the context changes. A value of 0 means that there are no retries after a failed request. |
- |
2.12 |
|
Device.LEDs. |
object |
R |
This object describes the LEDs on the device. |
- |
2.12 |
|
Device.LEDs.LED.{i}. |
object(0:) |
R |
Each instance of this object describes an LED on the device. The default illumination characteristics (e.g., Color, Brightness) of an in use LED is vendor specific. When a cycle completes (i.e., CyclePeriodRepetitions = 0), the LED reverts back to its default illumination characteristics. When the value of the Status parameter is Controlled, then the value of CycleElementNumberOfEntries and CycleElementNumberOfEntries parameters SHOULD be 0. When the value of the RelativeXPosition and RelativeYPosition parameters are 0, this indicates that the position of the LED is unknown. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.12 |
|
Device.LEDs.LED.{i}.CycleElement.{i}. |
object(0:) |
W |
Each instance of this object describes the LED characteristics for a portion of the LED cycle period. The pattern of lighting for the LED corresponding to this table (i.e., the LED cycle period) is defined by the illumination of the LED according to the entries in this table, taken sequentially in the order specified by the Order parameter, with the duration for the portion of the LED illumination corresponding to a given instance specified by the Duration parameter. The other parameters of the instance of this object (e.g., Color, Brightness) describes the illumination characteristics applied to the LED for this CycleElement instance. The length of the complete LED cycle is the sum of the Duration parameters for all of the entries in this table. At most one entry in this table can exist with a given value for Order, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Order and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Color |
hexBinary(3) |
W |
{{div|{{classes}}|The color being displayed by the LED RGB hexadecimal notation (e.g., FF0088). Note: If the parameter is set to an unsupported color the CPE MUST NOT infer a different color.}} The color being displayed by the LED RGB hexadecimal notation (e.g., FF0088). Note: If the parameter is set to an unsupported color the CPE MUST NOT infer a different color. |
- |
2.12 |
|
FadeInterval |
unsignedInt |
W |
{{div|{{classes}}|The interval corresponding to this {{object}} instance, in {{units}}, from the starting from the target illumination characteristics of the previous {{object}} instance to the target illumination characteristics of this {{object}} instance. The transition to the target illumination characteristics is uniformly interpolated "perceptually" over the value of this {{param}} parameter.}} The interval corresponding to this CycleElement instance, in milliseconds, from the starting from the target illumination characteristics of the previous CycleElement instance to the target illumination characteristics of this CycleElement instance. The transition to the target illumination characteristics is uniformly interpolated "perceptually" over the value of this FadeInterval parameter. |
- |
2.12 |
|
Device.LEDs.LED.{i}.CurrentCycleElement. |
object |
R |
This object describes the status of the current cycle element for this LED. |
- |
2.12 |
|
CycleElementReference |
string |
R |
{{div|{{classes}}|This object describes the current properties of the {{object|#.CycleElement.{i}}} object instance that is currently active. {{reference}} If the LED instances does not have a current cycle element active, this parameter MUST be set to {{empty}}.}} This object describes the current properties of the CycleElement.{i} object instance that is currently active. The value MUST be the Path Name of a row in the CycleElement. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the LED instances does not have a current cycle element active, this parameter MUST be set to an empty string. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.BASAPM. |
object |
R |
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 |
|
Device.BASAPM.MeasurementEndpoint.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and MeasurementAgent such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this MeasurementEndpoint instance. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
DeviceOwnership |
string |
W |
{{div|{{classes}}|This parameter describes the ownership of the device that hosts the measurement endpoint. {{enum}}}} This parameter describes the ownership of the device that hosts the measurement endpoint. Enumeration of:
|
- |
2.12 |
|
Device.BASAPM.MeasurementEndpoint.{i}.ISPDevice. |
object |
R |
This object represents the information necessary to utilize an ISP owned device within the measurement endpoint. |
- |
2.12 |
|
ReferencePoint |
string |
W |
{{div|{{classes}}|This parameter describes the measurement reference point of the measurement endpoint. {{enum}}}} This parameter describes the measurement reference point of the measurement endpoint. Enumeration of:
|
- |
2.12 |
|
Device.LMAP. |
object |
R |
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 |
|
Device.LMAP.MeasurementAgent.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Identifier such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this MeasurementAgent instance. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}. |
object(0:) |
R |
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 |
|
TaskCapabilityRegistryNumberOfEntries |
unsignedInt |
R |
The number of entries in the associated table. Changes since 2.14:
|
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Controller. |
object |
R |
This objects represents the measurement controller that is assigned to a measurement agent. |
- |
2.12 |
|
ControllerTimeout |
int(0:) |
W |
{{div|{{classes}}|The timer, in {{units}}, 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.}} 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 |
{{div|{{classes}}|{{list}} {{reference|a {{object|#.Schedule}} object}} This parameter lists the available control schedules for invoking control tasks by the measurement agent.}} 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 |
{{div|{{classes}}|{{list}} {{reference|a {{object|#.Task}} object}} This parameter lists the available control tasks that can be invoked by the measurement agent.}} 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 |
{{div|{{classes}}|{{list}} {{reference|a {{object|#.CommunicationChannel}} object}} 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 {{bibref|LMAPIFM}}.}} 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(0:) |
W |
{{div|{{classes}}|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 {{object}} are gracefully terminated by the defining either the {{param|End}} or {{param|Duration}} parameters. Only one of these parameters may be defined at a time.}} 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
- |
2.12 |
|
State |
string |
R |
{{div|{{classes}}|The current operational state of the Schedule. Only one instance of the schedule is active. An active schedule is defined where the {{param}} parameter has a value of {{enum|Running|State}}. {{enum}}}} 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. Enumeration of:
|
- |
2.12 |
|
ExecutionMode |
string |
W |
{{div|{{classes}}|This parameter describes the execution method to apply to this schedule for the associated Actions. {{enum}}}} This parameter describes the execution method to apply to this schedule for the associated Actions. Enumeration of:
|
Pipelined |
2.12 |
|
Storage |
unsignedLong |
R |
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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object|##.Schedule.{i}.Action}} object. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this Schedule.{i}.Action object. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Storage |
unsignedLong |
R |
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. Value Change Notification requests for this parameter MAY be denied. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
- |
2.12 |
|
Name |
int |
W |
{{div|{{classes}}|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.}} 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. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Task.{i}. |
object(0:) |
W |
{{div|{{classes}}|The {{object}} object defines the configuration for a task that can be performed by {{object|##.MeasurementAgent}} objects. Tasks are performed by {{object|##.MeasurementAgent}} objects when a {{object|#.Schedule}} object invokes the Task.}} 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for RegistryEntry and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
- |
2.12 |
|
Name |
int |
W |
{{div|{{classes}}|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.}} 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. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}. |
object(0:) |
W |
{{div|{{classes}}|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 {{param|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 {{object|###.BulkData.Profile.{i}}} object instance referred to by this object.}} 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this CommunicationChannel instance. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this Instruction instance. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
InstructionSchedules |
string[] |
W |
{{div|{{classes}}|{{list}} {{reference|a {{object|#.Schedule}} object}} This parameter lists the available instruction schedules for invoking control tasks by the measurement agent.}} 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 |
{{div|{{classes}}|{{list}} {{reference|a {{object|#.Task}} object}} This parameter lists the available instruction tasks that can be invoked by the measurement agent.}} 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 |
{{div|{{classes}}|{{list}} {{reference|a {{object|#.CommunicationChannel}} object}} This parameter defines the corresponding report channels to be used when reporting results of tasks to a measurement collector.}} 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 |
|
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this MeasurementSuppression instance. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.12 |
|
Device.LMAP.Report.{i}. |
object(0:) |
R |
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 |
|
Device.LMAP.Report.{i}.Result.{i}. |
object(0:) |
R |
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 the same values for all of ScheduleName, ActionName and StartTime. |
- |
2.12 |
|
CycleNumber |
string |
R |
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 representrepresents an invalid CycleNumber. Possible patterns:
|
- |
2.12 |
|
ResultConflictNumberOfEntries |
unsignedInt |
R |
The number of entries in the associated table. Changes since 2.14:
|
- |
2.12 |
|
ResultReportTableNumberOfEntries |
unsignedInt |
R |
The number of entries in the ReportTable table. Changes since 2.14:
|
- |
2.12 |
|
Device.LMAP.Report.{i}.Result.{i}.Option.{i}. |
object(0:) |
R |
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 |
|
Name |
int |
R |
{{div|{{classes}}|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.}} 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 |
|
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}. |
object(0:) |
R |
This ReportTable object instances represents a row of results. |
- |
2.12 |
|
ColumnLabels |
string[] |
R |
{{div|{{classes}}|{{list}} This parameter contains the column labels used for the result. The column labels are ordered with the corresponding entries in the {{object|ResultRow}} table.}} 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 |
R |
The number of entries in the associated table. Changes since 2.14:
|
- |
2.12 |
|
Device.LMAP.Event.{i}. |
object(0:) |
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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}} instance. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} |
- |
2.12 |
|
Type |
string |
W |
{{div|{{classes}}|This parameter describes the type of {{object}} for this object instance. The timing of the event occurrence is adjusted based on the value of the {{param|RandomnessSpread}} parameter. {{enum}}}} 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. Enumeration of:
|
Immediate |
2.12 |
|
Device.LMAP.Event.{i}.CalendarTimer. |
object |
R |
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 |
|
ScheduleMonths |
string |
W |
{{div|{{classes}}|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)).}} 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 |
|
ScheduleDaysOfWeek |
string |
W |
{{div|{{classes}}|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)).}} 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 |
|
EnableScheduleTimezoneOffset |
boolean |
W |
{{div|{{classes}}|When {{true}}, the value of the {{param|ScheduleTimezoneOffset}} parameter is applied to the schedule elements. When {{false}}, the device's system timezone offset is applied to the schedule elements.}} 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 |
|
Device.WWC. |
object |
R |
Base object for Wireline Wireless Convergence. The controller can use this object to learn the supported 5G features and whether the 5G-RG is operating in 5G mode. |
- |
2.14 |
|
Device.WWC.AccessNetwork.{i}. |
object(0:) |
R |
Each table entry describes a single access network. The entire table is built by the 5G-RG upon startup. The primary purpose is to show the registration and connectivity status of each access network. Typically a 5G-RG would register on each available access network. A minimum of one access network must be in the CM-CONNECTED state in order to support N1 messaging. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.14 |
|
RegistrationStatus |
string |
R |
{{div|{{classes}}|The registration status of this entry. See {{bibref|3GPP-TS.23.501|Clause 5.3.2}}. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The registration status of this entry. See [Clause 5.3.2/3GPP-TS.23.501]. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.14 |
|
ConnectionStatus |
string |
R |
{{div|{{classes}}|The connection status of this entry. A 5G-RG is deemed in the {{enum|CM_CONNECTED|ConnectionStatus}} state if there is a NAS signalling connection established between the 5G-RG and AMF. If {{param|RegistrationStatus}} transitions from {{enum|RM_REGISTERED|RegistrationStatus}} to {{enum|RM_DEREGISTERED|RegistrationStatus}}, the status of {{param}} must change to {{enum|CM_UNDEFINED||ConnectionStatus}}. See {{bibref|3GPP-TS.23.501|Clause 5.3.3}}. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.}} The connection status of this entry. A 5G-RG is deemed in the CM_CONNECTED state if there is a NAS signalling connection established between the 5G-RG and AMF. If RegistrationStatus transitions from RM_REGISTERED to RM_DEREGISTERED, the status of ConnectionStatus must change to CM_UNDEFINED. See [Clause 5.3.3/3GPP-TS.23.501]. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.14 |
|
Device.WWC.AccessNetwork.{i}.GUTI. |
object |
R |
{{div|{{classes}}|A 5G Globally Unique Temparary Identity (GUTI) securely identifes an CPE by keeping the permanent User Equipment (UE identifier (IMSI) hidden. This identity is globally unique and assigned by the AMF at the time of registration. See {{bibref|3GPP-TS.23.003|.Clause 2.10}}.}} A 5G Globally Unique Temparary Identity (GUTI) securely identifes an CPE by keeping the permanent User Equipment (UE identifier (IMSI) hidden. This identity is globally unique and assigned by the AMF at the time of registration. See [.Clause 2.10/3GPP-TS.23.003]. |
- |
2.14 |
|
PLMN |
unsignedInt |
R |
The Public Land Mobile Network (PLMN) globally identifies the service provider. A PLMN consists of a country code (MCC) and a network code (MNC). See [Clause 12.1/3GPP-TS.23.003]. For example, a PLMN of 50101 refers to MCC 501 (Australia) and MNC 01 (Telstra). |
- |
2.14 |
|
AMFId |
unsignedInt |
R |
{{div|{{classes}}|The AMFId identifies an AMF instance within a service provider's network. In conjunction with the PLMN, it forms a Globally Unique AMF Id (GUAMI) which globally uniquely identifes an AMF. See {{bibref|3GPP-TS.23.003|Clause 2.10}}.}} The AMFId identifies an AMF instance within a service provider's network. In conjunction with the PLMN, it forms a Globally Unique AMF Id (GUAMI) which globally uniquely identifes an AMF. See [Clause 2.10/3GPP-TS.23.003]. |
- |
2.14 |
|
TMSI |
unsignedInt |
R |
{{div|{{classes}}|The Temporary Mobile Subscriber Identity (TMSI) is allocatred by the AMF at the time of registration and uniquely identifies the CPE. See {{bibref|3GPP-TS.23.003|Clause 2.4}}.}} The Temporary Mobile Subscriber Identity (TMSI) is allocatred by the AMF at the time of registration and uniquely identifies the CPE. See [Clause 2.4/3GPP-TS.23.003]. |
- |
2.14 |
|
Device.WWC.URSP.{i}. |
object(0:) |
R |
{{div|{{classes}}|User equipment Router Selection Policy (URSP) is a table of rules used to determine which network slice and data network to route a PDU over. Typically a 5G-RG would search the URSP table in precedence order matching the traffic descriptor types against the service it was setting up. For example a 5G-RG would search for 'connection capabilities' matching 'ims' in order to establish a dedicated PDU session for telephony. See {{bibref|3GPP-TS.24.526|Clause 5.2}} for a full descrption of the URSP data elements.}} User equipment Router Selection Policy (URSP) is a table of rules used to determine which network slice and data network to route a PDU over. Typically a 5G-RG would search the URSP table in precedence order matching the traffic descriptor types against the service it was setting up. For example a 5G-RG would search for 'connection capabilities' matching 'ims' in order to establish a dedicated PDU session for telephony. See [Clause 5.2/3GPP-TS.24.526] for a full descrption of the URSP data elements. At most one entry in this table can exist with a given value for Alias, or with a given value for Precedence. |
- |
2.14 |
|
Device.WWC.URSP.{i}.TrafficDescriptor.{i}. |
object(0:) |
R |
A set of rules for a given precedence that must be matched in order to select a router in the form of data network and slice. Selection criteria range from destination IP addresses to connection capabilities. At most one entry in this table can exist with a given value for Alias. |
- |
2.14 |
|
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}. |
object(0:) |
R |
{{div|{{classes}}|This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established. See ((bibref\|3GPP-TS.23.503\|Annex A}} This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established. See ((bibref|3GPP-TS.23.503|Annex A for an example URSP rule traversal.}} At most one entry in this table can exist with a given value for Alias, or with a given value for Precedence. |
- |
2.14 |
|
AccessType |
string |
R |
{{div|{{classes}}|The preferred access type for the PDU session. For a 5G-RG non-3GPP refers to any fixed access technology. See {{bibref|3GPP-TS.24.501|Clause 9.11.3.11}}. {{enum}}}} The preferred access type for the PDU session. For a 5G-RG non-3GPP refers to any fixed access technology. See [Clause 9.11.3.11/3GPP-TS.24.501]. Enumeration of:
|
- |
2.14 |
|
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}.NetworkSlice. |
object |
R |
{{div|{{classes}}|Describes a S-NSSAI Information element providing network slice specification. See {{bibref|3GPP-TS.24.501|Clause 9.11.2.8}}}} Describes a S-NSSAI Information element providing network slice specification. |
- |
2.14 |
|
SliceServiceType |
string |
R |
[SST] {{div|{{classes}}|The Slice Service Type (SST). {{enum}} See {{bibref|3GPP-TS.23.501|Clause 5.15.2.2}}.}} The Slice Service Type (SST). Enumeration of:
|
- |
2.14 |
|
SliceDifferentiator |
unsignedInt |
R |
{{div|{{classes}}|The Slice differentiator is an optional number used to differentiate network slices with the same SST. See {{bibref|3GPP-TS.23.501|Clause 5.15.2.1}}.}} The Slice differentiator is an optional number used to differentiate network slices with the same SST. |
- |
2.14 |
|
Device.PDU. |
object |
R |
The logical connection between the 5G-RG and data network is the Protocol Data Unit (PDU). The Device.PDU subtree describes each PDU sessions properties together with the QoS rules specific to that PDU session. |
- |
2.14 |
|
Device.PDU.Session.{i}. |
object(0:) |
R |
Contains all the properties of a PDU session instance, ranging from maximum bitrate through to assigned network slice. This object contains the Session table. At most one entry in this table can exist with a given value for Alias, or with a given value for SessionID. |
- |
2.14 |
|
AlwaysOn |
boolean |
R |
{{div|{{classes}}|Always on PDU session indication. The purpose of the Always-on PDU session indication information element is to indicate whether a PDU session is established as an always-on PDU session. See {{bibref|3GPP-TS.24.501|clause 9.11.4.3}}.}} Always on PDU session indication. The purpose of the Always-on PDU session indication information element is to indicate whether a PDU session is established as an always-on PDU session. |
- |
2.14 |
|
Device.PDU.Session.{i}.NetworkSlice. |
object |
R |
{{div|{{classes}}|Describes a S-NSSAI Information element providing network slice specification. See {{bibref|3GPP-TS.24.501|Clause 9.11.2.8}}}} Describes a S-NSSAI Information element providing network slice specification. |
- |
2.14 |
|
SliceServiceType |
string |
R |
[SST] {{div|{{classes}}|The Slice Service Type (SST). {{enum}} See {{bibref|3GPP-TS.23.501|Clause 5.15.2.2}}.}} The Slice Service Type (SST). Enumeration of:
|
- |
2.14 |
|
SliceDifferentiator |
unsignedInt |
R |
{{div|{{classes}}|The Slice differentiator is an optional number used to differentiate network slices with the same SST. See {{bibref|3GPP-TS.23.501|Clause 5.15.2.1}}.}} The Slice differentiator is an optional number used to differentiate network slices with the same SST. |
- |
2.14 |
|
Device.PDU.Session.{i}.QoSRule.{i}. |
object(0:) |
R |
This object describes the PDU QoS Rule table. The purpose of the QoS Rule table is to assign a QFI to mark traffic based on a set of classification rules. The rules are set by the netowrk operator and are specific for each PDU. For example:
At most one entry in this table can exist with a given value for Alias, or with a given value for Identifier. |
- |
2.14 |
|
Device.PDU.Session.{i}.QoSFlow.{i}. |
object(0:) |
R |
Table of all QoS Flow Indicators (QFI) and their properties supported by the access network for this particular PDU. For example:
At most one entry in this table can exist with a given value for Alias, or with a given value for QFI. |
- |
2.14 |
|
Device.FWE. |
object |
R |
5G Wireline wireless Encapsulation transport for data plane. See {{bibref: non-existent FWEREG}}. |
- |
2.14 |
|
Device.FWE.Link.{i}. |
object(0:) |
R |
5G Wireline wireless Encapsulation link layer 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. |
- |
2.14 |
|
Status |
string |
R |
{{div|{{classes}}|The current operational state of the link (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} This parameter is based on ifOperStatus from {{bibref|RFC2863}}.}} The current operational state of the link (see [Section 4.2.2/TR-181i2]). Enumeration of:
This parameter is based on ifOperStatus from [RFC2863]. |
- |
2.14 |
|
Device.FWE.Link.{i}.Stats. |
object |
R |
{{div|{{classes}}|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 {{param|#.Status}} parameter transitions to a down state after the interface is disabled). Operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.}} 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). Operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.14 |
|
Device.LocalAgent. |
object |
R |
{{div|{{classes}}|This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the {{object|.DeviceInfo}} object. NOTE: The Vendor Log File table ({{object|.DeviceInfo.VendorLogFile}}) details are located on the {{object|.DeviceInfo}} 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 |
|
SoftwareVersion |
string(:64) |
R |
{{div|{{classes}}|The current USP Agent software version; not the version of the overall device firmware, which is located in {{param|.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.}} 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 |
|
SupportedProtocols |
string[1:] |
R |
Comma-separated list (at least 1 item) of strings. USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol. Each list item is an enumeration of:
See [RFC7252]. This enumeration was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2. Changes since 2.14:
) |
- |
2.12 |
|
MaxSubscriptionChangeAdoptionTime |
unsignedInt(5:) |
W |
{{div|{{classes}}|The acceptable amount of time in {{units}} 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 {{units}}, then once a Subscription has been updated, the Agent has 30 {{units}} before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription).}} 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 |
|
TransferComplete! |
event |
- |
{{div|{{classes}}|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 {{param|FaultCode}} will be zero), or else has failed (in which case {{param|FaultCode}} will be non-zero and {{param|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 {{param|Command}}, {{param|CommandKey}} and {{param|Requestor}} give further details.}} 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 |
|
Device.LocalAgent.MTP.{i}. |
object(0:) |
W |
Each instance of this table represents a MTP used by the local Agent. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enable/Disable this {{object}} instance. If this {{object}} 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 SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. This parameter discriminates between the CoAP, STOMP, WebSocket, MQTT union objects. Changes since 2.14:
|
WebSocket |
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(0:1) |
R |
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. This object was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Device.LocalAgent.MTP.{i}.STOMP. |
object(0:1) |
R |
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. This object MUST be present if, and only if, Protocol is STOMP. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
DestinationFromServer |
string |
R |
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 MUST be set to 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(0:1) |
R |
If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. This object MUST be present if, and only if, Protocol is WebSocket. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Interfaces |
string[] |
W |
Comma-separated list of strings. {{div|{{classes}}|{{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}} {{empty}} will bind this server to all interfaces for this device.}} 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 |
|
Path |
string |
W |
The service path that is usedprovided by the WebSocket Server in order to receiveexchange USP messages. The value MUST be used as defined in [Section 3.3/RFC3986]. |
- |
2.12 |
|
KeepAliveInterval |
unsignedInt(1:) |
W |
The duration in seconds between when WebSocket ping control frames are transmitted by the Agent's WebSocket server to the Controller's WebSocket client. |
- |
2.15 |
|
Device.LocalAgent.MTP.{i}.MQTT. |
object(0:1) |
R |
If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how the Agent communicates with the MQTT broker. This object MUST be present if, and only if, Protocol is MQTT. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.13 |
|
PublishQoS |
unsignedInt(0:2) |
W |
{{div|{{classes}}|The Agent MUST use this QoS value when sending a USP Record on this MTP. If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server.}} The Agent MUST use this QoS value when sending a USP Record on this MTP. If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server. |
- |
2.13 |
|
Device.LocalAgent.Threshold.{i}. |
object(0:) |
W |
Each Threshold instance of this table represents a Threshold Event. ThresholdParam is monitored to determine if it has met the ThresholdOperator condition against ThresholdValue, when it meets the condition a Triggered! Event is sent. ThresholdParam may only reference integer parameters and ThresholdValue only usese integer values. For example: ReferencePath: Device.Ethernet.Interface.[Enable=="1"].Stats. ThresholdParam: BytesSent ThresholdOperator: Rise ThresholdValue: 100000 This would trigger a Triggered! Event whenever a value of a parameter matching Device.Ethernet.Interface.[Enable==1].Stats.BytesSent rises from below to above 100000.{{div|{{classes}}|When creating a {{object}}, if the {{param|ReferencePath}}, {{param|ThresholdParam}} or {{param|ThresholdValue}} are invalid (not in the supported Data Model), the object will not be created. If the concatenation of {{param|ReferencePath}} and {{param|ThresholdParam}} reference a parameter that isn't in the instantiated data model, then there will be no {{event|Triggered!}} Event.}} When creating a Threshold, if the ReferencePath, ThresholdParam or ThresholdValue are invalid (not in the supported Data Model), the object will not be created. If the concatenation of ReferencePath and ThresholdParam reference a parameter that isn't in the instantiated data model, then there will be no Triggered! Event. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.13 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enable/Disable this {{object}} instance. If the {{object}} instance is disabled, the {{event|Triggered!}} Event will not be invoked, even if there is a {{object|.LocalAgent.Subscription.{i}.}} instance that references it}} Enable/Disable this Threshold instance. If the Threshold instance is disabled, the Triggered! Event will not be invoked, even if there is a LocalAgent.Subscription.{i}. instance that references it |
false |
2.13 |
|
ReferencePath |
string |
W |
{{div|{{classes}}|The concatenation of {{param}} and {{param|ThresholdParam}} refers to the parameter being checked for the threshold test. {{param}} can be either an Object Path, Object Instance Path, or and Object Instance Path with a Search Expression instead of an Instance Identifier, as defined in the introduction section of {{bibref|TR-369}}.}} The concatenation of ReferencePath and ThresholdParam refers to the parameter being checked for the threshold test. ReferencePath can be either an Object Path, Object Instance Path, or and Object Instance Path with a Search Expression instead of an Instance Identifier, as defined in the introduction section of [TR-369]. |
- |
2.13 |
|
ThresholdParam |
string |
W |
{{div|{{classes}}|The concatenation of {{param|ReferencePath}} and {{param}} refers to the parameter being checked for the threshold test. {{param}} is the name of the Parameter in the context of {{param|ReferencePath}}.}} The concatenation of ReferencePath and ThresholdParam refers to the parameter being checked for the threshold test. ThresholdParam is the name of the Parameter in the context of ReferencePath. |
- |
2.13 |
|
Controller |
string |
R |
The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created Threshold. 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 Threshold creation using the reference to the USP Controller that created the instance. The USP Controller referenced by this parameter also defines the set of permissions to use when evaluating the threshold. Furthermore, only the USP Controller referenced by this parameter will receive a Triggered! Event (assuming it has an associated Subscription), even if another USP Controller has an associated Subscription. |
- |
2.15 |
|
Triggered! |
event |
- |
{{div|{{classes}}|Triggered event requested via a {{object}} object. When any of the {{param|##.Threshold.{i}.ThresholdParam}}s that are in the {{param|##.Threshold.{i}.ReferencePath}} change and the threshold test conditation changes from {{false}} to {{true}}, the Triggered Event will be invoked. The Triggered Event will only be eligible for retriggering if the test condition is fulfilled again.}} Triggered event requested via a Threshold object. When any of the Threshold.{i}.ThresholdParams that are in the Threshold.{i}.ReferencePath change and the threshold test conditation changes from false to true, the Triggered Event will be invoked. The Triggered Event will only be eligible for retriggering if the test condition is fulfilled again. |
- |
2.13 |
|
Device.LocalAgent.Controller.{i}. |
object(0:) |
W |
{{div|{{classes}}|Each instance of this table represents a USP Controller that has access to this USP Agent. On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller.}} Each instance of this table represents a USP Controller that has access to this USP Agent. On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller. At most one entry in this table can exist with a given value for EndpointID, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
ControllerCode |
string(:128) |
W |
{{div|{{classes}}|Information about the configuration state of an Agent as it pertains to the {{object}} instance. This is not information related to an operator's installation or usage of the protocol, that information is maintained in {{param|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.}} 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 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enable/Disable this {{object}} instance. If the Controller instance is to be disabled, the Agent MUST send the ValueChange notification to all subscribed recipients, even if the recipient is the disabled Controller itself. This notification is the last notification sent to this Controller until it is enabled again. The USP Endpoint MUST terminate the MTP connection. When {{false}}, messages (notifications) are not sent to the remote endpoint represented by this {{object}} instance, and any MTP session establishment are refused.}} Enable/Disable this Controller instance. If the Controller instance is to be disabled, the Agent MUST send the ValueChange notification to all subscribed recipients, even if the recipient is the disabled Controller itself. This notification is the last notification sent to this Controller until it is enabled again. The USP Endpoint MUST terminate the MTP connection. When false, messages (notifications) are not sent to the remote endpoint represented by this Controller instance, and any MTP session establishment are refused. |
false |
2.12 |
|
AssignedRole |
string[] |
W |
Each list item MUST be the Path Name of a row in the 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 ControllerTrust.Credential.{i}.Role parameter. |
- |
2.12 |
|
InheritedRole |
string[] |
R |
Each list item MUST be the Path Name of a row in the 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 ControllerTrust.Credential.{i}.Role parameter associated with the CA credential (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. {{div|{{classes}}|{{nolist}} Comma-separated list of strings, the set of certificates from {{object|#.Certificate.{i}}} that a Controller can present for use in authenticating the identity of this {{object}} instance.}} 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 {{object|#.Subscription}}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 {{object|#.Subscription}}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-106] indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified PeriodicNotifInterval. If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the PeriodicNotifTime parameter was set to the Unknown Time value. |
- |
2.12 |
|
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. This command is DEPRECATED This command was DEPRECATED in 2.14.because it was replaced by a more flexible asynchronous {{command|*ScheduleTimer()*Device.ScheduleTimer()}} in 2.14. |
- |
2.12 |
|
Timer! |
event |
- |
Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message. This event is DEPRECATED This event was DEPRECATED in 2.14.because the associated {{command|**{{command: empty ref only valid in command descriptions}}**ScheduleTimer()}} was replaced by a more flexible asynchronous {{command|**{{command: empty ref only valid in command descriptions}}**Device.ScheduleTimer()}} in 2.14. |
- |
2.12 |
|
Device.LocalAgent.Controller.{i}.MTP.{i}. |
object(0:) |
W |
Each instance of this table represents a MTP used by this Controller. At most one entry in this table can exist with a given value for Protocol, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.14:
|
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enable/Disable this {{object}} instance. If this {{object}} 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 SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. This parameter discriminates between the CoAP, STOMP, WebSocket, MQTT union objects. Changes since 2.14:
|
WebSocket |
2.12 |
|
Order |
unsignedInt(1:) |
W |
The order (relative priority) to use when determining which MTP to use for communicating to the Controller. A value of 1 indicates the highest precedence. For each configured MTP, the instance with the lowest value is attempted first. When more than one MTP instance has the same value, then each instance with the same value SHOULD be attempted at the same time. The value of Order on creation of a MTP table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). |
- |
2.15 |
|
Device.LocalAgent.Controller.{i}.MTP.{i}.CoAP. |
object(0:1) |
R |
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. This object was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Device.LocalAgent.Controller.{i}.MTP.{i}.STOMP. |
object(0:1) |
R |
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. This object MUST be present if, and only if, Protocol is STOMP. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket. |
object(0:1) |
R |
If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. This object MUST be present if, and only if, Protocol is WebSocket. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.12 |
|
Path |
string |
W |
The service path that is usedprovided by the Controller's WebSocket server in order to receiveexchange USP messages. The value MUST be used as defined in [Section 3.3/RFC3986]. |
- |
2.12 |
|
IsEncrypted |
boolean |
R |
This parameter represents whether or not communications that utilize this WebSocket object instance are encrypted. This parameter is DEPRECATED, This parameter was DEPRECATED in 2.14.because the {{param|IsEncryptedEnableEncryption}} parameter will dictate whether this {{object}}WebSocket is or is not encrypted.encrypted |
- |
2.12 |
|
KeepAliveInterval |
unsignedInt(1:) |
W |
The the duration in seconds between when WebSocket ping control frames are transmitted by the AgentAgent's WebSocket client to the Controller's WebSocket server for the USP Controller.server. |
- |
2.12 |
|
SessionRetryMinimumWaitInterval |
unsignedInt(1:65535) |
W |
{{div|{{classes}}|Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}. The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.}} 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 |
|
Device.LocalAgent.Controller.{i}.MTP.{i}.MQTT. |
object(0:1) |
R |
If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker. This object MUST be present if, and only if, Protocol is MQTT. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.14:
|
- |
2.13 |
|
Device.LocalAgent.Controller.{i}.BootParameter.{i}. |
object(0:) |
W |
{{div|{{classes}}|This table provides the Controller with the ability to dictate the Parameters that are delivered via Boot! events. Any Parameter (identified by {{param|ParameterName}}) contained in this table MUST be included within the param_map element of the Boot! event.}} 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
ParameterName |
string(:256) |
W |
{{div|{{classes}}|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 {{object|#.BootParameter}} instance is not included in the param_map of the Boot! event.}} 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 |
R |
The E2ESession object represents the End to End (E2E) Session Context functionality for this Controller.{i} object instance. Changes since 2.14:
|
- |
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. This parameter was DEPRECATED in 2.15 because it is replaced by SessionMode. Changes since 2.14:
|
false |
2.12 |
|
SessionMode |
string |
W |
The desired usage mode of an End-to-End Session Context with this particular Controller. Enumeration of:
|
- |
2.15 |
|
Status |
string |
R |
The current status of the Session Context. Enumeration of:
|
- |
2.12 |
|
SessionExpiration |
unsignedInt(0:) |
W |
{{div|{{classes}}|The duration in {{units}} 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.}} 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 |
|
SegmentedPayloadChunkSize |
unsignedInt(0,512:) |
W |
{{div|{{classes}}|The maximum size, in {{units}}, 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.}} 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:
|
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.Certificate.{i}. |
object(0:) |
R |
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 Controller.{i}.Credential and ControllerTrust.Credential.{i}.Credential. At most one entry in this table can exist with the same values for both SerialNumber and Issuer, or with a given value for Alias. |
- |
2.12 |
|
Device.LocalAgent.ControllerTrust. |
object |
R |
This object contains information that an Agent applies when establishing a trust relationship with a Controller. |
- |
2.12 |
|
UntrustedRole |
string[:1] |
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 item) 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 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 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 |
|
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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ RequestExpiration |
int(0:) |
W |
{{div|{{classes}}|The expiration period, in {{units}}, where the Controller request that this challenge request expire (times-out). A value of zero indicates that the challenge request will never expire. The default is 900 {{units}}.}} The expiration period, in seconds, where the Controller request that this challenge request expire (times-out). A value of zero indicates that the challenge request will never expire. The default is 900 seconds. |
- |
2.12 |
|
⇐ Output. |
arguments |
- |
Output arguments. |
- |
|
|
⇐ InstructionType |
string |
R |
{{div|{{classes}}|The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter. The allowable values of the media type are defined by the {{param|##.Challenge.{i}.InstructionType}} parameter.}} The media type with a format as defined by [RFC6838] of the content of the Instruction parameter. The allowable values of the media type are defined by the Challenge.{i}.InstructionType parameter. |
- |
2.12 |
|
⇐ ValueType |
string |
R |
{{div|{{classes}}|The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|##.Challenge.{i}.Value}} parameter. The allowable values of the media type are defined by the {{param|##.Challenge.{i}.ValueType}} parameter.}} The media type with a format as defined by [RFC6838] of the content of the Challenge.{i}.Value parameter. The allowable values of the media type are defined by the Challenge.{i}.ValueType parameter. |
- |
2.12 |
|
Device.LocalAgent.ControllerTrust.Role.{i}. |
object(0:) |
W |
{{div|{{classes}}|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.}} 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 Name, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Name and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.LocalAgent.ControllerTrust.Role.{i}.Permission.{i}. |
object(0:) |
W |
{{div|{{classes}}|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.}} 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 Order, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Order |
unsignedInt |
W |
{{div|{{classes}}|The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same {{object|#.}}. The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority).}} 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) |
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:
|
---- |
2.12 |
|
Obj |
string(4) |
W |
The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n). The following describes the meaning of the permissions for Object type of Targets:
|
---- |
2.12 |
|
InstantiatedObj |
string(4) |
W |
The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n). The following describes the meaning of the permissions for Instantiated Object type of Targets:
|
---- |
2.12 |
|
CommandEvent |
string(4) |
W |
The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n). The following describes the meaning of the permissions for Command and Event type of Targets:
|
---- |
2.12 |
|
Device.LocalAgent.ControllerTrust.Credential.{i}. |
object(0:) |
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 Credential, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Credential and Alias such that the new entry does not conflict with any existing entries. |
- |
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 Controller.{i}.InheritedRole parameter. If the Controller is already known to the Agent, with an associated Role, this parameter has no impact. |
- |
2.12 |
|
Device.LocalAgent.ControllerTrust.Challenge.{i}. |
object(0:) |
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 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
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 Controller.{i}.AssignedRole parameter. |
- |
2.12 |
|
Retries |
unsignedInt |
W |
The number of timesconsecutive failed ChallengeResponse() attempts against this Challenge instance (as determined by the RequestChallenge().ChallengeRef associated with ChallengeResponse().ChallengeID parameters) that are allowed before a challengeLockoutPeriod is retriedstarted beforefor this Challenge instance. Counts of failed attempts for a Challenge instance are reset after a successful ChallengeResponse() for the challengeChallenge procedureinstance isor terminated.after a started LockoutPeriod expires. |
- |
2.12 |
|
LockoutPeriod |
int(0:) |
W |
TheOnce time,the inRetries {{units}} that a Controller thatvalue has been reached by failed ChallengeResponse() attempts against this Challenge instance (as determined by the challengeRequestChallenge().ChallengeRef isassociated lockedwith outChallengeResponse().ChallengeID (based onparameters), the value of this parameter represents the {{param|Retries}}amount parameter)of priortime (in seconds) that the Agent will prevent any ChallengeResponse() or RequestChallenge() against this Challenge instance from succeeding. Any attempt to beingissue provideda RequestChallenge() or ChallengeResponse() command where the challengeassociated again.RequestChallenge().ChallengeRef points to this Challenge instance during the lockout period will result in an Error response with 7002 as the error code. When a started lockout period has expired, the count of failed attempts for this Challenge instance will be reset. If the Agent chooses to delete ChallengeResponse().ChallengeID values for a locked out Challenge, the Agent can send the 7004 error code for values it does not recognize.A value of zero means that a LockoutPeriodlockout period doesn't apply and the challengeRequestChallenge() command can be providedattempted indefinitely.without the need to wait between failed challenges. |
30 |
2.12 |
|
Device.LocalAgent.Subscription.{i}. |
object(0:) |
W |
A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller. At most one entry in this table can exist with a given value for Alias, or with the same values for both Recipient and ID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Recipient and ID such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Recipient |
string |
R |
{{div|{{classes}}|{{reference|the {{object|#.Controller}} instance that will receive the Notification associated with this {{object}}|delete}} The value of this parameter is automatically populated by the USP Agent upon {{object}} creation using the reference to the USP Controller that created the instance.}} 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. The Agent MUST choose an initial value that (together with ID) doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been set internally by the Agent. |
- |
2.12 |
|
ID |
string(1:64) |
W |
{{div|{{classes}}|Unique identifier of the {{object}} itself, which is specific to the USP Controller that creates the instance of the {{object}}. This value is used as the subscription_id element of every Notification message from a USP Agent to a USP Controller caused by this subscription entry.}} Unique identifier of the Subscription itself, which is specific to the USP Controller that creates the instance of the Subscription. This value is used as the subscription_id element of every Notification message from a USP Agent to a USP Controller caused by this subscription entry. If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Recipient) doesn't conflict with any existing entries. This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent. |
- |
2.12 |
|
CreationDate |
dateTime |
R |
{{div|{{classes}}|The date and time when this instance of {{object}} was created. This is internally used by the {{param|TimeToLive}} parameter to determine the expiration of this {{object}} instance. The value of this parameter is automatically populated by the USP Agent upon {{object}} creation.}} 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 |
|
ReferenceList |
string(:256)[] |
W |
Comma-separated list of strings (maximum number of characters per item 256). Each entry in the list is a Path Name, Search Path, Command reference, or Event reference that determines the element(s) of the data model that the Subscription is applicable to. Different values of the NotifType parameter will cause the Subscription to interact with ReferenceList differently. For example, an instance of Subscription with ValueChange will utilize the value of this parameter differently than an instance with Event. 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. The following bullet points describe what is allowed as a value of ReferenceList based on the different values of the NotifType parameter:
|
- |
2.13 |
|
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 parameter 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 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 parameter 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(0:) |
R |
{{div|{{classes}}|{{object}} instances are created using USP Operate messages. Only Operate messages with async=true will create a {{object}} instance in the data model. When the command of the Operate completes, then this {{object}} instance is removed from this table.}} 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 the same values for all of Originator, Command and CommandKey, or with a given value for Alias. |
- |
2.12 |
|
Command |
string |
R |
{{div|{{classes}}|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.}} 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 |
|
Cancel() |
command |
- |
{{div|{{classes}}|Request cancelation of this {{object}}'s command. This command completes immediately. If successful, {{param|Status}} will immediately change to {{enum|Canceling|Status}} and will change to {{enum|Canceled|Status}} when the cancelation is complete.}} |
- |
2.12 |
|
Device.SoftwareModules. |
object |
R |
Top level object for dynamically managed software applications. |
- |
2.1 |
|
InstallDU() |
command |
- |
[ASYNC] Install one or more Deployment Units (DUs) to the associated SoftwareModules. |
- |
2.12 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ URL |
string(:2048) |
W |
[MANDATORY] The [URL] that specifies the location of the DU to be installed. The URL MUST NOT include the "userinfo" component, as defined in [RFC3986]. HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported. |
- |
2.12 |
|
⇒ UUID |
string(36) |
W |
[UUID] {{div|{{classes}}|The UUID (see {{bibref|RFC4122}}) of the DU to be installed. If this parameter is {{empty}} the device MUST generate the UUID based on the rules defined in {{bibref|RFC4122}} and {{bibref|TR-181i2|Annex C}}.}} The UUID (see [RFC4122]) of the DU to be installed. If this parameter is an empty string the device MUST generate the UUID based on the rules defined in [RFC4122] and [Annex C/TR-181i2]. |
- |
2.12 |
|
⇒ ExecutionEnvRef |
string(:256) |
W |
The value MUST be the Path Name of a row in the ExecEnv. table. A reference to the Execution Environment upon which the DU is to be installed. If an empty string the device MUST choose the Execution Environment to use. |
- |
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 |
|
⇒ Version |
string(:32) |
R |
{{div|{{classes}}|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 {{param|.SoftwareModules.DeploymentUnit.{i}.Version}} Parameter contained within the instance of the DeploymentUnit that is contained within the {{param|DeploymentUnitRef}} argument.}} 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 |
|
⇒ Resolved |
boolean |
R |
{{div|{{classes}}|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}}.}} 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[] |
R |
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 |
|
⇒ Fault. |
object |
R |
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 |
R |
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 90017002 (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 90037004 (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 90237223 (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 90257225 (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 90267226 (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 90277227 (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 90297229 (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 90297229 (Invalid Deployment Unit State) fault code. |
- |
2.12 |
|
Device.SoftwareModules.ExecEnv.{i}. |
object(0:) |
R |
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. |
- |
2.1 |
|
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.1 |
|
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.1 |
|
CurrentRunLevel |
int(-1:65535) |
R |
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.1 |
|
InitialExecutionUnitRunLevel |
int(-1:65535) |
W |
{{div|{{classes}}|Indicates the initial value on creation for {{param|#.ExecutionUnit.{i}.RunLevel}} for all Execution Unit instances associated with this {{object}}. If the value of {{param|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.}} 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.1 |
|
ParentExecEnv |
string |
R |
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. {{div|{{classes}}|Represents the parent {{object}} of this {{object}}. If this value is {{empty}} then this is the Primary Execution Environment.}} |
- |
2.1 |
|
AllocatedDiskSpace |
int(-1:) |
R |
The amount of disk space measured in KiB allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. Changes since 2.14:
|
- |
2.1 |
|
AvailableDiskSpace |
int(-1:) |
R |
The amount of disk space measured in KiB 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. Changes since 2.14:
|
- |
2.1 |
|
AllocatedMemory |
int(-1:) |
R |
The amount of physical RAM measured in KiB allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. Changes since 2.14:
|
- |
2.1 |
|
AvailableMemory |
int(-1:) |
R |
The amount of physical RAM measured in KiB 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. Changes since 2.14:
|
- |
2.1 |
|
SetRunLevel() |
command |
- |
{{div|{{classes}}|Provides a mechanism to remotely manipulate the run level of this {{object}}, meaning that altering this comand will change the value of the {{param|#.CurrentRunLevel}}. Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.}} 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 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ RequestedRunLevel |
int(-1:65535) |
W |
[MANDATORY] {{div|{{classes}}|This parameter will request to change the value of the {{param|#.CurrentRunLevel}} to the value of this parameter. Setting this value when {{param|#.CurrentRunLevel}} is -1 has no impact to the Run Level of this instance of the {{object|##.}} object.}} This parameter will request to change the value of the CurrentRunLevel to the value of this parameter. Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this instance of the SoftwareModules object. Changes since 2.14:
|
- |
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:
|
- |
2.12 |
|
Device.SoftwareModules.DeploymentUnit.{i}. |
object(0:) |
R |
{{div|{{classes}}|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.}} This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit. A new instance of this table gets created during the installation of a Software Module. At most one entry in this table can exist with the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias. |
- |
2.1 |
|
UUID |
string(:36) |
R |
A Universally Unique Identifier either provided by the Controller, or generated by the device, at the time of Deployment Unit Installation. The format of this value is defined by [RFC4122] Version 5 (Name-Based) and [Annex C/TR-181i2]. This value MUST NOT be altered when the DeploymentUnit is updated. |
- |
2.1 |
|
Name |
string(:64) |
R |
{{div|{{classes}}|Indicates the Name of this {{object}}, which is chosen by the author of the Deployment Unit. The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}.}} 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 C/TR-181i2]. |
- |
2.1 |
|
Vendor |
string(:128) |
R |
{{div|{{classes}}|The author of this {{object}} formatted as a domain name. The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}.}} 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 C/TR-181i2]. |
- |
2.1 |
|
VendorLogList |
string[] |
R |
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.1 |
|
VendorConfigList |
string[] |
R |
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.1 |
|
Update() |
command |
- |
[ASYNC] Update the associated DeploymentUnit. |
- |
2.1 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ URL |
string(:2048) |
W |
The [URL] that specifies the location of the DU to be installed. The URL MUST NOT include the "userinfo" component, as defined in [RFC3986]. HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported. If the device receives an Update command with the same source URL as a previous Update or Install comamnd, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time. |
- |
2.12 |
|
Device.SoftwareModules.ExecutionUnit.{i}. |
object(0:) |
R |
This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object. At most one entry in this table can exist with a given value for EUID, or with a given value for Alias. |
- |
2.1 |
|
EUID |
string(:64) |
R |
{{div|{{classes}}|Execution Unit Identifier chosen by the {{object|#.ExecEnv}} during installation of the associated {{object|#.DeploymentUnit}}. The format of this value is Execution Environment specific, but it MUST be unique across {{object|#.ExecEnv}} instances. Thus, it is recommended that this be a combination of the {{param|#.ExecEnv.{i}.Name}} and an Execution Environment local unique value.}} 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.1 |
|
ExecutionFaultCode |
string |
R |
{{div|{{classes}}|If while running or transitioning between states this {{object}} identifies a fault this parameter embodies the problem. The value of {{enum|NoFault}} MUST be used when everything is working as intended. {{enum}} For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}.}} 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-106]. |
- |
2.1 |
|
ExecutionFaultMessage |
string(:256) |
R |
{{div|{{classes}}|If while running or transitioning between states this {{object}} identifies a fault this parameter provides a more detailed explanation of the problem. If {{param|ExecutionFaultCode}} has the value of {{enum|NoFault|ExecutionFaultCode}} then the value of this parameter MUST be {{empty}} and ignored by the Controller.}} 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 be an empty string and ignored by the Controller. |
- |
2.1 |
|
AutoStart |
boolean |
W |
{{div|{{classes}}|If {{true}} and the {{param|RunLevel}} verification is also met, then this {{object}} will be automatically started by the device after its {{object|#.ExecEnv}} is either rebooted or restarted. If {{false}} this {{object}} will not be started after its {{object|#.ExecEnv}} is either rebooted or restarted until it is explicitly commanded to do so by either the Controller or another Execution Unit.}} 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.1 |
|
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.1 |
|
DiskSpaceInUse |
int(-1:) |
R |
The amount of disk space measured in KiB currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. Changes since 2.14:
|
- |
2.1 |
|
MemoryInUse |
int(-1:) |
R |
The amount of physical RAM measured in KiB currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. Changes since 2.14:
|
- |
2.1 |
|
References |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of a table row, or an empty string. {{div|{{classes}}|Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this {{object}}. NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this {{object}} has caused to come into existence can be discovered via the GetSupportedDM and GetInstances USP messages.}} 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.1 |
|
AssociatedProcessList |
string[] |
R |
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. {{div|{{classes}}|Represents the system processes that are active in the system because of this {{object}}. If {{param|Status}} is not {{enum|Active|Status}} it is expected that this list will be {{empty}}. Some {{object}} instances MIGHT NOT have any system processes irrespective of the value of {{param|Status}}.}} 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.1 |
|
VendorLogList |
string[] |
R |
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.1 |
|
VendorConfigList |
string[] |
R |
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.1 |
|
SetRequestedState() |
command |
- |
{{div|{{classes}}|Set the state transition that the Controller is requesting for this instance of the {{object}} object. If this instance of the {{object}} 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.}} Set the state transition that the Controller is requesting for this instance of the ExecutionUnit object. If this instance of the ExecutionUnit object is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a error message MUST be generated. |
- |
2.1 |
|
⇒ Input. |
arguments |
- |
Input arguments. |
- |
|
|
⇒ RequestedState |
string |
W |
[MANDATORY] Indicates the requested state to transition this instance of the SoftwareModules object. Enumeration of:
Changes since 2.14:
|
- |
2.12 |
|
Device.SoftwareModules.ExecutionUnit.{i}.Extensions. |
object |
R |
{{div|{{classes}}|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 {{param|#.References}} and use of GetSupportDM and GetInstances USP messages will be used to determine their locations.}} 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(0:) |
R |
Each entry in the table is a ProxiedDevice object that is a mount point. Each ProxiedDevice represents distinct hardware Devices. ProxiedDevice objects are virtual and abstracted representation of functionality, that exists on hardware other than that which the Agent is running. This object is a mount point, under which mountable objects can be mounted. At most one entry in this table can exist with a given value for Alias. |
- |
2.12 |
|
ProxyProtocol |
string |
R |
{{div|{{classes}}|The protocol being used to communicate between the Agent and this Proxied Device. {{enum}} Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to.}} The protocol being used to communicate between the Agent and this Proxied Device. Enumeration of: Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to. |
- |
2.13 |
|
Device.CWMPManagementServer. |
object |
R |
- |
2.15 |
|
|
EnableCWMP |
boolean |
W |
Enables and disables the CPE's support for CWMP. false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS. true means that CWMP support on the CPE is enabled. The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true. The factory default value MUST be true. |
- |
2.15 |
|
Device.STOMP. |
object |
R |
The STOMP represents the STOMP capabilities of the device as described in [TR-369]. |
- |
2.12 |
|
Device.STOMP.Connection.{i}. |
object(0:) |
W |
The Connection represents a STOMP connection between the Agent and a STOMP server. At most one entry in this table can exist with the same values for all of Host, Username and VirtualHost, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Host, Username and Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Enable |
boolean |
W |
{{div|{{classes}}|Enables or disables this {{object}}. This parameter is based on ifAdminStatus from {{bibref|RFC2863}}.}} Enables or disables this Connection. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.12 |
|
Status |
string |
R |
The current operational state of this Connection (see [Section 4.2.2/TR-181i2]). Enumeration of:
|
- |
2.12 |
|
VirtualHost |
string(:256) |
W |
{{div|{{classes}}|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.}} 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 (in milliseconds) 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 (in milliseconds) 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 |
{{div|{{classes}}|The maximum first reconnection wait interval, in {{units}}, as specified in {{bibref|TR-369}}. The Device MUST use a random value between 0 and {{param}} as the first reconnection wait interval.}} 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). The server retry mechanism reaches its upper limit at 10 reconnection attempts. Meaning, that if the number of reconnection attempts exceeds 10, then the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (10 - 1). |
2000 |
2.12 |
|
ServerRetryMaxInterval |
unsignedInt(1:) |
W |
{{div|{{classes}}|The maximum reconnection wait interval, in {{units}}. If the nth reconnection wait interval calculated from {{param|ServerRetryInitialInterval}} and {{param|ServerRetryIntervalMultiplier}} exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval.}} 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 |
R |
This parameter represents whether or not communications that utilize this Connection object instance are encrypted. This parameter is DEPRECATED, This parameter was DEPRECATED in 2.14.because the {{param|IsEncryptedEnableEncryption}} parameter will dictate whether all connections for this STOMP instance are or are not encrypted.encrypted |
- |
2.12 |
|
Device.IoTCapability.{i}. |
object(0:) |
R |
This list of IoT capability objects. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.13 |
|
Class |
string |
R |
{{div|{{classes}}|Describes the type of functionality that {{object}} is representing. Depending on the functionality the corresponding sub-object is instantiated. Note: Only one of the defined sub-objects can exist in an {{object}} instance.}} Describes the type of functionality that IoTCapability is representing. Depending on the functionality the corresponding sub-object is instantiated. Note: Only one of the defined sub-objects can exist in an IoTCapability instance. Enumeration of:
|
- |
2.13 |
|
Device.IoTCapability.{i}.BinaryControl. |
object |
R |
{{div|{{classes}}|This capability provides a boolean function that is mapped to the type of function it represents. E.g. If the instance represents a door lock ({{param|Type}} is {{enum|Locked|Type}}), a {{param|Value}} of {{true}} says the door lock is locked.}} |
- |
2.13 |
|
Device.IoTCapability.{i}.LevelControl. |
object |
R |
LevelController is used to model a control with a range of continuous states. These values are configurable via Value and measured in Unit and are restricted between a Min and Max values. Intensity profile - Value of intensity and ability to update that level through {{param|StepUp}}StepUp() and {{param|StepDown}}StepDown() commands with a configurable StepValue. |
- |
2.13 |
|
StepValue |
decimal |
W |
Number of Unit changes of each {{param|StepUp}}StepUp() and {{param|StepDown}}StepDown() command. |
- |
2.13 |
|
Device.IoTCapability.{i}.EnumControl. |
object |
R |
{{div|{{classes}}|The EnumControl reflects the Enumerated level Control functionality. The enumeration is defined by the {{param|ValidValues}} parameter. This will provide a comma-separated list of values that are available for configuring via the {{param|Value}} parameter.}} The EnumControl reflects the Enumerated level Control functionality. The enumeration is defined by the ValidValues parameter. This will provide a comma-separated list of values that are available for configuring via the Value parameter. |
- |
2.13 |
|
Device.IoTCapability.{i}.BinarySensor. |
object |
R |
{{div|{{classes}}|BinarySensor is used to reflect the functionality of a sensor that reports a {{param|Value}}. The {{param|Sensitivity}} configures the degree of sensitivity that the sensor uses for detection. Timed BinarySensor profile - To provide the ability to add time based control over the {{param|Value}} attribute. How long the {{param|Value}} remains true is controlled by the {{param|HoldTime}}. {{param|RestTime}} controls how soon, after being activated, the sensor will respond to continuous events.}} BinarySensor is used to reflect the functionality of a sensor that reports a Value. The Sensitivity configures the degree of sensitivity that the sensor uses for detection. Timed BinarySensor profile - To provide the ability to add time based control over the Value attribute. How long the Value remains true is controlled by the HoldTime. RestTime controls how soon, after being activated, the sensor will respond to continuous events. |
- |
2.13 |
|
Device.IoTCapability.{i}.LevelSensor. |
object |
R |
LevelSensor is used to reflect the functionality of a sensor that reports a Value in Unit. |
- |
2.13 |
|
Unit |
string |
R |
{{div|{{classes}}|{{datatype|expand}} Unit in which {{param|Value}} is expressed.}} [IoTUnitType] Possible Unit types used for decimal values. Enumeration of:
Unit in which Value is expressed. |
- |
2.13 |
|
Device.IoTCapability.{i}.MultiLevelSensor. |
object |
R |
MultiLevelSensor is used to reflect the functionality of a sensor that reports multiple Values with the same Unit. |
- |
2.13 |
|
Unit |
string |
R |
{{div|{{classes}}|{{datatype|expand}} Unit in which {{param|Values}} are expressed.}} [IoTUnitType] Possible Unit types used for decimal values. Enumeration of:
Unit in which Values are expressed. |
- |
2.13 |
Generated by Broadband Forum bbfreport v2.6.1 (2026-11-11 version) on 2026-11-11 at 13:02:42 UTC.
report.py --include ../../install/cwmp --output tr-181-2-15-1-usp-diffs.html --show --transform diff --format html tr-181-2-14-1-usp.xml tr-181-2-15-1-usp.xml