{{docname|Device:2 Root Data Model for USP (TR-369)}} {{appdate|November
2020}} {{trname|TR-181i2a14}}
* Added WWC (5G Wireline Wireless Convergence), PDU (Protocol Data Unit)
and FWE (5G Wireline wireless Encapsulation) top-level objects
* Updated Cellular object to be applicable to 5G Residential Gateways
* Extended support for TR-471 IP-layer metrics, including new IP-layer
capacity test
* Supported LAN device time-based access-control
* Various Wi-Fi improvements
A non-volatile handle used to reference this instance.
'''This is intended only for use in protocol-independent "common"
definitions, and MUST NOT be used in protocol-specific definitions.'''
A non-volatile unique key used to reference this instance. Alias provides
a mechanism for a Controller to label this instance for future reference.
The following mandatory constraints MUST be enforced:
* The value MUST NOT be empty.
* The value MUST start with a letter.
* If the value is not assigned by the Controller at creation time, the
Agent MUST assign a value with an "cpe-" prefix.
A non-volatile unique key used to reference this instance. Alias provides
a mechanism for a Controller to label this instance for future reference.
The following mandatory constraints MUST be enforced:
* The value MUST NOT be empty.
* The value MUST start with a letter.
* If the value is not assigned by the Controller at creation time, the
Agent MUST assign a value with an "cpe-" prefix.
The value 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.
The IEEE EUI 64-bit identifier as defined in {{bibref|IEEE_EUI64}}. The
IEEE defined 64-bit extended unique identifier (EUI-64) is a
concatenation of:
* The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the
IEEE Registration Authority (IEEE-RA), and
* The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36)
assigned by the organization with that company_id assignment.
IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.
All IPv4 addresses and subnet masks MUST be represented as strings in
IPv4 dotted-decimal notation. Here are some examples of valid IPv4
address textual representations:
* 216.52.29.100
* 192.168.1.254
All IPv6 addresses MUST be represented using any of the 3 standard
textual representations defined in {{bibref|RFC4291}} Sections 2.2.1,
2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but
use of lower-case letters is RECOMMENDED. Here are some examples of valid
IPv6 address textual representations:
* 1080:0:0:800:ba98:3210:11aa:12dd
* 1080::800:ba98:3210:11aa:12dd
* 0:0:0:0:0:0:13.1.68.3
IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are
discussed in {{bibref|RFC4007|Section 6}}.
Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be
represented as empty strings unless otherwise specified by the parameter
definition.
IPv4 address (or subnet mask).
Can be any IPv4 address that is permitted by the ''IPAddress'' data type.
IPv6 address.
Can be any IPv6 address that is permitted by the ''IPAddress'' data type.
IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR)
notation {{bibref|RFC4632}}. This is specified as an IP address followed
by an appended "/n" suffix, where ''n'' (the prefix size) is an integer
in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the
number of (leftmost) '1' bits of the routing prefix.
* IPv4 example: 192.168.1.0/24
* IPv6 example: 2001:edff:fe6a:f76::/64
This notation can also represent individual addresses by specifying all
bits.
* IPv4 example: 192.168.1.1/32
* IPv6 example: 2001:edff:fe6a:f76::1/128
If the IP address part is unspecified or inapplicable, it MUST be
{{empty}} 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
{{empty}} unless otherwise specified by the parameter definition.
IPv4 address prefix.
Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type.
IPv6 address prefix.
Can be any IPv6 prefix that is permitted by the ''IPPrefix'' data type.
A JSON Object as defined in {{bibref|RFC7159|Section 4}}.
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.
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.
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.
Universally Unique Identifier. See {{bibref|RFC4122}}.
Uniform Resource Identifier. See {{bibref|RFC3986}}.
Uniform Resource Locator. See {{bibref|RFC3986}} (URI),
{{bibref|IANA-uri-schemes}}, and individual URI scheme RFCs such as
{{bibref|RFC7252}} (''coap'', ''coaps'') and {{bibref|RFC7230}}
(''http'', ''https'').
The ZigBee 16-bit network address (NWK) as defined in
{{bibref|ZigBee2007}}. The address is assigned to a device by the network
layer and used by the network layer for routing messages between devices.
Possible Unit types used for decimal values. {{enum}}
Dimensionless quantity
Percent
Decimal degrees
Celsius
Fahrenheit
Kelvin [SI]
Kilometer [SI]
Meter [SI]
Centimeter [SI]
Millimeter [SI]
Hour
Minute
Second [SI]
Millisecond
Square kilometer
Square meter
Square cm
Cubic meter
Liter [SI]
Centiliter [SI]
Milliliter [SI]
Kilogram [SI]
Gram [SI]
Milligram [SI]
Watt hour
Kilowatt hour
Watt [SI]
Ampere [SI]
Hertz [SI]
Volt [SI]
Newton [SI]
Pascal [SI]
Coulomb [SI]
Farad [SI]
Ohm [SI]
Siemens [SI]
Weber [SI]
Tesla [SI]
Henry [SI]
Lumen [SI]
Lux [SI]
Meter per second
Candela [SI]
Mole [SI]
Ultraviolet index
RGB color, encoded as integer value between 0 (usually represented as
0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue
would be 255 (usually represented as 0x0000FF)
Parts per million (Alternative use percent: 1ppm = 0.0001%)
Sievert (J/kg) [SI]
Joule [SI]
Describes the type of Device that the {{object}} instance is
representing. {{enum}}
Describes the type of IoT Level Controller or Sensor that the {{object}}
instance is representing. {{enum}}
Amount of space that an object or substance occupies
Describes the type of IoT Enum Controller that the {{object}} instance is
representing. {{enum}}
Describes the type of IoT Enum Sensor that the {{object}} instance is
representing. {{enum}}
Pair of 32-bit signed integers a(i),b(i) with each pair representing a
complex component of the uncalibrated echo response (UER);
# Real UER component, a(i)
# Imaginary UER component, b(i) for values of i starting at i=0. Both
values are represented as signed integers. The interpretation of the
UER value is as defined in {{bibref|G.996.2|Clause A.2.2.1}}.
# the Power Spectral Density (PSD) breakpoint sub-carrier index in the
range [0:49152] with Df = 4.3125 kHz frequency spacing, and
# the value of the level of the PSD at this sub-carrier expressed in
''0.1 dBm/Hz'' with an offset of -200 dBm/Hz. The range of valid values
for PSD is -30 to -200 dBm/Hz. Both values are represented as
unsignedInt.
# The PSM breakpoint sub-carrier index in the range [0:4095], and
# the value of the level of the PSM at this sub-carrier expressed in
''0.1 dBm/Hz'' with an offset of -140 dBm/Hz. Both values are
represented as unsignedInt. {{bibref|G.9964|Clause 5.2}} defines limits
on PSM breakpoint levels.
# The paired frequency spacing index in the range [0:8191], and
# The transfer function log value, i.e. [i, TFlog(i *
{{param|TFlogGroupSize}} * Df)], where the reference frequency spacing
Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i *
{{param|TFlogGroupSize}} * Df) spans a range from +6.0 dB down to -96.2
dB with units of 0.1 dB. Both values are represented as unsignedInt.
Service Slice Type (SST). {{enum}} See {{bibref|3GPP-TS.23.501|Clause
5.15.2.2}}.
5G Enhanced Mobile Broadband
Ultra-Reliable Low Latency Communications
Massive IoT
Vehicle to Everything
High Speed Packet data Access (HSPA)
3GPP
https://www.3gpp.org/technologies/keywords-acronyms/99-hspa
3GPP TS 23.003
Numbering, addressing and identification
3GPP CT WG4
https://www.3gpp.org/ftp/Specs/html-info/23003.htm
3GPP TS 23.501
System architecture for the 5G System (5GS); Stage 2
3GPP SA WG2
https://www.3gpp.org/ftp/Specs/html-info/23501.htm
3GPP TS 24.008
Mobile radio interface Layer 3 specification; Core network protocols;
Stage 3
3GPP CT WG1
https://www.3gpp.org/ftp/Specs/html-info/24008.htm
3GPP TS 24.301
Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS);
Stage 3
3GPP CT WG1
https://www.3gpp.org/ftp/Specs/html-info/24301.htm
3GPP TS 24.501
Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3
3GPP CT WG1
https://www.3gpp.org/ftp/Specs/html-info/24501.htm
3GPP TS 24.526
User Equipment (UE) policies for 5G System (5GS); Stage 3
3GPP CT WG1
https://www.3gpp.org/ftp/Specs/html-info/24526.htm
3GPP TS 25.171
Requirements for support of Assisted Global Positioning System (A-GPS)
3GPP RAN WG4
https://www.3gpp.org/ftp/Specs/html-info/25171.htm
Organizationally Unique Identifiers (OUIs)
https://standards.ieee.org/faqs/regauth
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
IEEE
March 1997
https://standards.ieee.org/regauth/oui/tutorials/EUI64.html
IEEE Std 802.1AB-2009
Station and Media Access Control Connectivity Discovery
IEEE
2009
https://standards.ieee.org/getieee802/download/802.1AB-2009.pdf
IEEE Std 802.1ad-2005
Virtual Bridged Local Area Networks Amendment 4: Provider Bridges
IEEE
May 2005
https://standards.ieee.org/getieee802/download/802.1ad-2005.pdf
IEEE Std 802.1AX-2014
IEEE Standard for Local and metropolitan area networks - Link
Aggregation
IEEE
2014
https://ieeexplore.ieee.org/servlet/opac?punumber=6997981
IEEE Std 802.1D-2004
Media Access Control (MAC) Bridges
IEEE
2004
https://standards.ieee.org/getieee802/download/802.1D-2004.pdf
IEEE Std 802.1Q-2005
Virtual Bridged Local Area Networks
IEEE
2006
https://standards.ieee.org/getieee802/download/802.1Q-2005.pdf
IEEE Std 802.1Q-2011
MAC Bridges and Virtual Bridge Local Area Networks
IEEE
2011
https://standards.ieee.org/getieee802/download/802.1Q-2011.pdf
IEEE Std 802.1x-2004
Standards for Local and Metropolitan Area Networks: Port based Network
Access Control
IEEE
2004
https://standards.ieee.org/getieee802/download/802.1X-2004.pdf
IEEE Std 802.3-2015
IEEE Standard for Ethernet
IEEE
2015
https://ieeexplore.ieee.org/servlet/opac?punumber=7428774
IEEE 802.3-2012 - Section Six
IEEE Standard for Ethernet - Section Six
IEEE
December 2012
https://standards.ieee.org/getieee802/download/802.3-2012_section6.pdf
IEEE Std 802.11-2007
Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY)
Specifications
IEEE
2007
https://standards.ieee.org/getieee802/download/802.11-2007.pdf
IEEE Std 802.11-2012
Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY)
Specifications
IEEE
March 2012
https://standards.ieee.org/getieee802/download/802.11-2012.pdf
IEEE Std 802.11-2016
Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY)
Specifications
IEEE
December 2016
https://ieeexplore.ieee.org/document/7786995
IEEE Std 802.11a-1999
High-speed Physical Layer in the 5 GHz band
IEEE
1999
https://standards.ieee.org/getieee802/download/802.11a-1999.pdf
IEEE Std 802.11ac-2013
Enhancements for Very High Throughput for Operation in Bands below 6
GHz
IEEE
December 2013
https://www.ieee802.org/11/Reports/tgac_update.htm
IEEE Std 802.11ax
Enhancements for High Efficiency WLAN
IEEE
May 2021
https://standards.ieee.org/standard/802_11ax-2021.html
IEEE Std 802.11b-1999
Higher Speed Physical Layer Extension in the 2.4 GHz band
IEEE
1999
https://standards.ieee.org/getieee802/download/802.11b-1999.pdf
IEEE Std 802.11g-2003
Further Higher Data Rate Extension in the 2.4 GHz Band
IEEE
2003
https://standards.ieee.org/getieee802/download/802.11g-2003.pdf
IEEE Std 802.11h-2003
Spectrum and Transmit Power Management Extensions
IEEE
2003
https://standards.ieee.org/getieee802/download/802.11h-2003.pdf
IEEE Std 802.11n-2009
Amendment 5: Enhancements for Higher Throughput
IEEE
2009
https://ieeexplore.ieee.org/xpl/freeabs_all.jsp?reload=true&arnumber=5307322
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
https://www.IEEE.org
ETSI EN 301 893
Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN;
Harmonized EN covering the essential requirements of article 3.2 of the
RTTE Directive
ETSI
https://www.etsi.org/deliver/etsi_en/301800_301899/301893/01.08.01_60/en_301893v010801p.pdf
ITU E.118
The international telecommunication charge card
International Telecommunication Union
May 2006
https://www.itu.int/rec/T-REC-E.118-200605-I/en
ITU E.164
The international public telecommunication numbering plan
International Telecommunication Union
October 2010
https://www.itu.int/rec/T-REC-E.164-201011-I/en
G.988
ONU management and control interface (OMCI) specification
ITU-T
2010
https://www.itu.int/rec/T-REC-G.988-201010-P/en
G.993.1
Very high speed digital subscriber line transceivers
ITU-T
https://www.itu.int/rec/T-REC-G.993.1
G.993.2
Very high speed digital subscriber line transceivers 2 (VDSL2)
ITU-T
https://www.itu.int/rec/T-REC-G.993.2
G.996.2
Single-ended line testing for digital subscriber lines (DSL)
ITU-T
https://www.itu.int/rec/T-REC-G.996.2
G.997.1
Physical layer management for digital subscriber line (DSL)
transceivers
ITU-T
https://www.itu.int/rec/T-REC-G.997.1
G.997.2
Physical layer management for FAST transceivers
ITU-T
2015
https://www.itu.int/rec/T-REC-G.997.2-201505-I
G.998.1
ATM-based Multi-Pair Bonding
ITU-T
2005
https://www.itu.int/rec/T-REC-G.998.1
G.998.2
Ethernet-based Multi-Pair Bonding
ITU-T
2005
https://www.itu.int/rec/T-REC-G.998.2
G.998.3
Multi-Pair Bonding Using Time-Division Inverse Multiplexing
ITU-T
2005
https://www.itu.int/rec/T-REC-G.998.2
G.9954
Phoneline networking transceivers - Enhanced physical, media access,
and link layer specifications (HPNA 3.0 and 3.1)
ITU-T
2007
https://www.itu.int/rec/T-REC-G.9954/en
G.9960
Unified high-speed wire-line based home networking transceivers -
System architecture and physical layer specification
ITU-T
G.hn series
https://www.itu.int/rec/T-REC-G.9960-201006-P
G.9961
Unified high-speed wire-line based home networking transceivers - Data
link layer specification
ITU-T
G.hn series
https://www.itu.int/rec/T-REC-G.9961-201006-P
G.9962
Unified high-speed wire-line based home networking transceivers -
Management specification
ITU-T
G.hn series
https://www.itu.int/rec/T-REC-G.9962-201308-P
G.9964
Unified high-speed wire-line based home networking transceivers - Power
spectral density specification
ITU-T
G.hn series
https://www.itu.int/rec/T-REC-G.9962-201308-P
G.9973
Protocol for identifying home network topology
ITU-T
2011
https://www.itu.int/rec/T-REC-G.9973-201110-I/en
G.9701
Fast access to subscriber terminals (G.fast)- Physical layer
specification
ITU-T
2014
https://www.itu.int/rec/T-REC-G.9701-201412-P
ITU X.733
Information technology - Open Systems Interconnection - Systems
Management: Alarm reporting function
International Telecommunication Union
February 1992
https://www.itu.int/rec/T-REC-X.733/en
IANAifType
IANAifType-MIB DEFINITIONS
IANA
2009
https://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib
IANA Protocol Numbers
Protocol Numbers
IANA
https://www.iana.org/assignments/protocol-numbers
IANA Uniform Resource Identifier (URI) Schemes Registry
Uniform Resource Identifier (URI) Schemes
IANA
https://www.iana.org/assignments/uri-schemes
IKEv2 Parameters
Internet Key Exchange Version 2 (IKEv2) Parameters
IANA
https://www.iana.org/assignments/ikev2-parameters/ikev2-parameters.xml
ISO 639-1
Codes for the representation of names of Languages - Part 1: Alpha-2
code
ISO
2002
https://www.iso.org/iso/language_codes
ISO/IEC 646-1991
Information Technology - ISO 7-bit coded character set for information
interchange
ISO
1991
ISO 3166-1
Codes for the representation of names of countries and their
subdivisions - Part 1: Country codes
ISO
2006
https://www.iso.org/iso/country_codes.htm
draft-ietf-ippm-metric-registry-12
Registry for Performance Metrics
IETF
Internet Draft
June 30, 2017
https://datatracker.ietf.org/doc/html/draft-ietf-ippm-metric-registry
RFC 7648
Port Control Protocol (PCP) Proxy Function
IETF
RFC
September 2015
https://www.rfc-editor.org/rfc/rfc7648
RFC 793
Transmission Control Protocol
IETF
RFC
September 1981
https://www.rfc-editor.org/rfc/rfc793
RFC 862
Echo Protocol
IETF
RFC
1983
https://www.rfc-editor.org/rfc/rfc862
RFC 959
File Transfer Protocol
IETF
RFC
1985
https://www.rfc-editor.org/rfc/rfc958
RFC 1035
Domain Names - Implementation and Specification
IETF
RFC
1987
https://www.rfc-editor.org/rfc/rfc1035
RFC 1323
TCP Extensions for High Performance
IETF
RFC
May 1992
https://www.rfc-editor.org/rfc/rfc1323
RFC 1332
The PPP Internet Protocol Control Protocol (IPCP)
IETF
1992
https://www.rfc-editor.org/rfc/rfc1332
RFC 1378
The PPP AppleTalk Control Protocol (ATCP)
IETF
RFC
1992
https://www.rfc-editor.org/rfc/rfc1378
RFC 1552
The PPP Internetwork Packet Exchange Control Protocol (IPXCP)
IETF
RFC
1993
https://www.rfc-editor.org/rfc/rfc1552
RFC 1661
The Point-to-Point Protocol (PPP)
IETF
1994
https://www.rfc-editor.org/rfc/rfc1661
RFC 1877
PPP Internet Protocol Control Protocol Extensions for Name Server
Addresses
IETF
1995
https://www.rfc-editor.org/rfc/rfc1877
RFC 1974
PPP Stac LZS Compression Protocol
IETF
1996
https://www.rfc-editor.org/rfc/rfc1974
RFC 2080
RIPng for IPv6
IETF
RFC
1997
https://www.rfc-editor.org/rfc/rfc2080
RFC 2097
The PPP NetBIOS Frames Control Protocol (NBFCP)
IETF
RFC
1997
https://www.rfc-editor.org/rfc/rfc2097
RFC 2131
Dynamic Host Configuration Protocol
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2131
RFC 2132
DHCP Options and BOOTP Vendor Extensions
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2132
RFC 2225
Classical IP and ARP over ATM
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2225
RFC 2364
PPP Over AAL5
IETF
1998
https://www.rfc-editor.org/rfc/rfc2364
RFC 2474
Definition of the Differentiated Services Field (DS Field) in the IPv4
and IPv6 Headers
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2474
RFC 2581
TCP Congestion Control
IETF
RFC
April 1999
https://www.rfc-editor.org/rfc/rfc2581
RFC 2582
The NewReno Modification to TCP's Fast Recovery Algorithm
IETF
RFC
April 1999
https://www.rfc-editor.org/rfc/rfc2582
RFC 2616
Hypertext Transfer Protocol - HTTP/1.1
IETF
RFC
1999
https://www.rfc-editor.org/rfc/rfc2616
RFC 2684
Multiprotocol Encapsulation over ATM Adaptation Layer 5
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2684
RFC 2697
A Single Rate Three Color Marker
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2697
RFC 2698
A Two Rate Three Color Marker
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2698
RFC 2782
A DNS RR for specifying the location of services (DNS SRV)
IETF
RFC
2000
https://www.rfc-editor.org/rfc/rfc2782
RFC 2784
Generic Routing Encapsulation (GRE)
IETF
RFC
November 2000
https://www.rfc-editor.org/rfc/rfc2784
RFC 2818
HTTP Over TLS
IETF
RFC
May 2000
https://www.rfc-editor.org/rfc/rfc2818
RFC 2819
Remote Network Monitoring Management Information Base
IETF
2000
RFC 2863
The Interfaces Group MIB
IETF
2000
https://www.rfc-editor.org/rfc/rfc2863
RFC 2865
Remote Authentication Dial In User Service (RADIUS)
IETF
2000
https://www.rfc-editor.org/rfc/rfc2865
RFC 2866
RADIUS Accounting
IETF
RFC
2000
RFC 2869
RADIUS Extensions
IETF
RFC
2000
RFC 2890
Key and Sequence Number Extensions to GRE
IETF
RFC
November 2000
https://www.rfc-editor.org/rfc/rfc2890
RFC 2898
PKCS #5: Password-Based Cryptography Specification Version 2.0
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2898
RFC 3004
The User Class Option for DHCP
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3004
RFC 3066
Tags for the Identification of Languages
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3066
RFC 3174
US Secure Hash Algorithm 1 (SHA1)
IETF
Draft Standard
September, 2001
https://www.rfc-editor.org/rfc/rfc3174
RFC 3232
"Assigned Numbers: RFC 1700 is Replaced by an On-line Database"
IETF
RFC
2002
https://www.rfc-editor.org/rfc/rfc3232
RFC 3315
Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
IETF
RFC
2003
https://www.rfc-editor.org/rfc/rfc3315
RFC 3339
Date and Time on the Internet: Timestamps
IETF
Draft Standard
July, 2002
https://www.rfc-editor.org/rfc/rfc3339
RFC 3596
DDNS Extensions to Support IP Version 6
IETF
RFC
2003
https://www.rfc-editor.org/rfc/rfc3596
RFC 3633
IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP)
version 6
IETF
RFC
2003
https://www.rfc-editor.org/rfc/rfc3633
RFC 3646
DNS Configuration options for Dynamic Host Configuration Protocol for
IPv6 (DHCPv6)
IETF
RFC
2003
https://www.rfc-editor.org/rfc/rfc3646
RFC 3775
Mobility Support in IPv6
IETF
RFC
2004
https://www.rfc-editor.org/rfc/rfc3775
RFC 3925
Vendor-Identifying Vendor Options for Dynamic Host Configuration
Protocol version 4 (DHCPv4)
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3925
RFC 3927
Dynamic Configuration of IPv4 Link-Local Addresses
IETF
2005
https://www.rfc-editor.org/rfc/rfc3927
RFC 3931
Layer Two Tunneling Protocol - Version 3 (L2TPv3)
IETF
RFC
March 2005
RFC 3948
UDP Encapsulation of IPsec ESP Packets
IETF
RFC
January 2005
https://www.rfc-editor.org/rfc/rfc3948
RFC 3986
Uniform Resource Identifier (URI): Generic Syntax
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3986
RFC 4007
IPv6 Scoped Address Architecture
IETF
RFC
https://www.rfc-editor.org/rfc/rfc4007
RFC 4122
A Universally Unique IDentifier (UUID) URN Namespace
IETF
RFC
2005
https://www.rfc-editor.org/rfc/rfc4122
RFC4180
Common Format and MIME Type for Comma-Separated Values (CSV) Files
IETF
RFC
October 2005
https://www.rfc-editor.org/rfc/rfc4180
RFC 4191
Default Router Preferences and More-Specific Routes
IETF
RFC
2005
https://www.rfc-editor.org/rfc/rfc4191
RFC 4193
Unique Local IPv6 Unicast Addresses
IETF
RFC
2005
https://www.rfc-editor.org/rfc/rfc4193
RFC 4242
Information Refresh Time Option for Dynamic Host Configuration Protocol
for IPv6 (DHCPv6)
IETF
RFC
2005
https://www.rfc-editor.org/rfc/rfc4242
RFC 4291
IP Version 6 Addressing Architecture
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4291
RFC 4292
IP Forwarding Table MIB
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4292
RFC 4293
Management Information Base for the Internet Protocol (IP)
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4293
RFC 4301
Security Architecture for the Internet Protocol
IETF
December 2005
https://www.rfc-editor.org/rfc/rfc4301
RFC 4302
IP Authentication Header
IETF
RFC
December 2005
https://www.rfc-editor.org/rfc/rfc4302
RFC 4303
IP Encapsulating Security Payload (ESP)
IETF
RFC
December 2005
https://www.rfc-editor.org/rfc/rfc4303
RFC 4389
Neighbor Discovery Proxies (ND Proxy)
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4389
RFC 4632
Classless Inter-domain Routing (CIDR): The Internet Address Assignment
and Aggregation Plan
IETF
2006
https://www.rfc-editor.org/rfc/rfc4632
RFC 4719
Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3
(L2TPv3)
IETF
RFC
November 2006
RFC 4835
Cryptographic Algorithm Implementation Requirements for Encapsulating
Security Payload (ESP) and Authentication Header (AH)
IETF
RFC
2007
https://www.rfc-editor.org/rfc/rfc4835
RFC 4861
Neighbor Discovery for IP version 6 (IPv6)
IETF
RFC
2007
https://www.rfc-editor.org/rfc/rfc4861
RFC 4862
IPv6 Stateless Address Autoconfiguration
IETF
RFC
2007
https://www.rfc-editor.org/rfc/rfc4862
RFC 5072
IP Version 6 over PPP
IETF
RFC
2007
https://www.rfc-editor.org/rfc/rfc5072
RFC 5139
Revised Civic Location Format For Presence Information Data Format
Location Object (PIDF-LO)
IETF
February 2008
https://www.rfc-editor.org/rfc/rfc5139
RFC 5280
Internet X.509 Public Key Infrastructure Certificate and Certificate
Revocation List (CRL) Profile
IETF
May 2008
https://www.rfc-editor.org/rfc/rfc5280
RFC 5491
GEOPRIV Presence Information Data Format Location Object (PIDF-LO)
Usage Clarification, Considerations, and Recommendations
IETF
March 2009
https://www.rfc-editor.org/rfc/rfc5491
RFC 5625
DNS Proxy Implementation Guidelines
IETF
2009
https://www.rfc-editor.org/rfc/rfc5625
RFC 5969
IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol
Specification
IETF
RFC
2010
https://www.rfc-editor.org/rfc/rfc5969
RFC 5996
Internet Key Exchange Protocol Version 2 (IKEv2)
IETF
RFC
September 2010
https://www.rfc-editor.org/rfc/rfc5996
RFC 6106
IPv6 Router Advertisement Option for DNS Configuration
IETF
RFC
2010
https://www.rfc-editor.org/rfc/rfc6106
RFC 6120
Extensible Messaging and Presence Protocol (XMPP) : Core
IETF
2011
https://www.rfc-editor.org/rfc/rfc6120
RFC 6234
US Secure Hash Algorithms (SHA and SHA-based HMAC and HKDF)
IETF
Draft Standard
May, 2011
https://www.rfc-editor.org/rfc/rfc6234
RFC 6333
Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion
IETF
RFC
2011
RFC 6334
Dynamic Host Configuation Protocol for IPv6 (DHCPv6) Option for
Dual-Stack Lite
IETF
RFC
2011
RFC 6455
The WebSocket Protocol
IETF
RFC
December 2011
https://www.rfc-editor.org/rfc/rfc6455
RFC 6762
Multicast DNS
IETF
RFC
February 2013
https://www.rfc-editor.org/rfc/rfc6762
RFC 6763
DNS-Based Service Discovery
IETF
RFC
2013
https://www.rfc-editor.org/rfc/rfc6763
RFC 6838
Media Type Specifications and Registration Procedures
IETF
Best Current Practice
January 2013
https://www.rfc-editor.org/rfc/rfc6838
RFC 6887
Port Control Protocol (PCP)
IETF
2013
https://www.rfc-editor.org/rfc/rfc6887
RFC 6970
Universal Plug and Play (UPnP) Internet Gateway Device (IGD) - Port
Control Protocol (PCP) Interworking Function
IETF
2013
https://www.rfc-editor.org/rfc/rfc6970
RFC7159
The JavaScript Object Notation (JSON) Data Interchange Format
IETF
RFC
March 2014
https://www.rfc-editor.org/rfc/rfc7159
RFC 7230
Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
IETF
RFC
June 2014
https://www.rfc-editor.org/rfc/rfc7230
RFC 7252
The Constrained Application Protocol (CoAP)
IETF
RFC
June 2014
https://www.rfc-editor.org/rfc/rfc7252
RFC 7291
DHCP Options for the Port Control Protocol (PCP)
IETF
RFC
July 2014
https://www.rfc-editor.org/rfc/rfc7291
RFC 7348
Virtual eXtensible Local Area Network (VXLAN)
IETF
RFC
August 2014
RFC 7395
An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for
WebSocket
IETF
Standards Track
October 2014
https://www.rfc-editor.org/rfc/rfc7395
RFC 7398
A Reference Path and Measurement Points for Large-Scale Measurement of
Broadband Performance
IETF
Informational RFC
February 2015
https://www.rfc-editor.org/rfc/rfc7398
RFC 7468
Textual Encoding of PKIX, PKCS, and CMS Structures
IETF
Standards Track
April 2015
https://www.rfc-editor.org/rfc/rfc7468
RFC 7594
A Framework for Large-Scale Measurement of Broadband Performance (LMAP)
IETF
Informational RFC
September 2015
https://www.rfc-editor.org/rfc/rfc7594
RFC 7597
Mapping of Address and Port with Encapsulation (MAP)
IETF
RFC
July 2015
https://www.rfc-editor.org/rfc/rfc7597
RFC 7598
DHCPv6 Options for configuration of Softwire Address and Port Mapped
Clients
IETF
RFC
July 2015
https://www.rfc-editor.org/rfc/rfc7598
RFC 7599
Mapping of Address and Port using Translation (MAP-T)
IETF
RFC
July 2015
https://www.rfc-editor.org/rfc/rfc7599
RFC 8141
Uniform Resource Names (URNs)
IETF
RFC
April 2017
https://www.rfc-editor.org/rfc/rfc8141
RFC 8193
Information Model for Large-Scale Measurement Platforms (LMAPs)
IETF
Informational RFC
August 2017
https://www.rfc-editor.org/rfc/rfc8193
TR-064 Corrigendum 1
LAN-Side DSL CPE Configuration Specification
Broadband Forum
TR
August 2015
TR-069 Amendment 6
CPE WAN Management Protocol
Broadband Forum
TR
April 2018
TR-106 Amendment 8
Data Model Template for CWMP Endpoints and USP Agents
Broadband Forum
TR
May 2018
TR-124 Issue 5
Functional Requirements for Broadband Residential Gateway Devices
Broadband Forum
TR
July 2016
TR-124 Issue 6
Functional Requirements for Broadband Residential Gateway Devices
Broadband Forum
TR
July 2020
TR-143 Amendment 1 Corrigendum 1
Enabling Network Throughput Performance Tests and Statistical
Monitoring
Broadband Forum
TR
August 2015
TR-159
Management Framework for xDSL Bonding
Broadband Forum
TR
December 2008
TR-181 Issue 2 Amendment 15
Device Data Model
Broadband Forum
TR
January 2022
TR-232
Bulk Data Collection
Broadband Forum
Technical Report
May 2012
TR-262
Femto Component Objects
Broadband Forum
TR
November 2011
TR-304
Broadband Access Service Attributes and Performance Metrics
Broadband Forum
Technical Report
February 2015
TR-369 Issue 1 Amendment 2
User Services Platform
Broadband Forum
Technical Report
January 2022
https://usp.technology/specification
TR-390
Performance Measurement from Customer Equipment to IP Edge
Broadband Forum
Technical Report
May 2017
TR-471
Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements
Broadband Forum
Technical Report
December 2023
https://www.broadband-forum.org/download/TR-471_Issue-4.pdf
Data Elements Specification
Data Elements Specification Version 1.0
January 2019
https://www.wi-fi.org/discover-wi-fi/specifications
Multi-AP Specification
Multi-AP Specification Version 1.0
June 2018
https://www.wi-fi.org/discover-wi-fi/specifications
Wi-Fi Protected Setup Specification Version 1.0h
Wi-Fi Alliance
2006
https://www.wi-fi.org/discover-wi-fi/specifications
WSC 2.0
Wi-Fi Simple Configuration Technical Specification Version 2.0.x
Wi-Fi Alliance
https://www.wi-fi.org/discover-wi-fi/specifications
Blue
A New Class of Active Queue Management Algorithms
https://en.wikipedia.org/wiki/Blue_(queue_management_algorithm)
BPF
Berkeley Packet Filter Syntax
FreeBSD.org
October 2016
https://www.freebsd.org/cgi/man.cgi?query=bpf
DLNA Networked Device Interoperability Guidelines
DLNA Networked Device Interoperability Guidelines, Volume 2: Media
Format Profiles.
DLNA
October 2006
https://www.dlna.org/industry/certification/guidelines/
HomePlug™ AV Specification
Version 1.1
HomePlug Alliance
2007
https://en.wikipedia.org/wiki/HomePlug
HTML 4.01 Specification
W3C
https://www.w3.org/TR/html4
ICSA Baseline Modular Firewall Certification Criteria
Baseline module - version 4.1
ICSA Labs
2008
https://www.icsalabs.com/sites/default/files/baseline.pdf
ICSA Residential Modular Firewall Certification Criteria
Required Services Security Policy - Residential Category module -
version 4.1
ICSA Labs
2008
https://www.icsalabs.com/sites/default/files/residential.pdf
IPDR File Transfer Protocol
IPDR/File Transfer Protocol
TM Forum
https://www.tmforum.org/ipdr/
IPDR Streaming Protocol
IPDR Streaming Protocol (IPDR/SP) Specification
TM Forum
https://www.tmforum.org/ipdr/
IPDR XDR Encoding Format
IPDR/XDR Encoding Format
TM Forum
https://www.tmforum.org/ipdr/
IPDR XML File Encoding Format
IPDR/XML File Encoding Format
TM Forum
https://www.tmforum.org/ipdr/
JJ-300.00
Home-network Topology Identifying Protocol
TTC
2017
https://www.ttc.or.jp/application/files/1115/5443/0461/JJ-300.00Ev3.pdf
JJ-300.01
The List of Device Categories
TTC
2018
https://www.ttc.or.jp/application/files/8315/5443/0461/JJ-300.01Ev2.1.pdf
Libpcap
Libpcap File Format
Wireshark
2015
https://wiki.wireshark.org/Development/LibpcapFileFormat
MoCA v1.0
MoCA MAC/PHY Specification v1.0
MoCA Alliance
2009
https://www.mocalliance.org
MoCA v1.1
MoCA MAC/PHY Specification v1.1 Extensions
MoCA Alliance
2009
https://www.mocalliance.org
MOCA11-MIB
Remote Management of MoCA Interfaces using SNMP MIB
MoCA Alliance
2009
https://www.mocalliance.org
MQTT v3.1
MQ Telemetry Transport (MQTT) V3.1 Protocol Specification
2010
https://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html
MQTT Version 3.1.1
MQTT v3.1.1
OASIS Message Queuing Telemetry Transport (MQTT) TC
October 2014
https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html
MQTT Version 5.0
MQTT Version 5.0, Candidate OASIS Standard 02.
OASIS Message Queuing Telemetry Transport (MQTT) TC
February 2019
https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html
References on RED (Random Early Detection) Queue Management
http://www.icir.org/floyd/red.html
Simple Object Access Protocol (SOAP) 1.1
W3C
https://www.w3.org/TR/2000/NOTE-SOAP-20000508
STOMP Protocol Specification
STOMP Protocol Specification, Version 1.2
https://stomp.github.io/stomp-specification-1.2.html
Universal Powerline Association
UPA
https://www.upaplc.org
UPnP Device Architecture
UPnP Device Architecture 1.0
UPnP Forum
April 2008
http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf
UPnP Device Architecture 1.1
UPnP Device Architecture 1.1
UPnP Forum
October, 2008
http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf
UPnP Device Management:1
UPnP Device Management v1
https://openconnectivity.org/developer/specifications/upnp-resources/upnp/device-management1-2
UPnP InternetGatewayDevice:1
InternetGatewayDevice:1 Device Template Version 1.01
UPnP
SDCP
2001
http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf
UPnP InternetGatewayDevice:2
InternetGatewayDevice:2 Device Template Version 1.01
UPnP
SDCP
2010
http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf
USB 1.0
USB 1.0 Specification
USB-IF
January 1996
https://www.usb.org/documents
USB 2.0
USB 2.0 Specification
USB-IF
April 2000
https://www.usb.org/documents
USB 3.0
USB 3.0 Specification
USB-IF
November 2008
https://www.usb.org/documents
Z-Wave
Z-Wave website
https://www.z-wave.com
ZigBee
ZigBee Alliance website
https://csa-iot.org/all-solutions/zigbee
ZigBee 2007 Specification
ZigBee 2007 Specification
ZigBee Alliance
October 2007
https://csa-iot.org/all-solutions/zigbee
A change of this parameter is only communicated to the MQTT server with the
next MQTT CONNECT packet.
{{template|MQTTChange}} If the change needs to be applied immediately, the
command {{command|ForceReconnect()}} has to be executed.
{{template|MQTTChange}} If will handling is enabled (Parameter
{{param|WillEnable}} is set to {{true}}) and the change needs to be applied
immediately, the command {{command|ForceReconnect()}} has to be executed.
This parameter only applies if {{param|ProtocolVersion}} is set to
{{enum|5.0|#.Capabilities.ProtocolVersionsSupported}}.
{{bibref|TR-369|Annex A}}
{{bibref|TR-369|Annex A.1.1}}
{{bibref|TR-369|Annex A.1.2.1}}
{{bibref|TR-369|Annex A.2.1}}
{{bibref|TR-369|Annex A.2.4}}
{{bibref|TR-369|Annex A.2.5}}
The USPEventNotif solution is based on sending a
{{event|Profile.{i}.Push!}} Event Notification via USP {{bibref|TR-369}}.
The top-level object for a Device.
Root data model version, e.g. ''2.4''. For a vendor-defined root data
model, this is the standard Broadband Forum model on which the
vendor-defined model is based.
{{numentries}}
{{numentries}}
Reboot the entity associated with the containing {{object}}.
Boot event indicating that the {{object}} was rebooted.
The ''command_key'' supplied when requesting the boot, or {{empty}}
if the boot was not requested via a USP operation.
The cause of the boot.
A {{object}} Event that was the result of a reboot triggered
locally on the Device (NOT as a result of a
{{command|#.Reboot()}} Command)
A {{object}} Event that was the result of a reboot triggered
via the {{command|#.Reboot()}} Command
A {{object}} Event that was the result of a factory reset
triggered locally on the Device (NOT as a result of a
{{command|#.FactoryReset()}} Command)
A {{object}} Event that was the result of a factory reset
triggered via the {{command|#.FactoryReset()}} Command
{{true}} if the firmware was updated as a result of the boot that
caused this Event Notification; otherwise {{false}}.
Boot parameters configured via the recipient Controller's
{{object|.LocalAgent.Controller.{i}.BootParameter}} table.
Formatted as a {{datatype|expand}}
Factory reset the entity associated with the containing {{object}}.
This diagnostics test is vendor-specific and MAY include testing
hardware, software, and/or firmware.
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.
Results of self-test (vendor specific).
This diagnostic command is used to record packet capture data on a
valid (layer 2 or above) interface in libpcap or pcapng format.
A reference to a (layer 2 or above) interface object that will be
the target of this packet capture diagnostic.
This indicates whether the network trace will be recorded in
libpcap {{bibref|LIBPCAP}} or pcapng format, and is dependent on
the underlying method of performing a network trace.
The packet data is recorded in libpcap {{bibref|LIBPCAP}}
format.
The packet data is recorded in pcapng format.
The duration in {{units}} to copy packets to the file target. The
diagnostic completes when either the {{param}},
{{param|PacketCount}}, or {{param|ByteCount}} conditions are met.
The maximum number of packets to record to the file target. A
value of zero (0) indicates no limit. The diagnostic completes
when the {{param|Duration}}, {{param|ByteCount}}, or {{param}}
conditions are met.
The maximum number of bytes to record to the file target. A value
of zero (0) indicates no limit. The diagnostic completes when
{{param|Duration}}, {{param|PacketCount}} or {{param}} conditions
are met.
The {{datatype}} specifying the destination file location. HTTP
and HTTPS transports MUST be supported. Other transports MAY be
supported.
A ({{bibref|BPF}}) formatted expression used to restrict the
types of network packets that are recorded to
{{param|FileTarget}}.
Username to be used by the Agent to authenticate with the file
location. This string is set to {{empty}} if no authentication is
required.
Password to be used by the Agent to authenticate with the file
location. This string is set to {{empty}} if no authentication is
required. When read, this parameter returns an empty string,
regardless of the actual value.
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.
Results for individual packet capture diagnostics. Packet capture
files whose FileLocation is local to the system SHOULD be deleted
when the next diagnostic is run, or upon a system reboot.
The {{datatype}} specifying the resulting file location of the
packet capture record that triggered this result. This MAY be
different than the location specified in FileTarget.
The local system time at which the capture was started.
The local system time at which the capture was completed.
The number of packets recorded to the file target.
Schedule an async timer operation. A scheduled timer MUST persist
across reboots. NOTE: This command changed from synchronous to
asynchronous in version 2.14.
The number of {{units}} from the time this command is invoked
until the Agent responds with an OperationComplete Event
notification (based on the associated subscriptions).
{{numentries}}
{{numentries}}
This object contains general services information.
This object contains general device information.
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.
The manufacturer of the CPE (human readable string).
Organizationally unique identifier of the device manufacturer.
Represented as a six hexadecimal-digit value using all upper-case
letters and including any leading zeros. {{pattern}} The value MUST
be a valid OUI as defined in {{bibref|OUI}}. This value MUST remain
fixed over the lifetime of the device, 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. {{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.
Model name of the CPE (human readable string).
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.
A full description of the CPE device (human readable string).
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 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.
A string identifying the particular CPE model and version.
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.
{{noreference}}A full path reference to the row in the
{{object|FirmwareImage}} table representing the currently running
firmware image.
{{noreference}}A full path reference to the row in the
{{object|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 {{object|FirmwareImage}}
object where the ({{param|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.
{{list}} Each entry is an additional version. Represents any
additional hardware version information the vendor might wish to
supply.
{{list}} Each entry is an additional version. Represents any
additional software version information the vendor might wish to
supply.
Identifier of the primary service provider and other provisioning
information, which MAY be used by the ACS to determine service
provider-specific customization and provisioning parameters.
Time in {{units}} since the CPE was last restarted.
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.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
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}}.
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.
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.
{{datatype|expand}}
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.
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 {{empty}}.
Date and time when the content of the current version of this vendor
configuration file was first applied by the CPE.
A description of the vendor configuration file (human-readable
string).
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.
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.
The {{datatype}} 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 {{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file
server. This string is set to {{empty}} if no authentication is
required.
Password to be used by the Agent to authenticate with the file
server. This string is set to {{empty}} if no authentication is
required.
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.
The {{datatype}} 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
{{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file
server. This string is set to {{empty}} if no authentication is
required.
Password to be used by the Agent to authenticate with the file
server. This string is set to {{empty}} if no authentication is
required.
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.
The name of the file to be used on the target file system. This
argument MAY be {{empty}} 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.
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.
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
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
{{param|CheckSumAlgorithm}} input argument. If this argument is
{{empty}}, the Agent MUST NOT perform a checksum validation of
the downloaded file.
Status of the device's volatile physical memory.
The total physical RAM, in {{units}}, installed on the device.
The free physical RAM, in {{units}}, currently available on the
device.
Status of the processes on the device.
The total amount of the CPU, in {{units}}, rounded up to the nearest
whole {{units}}. In the case that multiple CPU are present, this
value represents the average of all CPU.
{{numentries}}
List of all processes running on the device.
The Process Identifier.
The name of the command that has caused the process to exist.
The size in {{units}} of the memory occupied by the process.
The priority of the process where 0 is highest.
The amount of time in {{units}} that the process has spent taking up
CPU time since the process was started.
The current state that the process is in.
Status of the temperature of the device.
{{numentries}}
This object represents information that the device has obtained via
sampling an internal temperature sensor.
{{datatype|expand}}
Indicates whether or not the temperature sensor is enabled.
The status of this temperature sensor.
The sensor is not currently sampling the temperature.
The sensor is currently sampling the temperature.
The sensor error currently prevents sampling the temperature.
Resets the temperature sensor.
The time at which this temperature sensor was reset. Reset can be
caused by:
* {{param|Status}} transition from {{enum|Disabled|Status}} to
{{enum|Enabled|Status}}
* {{param|Reset}} set to {{true}}.
* An internal reset of the temperature sensor (including a reboot of
the device). The Unknown Time value, as defined in
{{bibref|TR-106}}, indicates that this temperature sensor has never
been reset, which can only happen if it has never been enabled.
Name of this temperature sensor. This text MUST be sufficient to
distinguish this temperature sensor from other temperature sensors.
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.
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.
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.
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.
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.
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.
This temperature sensor's low alarm value in {{units}}. A value of
-274 (which is below absolute zero) indicates a non configured value.
A change to this value will cause {{param|LowAlarmTime}} to be reset.
Initial time at which this temperature sensor's
{{param|LowAlarmValue}} was encountered. This value is only set the
first time the alarm is seen and not changed until the next reset.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates
that an alarm has not been encountered since the last reset.
This temperature sensor's high alarm value in {{units}}. A value of
-274 (which is below absolute zero) indicates a non configured value.
A change to this value will cause {{param|HighAlarmTime}} to be
reset.
The interval, measured in {{units}}, in which the device polls this
{{object}}. 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.
Initial time at which this temperature sensor's
{{param|HighAlarmValue}} was encountered. This value is only set the
first time the alarm is seen and not changed until the next reset.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates
that an alarm has not been encountered since the last reset.
This object defines the parameters that describe how the device handles
network traffic.
The maximum number of {{units}} of outstanding data a sender can send
on a particular connection prior to an acknowledgment
{{bibref|RFC793}}. Any scaling factor SHOULD be included in this
parameter {{bibref|RFC1323}}.
{{list}} Indicates the TCP congestion control mechanism(s)
implemented. {{enum}} Tahoe, Reno, and New Reno are defined in
{{bibref|RFC2582}}
Represents the base TCP implementation in {{bibref|RFC793}} and
elements of {{bibref|RFC2582}}
Represents the base TCP implementation in {{bibref|RFC793}}
with the additional algorithms defined in {{bibref|RFC2581}}
Described as a modification to the Reno algorithms in
{{bibref|RFC2582}}
An emerging TCP congestion control mechanism
Each table entry represents a hardware or virtual processor that
resides on this device.
{{datatype|expand}}
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}}.
big-endian
little-endian
big-endian
little-endian
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.
{{datatype|expand}}
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.
The maximum size of the log file in {{units}}. If the device doesn't
know the maximum file size then {{param}} will be 0.
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.
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.
The {{datatype}} 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 {{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file
server. This string is set to {{empty}} if no authentication is
required.
Password to be used by the Agent to authenticate with the file
server. This string is set to {{empty}} if no authentication is
required.
This object contains Location information.
Identifies the source of the location data.
The time when the location was acquired.
URL, MAC address, or other identifier that identifies an "External"
source of this location. Meaningful only if {{param|Source}} has a
value of {{enum|External|Source}}, otherwise it MUST be {{empty}}. If
{{param|ExternalProtocol}} has a value of
{{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the
Controller.
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}}.
{{empty}}
The currently valid location information. Writable only when
{{param|ExternalProtocol}} has a value of
{{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}}. If
obtained through the local GPS/AGPS then the location information is
formatted according to {{bibref|RFC5491}}. If manually configured
then location information will be XML-formatted according to
{{bibref|RFC5491}} (geographical information) and {{bibref|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
{{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}}
(civic addresses). Only zero or one Location object instance with
value {{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}}
MUST exist at any given time.
This object describes an image of the device.
{{datatype|expand}}
The location of the device that represents the image as the user
looks at the front of the device in its typical orientation (e.g.,
on-end, flat).
The device image in PNG, JPEG or GIF format.
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.
{{datatype|expand}}
Firmware/software image name. Descriptive text of the image or
filename. The value of {{param}} is {{empty}} if {{param|Status}} is
anything other than {{enum|Available|Status}},
{{enum|InstallationFailed|Status}}, or
{{enum|ActivationFailed|Status}}.
A string identifying the version of the firmware image represented by
this {{object}}. Whenever this firmware image is active (ie, the
device has booted this firmware image), the value of the
{{param|.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 {{param}} is {{empty}} if
{{param|Status}} is anything other than {{enum|Available|Status}},
{{enum|InstallationFailed|Status}}, or
{{enum|ActivationFailed|Status}}.
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 {{param|#.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.
Status of the firmware image, as determined by the Agent. {{enum}}
This Firmware Image instance is empty. This value could happen
on an Agent that supports multiple firmware images, but only
has a single image installed.
This Firmware Image instance is the currently active image.
This Firmware Image instance is being downloaded.
This Firmware Image instance has been downloaded, and is in the
process of being validated.
This Firmware Image instance has been downloaded, validated,
and installed, and is ready to be activated.
The Agent has attempted to download this Firmware Image
instance, but ultimately failed while retrieving it from the
source URL.
The Agent has attempted to validate a Firmware Image downloaded
to this instance, but ultimately failed while validating it.
The Agent has attempted to install a Firmware Image downloaded
and validated to this instance, but ultimately failed while
installing it.
The Agent has attempted to active this Firmware Image instance,
but ultimately failed while being activated.
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
{{empty}}. 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.
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.
The {{datatype}} 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
{{bibref|RFC3986}}.
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.
Username to be used by the Agent to authenticate with the file
server. This argument is omitted if no authentication is
required.
Password to be used by the Agent to authenticate with the file
server. This argument is omitted if no authentication is
required.
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.
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.
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
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
{{param|CheckSumAlgorithm}} input argument. If this argument is
{{empty}}, the Agent MUST NOT perform a checksum validation of
the downloaded file.
This command is issued to activate this {{object}} instance. A
{{object}} instance can also be activated by setting the
{{param|Device.DeviceInfo.BootFirmwareImage}} parameter and causing
the Agent to reboot. A successful activation will result in a reboot
of the device with this {{object}} as the currently running firmware
image. Furthermore, this {{object}} will be referenced by the
{{param|Device.DeviceInfo.ActiveFirmwareImage}} parameter. A failed
activation will result in this {{object}} instance's
{{param|BootFailureLog}} being updated.
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 {{object}} 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.
Start of this time window as an offset in {{units}} after
invoking the command. An offset is used in order to avoid a
dependence on absolute time.
End of this time window as an offset in {{units}} after
invoking the command. An offset is used in order to avoid a
dependence on absolute time.
Specifies when within this time window the Agent is permitted
to activate the specified firmware image.
The Agent MAY activate the firmware image at any time
during the time window even if this results in
interruption of service for the subscriber.
The Agent MUST activate the firmware image immediately at
the start of the time window even if this results in
interruption of service for the subscriber.
The Agent MUST NOT cause an interruption of service from
the subscriber's standpoint while activating the firmware
image during the time window. How the Agent determines
this is outside the scope of this specification.
The Agent MUST ask for and receive confirmation before
activating the firmware image. It is outside the scope of
this specification how the Agent asks for and receives
this confirmation. If confirmation is not received, this
time window MUST NOT be used.
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 {{param|Mode}} is
{{enum|ConfirmationNeeded|Mode}}. When there is no need for
such a message, it SHOULD be {{empty}} and MUST be ignored.
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 {{param|Mode}} input
argument is {{enum|ConfirmationNeeded|Mode}}, otherwise this
input argument MUST be ignored.
This object contains parameters relating an NTP or SNTP time client in
the CPE.
Enables or disables the NTP or SNTP time client.
Status of Time support on the CPE. {{enum}} The
{{enum|Unsynchronized}} value indicates that the CPE's absolute time
has not yet been set. The {{enum|Synchronized}} value indicates that
the CPE has acquired accurate absolute time; its current time is
accurate. The {{enum|Error_FailedToSynchronize}} value indicates that
the CPE failed to acquire accurate absolute time; its current time is
not accurate. The {{enum|Error}} value MAY be used by the CPE to
indicate a locally defined error condition.
First NTP timeserver. Either a host name or IP address.
Second NTP timeserver. Either a host name or IP address.
Third NTP timeserver. Either a host name or IP address.
Fourth NTP timeserver. Either a host name or IP address.
Fifth NTP timeserver. Either a host name or IP address.
The current date and time in the CPE's local time zone.
The local time zone definition, encoded according to IEEE 1003.1
(POSIX). The following is an example value:
: EST+5 EDT,M4.1.0/2,M10.5.0/2
This object contains parameters relating to the user interface of the
CPE.
Enables and disables the CPE's user interface.
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 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 Agent provides a password-protected LAN-side user
interface and supports LAN-side Auto-Configuration. Reset
{{param|.LANConfigSecurity.ConfigPassword}} to its factory value.
Indicates that a CPE upgrade is available, allowing the CPE to
display this information to the user.
Indicates the date and time in UTC that the warranty associated with
the CPE is to expire.
The name of the customer's ISP.
The help desk phone number of the ISP.
The {{datatype}} of the ISP's home page.
The {{datatype}} of the ISP's on-line support page.
Base64 encoded GIF or JPEG image. The binary image is constrained to
4095 bytes or less.
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.
The {{datatype}} of the ISP's mail server.
The {{datatype}} of the ISP's news server.
The color of text on the GUI screens in RGB hexadecimal notation
(e.g., FF0088).
The color of the GUI screen backgrounds in RGB hexadecimal notation
(e.g., FF0088).
The color of buttons on the GUI screens in RGB hexadecimal notation
(e.g., FF0088).
The color of text on buttons on the GUI screens in RGB hexadecimal
notation (e.g., FF0088).
The server the CPE can check to see if an update is available for
direct download to it.
The server where a user can check via a web browser if an update is
available for download to a PC.
{{list}} List items represent user-interface languages that are
available, where each language is specified according to
{{bibref|RFC3066}}.
Current user-interface language, specified according to
{{bibref|RFC3066}}. The value MUST be a member of the list reported
by the {{param|AvailableLanguages}} parameter.
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}}.
Enables/Disables remotely accessing the CPE's user interface.
Destination TCP port required for remote access connection.
{{list}} Indicates the protocols that are supported by the CPE for
the purpose of remotely accessing the user interface.
As defined in {{bibref|RFC2616}}
As defined in {{bibref|RFC2818}}
This is the protocol currently being used for remote access.
This object describes how to remotely manage the initial positioning of
a user interface on a device's local display.
Controls whether the user is allowed to change the GUI window
position on the local CPE's display.
Controls whether the user is allowed to resize the GUI window on the
local CPE's display.
The horizontal position of the User Interface's top left corner
within the local CPE's display measured from the top left corner,
expressed in {{units}}.
The vertical position of the User Interface's top left corner within
the local CPE's display measured from the top left corner, expressed
in {{units}}.
The width of the user interface within the local CPE's display,
expressed in {{units}}.
The height of the user interface within the local CPE's display,
expressed in {{units}}.
The width of the local CPE's display, expressed in {{units}}.
The height of the local CPE's display, expressed in {{units}}.
Definition of user information message displays.
Enables and displays the user information message.
Message title to be displayed.
Message sub title to be displayed.
Message text.
Icon to be displayed.
The color of message text in RGB hexadecimal notation (e.g., FF0088).
The color of the message screen background in RGB hexadecimal
notation (e.g., FF0088).
The color of the message title in RGB hexadecimal notation (e.g.,
FF0088).
The color of the sub title in RGB hexadecimal notation (e.g.,
FF0088).
The number of times the device SHOULD repeat the message.
The number of times the device repeated the message.
This table contains information about the relationships between the
multiple layers of interface objects ({{bibref|TR-181i2|Section 4.3}}).
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
{{param|HigherLayer}}) and a lower-layer interface object (referenced
by {{param|LowerLayer}}). Consequently, if a referenced interface
object is deleted, the CPE MUST delete the corresponding {{object}}
row(s) that had referenced it.
{{datatype|expand}}
{{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.
{{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.
The value of the ''Alias'' parameter for the interface object
referenced by {{param|HigherLayer}}.
The value of the ''Alias'' parameter for the interface object
referenced by {{param|LowerLayer}}.
This object models DSL lines, DSL channels, DSL bonding, and DSL
diagnostics. The specific interface objects defined here are
{{object|Line}}, {{object|Channel}}, and {{object|BondingGroup}}. Each
{{object|Line}} models a layer 1 DSL Line interface, and each
{{object|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 {{object|BondingGroup}} is stacked
above the {{object|Channel}} instances within its group.
{{numentries}}
{{numentries}}
{{numentries}}
DSL Line table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This table models physical DSL lines.
Enables or disables the DSL line. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
Enables or disables data gathering on the DSL line.
The current operational state of the DSL line (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the DSL line as assigned by the CPE.
The accumulated time in {{units}} since the DSL line entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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.
Status of the DSL physical link. {{enum}} When {{param}} is
{{enum|Up}}, {{param|Status}} is expected to be {{enum|Up|Status}}.
When {{param}} is {{enum|Initializing}} or {{enum|EstablishingLink}}
or {{enum|NoSignal}} or {{enum|Disabled}}, {{param|Status}} is
expected to be {{enum|Down|Status}}. The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{list}} List items indicate which DSL standards and recommendations
are supported by the {{object}} instance. {{enum}} Note: In G.997.1,
this parameter is called "xDSL Transmission system capabilities". See
ITU-T Recommendation {{bibref|G.997.1}}. This parameter was
DEPRECATED because its entries are out-of-date; {{param|XTSE}} points
to a current list. Therefore its value MAY be {{empty}} if (and only
if) {{param|XTSE}} is supported. This parameter is OBSOLETED in 2.14.
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}}.
Indicates the standard that the {{object}} instance is using for the
connection. Note: In G.997.1, this parameter is called "xDSL
Transmission system". See ITU-T Recommendation {{bibref|G.997.1}}.
This parameter was DEPRECATED because its entries are out-of-date;
{{param|XTSE}} points to a current list. Therefore its value MAY be
{{empty}} if (and only if) {{param|XTSUsed}} is supported. This
parameter is OBSOLETED in 2.14.
This parameter indicates which DSL standard and recommendation are
currently in use by the {{object}} instance. Only one bit is set, as
defined for the xTU transmission system enabling (XTSE) in ITU-T
G.997.1.
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.
{{list}} List items indicate which VDSL2 profiles are allowed on the
line. {{enum}} Note: In G.997.1, this parameter is called PROFILES.
See ITU-T Recommendation {{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
{{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 {{empty}}.
The power management state of the line. {{enum}} Note: See ITU-T
Recommendation {{bibref|G.997.1}}.
The success failure cause of the initialization. An enumeration of
the following integer values:
* 0: Successful
* 1: Configuration error. This error occurs with inconsistencies in
configuration parameters, e.g. when the line is initialized in an
xDSL Transmission system where an xTU does not support the
configured Maximum Delay or the configured Minimum or Maximum Data
Rate for one or more bearer channels.
* 2: Configuration not feasible on the line. This error occurs if the
Minimum Data Rate cannot be reached on the line with the Minimum
Noise Margin, Maximum PSD level, Maximum Delay and Maximum Bit
Error Ratio for one or more bearer channels.
* 3: Communication problem. This error occurs, for example, due to
corrupted messages or bad syntax messages or if no common mode can
be selected in the G.994.1 handshaking procedure or due to a
timeout.
* 4: No peer xTU detected. This error occurs if the peer xTU is not
powered or not connected or if the line is too long to allow
detection of a peer xTU.
* 5: Any other or unknown Initialization Failure cause.
* 6: ITU T G.998.4 retransmission mode was not selected while
RTX_MODE = FORCED or with RTX_MODE = RTX_TESTMODE. Note: In
G.997.1, this parameter is called "Initialization success/failure
cause". See Clause 7.5.1.6 of ITU-T Recommendation
{{bibref|G.997.1}}.
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}}.
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 {{units}}
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 {{units}}, 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
{{bibref|G.997.1}}.
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 {{units}}
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 {{units}}, 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 {{units}}. Note: This parameter is
defined as UPBOKLE-R-pb in Clause 7.5.1.23.4 of ITU-T Recommendation
{{bibref|G.997.1}}.
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 {{units}}. 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 {{units}}. Note: See ITU-T Recommendation {{bibref|G.997.1}}.
This parameter indicates the actual active rate adaptation mode in
the downstream direction.
* If {{param}} equals 1, the link is operating in RA-MODE 1 (MANUAL).
* If {{param}} equals 2, the link is operating in RA-MODE 2
(AT_INIT).
* If {{param}} equals 3, the link is operating in RA-MODE 3
(DYNAMIC).
* If {{param}} equals 4, the link is operating in RA-MODE 4 (DYNAMIC
with SOS). Note: This parameter is defined as ACT-RA-MODEds in
Clause 7.5.1.33.1 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter indicates the actual active rate adaptation mode in
the upstream direction.
* If {{param}} equals 1, the link is operating in RA-MODE 1 (MANUAL).
* If {{param}} equals 2, the link is operating in RA-MODE 2
(AT_INIT).
* If {{param}} equals 3, the link is operating in RA-MODE 3
(DYNAMIC).
* If {{param}} equals 4, the link is operating in RA-MODE 4 (DYNAMIC
with SOS). Note: This parameter is defined as ACT-RA-MODEus in
Clause 7.5.1.33.2 of ITU-T Recommendation {{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
{{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 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 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 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 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
{{bibref|G.997.1}}.
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
{{bibref|G.997.1}}.
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 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
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}}.
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 {{bibref|G.997.1}}.
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 {{bibref|G.997.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 {{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 {{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 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
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 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 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 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.
Signifies the line pair that the modem is using to connection.
{{param}} = 1 is the innermost pair.
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 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 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 {{units}}) in
the downstream direction. Note: In G.997.1, this parameter is called
SNRMds. See ITU-T Recommendation {{bibref|G.997.1}}.
{{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}}.
{{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}}.
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) 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) 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) 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 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 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 output power at the CPE's DSL line (expressed in
{{units}}).
The current received power at the CPE's DSL line (expressed in
{{units}}).
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
{{bibref|G.997.1}}.
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 {{bibref|G.997.1}}.
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 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 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".
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".
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 Vendor Revision Number as defined in T1.413 Issue 2. When
T1.413 modulation is not in use, the parameter value SHOULD be 0.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|Total}} statistics.
Statistics SHOULD continue to be accumulated across CPE reboots,
though this might not always be possible. Note: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the most recent
DSL Showtime - the beginning of the period used for collection of
{{object|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: {{param}} SHOULD NOT be reset when the interface
statistics are reset via an interface disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the second most
recent DSL Showtime-the beginning of the period used for collection
of {{object|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: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}}
SHOULD NOT be reset when the interface statistics are reset via an
interface disable / enable cycle.
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.
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 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).
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.
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 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).
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.
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 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).
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.
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 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).
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.
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 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).
This object contains the DSL line test parameters that are available
during the L0 (i.e., Showtime) state.
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 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.
{{list}} 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 {{param|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 {{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 ''None''. Note:
{{param}} is measured during initialization and is not updated during
Showtime.
{{list}} 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 {{param|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 {{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 ''None''. Note: {{param}} is measured
during initialization and is not updated during Showtime.
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 {{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.
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 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.
{{list}} 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
{{param|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 {{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 ''None''. Note: {{param}} is measured
during initialization and is not updated during Showtime.
{{list}} 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
{{param|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 {{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 ''None''. Note: {{param}} is measured
during initialization and is not updated during Showtime.
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 {{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.
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 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.
{{list}} 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
{{param|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 {{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 ''None''. Note: {{param}} is first
measured during initialization and is updated during Showtime.
{{list}} 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 {{param|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
{{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 ''None''. Note: {{param}} is first measured during
initialization and is updated during Showtime.
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 {{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.
{{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}}.
{{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}}.
{{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}}.
{{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}}.
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 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 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 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
{{object|###.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 {{bibref|G.997.1}} and Clause
11.5 of ITU-T Recommendation {{bibref|G.993.2}}.
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.
Enables or disables the channel. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the channel (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the channel as assigned by the CPE.
The accumulated time in {{units}} since the channel entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
{{list}} List items indicate which link encapsulation standards and
recommendations are supported by the {{object}} instance.
Auto
Indicates the link encapsulation standard that the {{object}}
instance is using for the connection. {{enum}} When ATM encapsulation
is identified then an upper-layer {{object|.ATM.Link}} interface MUST
be used. When PTM encapsulation is identified then an upper-layer
{{object|.PTM.Link}} interface MUST be used.
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 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.
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.
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 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 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 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.
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.
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.
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
{{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).
Actual net data rate expressed in {{units}}. Independent whether
retransmission is used or not in a given transmit direction:
* In L0 state, this parameter reports the net data rate (as specified
in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) at which
the bearer channel is operating.
* In L2 state, the parameter contains the net data rate (as specified
in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) in the
previous L0 state. Note: See ITU-T Recommendation
{{bibref|G.997.1}}.
Actual impulse noise protection against REIN, expressed in {{units}}.
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 {{bibref|G.997.1}}.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|Total}} statistics.
Statistics SHOULD continue to be accumulated across CPE reboots,
though this might not always be possible. Note: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the most recent
DSL Showtime - the beginning of the period used for collection of
{{object|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: {{param}} SHOULD NOT be reset when the interface
statistics are reset via an interface disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the second most
recent DSL Showtime-the beginning of the period used for collection
of {{object|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: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}}
SHOULD NOT be reset when the interface statistics are reset via an
interface disable / enable cycle.
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.
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 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 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 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 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 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).
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.
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 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 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 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 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 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).
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.
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 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 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 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 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 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).
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.
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 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 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 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 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 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).
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.
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 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 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 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 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 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).
DSL bonding group table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each instance is a bonding group, and
is expected to be stacked above a {{object|.DSL.Channel}} instance or a
{{object|.FAST.Line}} instance for each bonded channel in the group.
Many of the parameters within this object, including
{{param|LowerLayers}}, are read-only because bonding is not expected to
be configured by a Controller. The DSL bonding data model is closely
aligned with {{bibref|TR-159}}. Corresponds to {{bibref|TR-159}}
''oBondingGroup''.
Enables or disables the bonding group. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the bonding group (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the bonding group as assigned by the CPE.
The accumulated time in {{units}} since the bonding group entered its
current operational state.
{{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.
{{list}} Indicates the current fault status of the DSL bonding group.
{{enum}} Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupStatus''.
Peer physical layer is unreachable
Local device received a "dying gasp" message (preceding a
loss-of-power) from the peer device
Operating bonding scheme of the peer port is different from the
local one
Upstream or downstream data rate is at or below threshold
DSL bonding group ID. Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupID''.
{{list}} Supported DSL bonding schemes. {{enum}} Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupBondSchemesSupported''.
{{bibref|G.998.1}} ATM-based bonding
{{bibref|G.998.2}} Ethernet-based bonding
{{bibref|G.998.3}} TDIM-based bonding
Currently operating bonding scheme. Corresponds to {{bibref|TR-159}}
''aGroupOperBondScheme''.
DSL bonding group capacity, i.e. the maximum number of channels that
can be bonded in this group. Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupCapacity''.
The accumulated time in {{units}} for which this bonding group has
been operationally up. Corresponds to {{bibref|G.998.1|section
11.4.2}} ''Group Running Time''.
Desired upstream data rate in {{units}} for this DSL bonding group
(zero indicates best effort). Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupTargetUpRate''.
Desired downstream data rate in {{units}} for DSL bonding group (zero
indicates best effort). Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupTargetDownRate''.
Threshold upstream data rate in {{units}} for this DSL bonding group.
{{param|GroupStatus}} will include {{enum|LowRate|GroupStatus}}
whenever the upstream rate is less than this threshold. Corresponds
to {{bibref|TR-159}} ''oBondingGroup.aGroupThreshLowUpRate''.
Threshold downstream data rate in {{units}} for this DSL bonding
group. {{param|GroupStatus}} will include
{{enum|LowRate|GroupStatus}} whenever the downstream rate is less
than this threshold. Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupThreshLowDownRate''.
The maximum upstream differential delay in {{units}} among member
links in a bonding group. Corresponds to {{bibref|G.998.1|section
11.4.1}} ''Differential Delay Tolerance''.
The maximum downstream differential delay in {{units}} among member
links in a bonding group. Corresponds to {{bibref|G.998.1|section
11.4.1}} ''Differential Delay Tolerance''.
{{numentries}} Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupNumChannels''.
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.
{{datatype|expand}}
{{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.
Per-channel {{bibref|G.998.2}} Ethernet-based bonding parameters. This
object MUST be present if, and only if, {{param|##.BondScheme}} is
{{enum|Ethernet|##.BondScheme}}.
Per-channel {{bibref|G.998.2}} Ethernet-based bonding statistics. These
relate to the {{bibref|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 {{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}}.
Number of underflow errors sent, i.e. on the transmit side of the
interface.
Number of CRC errors received, i.e. on the receive side of the
interface.
Number of alignment errors received, i.e. on the receive side of the
interface.
Number of short packets received, i.e. on the receive side of the
interface.
Number of long packets received, i.e. on the receive side of the
interface.
Number of overflow errors received, i.e. on the receive side of the
interface.
Number of pause frames received, i.e. on the receive side of the
interface.
Number of frames dropped, e.g. because the receive queue is full.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|Total}} statistics.
Statistics SHOULD continue to be accumulated across CPE reboots,
though this might not always be possible. Note: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
DSL-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}}
SHOULD NOT be reset when the interface statistics are reset via an
interface disable / enable cycle.
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.
{{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''.
Minimum data rate not met
Differential delay tolerance exceeded
Insufficient buffers on receiver
Other failure occurred
The achieved upstream data rate in {{units}} (which might change
subject to dynamic link usage conditions). Corresponds to
{{bibref|G.998.1|section 11.4.2}} ''Achieved Aggregate Data Rate''.
The achieved downstream data rate in {{units}} (which might change
subject to dynamic link usage conditions). Corresponds to
{{bibref|G.998.1|section 11.4.2}} ''Achieved Aggregate Data Rate''.
The total number of upstream packets that were lost at aggregation
output from a bonding group during the accumulation period.
Corresponds to {{bibref|G.998.1|section 11.4.2}} ''Group Rx Cell Loss
Count''.
The total number of downstream packets that were lost at aggregation
output from a bonding group during the accumulation period.
Corresponds to {{bibref|G.998.1|section 11.4.2}} ''Group Rx Cell Loss
Count''.
The achieved upstream differential delay in {{units}} (which might
change subject to dynamic link usage conditions).
The achieved downstream differential delay in {{units}} (which might
change subject to dynamic link usage conditions).
The number of times that the group was declared ''Unavailable''
during the accumulation period. Corresponds to
{{bibref|G.998.1|Section 11.4.3}} ''Group Failure Count''.
The time in {{units}} during which the group was declared ''Errored''
during the accumulation period. Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupPerf**ES''.
The time in {{units}} during which the group was declared
''SeverelyErrored'' during the accumulation period. Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupPerf**SES''.
The time in {{units}} during which the group was declared
''Unavailable'' during the accumulation period. Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupPerf**UAS''.
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.
{{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''.
Minimum data rate not met
Differential delay tolerance exceeded
Insufficient buffers on receiver
Other failure occurred
The achieved upstream data rate in {{units}} (which might change
subject to dynamic link usage conditions). Corresponds to
{{bibref|G.998.1|section 11.4.2}} ''Achieved Aggregate Data Rate''.
The achieved downstream data rate in {{units}} (which might change
subject to dynamic link usage conditions). Corresponds to
{{bibref|G.998.1|section 11.4.2}} ''Achieved Aggregate Data Rate''.
The total number of upstream packets that were lost at aggregation
output from a bonding group during the accumulation period.
Corresponds to {{bibref|G.998.1|section 11.4.2}} ''Group Rx Cell Loss
Count''.
The total number of downstream packets that were lost at aggregation
output from a bonding group during the accumulation period.
Corresponds to {{bibref|G.998.1|section 11.4.2}} ''Group Rx Cell Loss
Count''.
The achieved upstream differential delay in {{units}} (which might
change subject to dynamic link usage conditions).
The achieved downstream differential delay in {{units}} (which might
change subject to dynamic link usage conditions).
The number of times that the group was declared ''Unavailable''
during the accumulation period. Corresponds to
{{bibref|G.998.1|Section 11.4.3}} ''Group Failure Count''.
The time in {{units}} during which the group was declared ''Errored''
during the accumulation period. Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupPerf**ES''.
The time in {{units}} during which the group was declared
''SeverelyErrored'' during the accumulation period. Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupPerf**SES''.
The time in {{units}} during which the group was declared
''Unavailable'' during the accumulation period. Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupPerf**UAS''.
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.
{{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''.
Minimum data rate not met
Differential delay tolerance exceeded
Insufficient buffers on receiver
Other failure occurred
The achieved upstream data rate in {{units}} (which might change
subject to dynamic link usage conditions). Corresponds to
{{bibref|G.998.1|section 11.4.2}} ''Achieved Aggregate Data Rate''.
The achieved downstream data rate in {{units}} (which might change
subject to dynamic link usage conditions). Corresponds to
{{bibref|G.998.1|section 11.4.2}} ''Achieved Aggregate Data Rate''.
The total number of upstream packets that were lost at aggregation
output from a bonding group during the accumulation period.
Corresponds to {{bibref|G.998.1|section 11.4.2}} ''Group Rx Cell Loss
Count''.
The total number of downstream packets that were lost at aggregation
output from a bonding group during the accumulation period.
Corresponds to {{bibref|G.998.1|section 11.4.2}} ''Group Rx Cell Loss
Count''.
The achieved upstream differential delay in {{units}} (which might
change subject to dynamic link usage conditions).
The achieved downstream differential delay in {{units}} (which might
change subject to dynamic link usage conditions).
The number of times that the group was declared ''Unavailable''
during the accumulation period. Corresponds to
{{bibref|G.998.1|Section 11.4.3}} ''Group Failure Count''.
The time in {{units}} during which the group was declared ''Errored''
during the accumulation period. Corresponds to {{bibref|TR-159}}
''oBondingGroup.aGroupPerf**ES''.
The time in {{units}} during which the group was declared
''SeverelyErrored'' during the accumulation period. Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupPerf**SES''.
The time in {{units}} during which the group was declared
''Unavailable'' during the accumulation period. Corresponds to
{{bibref|TR-159}} ''oBondingGroup.aGroupPerf**UAS''.
Ethernet-based bonding parameters {{bibref|G.998.2}}. This object MUST
be present if, and only if, {{param|#.BondScheme}} is
{{enum|Ethernet|#.BondScheme}}.
{{bibref|G.998.2}} Ethernet-based bonding statistics. These relate to
the {{bibref|G.998.2}} PME (Physical Medium Entity) Aggregation
Function (PAF) and to its upper layer interface. PAF lower layer
interface statistics are in the
{{object|##.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 {{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}}.
Number of PAF errors. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxErrors''.
Number of PAF Small Fragment events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxSmallFragments''.
Number of PAF Large Fragment events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxLargeFragments''.
Number of PAF Bad Fragment events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxBadFragments''.
Number of PAF Lost Fragment events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxLostFragments''.
Number of PAF Late Fragment events.
Number of PAF Lost Start events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxLostStarts''.
Number of PAF Lost End events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxLostEnds''.
Number of PAF Overflow events. Corresponds to {{bibref|TR-159}}
''oBondETH.aEthRxOverflows''.
Number of pause frames sent, i.e. on the transmit side of the
interface.
Number of CRC errors received, i.e. on the receive side of the
interface.
Number of alignment errors received, i.e. on the receive side of the
interface.
Number of short packets received, i.e. on the receive side of the
interface.
Number of long packets received, i.e. on the receive side of the
interface.
Number of overflow errors received, i.e. on the receive side of the
interface.
Number of frames dropped, e.g. because the receive queue is full.
The DSL Diagnostics object.
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.
{{reference}} This is the interface over which the test is to be
performed.
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.
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}}.
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}}.
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}}.
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}}.
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.
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.
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.
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.
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.
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.
{{list}} 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
{{param|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 {{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 ''None''. Note:
{{param}} is measured during initialization and is not updated
during Showtime.
{{list}} 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 {{param|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
{{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 ''None''. Note: {{param}} is measured during
initialization and is not updated during Showtime.
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 {{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.
{{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}}.
{{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}}.
{{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}}.
{{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}}.
{{list}} 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 {{param|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
{{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 ''None''.
{{list}} 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 {{param|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 {{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 ''None''.
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.
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.
{{list}} 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 {{param|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 {{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 ''None''.
{{list}} 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 {{param|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 {{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 ''None''.
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 {{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.
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.
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.
{{list}} 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 {{param|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 {{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 ''None''.
{{list}} 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
{{param|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 {{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 ''None''.
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 {{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.
{{list}} List items represent downstream bit allocation per
subcarrier group. Maximum number of elements is 256 for G.992.3,
512 for G.992.5. Interpretation of the value is as defined in
ITU-T Rec. {{bibref|G.997.1}}.
{{list}} List items represent upstream bit allocation per
subcarrier group. Maximum number of elements is 256 for G.992.3,
512 for G.992.5. Interpretation of the value is as defined in
ITU-T Rec. {{bibref|G.997.1}}.
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 {{bibref|G.996.2|Clause A.2, SELT-PMD
management entity}}.
{{reference}} This is the interface over which the test is to be
performed.
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}}.
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.
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
{{param|UERGroupSize}} has three valid values: 1, 2 and 12. If
the option for extended bandwidth SELT is not applied to UER,
then {{param|UERGroupSize}} has two valid values: 1 and 2.
{{param|UERGroupSize}} is reported if the option for extended
bandwidth UER SELT is supported; otherwise, reporting of the
group size is optional.
The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)],
... {{list|with each list item consisting of the following}}
{{datatype|expand}} The value of UER at frequency
i*{{param|UERGroupSize}}*Df =
({{param|UERScaleFactor}}/(2^31))*(a(i)+j*b(i))/(2^31) where Df =
4.3125 kHz. This parameter is defined as CPE SELT uncalibrated
echo response (SELT-UER-R) in ITU-T Recommendation
{{bibref|G.996.2|Clause A.2.2.1}}.
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 {{bibref|G.996.2|Clause
A.2.2.1}}. 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 {{param}} to be zero.
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}}.
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 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 {{bibref|G.996.2|Clause A.2, SELT-PMD management
entity}}.
{{reference}} This is the interface over which the test is to be
performed.
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}}.
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.
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
{{param|QLNGroupSize}} has three valid values: 1, 2 and 12. If
the option for extended bandwidth SELT is not applied to QLN,
then {{param|QLNGroupSize}} has two valid values: 1 and 2.
{{param|QLNGroupSize}} is reported if the option for extended
bandwidth QLN SELT is supported; otherwise, reporting of the
group size is optional.
{{list}} 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*{{param|QLNGroupSize}}*Df with
Df=4.3125 kHz is defined as QLN(i*{{param|QLNGroupSize}}*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
{{bibref|G.996.2|Clause A.2.2.3}}.
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 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
{{bibref|G.996.2}}.
{{reference}} This is the interface over which the test is to be
performed.
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}}.
The capacity estimate signal Power Spectral Density (PSD):
{{list|with each list item consisting of the following}}
{{datatype|expand}} This capacity estimate signal PSD parameter
is defined in ITU-T Recommendation {{bibref|G.996.2|Clause
B.2.1.2}}.
The capacity estimate noise Power Spectral Density (PSD):
{{list|with each list item consisting of the following}}
{{datatype|expand}} This capacity estimate noise PSD parameter is
defined in ITU-T Recommendation {{bibref|G.996.2|Clause
B.2.1.3}}.
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}}.
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.
Loop termination indicator. {{enum}} This parameter is defined as
LOOP-TERM in ITU-T Recommendation {{bibref|G.996.2|Clause
B.1.1.1}}.
This value has been removed from the ITU-T Recommendation.
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}}.
{{list}} 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 {{bibref|G.996.2|Clause B.1.1.3}}.
Specifies the list of attenuation characteristics. {{list|with
each list item consisting of the following}} {{datatype|expand}}
TFlog(i * {{param|TFlogGroupSize}} * Df) is represented by an
integer k, 0 <= k <= 1022, where TFlog(i *
{{param|TFlogGroupSize}} * Df) = 6.0 - k * 0.1. The special value
of k of 1023 is used to indicate that no measurement could be
done for this subcarrier because the attenuation is out of the
range that can be represented. The attenuation characteristics
TFlog(f) parameter is 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 {{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}}.
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}}.
Capacity Estimate: {{list}} This parameter represents the
downstream and/or upstream capacity estimates in {{units}}. 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
{{bibref|G.996.2|Clause B.1.1.7}}.
This object models FAST (defined in ITU Recommendation
{{bibref|G.9701}}) lines. Each {{object|Line}} models a layer 1 FAST
Line interface.
{{numentries}}
FAST Line table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This table models physical FAST
lines.
Enables or disables the FAST line. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the FAST line (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the FAST line as assigned by the CPE.
The accumulated time in {{units}} since the FAST line entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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.
Status of the FAST physical link. {{enum}} When {{param}} is
{{enum|Up}}, {{param|Status}} is expected to be {{enum|Up|Status}}.
When {{param}} is {{enum|Initializing}} or {{enum|EstablishingLink}}
or {{enum|NoSignal}} or {{enum|Disabled}}, {{param|Status}} is
expected to be {{enum|Down|Status}}. The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{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}}.
Indicates which FAST profile is currently in use on the line.
The power management state of the line. {{enum}} Note: See ITU-T
Recommendation {{bibref|G.9701}}.
The success failure cause of the initialization. An enumeration of
the following integer values:
* 0: Successful
* 1: Configuration error. Configuration error. This error occurs if
the line cannot reach L0 state due to a mismatch of configuration
and FTU capabilities.
* 2: Configuration not feasible on the line. This error occurs if the
line cannot reach the L0 state due to a mismatch of configuration
of line and noise characteristics.
* 3: Communication problem. This error occurs, for example, due to
corrupted messages or bad syntax messages or if no common mode can
be selected in the G.994.1 handshaking procedure or due to a
timeout.
* 4: No far-end FTU detected. This error occurs if the far-end FTU is
not powered or not connected or if the line is too long to allow
detection of a far-end FTU.
* 5: Any other or unknown initialization failure cause. Note: In
G.997.2, this parameter is called "Initialization success/failure
cause". See Clause 7.20.2.1 of ITU-T Recommendation
{{bibref|G.997.2}}.
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 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 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 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}}.
Signifies the line pair that the modem is using to connection.
{{param}} = 1 is the innermost pair.
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
{{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 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/{{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}}.
The current upstream signal loss (expressed in {{units}}).
The current downstream signal loss (expressed in {{units}}).
The current output power at the CPE's FAST line (expressed in
{{units}}).
The current received power at the CPE's FAST line (expressed in
{{units}}).
This parameter reports the signal-to-noise margin for the robust
management channel (RMC) in the downstream direction (express in
{{units}}). A special value (-512) indicates that the signal-to-noise
ratio margin for the RMC is out of the range to be represented. This
parameter is defined in clauses 7.10.12.1 of ITU-T Recommendation
{{bibref|G.997.2}}.
This parameter reports the signal-to-noise margin for the robust
management channel (RMC) in the upstream direction (express in
{{units}}). A special value (-512) indicates that the signal-to-noise
ratio margin for the RMC is out of the range to be represented. This
parameter is defined in clauses 7.10.12.2 of ITU-T Recommendation
{{bibref|G.997.2}}.
{{list}} List items report the bit allocation values on RMC
sub-carriers in RMC symbols in the downstream direction. Each pair
composes of a sub-carrier index from 0..4095 and an 8 bit allocation
value. There are maximum 512 pairs. This parameter is defined in
clause 7.10.12.3 of ITU-T Recommendation {{bibref|G.997.2}}.
{{list}} List items report the bit allocation values on RMC
sub-carriers in RMC symbols in the upstream direction. Each pair
composes of a sub-carrier index from 0..4095 and an 8 bit allocation
value. There are maximum 512 pairs. This parameter is defined in
clause 7.10.12.4 of ITU-T Recommendation {{bibref|G.997.2}}.
This indicates whether FEXT cancellation in the downstream direction
from all the other vectored lines into the line in the vectored group
is enabled (TRUE) or disabled (FALSE). This parameter is defined as
FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation
{{bibref|G.997.2}}.
This indicates whether FEXT cancellation in the upstream direction
from all the other vectored lines into the line in the vectored group
is enabled (TRUE) or disabled (FALSE). This parameter is defined as
FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation
{{bibref|G.997.2}}.
This parameter reports the expected throughput rate expressed in
{{units}} as defined in clause 7.11.1.2 of ITU-T Recommendation
{{bibref|G.997.2}}
This parameter reports the expected throughput rate expressed in
{{units}} as defined in clause 7.11.1.2 of ITU-T Recommendation
{{bibref|G.997.2}}
This parameter reports the attainable expected throughput expressed
in {{units}} as defined in clause 7.11.2.2 of ITU-T Recommendation
{{bibref|G.997.2}}
This parameter reports the attainable expected throughput expressed
in {{units}} as defined in clause 7.11.2.2 of ITU-T Recommendation
{{bibref|G.997.2}}
This parameter reports the minimum error free throughput value
expressed in {{units}} computed from power up as defined in clause
11.4.1.1.3 of ITU-T Recommendation {{bibref|G.9701}}
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
FAST-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|Total}} statistics.
Statistics SHOULD continue to be accumulated across CPE reboots,
though this might not always be possible. Note: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
FAST-specific statistic. The Number of {{units}} since the most
recent DSL Showtime - the beginning of the period used for collection
of {{object|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: {{param}} SHOULD NOT be reset when the interface
statistics are reset via an interface disable / enable cycle.
FAST-specific statistic. The Number of {{units}} since the second
most recent DSL Showtime-the beginning of the period used for
collection of {{object|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: {{param}}
SHOULD NOT be reset when the interface statistics are reset via an
interface disable / enable cycle.
FAST-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}} SHOULD NOT
be reset when the interface statistics are reset via an interface
disable / enable cycle.
FAST-specific statistic. The Number of {{units}} since the beginning
of the period used for collection of {{object|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: {{param}}
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 {{object}}
parameters SHOULD NOT be reset when the interface statistics are reset
via an interface disable / enable cycle.
Total number of errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}. An errored second (ES) is declared if, during a
1-second interval, there are one or more crc anomalies, or one or
more los defects, or one or more lor defects, or one or more lpr
primitives.
Total number of severely errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}.
Total number of loss of signal {{units}} (LOSS) as defined in ITU-T
Rec. {{bibref|G.997.2}}. A LOSS is declared if, during a 1-second
interval, there are one or more los defects.
Total number of loss of RMC {{units}} (LORS) as defined in ITU-T Rec.
{{bibref|G.997.2}}. A LORS is declared if, during a 1-second
interval, there are one or more lor defects.
Total number of unavailable {{units}} (UAS) as defined in ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of uncorrected DTU anomalies (rtx_uc).
This parameter is defined in clause 7.8.5 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of retransmitted DTU anomalies
(rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of the successful bit swap (BSW)
primitives. This parameter is defined as success_BSW in clause 7.7.20
of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful autonomous SRA
(seamless rate adaptation) primitives. This parameter is defined as
success_SRA in clause 7.7.21 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful FRA (fast rate
adaptation) primitives. This parameter is defined as success_FRA in
clause 7.7.22 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful RPA (RMC parameter
adjustment) primitives. This parameter is defined as success_RPA in
clause 7.7.23 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful TIGA (transmitter
initiated gain adjustment) primitives. This parameter is defined as
success_TIGA in clause 7.7.24 of ITU-T Rec. {{bibref|G.997.2}}.
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.
Total number of errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}. An errored second (ES) is declared if, during a
1-second interval, there are one or more crc anomalies, or one or
more los defects, or one or more lor defects, or one or more lpr
primitives.
Total number of severely errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}.
Total number of loss of signal {{units}} (LOSS) as defined in ITU-T
Rec. {{bibref|G.997.2}}. A LOSS is declared if, during a 1-second
interval, there are one or more los defects.
Total number of loss of RMC {{units}} (LORS) as defined in ITU-T Rec.
{{bibref|G.997.2}}. A LORS is declared if, during a 1-second
interval, there are one or more lor defects.
Total number of unavailable {{units}} (UAS) as defined in ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of uncorrected DTU anomalies (rtx_uc).
This parameter is defined in clause 7.8.5 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of retransmitted DTU anomalies
(rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of the successful bit swap (BSW)
primitives. This parameter is defined as success_BSW in clause 7.7.20
of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful autonomous SRA
(seamless rate adaptation) primitives. This parameter is defined as
success_SRA in clause 7.7.21 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful FRA (fast rate
adaptation) primitives. This parameter is defined as success_FRA in
clause 7.7.22 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful RPA (RMC parameter
adjustment) primitives. This parameter is defined as success_RPA in
clause 7.7.23 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful TIGA (transmitter
initiated gain adjustment) primitives. This parameter is defined as
success_TIGA in clause 7.7.24 of ITU-T Rec. {{bibref|G.997.2}}.
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.
Total number of errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}. An errored second (ES) is declared if, during a
1-second interval, there are one or more crc anomalies, or one or
more los defects, or one or more lor defects, or one or more lpr
primitives.
Total number of severely errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}.
Total number of loss of signal {{units}} (LOSS) as defined in ITU-T
Rec. {{bibref|G.997.2}}. A LOSS is declared if, during a 1-second
interval, there are one or more los defects.
Total number of loss of RMC {{units}} (LORS) as defined in ITU-T Rec.
{{bibref|G.997.2}}. A LORS is declared if, during a 1-second
interval, there are one or more lor defects.
Total number of unavailable {{units}} (UAS) as defined in ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of uncorrected DTU anomalies (rtx_uc).
This parameter is defined in clause 7.8.5 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of retransmitted DTU anomalies
(rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of the successful bit swap (BSW)
primitives. This parameter is defined as success_BSW in clause 7.7.20
of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful autonomous SRA
(seamless rate adaptation) primitives. This parameter is defined as
success_SRA in clause 7.7.21 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful FRA (fast rate
adaptation) primitives. This parameter is defined as success_FRA in
clause 7.7.22 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful RPA (RMC parameter
adjustment) primitives. This parameter is defined as success_RPA in
clause 7.7.23 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful TIGA (transmitter
initiated gain adjustment) primitives. This parameter is defined as
success_TIGA in clause 7.7.24 of ITU-T Rec. {{bibref|G.997.2}}.
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.
Total number of errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}. An errored second (ES) is declared if, during a
1-second interval, there are one or more crc anomalies, or one or
more los defects, or one or more lor defects, or one or more lpr
primitives.
Total number of severely errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}.
Total number of loss of signal {{units}} (LOSS) as defined in ITU-T
Rec. {{bibref|G.997.2}}. A LOSS is declared if, during a 1-second
interval, there are one or more los defects.
Total number of loss of RMC {{units}} (LORS) as defined in ITU-T Rec.
{{bibref|G.997.2}}. A LORS is declared if, during a 1-second
interval, there are one or more lor defects.
Total number of unavailable {{units}} (UAS) as defined in ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of uncorrected DTU anomalies (rtx_uc).
This parameter is defined in clause 7.8.5 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of retransmitted DTU anomalies
(rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of the successful bit swap (BSW)
primitives. This parameter is defined as success_BSW in clause 7.7.20
of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful autonomous SRA
(seamless rate adaptation) primitives. This parameter is defined as
success_SRA in clause 7.7.21 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful FRA (fast rate
adaptation) primitives. This parameter is defined as success_FRA in
clause 7.7.22 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful RPA (RMC parameter
adjustment) primitives. This parameter is defined as success_RPA in
clause 7.7.23 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful TIGA (transmitter
initiated gain adjustment) primitives. This parameter is defined as
success_TIGA in clause 7.7.24 of ITU-T Rec. {{bibref|G.997.2}}.
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.
Total number of errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}. An errored second (ES) is declared if, during a
1-second interval, there are one or more crc anomalies, or one or
more los defects, or one or more lor defects, or one or more lpr
primitives.
Total number of severely errored {{units}} as defined in ITU-T Rec.
{{bibref|G.997.2}}.
Total number of loss of signal {{units}} (LOSS) as defined in ITU-T
Rec. {{bibref|G.997.2}}. A LOSS is declared if, during a 1-second
interval, there are one or more los defects.
Total number of loss of RMC {{units}} (LORS) as defined in ITU-T Rec.
{{bibref|G.997.2}}. A LORS is declared if, during a 1-second
interval, there are one or more lor defects.
Total number of unavailable {{units}} (UAS) as defined in ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of uncorrected DTU anomalies (rtx_uc).
This parameter is defined in clause 7.8.5 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of retransmitted DTU anomalies
(rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec.
{{bibref|G.997.2}}.
This parameter reports a count of the successful bit swap (BSW)
primitives. This parameter is defined as success_BSW in clause 7.7.20
of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful autonomous SRA
(seamless rate adaptation) primitives. This parameter is defined as
success_SRA in clause 7.7.21 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful FRA (fast rate
adaptation) primitives. This parameter is defined as success_FRA in
clause 7.7.22 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful RPA (RMC parameter
adjustment) primitives. This parameter is defined as success_RPA in
clause 7.7.23 of ITU-T Rec. {{bibref|G.997.2}}.
This parameter reports a count of the successful TIGA (transmitter
initiated gain adjustment) primitives. This parameter is defined as
success_TIGA in clause 7.7.24 of ITU-T Rec. {{bibref|G.997.2}}.
This object contains the FAST line test parameters that are available
during the L0 (i.e., Showtime) state.
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 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}}.
{{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}}.
{{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}}.
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 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 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 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 redundancy as defined in clause
9.3/{{bibref|G.9701}}. Note: See ITU-T Recommendation
{{bibref|G.997.2}}.
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
{{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 actual INP against REIN as defined in clause
11.4.1.1.8/{{bibref|G.9701}}. A special value indicates an actual INP
against REIN of 63 symbols or higher. The valid range is 0..62
symbols, and 63 is the special value.
This object models optical interface technologies. It defines an
{{object|Interface}} object that models a layer 1 optical interface
that is capable of transporting Ethernet packets. The data model
definition is based on parts of {{bibref|G.988}}.
{{numentries}}
Optical interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This table models physical optical
interfaces.
Enables or disables the optical interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the optical interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the optical interface as assigned by the CPE.
The accumulated time in {{units}} since the optical interface entered
its current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
Current measurement of total downstream optical signal level.
{{datatype|expand}} 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 {{bibref|G.988|Section
9.2.1}}.
Optical level that is used to declare the downstream low received
optical power alarm. {{datatype|expand}} 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 {{bibref|G.988|section
9.2.1}}.
Optical level that is used to declare the downstream high received
optical power alarm. {{datatype|expand}} 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 {{bibref|G.988|section
9.2.1}}.
Current measurement of mean optical launch power. {{datatype|expand}}
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 {{bibref|G.988|section 9.2.1}}.
Minimum mean optical launch power that is used to declare the low
transmit optical power alarm. {{datatype|expand}} 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
{{bibref|G.988|section 9.2.1}}.
Maximum mean optical launch power that is used to declare the high
transmit optical power alarm. {{datatype|expand}} 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
{{bibref|G.988|section 9.2.1}}.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
This object models cellular interfaces and access points.
Enables or disables roaming.
Current roaming status.
{{numentries}}
{{numentries}}
Cellular interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each instance of this object models a
cellular modem with a single radio and a single {{object|USIM}}.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}}
* SHOULD change to {{enum|Up}} if and only if the interface is able
to transmit and receive network traffic.
* SHOULD change to {{enum|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 {{enum|Up}}
if still operable when the expected actions have completed)
* SHOULD remain in the {{enum|Error}} state if there is an error or
other fault condition detected on the interface
* SHOULD remain in the {{enum|NotPresent}} state if the interface has
missing (typically hardware) components; it SHOULD change to
{{enum|Unknown}} if the state of the interface can not be
determined for some reason. Because the interface includes layer 1
the {{enum|LowerLayerDown}} value SHOULD never be used. This
parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}.
Corresponds to {{enum|GPRS|CurrentAccessTechnology}},
{{enum|UMTS|CurrentAccessTechnology}},
{{enum|LTE|CurrentAccessTechnology}} etc ''ATTACHED'' status
Corresponds to {{enum|GPRS|CurrentAccessTechnology}},
{{enum|UMTS|CurrentAccessTechnology}},
{{enum|LTE|CurrentAccessTechnology}} etc ''DETACHED'' status
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
International Mobile Station Equipment Identity number, represented
as a 15 digit string (digits 0-9).
Access technologies supported by the interface.
GSM with GPRS
GSM with EDGE
UMTS with High Speed Packet Access (HSPA {{bibref|3GPP-HSPA}})
5G New Radio
Preferred access technology.
Access technology that is currently in use.
List of available networks.
Name of the network which will be used, or {{empty}} if the network
is selected automatically.
The value is {{empty}} if no network is found, or if the network
specified in {{param|NetworkRequested}} is not found.
The received signal strength in {{units}}. The allowed values depend
on {{param|CurrentAccessTechnology}}:
* For {{enum|GPRS|SupportedAccessTechnologies}},
{{enum|EDGE|SupportedAccessTechnologies}} the range is -111
{{units}} to -49 {{units}}
* For {{enum|UMTS|SupportedAccessTechnologies}},
{{enum|UMTSHSPA|SupportedAccessTechnologies}} the range is -117
{{units}} to -54 {{units}}
* For {{enum|LTE|SupportedAccessTechnologies}},
{{enum|NR|SupportedAccessTechnologies}} the range is -117 {{units}}
to -25 {{units}} Note: An undetectable signal is indicated by the
appropriate lower limit, e.g. -117 {{units}} for LTE.
The Reference Signal Received Power in {{units}} for
{{enum|LTE|SupportedAccessTechnologies}},
{{enum|NR|SupportedAccessTechnologies}} values of
{{param|CurrentAccessTechnology}}:
* The valid range of RSRP values from worst to best is -140 {{units}}
to -44 {{units}}
The Reference Signal Received Quality in {{units}} for
{{enum|LTE|SupportedAccessTechnologies}},
{{enum|NR|SupportedAccessTechnologies}} values of
{{param|CurrentAccessTechnology}}:
* RSRQ is calculated using RSSI and RSRP values using RSRQ =
(N*RSRP)/RSSI where N is the number of resource blocks (bandwidth).
* The valid range of RSRP values from worst to best is -20 {{units}}
to -3 {{units}}
The current maximum attainable data rate upstream (expressed in
{{units}}).
The current maximum attainable data rate downstream (expressed in
{{units}}).
USIM (Universal Subscriber Identity Module or SIM card) parameters for
the interface.
The current status of the USIM card.
No card available
Card is available but not verified
Card can be used; either valid PIN was entered, or PIN check is
deactivated
USIM is blocked because the maximum number of invalid PIN
entries was exceeded
An error was detected with the card
International Mobile Subscriber Identity represented as a string with
either 14 or 15 digits (digits 0-9). The first 3 digits are the
mobile country code (MCC), which are followed by the mobile network
code (MNC), either 2 digits (European standard) or 3 digits (North
American standard), followed by the mobile subscription
identification number (MSIN).
Integrated Circuit Card Identifier represented as a string of up to
20 digits (digits 0-9). The number is composed of the following
parts:
* Major industry identifier (MII), 2 fixed digits, 89 for
telecommunication purposes.
* Country code, 1–3 digits, as defined by ITU-T recommendation
{{bibref|ITU-E.164}}.
* identifier, 1–4 digits.
* Individual account identification number. Its length is variable,
but every number under one IIN will have the same length.
* Single check digit calculated from the other digits using the Luhn
algorithm. For cards using an ICCID according to
{{bibref|ITU-E.118}} the maximum length is 19 Digits, for GSM cards
20 digits.
Mobile Subscriber Integrated Service Digital Network Number, a number
uniquely identifying a subscription in a GSM, UMTS, or LTE mobile
network. {{bibref|ITU-E.164}}
Controls the PIN verification of the USIM card.
Check the PIN with each access to a new network
Check the PIN with first access after (re)boot
Disable the PIN check
Allows the Controller to change the USIM PIN used for SIM card
activation.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
Cellular Access Point table. Each entry is identified by an
{{param|APN}} (Access Point Name) that identifies a gateway between the
mobile network and another computer network.
Enables or disables the Access Point.
{{datatype|expand}}
Access Point Name.
Username used to authenticate the CPE when making a connection to the
Access Point.
Password used to authenticate the CPE when making a connection to the
Access Point.
Proxy server IP address.
Proxy server port.
Reference to the interface with which the access point is associated.
Asynchronous Transfer Mode (ATM) object that contains the
{{object|Link}} interface and {{object|Diagnostics.F5Loopback()}}
diagnostics.
{{numentries}}
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}}).
Enables or disables the link. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the link (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the link as assigned by the CPE.
The accumulated time in {{units}} since the link entered its current
operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
Indicates the type of connection and refers to the complete stack of
protocol used for this connection.
{{bibref|RFC2684}} bridged Ethernet over ATM
{{bibref|RFC2684}} routed IP over ATM
{{bibref|RFC2364}} PPP over ATM
{{bibref|RFC2225}} Classical IP over ATM
Indicates if the CPE is currently using some auto configuration
mechanisms for this connection. If this variable is {{true}}, all
writable variables in this connection instance become read-only. Any
attempt to change one of these variables SHOULD fail and an error
SHOULD be returned.
Destination address of this link, in the form "VPI/VCI" (e.g. "8/23"
or "0/35").
Identifies the connection encapsulation that will be used.
This flag tells if a checksum SHOULD be added in the ATM payload. It
does not refer to the checksum of one of the ATM cells or AALX
packets. In case of LLC or VCMUX encapsulation, this ATM checksum is
the FCS field described in {{bibref|RFC2684}}. It is only applicable
in the upstream direction.
{{list}} Ordered list of VPI/VCI pairs to search if a link using the
{{param|DestinationAddress}} cannot be established. In the form
"VPI1/VCI1, VPI2/VCI2, ...". {{pattern}} Example:
: ''0/35, 8/35, 1/35''
Describes the ATM Adaptation Layer (AAL) currently in use on the PVC.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
The current count of successfully transmitted cells.
The current count of successfully received cells.
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 number of Header Error Check related errors at the ATM
layer.
The ATM Link QoS object.
Describes the ATM Quality Of Service (QoS) being used on the VC.
Specifies the upstream peak cell rate in {{units}}.
Specifies the upstream maximum burst size in {{units}}.
Specifies the upstream sustainable cell rate, in {{units}}.
The ATM Diagnostics object.
This command provides access to an ATM-layer F5 OAM loopback test.
{{reference}} This is the interface over which the test is to be
performed.
Number of repetitions of the ping test to perform before
reporting the results.
Timeout in {{units}} for the ping test.
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.
Result parameter indicating the number of successful pings (those
in which a successful response was received prior to the timeout)
in the most recent ping test.
Result parameter indicating the number of failed pings in the
most recent ping test.
Result parameter indicating the average response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the minimum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the maximum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Packet Transfer Mode ({{bibref|G.993.1|Annex H}}). This object contains
the {{object|Link}} interface.
{{numentries}}
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}}).
Enables or disables the link. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the link (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the link as assigned by the CPE.
The accumulated time in {{units}} since the link entered its current
operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
Ethernet object. This object models several Ethernet interface objects,
each representing a different stack layer, including:
{{object|Interface}}, {{object|Link}}, and {{object|VLANTermination}}.
{{object|Interface}} is media-specific and models a port, the PHY
layer, and the MAC layer. {{object|Link}} is media-independent and
models the Logical Link Control (LLC) layer. An "outer"
{{object|VLANTermination}}, when present, is expected to be stacked on
top of {{object|Link}} objects to receive and send frames with a
configured VLANID.
Indicates that WoL (Wake on LAN) over Ethernet is supported.
Indicates that Flow Control over Ethernet is supported, as per
{{bibref|802.3-2015}}.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Ethernet interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This table models physical Ethernet
ports, but in terms of the interface stack it also models the PHY and
MAC level Ethernet interface.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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 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 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 duplex mode available to this connection.
Indicates whether this physical ethernet port supports Energy
Efficient Ethernet as specified in
{{bibref|802.3-2012_section6|Section 78}}.
Whether Energy Efficient Ethernet
{{bibref|802.3-2012_section6|Section 78}} support is currently
enabled. When enabled, this ethernet port will be capable of entering
or exiting Low Power Idle (LPI) mode.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
Ethernet link layer table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). 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.
Enables or disables the link. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the link (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the link as assigned by the CPE.
The accumulated time in {{units}} since the link entered its current
operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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.
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
{{param|.QoS.Classification.{i}.EthernetPriorityMark}} or
{{param|.QoS.Classification.{i}.InnerEthernetPriorityMark}}. When
{{false}}, egress frames leaving this interface will be untagged. The
parameter does not affect reception of ingress frames.
Configures Flow Control on given Ethernet port. When set to {{true}},
it activates the exchange of pause-resume flow control frames.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
VLAN Termination table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). A VLAN Termination entry is typically
stacked on top of a {{object|#.Link}} object to receive and send frames
with the configured {{param|VLANID}}.
Enables or disables the VLANTermination entry. This parameter is
based on ''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the VLANTermination entry (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the VLANTermination entry as assigned by the CPE.
The accumulated time in {{units}} since the VLANTermination entered
its current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
The VLAN ID for this {{object}} entry (as defined in
{{bibref|802.1Q-2011}}). Only ingress frames with this VLAN ID will
be passed to higher protocol layers; frames sent from higher protocol
layers will be tagged with this VLAN ID.
The Tag Protocol Identifier (TPID) assigned to this {{object}}. The
TPID is an EtherType value used to identify the frame as a tagged
frame. Standard {{bibref|802.1Q-2011|Table 9.1}} TPID values are:
*S-TAG 0x88A8 = 34984
*C-TAG 0x8100 = 33024 Non-Standard TPID values are:
*S-TAG 0x9100 = 37120
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
Ethernet statistics based on the {{bibref|RFC2819}} ''RMON-MIB''
''etherStatsTable'', with some extensions inspired by
{{bibref|G.988|Section 9.3.32}}. 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:
* If the instance is associated with an egress queue (or queues) via
the {{param|Queue}} parameter or by setting {{param|AllQueues}} to
{{true}} then data is sampled on egress. In this case {{param|Bytes}}
etc measure the data that has been sent on the interface, possibly
filtered by {{param|Queue}} or {{param|VLANID}}.
* Otherwise data is sampled on ingress. In this case {{param|Bytes}}
etc measure the data that has been received on the interface,
possibly filtered by {{param|VLANID}}. When sampling on egress, the
term ''received'' means ''received by the queuing sub-system''.
Multiple instances can be associated with a single interface:
individual instances can be configured to collect data associated
with the entire interface, or with a particular VLAN and/or queue.
The CPE MUST reset each instances's Stats parameters whenever the
instance is disabled and re-enabled. Whether this reset occurs when
the instance becomes operationally disabled ({{param|Status}} =
{{enum|Disabled|Status}}) or administratively enabled
({{param|Enable}} = {{true}}) is a local matter to the CPE. This is
similar to the behavior of interface statistics, e.g. as specified
for {{object|Device.Ethernet.Interface.{i}.Stats}}. Furthermore, this
instance's Stats parameters MUST be reset whenever the referenced
interface's Stats parameters are reset, or when the referenced queue
or VLAN is disabled and re-enabled. For enabled table entries, if
{{param|Interface}} references an interface that is not capable of
transporting Ethernet-encapsulated packets, or if {{param|Queue}}
references a queue that is not instantiated on {{param|Interface}},
or if {{param|Queue}} is not a valid reference and
{{param|AllQueues}} is {{false}}, the table entry is inoperable and
the CPE MUST set {{param|Status}} to
{{enum|Error_Misconfigured|Status}}. 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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable
the offending {{object}} row.
Enables or disables this instance.
The status of this instance. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
The textual name of the {{object}} entry as assigned by the CPE.
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.
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.
Filter criterion. The egress queue with which this instance is
associated. Only packets that are sent to the referenced queue will
be considered.
Indicates whether this instance applies to all queues. If {{true}},
the value of {{param|Queue}} is ignored since all egress queues are
indicated.
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 {{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 {{units}} (including bad packets, broadcast
packets, and multicast packets) received. This parameter is based on
''etherStatsPkts'' from {{bibref|RFC2819}}.
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 {{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 {{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 {{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 {{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 {{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 {{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 {{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 {{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 {{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 {{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}}.
This object provides access to the WoL (Wake on LAN) funtionality.
This command sends a magic packet over the CPE active Ethernet
interfaces.
MAC address target of the magic packet.
The SecureOn password. The parameter value can be empty or, if
present, can contain either 4 bytes or 6 bytes.
Ethernet Link Aggregation Group (LAG) table (a stackable interface
object as described in {{bibref|TR-181i2|Section 4.2}}). Table entries
model the Link Aggregation Sub-Layer as defined in
{{bibref|802.3-2015}} and {{bibref|802.1AX-2014}}. It is expected that
a {{object}} interface can only be stacked above
{{object|.Ethernet.Interface}} interfaces. The CPE can reject creation
of additional LAG instances if this would exceed its capabilities.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the LAG interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}}. See {{bibref|TR-181i2|Section 4.2.1}}.
{{param}} 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"
MAC address of the Link Aggregation Interface.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
Universal Serial Bus ({{bibref|USB1.0}}, {{bibref|USB2.0}},
{{bibref|USB3.0}}). This object contains the {{object|Interface}},
{{object|Port}}, and {{object|USBHosts}} objects.
{{numentries}}
{{numentries}}
USB interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This table models master and slave
USB physical interfaces that support carrying Ethernet frames, e.g. via
the USB Communication Device Class.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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 maximum PHY bit rate supported by this interface (expressed in
{{units}}).
{{reference}} This is the USB port associated with this interface
object.
Throughput statistics for this interface. The CPE MUST reset the
interface's Stats parameters (unless otherwise stated in individual
object or parameter descriptions) either when the interface becomes
operationally down due to a previous administrative down (i.e. the
interface's {{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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
USB Port table. This table models master and slave USB physical ports
on the device.
{{datatype|expand}}
The textual name of the port.
USB specification version supported by the Port. Example: "1.1"
Type of the USB connection.
Receptacle of the port.
Current speed of the USB connection. {{enum}}
1.5 Mbits/sec (187.5 KB/sec) defined in {{bibref|USB1.0}}
12 Mbits/sec (1.5 MB/sec) defined in {{bibref|USB1.0}}
480 Mbits/sec (60 MB/sec) defined in {{bibref|USB2.0}}
5.0 Gbits/sec (625 MB/sec) defined in {{bibref|USB3.0}}
Power configuration of the USB connection. {{enum}} Only applies when
{{param|Type}} is {{enum|Device|Type}}. In other cases value is
{{enum|Unknown}}.
This object models the CPE's USB Host controllers. See
{{bibref|TR-181i2|Appendix XVII}} for Theory of Operation.
{{numentries}}
Table of CPE USB Host controllers.
{{datatype|expand}}
Enables or disables the USB Host controller.
User-readable host controller name.
Type of USB Host
Open Host Controller Interface
Enhanced Host Controller Interface
Universal Host Controller Interface
Extensible Host Controller Interface
Reset the Host Controller and apply the reset signaling (see
{{bibref|USB2.0|Chapter 7.1.7.5}}) to all of the Host Controller Hub
downstream ports.
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.
USB specification version with which the controller complies.
Example: "1.1"
{{numentries}}
Table of connected USB devices.
Device number on USB bus.
USB specification version with which the device complies. Example:
"1.1"
Class Code as assigned by USB-IF. When 0x00, each device specifies
its own class code. When 0xFF, the class code is vendor specified.
Subclass code (assigned by USB-IF).
Device release number.
Protocol code (assigned by USB-IF).
Product ID (assigned by manufacturer).
Vendor ID (assigned by USB-IF).
Device Manufacturer string descriptor.
Device Product Class string descriptor.
Device SerialNumber string descriptor.
Hub port on parent device. 0 when no parent.
{{reference}} This is a reference to the USB host device to which
this (external) USB device is connected.
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.
1.5 Mbits/sec (187.5 KB/sec) defined in {{bibref|USB1.0}}
12 Mbits/sec (1.5 MB/sec) defined in {{bibref|USB1.0}}
480 Mbits/sec (60 MB/sec) defined in {{bibref|USB2.0}}
5.0 Gbits/sec (625 MB/sec) defined in {{bibref|USB3.0}}
{{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).
Number of ports. Only applies for hub device, equal to 0 for other
devices.
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 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.
{{numentries}}
Table of device configurations.
The identifier for each Device Configuration.
{{numentries}}
Table of device interface descriptors.
Number of this interface (from USB interface descriptor).
Class Code as assigned by USB-IF. When 0x00, each interface specifies
its own class code. When 0xFF, the class code is vendor specified.
Subclass code (assigned by USB-IF).
Protocol code (assigned by USB-IF).
HPNA object that contains the {{object|Interface}} and
{{object|Diagnostics}} objects. The HPNA (also known as HomePNA)
industry standard {{bibref|G.9954}} defines peer to peer communication
for home networking over existing coax cables and telephone wiring
within the home.
{{numentries}}
HPNA interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each table entry models the PHY and
MAC levels of an HPNA interface {{bibref|G.9954}}.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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.
This interface's firmware version.
The Node ID of this interface.
Whether this interface is the HPNA network master.
Whether this interface is synchronized with the HPNA network master.
If this interface is the HPNA network master, {{param}} MUST be
{{true}}.
Total time in {{units}} (since device reset) that this interface has
been up and synchronized to the HPNA network master.
The maximum HPNA PHY bit rate (expressed in {{units}}) of this
interface.
Current HPNA network utilization (expressed in {{units}}).
{{list}} List items indicate the types of connections possible for
this interface. {{enum}}
{{list}} Connection type(s) for which the HPNA protocol is active.
{{list}} List items indicate the spectral modes possible for this
interface. {{enum}}
4-20MHz - Phone / Coax
12-28MHz - Phone / Coax
36-52MHz - Coax only
4-36MHz - Coax only
Spectral mode for which the HPNA protocol is active.
Maximum Transmission Unit for this HPNA interface (expressed in
{{units}}).
The desired noise margin for which the local HPNA interface has been
configured (expressed in {{units}}).
The desired packet error rate for which the local HPNA interface has
been configured (expressed in 1E-8, e.g. PER of 1.27E-6 will be
presented as 127).
Enable or disable the Limited Automatic Repeat Request (LARQ)
mechanism.
The minimum multicast (and broadcast) rate that can be negotiated on
the HPNA network directly accessible via this interface (expressed in
{{units}}).
The negotiated multicast (and broadcast) rate on the HPNA network
directly accessible via this interface (expressed in {{units}}).
Master selection mode. {{enum}}
Automatic master selection
Force local HPNA interface to be end point
Force local HPNA interface to be master
{{numentries}} This is the number of HPNA nodes that are directly
accessible via this interface.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
QoS configuration object.
{{numentries}}
Flow specification table. The {{object|.QoS.Classification}} table is
used to classify ingress traffic, where
{{param|.QoS.Classification.{i}.TrafficClass}} is one of the
classification result outputs. This ''TrafficClass'' value can be used
to look up the appropriate {{object}} entry (i.e. the {{object}} entry
whose {{param|TrafficClasses}} list contains a matching traffic class).
For enabled table entries, if {{param|TrafficClasses}} is {{empty}}
then the table entry is inoperable and the CPE MUST set
{{param|Status}} to {{enum|Error_Misconfigured|Status}}.
Enables or disables the table entry.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
{{list}} This list identifies the set of traffic classes associated
with this flow spec.
Flow type. {{enum}}
Constant Bit Rate
Variable Bit Rate
Variable Bit Rate - Non Real Time
Best Effort
Flow queue network priority. Priority 0 is the lowest priority.
Maximum latency of the flow (expressed in {{units}}). Value 0 means
no latency requirements.
Maximum jitter of the flow (expressed in {{units}}). Value 0 means no
jitter requirements.
Typical packet size. Value 0 means undefined packet size.
Minimum required rate in Kbps. Value 0 means no MinRate requirements.
Average required rate in Kbps. Value 0 means no AvgRate requirements.
Maximum required rate in Kbps. Value 0 means no MaxRate 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.
Flow inactivity tear down timeout (expressed in {{units}}). Value 0
means unlimited timeout.
This table provides information about other HPNA devices that are
directly accessible via this HPNA interface.
The physical address of this node.
The Node ID of this node.
Whether this node is the HPNA network master.
Whether this node is synchronized with the HPNA network master. If
this node is the HPNA network master, {{param}} MUST be {{true}}.
Total time in {{units}} (since device reset) that this node has been
up and synchronized to the HPNA network master.
This node's maximum HPNA PHY bit rate (expressed in {{units}}).
Enable / disable PHY throughput diagnostics mode on this node. All
devices that are enabled will participate in the HPNA network PHY
throughput diagnostics process.
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.
The HPNA Diagnostics object.
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.
{{reference}} This is the interface over which the test is to be
performed.
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.
Test packet burst interval length (expressed in {{units}}).
Payload length in the test packets.
HPNA payload encoding in PHY diagnostics. 0 is used for
negotiated payload between devices according to line conditions.
Test packets payload data generator value.
Test packets payload type. {{enum}} In Pattern mode the
PayloadDataGen value is repeated pattern in the payload. In
IncrementByte mode LSByte in PayloadDataGen is used as first
payload and next bytes in payload are incremented.
Priority level of PHY diagnostics packets (0 lowest -7 highest).
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.
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).
HPNA source MAC address.
HPNA destination MAC address.
PHY diagnostics HPNA PHY rate (expressed in {{units}}).
PHY Baud rate (expressed in {{units}}).
PHY diagnostics SNR (expressed in {{units}}).
Number of received packets in PHY diagnostics mode.
Measured attenuation (expressed in {{units}}).
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.
{{reference}} This is the interface over which the test is to be
performed.
Time in {{units}} 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.
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.
Per-node HPNA performance monitoring results. When automatic
collection is enabled, i.e. {{param|#.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.
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.
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.
{{numentries}} This is the number of HPNA nodes for which
performance monitoring results were collected during the
current sample interval.
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}}.
The MAC address of the HPNA node.
The total number of bytes sent by host equipment for
transmission on the HPNA interface.
The total number of received bytes on the HPNA interface
destined for the host equipment.
The total number of packets sent by host equipment for
transmission on the HPNA interface. Number includes also short
error packets and control packets.
The total number of good packets received on the HPNA interface
destined for the host equipment.
The number of broadcast packets transmitted on the HPNA
interface.
The number of broadcast packets received on the HPNA interface.
The number of multicast packets transmitted on the HPNA
interface.
The number of multicast packets received on the HPNA interface.
The number of packets received on the HPNA interface with CRC
errors.
The number of CRC error packets received on the HPNA interface
destined for the host equipment.
The number of packets received on the HPNA interface that are
too short to be valid.
The number packets sent by the host equipment that are too
short to be valid.
The number of received packets dropped due to lack of
resources.
The number packets sent by the host equipment for transmission
on the HPNA interface but dropped due to lack of resources.
The number of HPNA control request packets from local host.
The number of HPNA control reply packets to local host.
The number of HPNA control request packets from remote host.
The number of HPNA control reply packets to remote host.
The total number of packets transmitted to wire.
The total number of broadcast packets transmitted to wire.
The total number of multicast packets transmitted to wire.
The number of HPNA control request packets from internal node.
The number of HPNA broadcast control request packets from
internal node.
The number of received packets queued on host output queues.
The number of packets received and forwarded to unknown hosts.
The node utilization (expressed in {{units}}).
Per-channel HPNA performance monitoring results. Note: channels
are unidirectional.
Time at which channel data was last collected.
{{numentries}} This is the number of HPNA channels for which
performance monitoring results have been collected.
Per-channel HPNA performance monitoring results.
The host source MAC address associated with the channel.
The host destination MAC address associated with the channel.
The HPNA source MAC address associated with the channel.
The HPNA destination MAC address associated with the channel.
Channel PHY rate (expressed in {{units}}).
PHY Baud rate (expressed in {{units}}).
Channel actual SNR measured in receiver side (expressed in
{{units}}).
Number of packets sent in the channel.
Pre-LARQ number of packets received in the channel.
Post-LARQ number of packets received in the channel. Valid only
if LARQ is enabled.
{{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.
MoCA object that contains the {{object|Interface}} table
{{bibref|MoCAv1.0}} {{bibref|MoCAv1.1}}.
{{numentries}}
MoCA interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each table entry models the PHY and
MAC levels of a MoCA interface {{bibref|MoCAv1.0}} {{bibref|MoCAv1.1}}.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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.
This interface's firmware version. This parameter is based on
''mocaIfSoftwareVersion'' from {{bibref|MOCA11-MIB}}.
The maximum MoCA PHY bit rate (expressed in {{units}}).
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 from the MoCA
network in {{units}}. This parameter is based on
''mocaIfMaxEgressNodeBw'' from {{bibref|MOCA11-MIB}}.
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. {{pattern}} This parameter is based on
''mocaIfMocaVersion'' from {{bibref|MOCA11-MIB}}.
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. {{pattern}} This parameter is based on
''mocaIfNetworkVersion'' from {{bibref|MOCA11-MIB}}.
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 this interface. This parameter is based on
''mocaIfNodeID'' from {{bibref|MOCA11-MIB}}.
The maximum network node capability supported by the interface. If
{{param}} is {{true}} then the interface supports 16 nodes (the
maximum for a MoCA 1.1 network). If {{param}} is false then the
interface supports 8 nodes (the maximum for a MoCA 1.0 network).
Whether this interface is a preferred Network Coordinator (NC). This
parameter is based on ''mocaIfPreferredNC'' from
{{bibref|MOCA11-MIB}}.
The Node ID of the backup Network Coordinator node. This parameter is
based on ''mocaIfBackupNC'' from {{bibref|MOCA11-MIB}}.
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.
Indicates whether link-layer security is enabled or disabled. This
parameter is based on ''mocaIfPrivacyEnable'' 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. For example, an interface that supports 1150 MHz through
1500 MHz would have a value of 0x000000001FFFC000. This parameter is
based on ''mocaIfCapabilityMask'' from {{bibref|MOCA11-MIB}}.
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.
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}}.
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}}.
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}}.
MoCA Password. The value consists of numeric characters (0-9).
{{pattern}} This parameter is based on ''mocaIfPassword'' from
{{bibref|MOCA11-MIB}}.
Transmit Power attenuation in dB relative to the maximum transmit
power. The MoCA interface SHOULD have {{param|Enable}} set to
{{false}} for any change in this configuration. If the parameter is
modified when {{param|Enable}} is {{true}} then this change might
take several minutes to complete. This parameter is based on
''mocaIfTxPowerLimit'' from {{bibref|MOCA11-MIB}}.
Target PHY rate in Mbps for the power control algorithm. The MoCA
interface SHOULD have {{param|Enable}} set to {{false}} for any
change in this configuration. If the parameter is modified when
{{param|Enable}} is {{true}} then this change might take several
minutes to complete. This parameter is based on
''mocaIfPowerControlTargetRate'' from {{bibref|MOCA11-MIB}}.
Beacon Transmit Power attenuation in {{units}} relative to the
maximum transmit power. The MoCA interface SHOULD have
{{param|Enable}} set to {{false}} for any change in this
configuration. If the parameter is modified when {{param|Enable}} is
{{true}} then this change might take several minutes to complete.
This parameter is based on ''mocaIfBeaconPowerLimit'' 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 {{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 {{bibref|MOCA11-MIB}}.
The broadcast PHY transmit rate in {{units}} for this interface. This
parameter is based on ''mocaIfTxGcdRate'' from {{bibref|MOCA11-MIB}}.
Transmit Power attenuation in {{units}} relative to the maximum
transmit power for broadcast transmissions. This parameter is based
on ''mocaIfTxGcdPowerReduction'' from {{bibref|MOCA11-MIB}}.
Whether this interface supports the 256 QAM feature. This parameter
is based on ''mocaIfQAM256Capable'' from {{bibref|MOCA11-MIB}}.
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}}.
{{numentries}}
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
The QoS object provides information on MoCA parameterized QoS for this
interface {{bibref|MoCAv1.1}}.
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 onto the MoCA
network. This parameter is based on ''mocaIfIngressNodeNumFlows''
from {{bibref|MOCA11-MIB}}.
{{numentries}}
The flow statistics table provides information on the MoCA
parameterized QoS flows this interface has allocated onto the MoCA
network.
The flow ID used to identify a flow in the network. This parameter is
based on ''mocaIfFlowID'' from {{bibref|MOCA11-MIB}}.
The Destination Address (DA) for the packets in this flow. This
parameter is based on ''mocaIfPacketDA'' from {{bibref|MOCA11-MIB}}.
Maximum required rate in {{units}}. This parameter is based on
''mocaIfPeakDataRate'' from {{bibref|MOCA11-MIB}}.
Maximum burst size. This parameter is based on ''mocaIfBurstSize''
from {{bibref|MOCA11-MIB}}.
Flow lease time (expressed in {{units}}). A {{param}} of 0 means
unlimited lease time. This parameter is based on ''mocaIfLeaseTime''
from {{bibref|MOCA11-MIB}}.
Flow lease time remaining (expressed in {{units}}). If
{{param|LeaseTime}} is 0 then a {{param}} of 0 means unlimited lease
time; otherwise, a {{param}} of 0 means expired. This parameter is
based on ''mocaIfLeaseTimeLeft'' from {{bibref|MOCA11-MIB}}.
The number of packets transmitted for this flow. This parameter is
based on ''mocaIfTxPacketsFlow'' from {{bibref|MOCA11-MIB}}.
This table contains information about other MoCA devices currently
associated with this MoCA interface.
The MAC address of the associated device's MoCA interface.
The Node ID of this remote device. This parameter is based on
''mocaNodeIndex'' from {{bibref|MOCA11-MIB}}.
Whether this remote device is a preferred Network Coordinator (NC).
This parameter is based on ''mocaNodePreferredNC'' from
{{bibref|MOCA11-MIB}}.
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. {{pattern}} This parameter is based on
''mocaNodeMocaVersion'' from {{bibref|MOCA11-MIB}}.
The PHY transmit rate (in {{units}}) to this remote device. This
parameter is based on ''mocaMeshTxRate'' from {{bibref|MOCA11-MIB}}.
The PHY receive rate (in {{units}}) from this remote device.
The reduction in transmitter level (in {{units}}) due to power
control. This parameter is based on ''mocaNodeTxPowerReduction'' from
{{bibref|MOCA11-MIB}}.
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 broadcast PHY transmit rate (in {{units}}) from this remote
device. This parameter is based on ''mocaNodeTxGcdRate'' from
{{bibref|MOCA11-MIB}}.
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 number of packets transmitted to this remote device (Note:
Includes Broadcast, Multicast and Unicast packets).
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 errored and missed packets received from this remote
device. This parameter is based on ''mocaNodeRxDrops'' from
{{bibref|MOCA11-MIB}}.
Whether this remote device supports the 256 QAM feature. This
parameter is based on ''mocaNodeQAM256Capable'' from
{{bibref|MOCA11-MIB}}.
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 signal to noise level (in {{units}}) received at this interface
from this remote device. This parameter is based on ''mocaNodeSNR''
from {{bibref|MOCA11-MIB}}.
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.
G.hn object that contains an {{object|Interface}} table for G.hn
supported CPE. The ITU-T G.hn specifications {{bibref|G.9960}} and
{{bibref|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.
{{numentries}}
G.hn interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each table entry models the PHY
{{bibref|G.9960}} and MAC {{bibref|G.9961}} layers of a G.hn interface.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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 firmware version of the interface.
This parameter was DEPRECATED because it has been replaced by
{{param|MediumType}}. This parameter is OBSOLETED in 2.14.
The maximum PHY data rate that the interface is capable of
transmitting (expressed in {{units}}).
{{list}} Identifies the target domains configured by the user, as
described in {{bibref|G.9961|Section 8.6.1}}. When registering or
re-registering, the G.hn interface SHOULD try to register to one of
these domains in the given order.
This is the domain name to which the interface is currently
registered. {{empty}} indicates that the interface is currently not
registered.
The Domain Name Identifier, a shortened version of
{{param|DomainName}}, denoted as DNI in {{bibref|G.9961|Section
8.6.11.2.1}}.
The Domain Identifier of the domain to which the interface is
registered, denoted as DOD in {{bibref|G.9961}}.
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 maximum PHY bit rate supported by this interface (expressed in
{{units}}).
Indicates whether this interface has the capability to act as Domain
Master in the G.hn domain.
Indicates a request to force the role of the G.hn interface to Domain
Master (DM) for the G.hn domain it is connected to. The selection of
the Domain Master follows the procedures described in
{{bibref|G.9961|Clause 8.6.6}}.
Indicates whether this G.hn interface is currently the Domain Master
(DM) for the G.hn domain it is connected to, as described in
{{bibref|G.9961|Clause 8.6}}.
Indicates whether this interface has the capability to act as
Security Controller in the G.hn domain.
Indicates a request to force the role of the G.hn interface to
Security Controller (SC) for the G.hn domain it is connected to. The
selection of the Security Controller follows the procedures described
in {{bibref|G.9961|Clause 9.2}}.
Indicates whether this G.hn interface is currently the Security
Controller (SC) for the G.hn domain it is connected to, as described
in {{bibref|G.9961|Clause 9.2}}.
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 largest bandplan that the interface can support, as defined in
{{bibref|G.9961|Clause 8.8.5.5}}.
The medium type that the interface currently operates on. Refer to
{{bibref|G.9962|Table 7-5}}.
The Acknowledgement InterFrame Gap, or TAIFG, as defined in
{{bibref|G.9961|Clause 8.4}}. It is represented as multiples of
{{units}}.
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}}).
Comma-separated list of DeviceIDs of nodes that need to enable their
PHY throughput diagnostics mode. All devices that are enabled will
participate in the G.hn network PHY throughput diagnostics process.
Comma-separated list of DeviceIDs of nodes that need to enable their
Performance Monitoring diagnostics mode on this node. All devices
that are enabled will participate in the G.hn network Performance
Monitoring diagnostics process.
{{numentries}}
Requests the interface to become the Domain Master in the G.hn
domain. This parameter is valid only if {{param|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.
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 Security Controller
({{true}}) or not ({{false}}).
{{numentries}}
Specifies the list of PSD shaping mask (PSM) breakpoints to be
applied to the G.hn interface. {{list|with each list item consisting
of the following}} {{datatype|expand}} The PSM level is 0.1*(the
value of the level of the PSM) - 140 dBm/Hz. For example, a PSM
defined by two breakpoints (subcarrier 450, PSM level -80 dBm/Hz) and
(subcarrier 1050, PSM level -90 dBm/Hz) is represented by PSM
[450,600],[1050,500] .
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}}.
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 {{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 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.
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 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 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 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 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 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 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 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 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 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 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 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 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 MPDU bytes transmitted by the node through a
physical medium, which correspond to management LPDUs and framing
overhead.
The total number of MPDU bytes received by the node through a
physical medium, which correspond to management LPDUs and framing
overhead.
The total number of LCDUs requested for transmission by a management
layer (i.e., outbound LCDUs generated in LLC defined in
{{bibref|G.9961|Clause 8.1.3}}) that were transmitted by the node
through a physical medium.
The total number of LCDUs delivered to a management layer (i.e.,
inbound LCDUs) that were received by the node through a physical
medium.
The total number of LPDUs that were transmitted by the node through a
physical medium, regardless of new or retransmitted LPDUs.
The total number of LPDUs that were received by the node through a
physical medium, with or without errors.
The total number of LPDUs that were retransmitted.
The total number of received LPDUs that contained errors. Note the
following relationships hold:
* PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent
+ MulticastPacketsSent + BroadcastPacketsSent.
* PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived
+ BroadcastPacketsReceived.
* Retransmission rate = BlocksResent / BlocksSent.
* Block error rate = BlocksErrorReceived / BlocksReceived.
This table contains information about other G.hn devices connected to
this G.hn interface.
MAC address of remote G.hn device. This is denoted as REGID in
{{bibref|G.9961}}.
Device Id (as defined in G.hn) for the remote G.hn device, denoted as
DEVICE_ID in {{bibref|G.9961}}.
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 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.
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, {{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. If {{param}} is
{{true}}, it indicates that the Status of the remote device is 0, 1,
or 2 (see {{bibref|G.9961|Table 7-3}}).
This object specifies management parameters pertaining to the domain
functionality (Domain Master function; see {{bibref|G.9961|Clause
8.6}}). The object exists only on G.hn interfaces that are currently
the Domain Master, i.e. for which parameter {{param|#.IsDM}} is
{{true}}.
This is the domain name to which the interface is currently
registered. {{empty}} indicates that the interface is currently not
registered.
The Domain Name Identifier, a shortened version of
{{param|DomainName}}, denoted as DNI in {{bibref|G.9961|Section
8.6.11.2.1}}.
The Domain Identifier of the domain to which the interface is
registered, denoted as DOD in {{bibref|G.9961}}.
The MAC cycle duration, as specified in {{bibref|G.9961|Clause 8.4}}.
It is represented as multiples of {{units}}. In the case of power
line, writing to this parameter has no effect and it reads back as 0,
which is a special value indicating that the MAC cycle is
synchronized with 2 AC cycles as defined in {{bibref|G.9961|Clause
8.6.3.1}}.
The DEVICE_ID of the Security Controller selected by the Domain
Master.
The REGID of the Security Controller selected by the Domain Master.
The time interval for periodic re-registration, as specified in
{{bibref|G.9961|Clause 8.8.5.8}}. It is represented as multiples of
{{units}}.
The time interval that a node sends out the periodic topology update
using TM_NodeTopologyChange.ind message, as specified in
{{bibref|G.9961|Clause 8.8.5.8.1}}. It is represented as multiples of
{{units}}. The special value 0 represents an infinite interval (i.e.,
no periodic topology update).
Indicates the value of the minimal bandplan capability for a node
that is allowed to register to the domain.
Indicates the value of the minimal bandplan capability for a node
that is allowed to register to the domain.
This object specifies management parameters pertaining to the Security
Controller functionality (Security Controller function; see
{{bibref|G.9961|Clause 9.2}}). The object exists only on G.hn
interfaces that are currently the Security Controller, i.e. for which
parameter {{param|#.IsSC}} is {{true}}.
The security modes that the Security Controller can support. Refer to
{{bibref|G.9961|Clause 9.2}}.
Node-to-Node
Network Membership Key
The security mode in which the Security Controller is operating.
The selected MIC size used in the domain.
Indicates whether the Security Controller is above the L1 reference
point. It is set to {{true}} if the Security Controller is above the
L1 reference point, and set to {{false}} otherwise.
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}}.
Enables or disables the {{object}}.
The masked band number.
Index of the lowest frequency sub-carrier in the band to be masked as
specified in {{bibref|G.9961|Table 8-79}}. This parameter is writable
only on the interface which acts as the Domain Master.
Index of the highest frequency sub-carrier in the band to be masked
as specified in Table 8-79 in {{bibref|G.9961}}. This parameter is
writable only on the interface which acts as the Domain Master.
The G.hn Diagnostics object.
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.
The interface over which the test is to be performed.
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.
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.
PHY throughput diagnostics results.
MAC address of the destination node of the link being measured.
Indicates the state of the link between the G.hn Interface with
MAC address {{param|#.DiagnoseMACAddress}} and the G.hn
Interface with MAC address {{param|DestinationMACAddress}}.
There is a direct link between G.hn Interface with MAC
address {{param|#.DiagnoseMACAddress}} and G.hn Interface
with MAC address {{param|DestinationMACAddress}}
There is no direct link between G.hn Interface with MAC
address {{param|#.DiagnoseMACAddress}} and G.hn Interface
with MAC address {{param|DestinationMACAddress}}
PHY data rate in transmit direction in the link between the
G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}}
and the G.hn Interface with MAC address
{{param|DestinationMACAddress}}. It is represented in {{units}}
as defined in Note 1 to {{bibref|G.9961|Table 8-48}}. To
convert from the value in the table, divide by 32K (32768) and
round down.
PHY data rate in receive direction in the link between the G.hn
Interface with MAC address {{param|#.DiagnoseMACAddress}} and
the G.hn Interface with MAC address
{{param|DestinationMACAddress}}. It is represented in {{units}}
as defined in Note 1 to {{bibref|G.9961|Table 8-48}}. To
convert from the value in the table, divide by 32K (32768) and
round down.
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.
The interface over which the test is to be performed.
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.
Time in {{units}} 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.
The number of sub-carriers in a group to be used for averaging
SNR values when providing SNR information for a channel.
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.
Per-node G.hn performance monitoring results. When automatic
collection is enabled, i.e. {{param|#.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.
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.
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.
{{numentries}} This is the number of G.hn nodes for which
performance monitoring results were collected during the
current sample interval.
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}}.
MAC address of the destination node of the link being measured.
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 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 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 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 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}}). This
parameter represents the total number of LCDUs requested for
transmission by a management layer (i.e., outbound LCDUs
generated in LLC defined in in {{bibref|G.9961|Clause 8.1.3}})
that were transmitted by the node through a physical medium)
but could not be transmitted because of errors (e.g., APDUs
containing CRC errors).
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 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 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 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 received APDUs that were chosen to be
discarded even though no errors had been detected to prevent
their being delivered.
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 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 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 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 APDUs received by the management that were
discarded because of an unknown or unsupported protocol.
The total number of MPDU bytes transmitted by the node through
a physical medium, which correspond to management LPDUs and
framing overhead.
The total number of MPDU bytes received by the node through a
physical medium, which correspond to management LPDUs and
framing overhead.
The total number of LCDUs requested for transmission by a
management layer (i.e., outbound LCDUs generated in LLC defined
in {{bibref|G.9961|Clause 8.1.3}}) that were transmitted by the
node through a physical medium.
The total number of LCDUs delivered to a management layer
(i.e., inbound LCDUs) that were received by the node through a
physical medium.
The total number of LPDUs that were transmitted by the node
through a physical medium, regardless of new or retransmitted
LPDUs.
The total number of LPDUs that were received by the node
through a physical medium, with or without errors.
The total number of LPDUs that were retransmitted.
The total number of received LPDUs that contained errors. Note
the following relationships hold:
* PacketsSent + ErrorsSent + DiscardPacketsSent =
UnicastPacketsSent + MulticastPacketsSent +
BroadcastPacketsSent.
* PacketsReceived = UnicastPacketsReceived +
MulticastPacketsReceived + BroadcastPacketsReceived.
* Retransmission rate = BlocksResent / BlocksSent.
* Block error rate = BlocksErrorReceived / BlocksReceived.
Per-channel G.hn performance monitoring results. Note: channels
are unidirectional.
Time at which channel data was last collected.
{{numentries}}
Per-channel G.hn performance monitoring results during the
current sample interval. Each table entry contains the results
collected from the channel between a G.hn interface (as indicated
by {{param|##.DiagnoseMACAddress}}) and a G.hn interface
indicated by {{param|DestinationMACAddress}})
MAC address of the destination node of the link being measured.
The result of an SNR test performed over the channel. It is
formatted as a comma-separated list of N/M unsigned integers
that represents the result of Signal-to-Noise-Ratio measurement
averaging in groups of M subcarriers. The number N depends on
the bandplan used by the node and corresponds to the OFDM
control parameter N of each medium as defined in
{{bibref|G.9964}}. The number M corresponds to the parameter
{{param|##.SNRGroupLength}}.
HomePlug object that contains the {{object|Interface}} table. The
HomePlug industry standard {{bibref|HPAV1.1}} defines peer to peer
communication over powerline medium.
{{numentries}}
HomePlug interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each table entry models the PHY and
MAC levels of a HomePlug interface {{bibref|HPAV1.1}}.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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 textual name of the HomePlug Logical Network.
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:
: "1.0"
: "1.1"
The firmware version of the interface.
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 {{param}} is set to automatic CCo
selection ({{false}}).
The network password of the device. This is a human readable ASCII
string that is hashed per the HomePlug specification to generate the
Network Membership Key (NMK). Note that care needs to be taken when
setting this parameter as it might prohibit communication with other
adapters or equipment connected via the powerline network.
{{list}} Indicates whether any other HomePlug networks are currently
visible via this interface. Examples of valid list items include, but
are not limited to:
: "HomePlugAV"
: "HomePlug1.0"
: "Other"
The maximum PHY bit rate supported by this interface (expressed in
{{units}}).
{{numentries}}
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
HomePlug-specific statistic. The Number of MAC Protocol Data Units
(MPDUs) Transmitted and Acknowledged.
HomePlug-specific statistic. The Number of MAC Protocol Data Units
(MPDUs) Transmitted and Collided
HomePlug-specific statistic. The Number of MAC Protocol Data Units
(MPDUs) Transmitted and Failed
HomePlug-specific statistic. The Number of MAC Protocol Data Units
(MPDUs) Received and Acknowledged
HomePlug-specific statistic. The Number of MAC Protocol Data Units
(MPDUs) Received and Failed
This table contains information about other HomePlug devices connected
to this HomePlug interface.
MAC address of remote HomePlug device. It is used to uniquely
identify and easily correlate with the connected remote HomePlug
device.
The PHY transmit Rate (expressed in {{units}}) to this remote device.
The PHY receive Rate (expressed in {{units}}) from this remote
device.
{{list}} List items indicate Signal to Noise Ratio (SNR) per tone
from this remote device (expressed in {{units}}).
Average attenuation from this remote device (expressed in {{units}}).
{{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"
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.
Universal Powerline Association {{bibref|UPA-PLC}}. This object
contains the {{object|Interface}} and {{object|Diagnostics}} objects.
{{numentries}}
UPA interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). Each table entry models the PHY and
MAC levels of a UPA interface {{bibref|UPA-PLC}}.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
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.
This interface's firmware version.
The maximum PHY bit rate supported by this interface (expressed in
{{units}}).
Type of UPA device role. It can be Fixed Access Point (master) or End
Point (slave) of the PLC network. {{enum}}
The name (network ID) of the logical PLC network in which the local
interface is a member (human readable string).
Encryption Method used by UPA device. {{enum}}
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
Power back-off management feature status in the UPA device. Boolean
can be {{true}} for "enabled" and {{false}} for "disabled".
Show if power back-off mechanism is active at that time in the UPA
device. Boolean can be {{true}} for "active" and {{false}} for "not
active".
The estimated application throughput (expressed in {{units}}),
received from the PLC link. This value can be used to indicate link
quality.
Enables or disables the {{object|ActiveNotch}} table for this
interface.
{{numentries}}
{{numentries}}
{{numentries}}
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
This table contains information about PLC connections running between
this UPA interface and other UPA devices.
Remote UPA device MAC address.
The PLC port number.
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.
Physical transmission throughput (in {{units}}).
Physical reception throughput (in {{units}}).
Real Physical reception throughput (in {{units}}).
Estimated PDU Loss Rate measurement between two devices (i.e.
estimated {{units}} of MPDUs that have been received with errors).
Mean estimated attenuation (i.e. channel loss between the local
interface and the remote device). It is measured in {{units}}.
Intermediate UPA adapter MAC address of the device that is acting as
a relay to increase coverage in mesh scenarios. This is the MAC
address of a third UPA device, with which the UPA interface is doing
smart repeating in order to transmit data to the associated
{{param|MACAddress}} UPA device. {{param}} will be empty when
{{param|DirectRoute}} is {{true}}.
Route status, where {{true}} indicates ''direct'' and {{false}}
indicates ''indirect''.
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.
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 {{object}} entries can be enabled/disabled as a group using the
{{param|#.ActiveNotchEnable}} parameter.
Enables or disables the active notch entry.
{{datatype|expand}}
The initial frequency (in {{units}}) of a notch enabled in the
spectrum of the local interface.
The final frequency (in {{units}}) of a notch enabled in the spectrum
of the local interface.
The depth (in {{units}}) of a notch enabled in the spectrum of the
local interface.
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.
{{datatype|expand}}
MAC address of the device.
Internal bridge associated port.
The UPA Diagnostics object.
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).
Indicates the type of port measurement test to be carried out.
{{enum}}.
Signal-to-Noise-Ratio
Channel Frequency Response
{{reference}} This is the local UPA interface from which the test
is to be performed.
PLC port being measured. This identifies which PLC connection to
measure between the local interface (indicated by
{{param|Interface}}) and the remote device (implied by
{{param}}).
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.
{{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}}).
Reception gain of the adapter (expresssed in {{units}}).
The WiFi object is based on the WiFi Alliance 802.11 specifications
({{bibref|802.11-2007}}). It defines interface objects
({{object|Radio}} and {{object|SSID}}), and application objects
({{object|AccessPoint}} and {{object|EndPoint}}).
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
This parameter counts the number of WiFi host or driver resets since
the last device reset. This parameter is reset to zero after the
device resets, and increments with each successive WiFi host or
driver reset.
Reports the cause for the previous Wi-Fi driver reset.
Indicates that the host processor intentionally performed the
reset. This can be due to an external instruction.
Indicates that the reset was spontaneous. This can be due to an
error condition.
Indicates that the reset was due to a loss of mains power on
the device.
This command defines access to other WiFi SSIDs that this device is
able to receive.
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.
Neighboring SSID table. This table models the other WiFi SSIDs
that this device is able to receive.
The Radio that detected the neighboring WiFi SSID.
The current service set identifier in use by the neighboring
WiFi SSID. The value MAY be empty for hidden SSIDs.
The BSSID used for the neighboring WiFi SSID.
The mode the neighboring WiFi radio is operating in.
The current radio channel used by the neighboring WiFi radio.
An indicator of radio signal strength (RSSI) of the neighboring
WiFi radio measured in {{units}}, as an average of the last 100
packets received.
The type of encryption the neighboring WiFi SSID advertises.
The {{enum|WEP}} value indicates either WEP-64 or WEP-128. The
{{enum|WPA}} value is the same as WPA-Personal. The
{{enum|WPA2}} value is the same as WPA2-Personal. The
{{enum|WPA-WPA2}} value is the same as WPA-WPA2-Personal. The
{{enum|WPA3-SAE}} value is the same as WPA3-Personal. The
{{enum|WPA2-PSK-WPA3-SAE}} value is the same as
WPA3-Personal-Transition.
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.
Indicates the frequency band at which the radio this SSID
instance is operating.
{{list}} List items indicate which IEEE 802.11 standards this
{{object}} instance can support simultaneously, in the
frequency band specified by {{param|OperatingFrequencyBand}}.
{{enum}} Each value indicates support for the indicated
standard. If {{param|OperatingFrequencyBand}} is set to
{{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}},
{{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. If
{{param|OperatingFrequencyBand}} is set to
{{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}},
{{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed.
{{bibref|802.11a-1999}}
{{bibref|802.11b-1999}}
{{bibref|802.11g-2003}}
{{bibref|802.11n-2009}}
{{bibref|802.11ac-2013}}
{{bibref|802.11ax}}
{{list}} List items indicate which IEEE 802.11 standard that is
detected for this {{object}}. Each value indicates support for
the indicated standard. If {{param|OperatingFrequencyBand}} is
set to {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}},
only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are
allowed. If {{param|OperatingFrequencyBand}} is set to
{{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values
{{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed.
For example, a value of "g,b" (or "b,g" - order is not
important) means that the 802.11g standard
{{bibref|802.11g-2003}} is used with a backwards-compatible
mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means
that only the 802.11g standard can be used.
Indicates the bandwidth at which the channel is operating.
Time interval (in {{units}}) between transmitting beacons.
Indicator of average noise strength (in {{units}}) received
from the neighboring WiFi radio.
{{list}} Basic data transmit rates (in Mbps) for the SSID. For
example, if {{param}} is "1,2", this indicates that the SSID is
operating with basic rates of 1 Mbps and 2 Mbps.
{{list}} Data transmit rates (in Mbps) for unicast frames at
which the SSID will permit a station to connect. For example,
if {{param}} is "1,2,5.5", this indicates that the SSID will
only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps.
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. {{bibref|802.11-2012}}
This parameter represents a request to reset or reboot the WiFi
sub-system without resetting or rebooting the device.
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.
{{numentries}}
The summary of statistics related to Multi-AP Steering for the Wi-Fi
network. The counters contained in {{object}} are all reset on reboot.
Number of times Associated Devices should have been steered but
weren't because a better candidate AP couldn't be found.
Number of times a Blacklist steer was attempted.
Number of times an attempted Blacklist steer succeeded.
Number of times an attempted Blacklist steer failed.
Number of times a BTM (BSS Transition Management; 802.11k) steer was
attempted.
Number of times an attempted BTM (BSS Transition Management; 802.11k)
steer succeeded.
Number of times an attempted BTM (BSS Transition Management; 802.11k)
steer failed.
Number of asynchronous BTM (BSS Transition Management; 802.11k)
Queries for which a BTM Request was issued.
Each instance of this object represents an individual Access Point
device in the Wi-Fi network.
A unique identifier for this particular device within the Wi-Fi
network.
The manufacturer of the Access Point device (human readable string).
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. {{pattern}} The
value MUST be a valid OUI as defined in {{bibref|OUI}}. 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
{{param|SerialNumber}} parameter is unique. This value MUST remain
fixed over the lifetime of the device, including across firmware
updates.
Identifier of the particular Access Point device that is unique for
the indicated class of product and manufacturer. This value MUST
remain fixed over the lifetime of the device, including across
firmware updates.
A string identifying the software version currently installed in the
Access Point device (i.e. version of the overall firmware). To allow
version comparisons, this element SHOULD be in the form of
dot-delimited integers, where each successive integer represents a
more minor category of variation. For example, ''3.0.21'' where the
components mean: ''Major.Minor.Build''.
The last time that the Access Point device was contacted via the
Multi-AP control protocol.
{{param}} 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.
The medium being used to backhaul this Access Point Device to the
Multi-AP Controller. The {{enum|None}} value is reserved for the
{{object}} instance that represents the Multi-AP Controller. {{enum}}
The MAC Address of the Device on the network that is providing a
Backhaul Link for this Access Point Device. The {{empty}} value is
reserved for the {{object}} instance that represents the Multi-AP
Controller.
The total number of bytes transmitted across the backhaul medium (as
identified by the value of the {{param|BackhaulLinkType}} parameter),
including framing characters.
The total number of bytes received across the backhaul medium (as
identified by the value of the {{param|BackhaulLinkType}} parameter),
including framing characters.
Current utilization (expressed in {{units}}) of the medium (as
identified by the value of the {{param|BackhaulLinkType}} parameter)
being used to backhaul this Access Point device to the Multi-AP
Controller. A value of 0 is used for the {{object}} instance that
represents the Access Point on the Multi-AP Controller.
An indicator of radio signal strength of the backhaul link of the
Access Point (AP) to the Multi-AP Controller, measured in {{units}}.
RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}.
The value of this parameter is indeterminate if the value of the
{{param|BackhaulLinkType}} parameter is anything other than
{{enum|Wi-Fi|BackhaulLinkType}}.
{{numentries}}
{{list}} List items represent channels in the non-occupancy list due
to radars detected by Dynamic Frequency Selection (DFS) Channel
Availability Check (CAC).
Enables or disables Dynamic Frequency Selection (DFS).
This object represents all of the individual Radios contained within
the identified Access Point device known to the controller.
A unique identifier for this particular Radio within the identified
Access Point.
Indicates the frequency band at which the radio is operating.
{{enum}}
{{list}} List items indicate which IEEE 802.11 standard this
{{object}} instance is configured for. {{enum}} If
{{param|OperatingFrequencyBand}} is set to
{{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}},
{{enum|g}}, {{enum|n}}, {{enum|ax}} are applicable. If
{{param|OperatingFrequencyBand}} is set to
{{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}},
{{enum|n}}, {{enum|ac}}, {{enum|ax}} are applicable. For example, a
value of "g,b" (or "b,g" - order is not important) means that the
802.11g standard {{bibref|802.11g-2003}} is used with a
backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A
value of "g" means that only the 802.11g standard is in use.
{{bibref|802.11a-1999}}
{{bibref|802.11b-1999}}
{{bibref|802.11g-2003}}
{{bibref|802.11n-2009}}
{{bibref|802.11ac-2013}}
{{bibref|802.11ax}}
The current radio channel used by the connection. To request
automatic channel selection, set
{{param|Device.WiFi.Radio.{i}.AutoChannelEnable}} to {{true}}.
Whenever {{param|Device.WiFi.Radio.{i}.AutoChannelEnable}} is
{{true}}, the value of the {{param}} parameter MUST be the channel
selected by the automatic channel selection procedure. For channels
in "wide mode" (where a channel bandwidth strictly greater than 20
MHz is used), this parameter is used for Primary Channel only. The
secondary or extension channel information is available through
{{param|ExtensionChannel}}. Note: Valid {{param}} values depend on
the {{param|OperatingFrequencyBand}} value specified and the
regulatory domain.
The secondary extension channel position, applicable when operating
in wide channel mode (i.e. when
{{param|CurrentOperatingChannelBandwidth}} is
{{enum|40MHz|CurrentOperatingChannelBandwidth}} If not operating in
wide channel mode (i.e. when
{{param|CurrentOperatingChannelBandwidth}} is something other than
{{enum|40MHz|CurrentOperatingChannelBandwidth}}, then the value of
{{param}} is {{enum|None}}. {{enum}}
{{list}} 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".
The channel bandwidth currently in use. {{enum}}
The Modulation Coding Scheme index (applicable to 802.11n and
802.11ac specifications only). Values from 0 to 15 MUST be supported
({{bibref|802.11n-2009}}). Values from 0 to 9 MUST be supported for
{{bibref|802.11ac-2013}}.
Indicates the current transmit power level as a {{units}} of full
power.
Indicates the maximum Effective Isotropic Radiated Power (EIRP) per
20 MHz bandwidth representing the nominal transmit power limit for
this radio. The field is coded in units of {{units}} relative to 1
mW. {{bibref|MAPv1.0|Clause 17.2.15}}
{{numentries}}
A single logical Access Point operating on this radio.
The MAC Address of the logical BSS (BSSID).
The SSID in use for this BSS.
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.
Number of times a BTM (BSS Transition Management; 802.11k) steer was
attempted for this Access Point.
Number of asynchronous BTM (BSS Transition Management; 802.11k)
Queries for which a BTM Request was issued by this Access Point.
{{numentries}}
Object describing a single Associated Device (STA).
The MAC address of an associated device.
The operating standard that this associated device is connected with.
{{enum}}
{{bibref|802.11a-1999}}
{{bibref|802.11b-1999}}
{{bibref|802.11g-2003}}
{{bibref|802.11n-2009}}
{{bibref|802.11ac-2013}}
{{bibref|802.11ax}}
Whether or not this associated device is currently present on the
Wi-Fi Access Point device. The ability to list inactive nodes is
OPTIONAL. If the Access Point devices includes inactive nodes in this
table, {{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.
Date and time in UTC when the device was associated.
The data transmit rate in {{units}} that was most recently used for
transmission of data from the access point to the associated device.
The data transmit rate in {{units}} that was most recently used for
transmission of data from the associated device to the access point.
An indicator of radio signal strength of the uplink from the
Associated Device (STA) to the Access Point (AP) measured in
{{units}}. RCPI threshold is encoded per Table 9-154 of
{{bibref|802.11-2016}}.
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
{{bibref|802.11-2016|Section 10.11.9.4}}.
{{numentries}}
Object describing the Statistics for a single Associated Device (STA).
The total number of bytes transmitted to the Associated Device.
The total number of bytes received from the Associated Device.
The total number of packets transmitted to the Associated Device.
The total number of packets received from the Associated Device.
The total number of outbound packets that could not be transmitted
because of errors. These might be due to the number of
retransmissions exceeding the retry limit, or from other causes.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
The total number of transmitted packets which were retransmissions.
Two retransmissions of the same packet results in this counter
incrementing by two.
The summary of statistics related to Multi-AP Steering for an
individual STA on the Wi-Fi network. The counters contained in
{{object}} are all reset on reboot.
Number of times this Associated Device should have been steered but
wasn't because a better candidate AP couldn't be found.
Number of times a Blacklist steer was attempted on this Associated
Device.
Number of times an attempted Blacklist steer succeeded for this
Associated Device.
Number of times an attempted Blacklist steer failed for this
Associated Device.
Number of times a BTM (BSS Transition Management; 802.11k) steer was
attempted on this Associated Device.
Number of times an attempted BTM (BSS Transition Management; 802.11k)
steer succeeded for this Associated Device.
Number of times an attempted BTM (BSS Transition Management; 802.11k)
steer failed for this Associated Device.
Number of asynchronous BTM (BSS Transition Management; 802.11k)
Queries for which a BTM Request was issued to this Associated Device.
The number of {{units}} since this Associated Device was last
attempted to be steered.
The history of Multi-AP Steering for an individual STA on the Wi-Fi
network. The contents of this multi-instance object are reset on
reboot.
The date/time when steering was initiated for the Associated Device.
The BSSID of the Access Point that initiated the steering.
The type of event that caused the steering to be initiaited. {{enum}}
NOTE: This might be Unknown for BTM Query Response steers.
The type of steering that was attempted. {{enum}}
The BSSID of the destination Access Point of a successful steer. A
failed steering attempt will leave this parameter {{empty}}.
The amount of time in {{units}} required for the steer to complete
successfully. A failed steering attempt will leave this parameter 0.
This object represents the Wi-Fi Alliance Data Elements as defined in
{{bibref|DataElements-v1.0}}.
This object describes a Wi-Fi network containing 1 or more Access Point
devices.
A unique identifier for this particular Wi-Fi network.
The time this group was collected.
A unique identifier for a Multi-AP controller.
{{numentries}}
Each instance of this object represents an individual Access Point
device in the Wi-Fi network.
A unique identifier for this particular device within the Wi-Fi
network as defined in {{bibref|DataElements-v1.0|Section 3.1}}.
The Multi-AP capabilities supported by this device as defined by the
APCapability TLV in {{bibref|MAPv1.0|Section 17.2.6}}.
The interval between the collection of consecutive measurements of
the most frequently updated Data Element from this device in
{{units}}.
{{numentries}}
This object represents all of the individual Radios contained within
the identified Access Point device known to the controller.
A unique identifier for this particular Radio within the identified
Access Point as defined in {{bibref|DataElements-v1.0|Section 3.1}}.
Indicates whether this radio is enabled or disabled.
An indicator of the average radio noise plus interference power
measured for the primary operating channel. Encoded as defined for
ANPI in {{bibref|802.11-2016|Section 11.11.9.4}}.
(Total Channel Utililzation) The percentage of time (linearly scaled
with 255 representing 100%) that the Access Point device sensed the
medium was busy, as indicated by either the physical or virtual
carier sense (CS) mechanism. This is essentially the amount of time
spent transmiting (both successful and failed transmissions),
receiving (both local and non-local transmissions), and processing
noise. When more than one channel is in use for the BSS operating on
the radio, the {{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 {{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 {{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 {{param}} value is calculated
only for the primary channel.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Contains the MACAddress of the STA on this radio providing Wi-Fi
backhaul to this device.
The MAC address of the logical STA sharing the radio for Wi-Fi
backhaul.
This object represents the capabilities of the radio which may be
different from the current operational configuration.
Describes the HT capabilities of the radio as defined by the
HTCapabilities TLV {{bibref|MAPv1.0|Section 17.2.8}}.
Describes the VHT capabilities of the radio as defined by the
VHTCapabilities TLV {{bibref|MAPv1.0|Section 17.2.9}}.
Describes the HE capabilities of the radio as defined by the
HECapabilities TLV {{bibref|MAPv1.0|Section 17.2.10}}.
{{numentries}}
Describes one of the possible Operating Classes supported by this
Radio.
The Operating Class per Table E-4 in {{bibref|802.11-2016}} that this
radio is capable of operating on.
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}}).
{{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.
The number of non-operable channels contained in
{{param|NonOperable}}.
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.
The Operating Class per Table E-4 in {{bibref|802.11-2016}} that this
radio is currently operating on.
This Channel number in the Operating Class that this Radio is
currently operating on.
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}}).
The time this group was collected.
A single logical BSS operating on this radio.
The MAC Address of the logical BSS (BSSID).
The SSID in use for this BSS.
Whether the BSSID is currently enabled (beaconing frames are being
sent) or disabled.
Time in {{units}} since the last change to the {{param|Enabled}}
value.
The time this group was collected.
Access Point (BSS) wide statistics for total unicast bytes
transmitted.
Access Point (BSS) wide statistics for total unicast bytes received.
Access Point (BSS) wide statistics for total multicast bytes
transmitted.
Access Point (BSS) wide statistics for total multicast bytes
received.
Access Point (BSS) wide statistics for total broadcast bytes
transmitted.
Access Point (BSS) wide statistics for total broadcast bytes
received.
Estimated Service Parameters information field for AC=BE, defined per
Figure 9-588 in {{bibref|802.11-2016}} and referenced in
{{bibref|MAPv1.0|Section 17.2.22}}.
Estimated Service Parameters information field for AC=BK, defined per
Figure 9-588 in {{bibref|802.11-2016}} and referenced in
{{bibref|MAPv1.0|Section 17.2.22}}.
Estimated Service Parameters information field for AC=VI, defined per
Figure 9-588 in {{bibref|802.11-2016}} and referenced in
{{bibref|MAPv1.0|Section 17.2.22}}.
Estimated Service Parameters information field for AC=VO, defined per
Figure 9-588 in {{bibref|802.11-2016}} and referenced in
{{bibref|MAPv1.0|Section 17.2.22}}.
{{numentries}}
Object describing a single Associated Device (STA).
The MAC address of an associated device.
The time this group was collected.
Describes the HT capabilities of the Associated Device (STA).
Describes the VHT capabilities of the Associated Device (STA).
Describes the HE capabilities of the Associated Device (STA).
The data transmit rate in {{units}} that was most recently used for
transmission of data from the access point to the associated device.
The data transmit rate in {{units}} that was most recently used for
transmission of data from the associated device to the access point.
The amount of time in {{units}} that the Radio has spent on the
Channel receiving data from this Associated Device (STA).
The amount of time in {{units}} that the Radio has spent on the
Channel transmitting data to this Associated Device (STA).
Estimate of the MAC layer throughput in {{units}} achievable in the
downlink direction if 100% of channel airtime and BSS operating
bandwidth were available, as defined in {{bibref|MAPv1.0|Section
10.3.1}}.
Estimate of the MAC layer throughput in {{units}} achievable in the
uplink direction if 100% of channel airtime and BSS operating
bandwidth were available, as defined in {{bibref|MAPv1.0|Section
10.3.1}}.
An indicator of radio signal strength of the uplink from the
associated STA to the access point - measured in {{units}}. RCPI
threshold (encoded per Table 9-154 of {{bibref|802.11-2016}}, and
described in 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.
The time in {{units}} since this Assocated Device (STA) was
associated.
The total number of bytes transmitted to the Associated Device.
The total number of bytes received from the Associated Device.
The total number of packets transmitted to the Associated Device.
The total number of packets received from the Associated Device.
The total number of outbound packets that could not be transmitted
because of errors. These might be due to the number of
retransmissions exceeding the retry limit, or from other causes.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
The total number of transmitted packets which were retransmissions.
Two retransmissions of the same packet results in this counter
incrementing by two.
{{list}} Measurement Report element(s) received from the Associated
Device (STA) that constitute the latest Beacon report as defined in
Figure 9-199 of {{bibref|802.11-2016}}.
The number of measurement report elements contained in
{{param|MeasurementReport}}.
IPV4 Address assigned to the client.
IPV6Address assigned to the client.
Hostname assigned to the client.
The list of neighboring Access Points discovered by a Radio organized
per Operating Class and Channel tuple.
The timestamp of the last scan.
{{numentries}}
The Operating Class of neighboring Access Points discovered by a Radio
during a channel scan.
The Operating Class per 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.
{{numentries}}
The Channel associated with an Operating Class of neighboring Access
Points discovered by a Radio during a channel scan.
The channel number of the Channel scanned by the Radio given the
Operating Class.
The timestamp of the last scan of the channel.
The current Channel Utilization measured by the Radio on the scanned
20MHz channel, as defined by {{bibref|802.11-2016|Section 9.4.2.28}}.
An indicator of the average radio noise plus interference power
measured for the primary operating channel. Encoded as defined for
ANPI in {{bibref|802.11-2016|Section 11.11.9.4}}.
{{numentries}}
The neighboring BSS discovered by a Radio during a channel scan.
The BSSID indicated by the neighboring BSS.
The SSID indicated by the neighboring BSS.
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 {{units}}. (RSSI is encoded per Table 9-154 of
{{bibref|802.11-2016}}). Reserved: 221 - 255. NOTE: The underlying
WFA specification is in the process of being reviewed for possible
clarification. Please refer to that specification for more details.
Indicates the maximum bandwidth at which the neighboring BSS is
operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz.
The channel utilization reported by the neighboring BSS per the BSS
Load element if present in Beacon or Probe Response frames, as
defined by Section 9.4.2.28 in {{bibref|802.11-2016}}.
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 {{bibref|802.11-2016|Section 9.4.2.28}}.
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.
The MAC address of the Non-AP STA.
An indicator of radio signal strength (RCPI) of the uplink from the
Non-AP STA - measured in {{units}}. (RCPI threshold is encoded per
Table 9-154 of {{bibref|802.11-2016}}, and described in 103.2 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.
This object contains the events generated when a STA associates to a
BSS.
{{numentries}}
The events generated when an Associated Device (STA) associates to a
BSS.
The MAC Address of the logical BSS ( BSSID) which is reporting the
Association Event.
The MAC Address of the Associated Device (STA).
The status code sent to the Associated Device (STA) in the
Association Response frame as defined by Table 9-46 in
{{bibref|802.11-2016}}.
Describes the HT capabilities of the Associated Device (STA).
Describes the VHT capabilities of the Associated Device (STA).
Describes the HE capabilities of the Associated Device (STA).
The time this event was collected.
This object contains the events generated when an Associated Device
(STA) disassociates from a BSS.
{{numentries}}
The events generated when an Associated Device (STA) disassociates from
a BSS.
The MAC Address of the logical BSS ( BSSID) which is reporting the
Disassociation Event.
The MAC address of the Associated Device (STA).
The Reason Code received by the AP from the Associated Device (STA)
in the most recent Disassociation or Deauthentication frame or sent
by the AP to the Associated Device (STA) in the most recent
Disassociation or Deauthenticaiton frame as defined in Table 9-45 in
{{bibref|802.11-2016}}.
The total number of bytes transmitted to the Associated Device (STA).
The total number of bytes received from the Associated Device (STA).
The total number of packets transmitted to the Associated Device
(STA).
The total number of packets received from the Associated Device
(STA).
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.
The total number of inbound packets from the Associated Device (STA)
that contained errors preventing them from being delivered to a
higher-layer protocol.
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 time this event was collected.
This object models an 802.11 wireless radio on a device (a stackable
interface object as described in {{bibref|TR-181i2|Section 4.2}}). If
the device can establish more than one connection simultaneously (e.g.
a dual radio device), a separate {{object}} instance MUST be used for
each physical radio of the device. See {{bibref|TR-181i2|Appendix
III.1}} 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 {{object}}
instance is used even for a dual-band radio.
Enables or disables the radio. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the radio (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the radio as assigned by the CPE.
The accumulated time in {{units}} since the radio entered its current
operational state.
{{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.
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
This parameter was DEPRECATED because it gives a wrong indication
for multiple SSIDs. Use the {{param|#.SSID.{i}.Upstream}} parameter
instead. This parameter is OBSOLETED in 2.14.
The maximum PHY bit rate supported by this interface (expressed in
{{units}}).
{{list}} List items indicate the frequency bands at which the radio
can operate.
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).
{{list}} List items indicate which IEEE 802.11 standards this
{{object}} instance can support simultaneously, in the frequency band
specified by {{param|OperatingFrequencyBand}}. {{enum}} Each value
indicates support for the indicated standard. If
{{param|OperatingFrequencyBand}} is set to
{{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}},
{{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. If
{{param|OperatingFrequencyBand}} is set to
{{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}},
{{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed.
{{bibref|802.11a-1999}}
{{bibref|802.11b-1999}}
{{bibref|802.11g-2003}}
{{bibref|802.11n-2009}}
{{bibref|802.11ac-2013}}
{{bibref|802.11ax}}
{{list}} List items indicate which IEEE 802.11 standard this
{{object}} instance is configured for. Each value indicates support
for the indicated standard. If {{param|OperatingFrequencyBand}} is
set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values
{{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. If
{{param|OperatingFrequencyBand}} is set to
{{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}},
{{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. For example, a
value of "g,b" (or "b,g" - order is not important) means that the
802.11g standard {{bibref|802.11g-2003}} is used with a
backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A
value of "g" means that only the 802.11g standard can be used.
{{list}} 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".
{{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.
The current radio channel used by the connection. To request
automatic channel selection, set {{param|AutoChannelEnable}} to
{{true}}. Whenever {{param|AutoChannelEnable}} is {{true}}, the value
of the {{param}} 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 {{param|ExtensionChannel}}. Note:
Valid {{param}} values depend on the {{param|OperatingFrequencyBand}}
value specified and the {{param|RegulatoryDomain}}.
Indicates whether automatic channel selection is supported by this
radio. If {{false}}, then {{param|AutoChannelEnable}} MUST be
{{false}}.
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. {{param}} MUST automatically change to {{false}}
whenever the channel is manually selected, i.e. whenever the
{{param|Channel}} parameter is written. Whenever {{param}} is
{{true}}, the value of the {{param|Channel}} parameter MUST be the
channel selected by the automatic channel selection procedure.
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 accumulated time in {{units}} since the current {{param|Channel}}
came into use.
The cause of the last channel selection.
Manual selection of the {{param|Channel}}.
Automatic channel selection procedure launched at radio
startup.
Automatic channel selection procedure triggered by the user
(e.g. via a GUI).
Automatic channel selection procedure triggered by the
{{param|AutoChannelRefreshPeriod}} timer.
Automatic channel selection procedure dynamically triggered to
adjust to environmental interference.
Automatic channel selection procedure triggered by Dynamic
Frequency Selection (DFS) {{bibref|ETSIBRAN}}.
Maximum number of SSIDs supported on this radio.
Maximum number of associated devices supported.
This radio's WiFi firmware version.
{{list}} These are the valid writable values for
{{param|OperatingChannelBandwidth}}.
wide mode
802.11ac and 802.11ax only
802.11ac and 802.11ax only
802.11ac and 802.11ax only
The preferred channel bandwidth to be used (applicable to 802.11n,
802.11ac, and 802.11ax specifications only).
The channel bandwidth currently in use.
The secondary extension channel position (applicable to the 802.11n
specification only), applicable when operating in wide channel mode
(i.e. when {{param|OperatingChannelBandwidth}} is set to
{{enum|40MHz|OperatingChannelBandwidth}} or
{{enum|Auto|OperatingChannelBandwidth}}).
The guard interval value between OFDM symbols.
applicable to 802.11n and 802.11ac specifications only
applicable to 802.11n and 802.11ac specifications only
applicable to 802.11ax specification only
applicable to 802.11ax specification only
applicable to 802.11ax specification only
applicable to 802.11ax specification only
applicable to 802.11ax specification only
applicable to 802.11ax specification only
When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}},
this parameter determines the Center Frequency Segment 0 for the
first 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}}
and Table 9-252. This parameter is DEPRECATED in 2.14 due to a typo.
Use {{param|CenterFrequencySegment0}} instead.
When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}},
this parameter determines the Center Frequency Segment 1 for the
second 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}}
and Table 9-252. This parameter is DEPRECATED in 2.14 due to a typo.
Use {{param|CenterFrequencySegment1}} instead.
When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}},
this parameter determines the Center Frequency Segment 0 for the
first 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}}
and Table 9-252.
When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}},
this parameter determines the Center Frequency Segment 1 for the
second 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}}
and Table 9-252.
The Modulation Coding Scheme index (applicable to 802.11n, 802.11ac,
and 802.11ax specifications only). Values from 0 to 15 MUST be
supported for ({{bibref|802.11n-2009}}). Values from 0 to 9 MUST be
supported for {{bibref|802.11ac-2013}}. Values from 0 to 11 MUST be
supported for {{bibref|802.11ax}}. A value of -1 indicates automatic
selection of the MCS index.
{{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.
Indicates the current transmit power level as a {{units}} of full
power. The value MUST be one of the values reported by the
{{param|TransmitPowerSupported}} parameter. A value of -1 indicates
auto mode (automatic decision by CPE).
Indicates whether IEEE 802.11h {{bibref|802.11h-2003}} functionality
is supported by this radio. The value can be {{true}} only if the
802.11a or the 802.11n@5GHz standard is supported (i.e.
{{param|SupportedFrequencyBands}} includes
{{enum|5GHz|SupportedFrequencyBands}} and
{{param|SupportedStandards}} includes {{enum|a|SupportedStandards}}
and/or {{enum|n|SupportedStandards}}).
Indicates whether IEEE 802.11h functionality is enabled on this
radio. The value can be {{true}} only if the 802.11a or the
802.11n@5GHz standard is supported and enabled (i.e.
{{param|OperatingFrequencyBand}} is
{{enum|5GHz|OperatingFrequencyBand}} and {{param|OperatingStandards}}
includes {{enum|a|OperatingStandards}} and/or
{{enum|n|OperatingStandards}}).
The 802.11d Regulatory Domain. First two octets are
{{bibref|ISO3166-1}} two-character country code. The third octet is
either " " (all environments), "O" (outside) or "I" (inside).
The maximum number of retransmissions of a short packet i.e. a packet
that is no longer than the {{param|RTSThreshold}}. This corresponds
to IEEE 802.11 parameter ''dot11ShortRetryLimit''
{{bibref|802.11-2012}}.
A request for the clear channel assessment (CCA) report in the format
specified in {{bibref|802.11-2012|Clause 8.4.2.23.3}}.
The clear channel assessment (CCA) report in the format specified in
{{bibref|802.11-2012|Clause 8.4.2.24.3}}. When read, the value of
this parameter MUST correspond to {{param|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 {{empty}}.
A request for a received power indicator (RPI) histogram in the
format specified in {{bibref|802.11-2012|Clause 8.4.2.23.4}}.
Received power indicator (RPI) histogram report in the format
specified in {{bibref|802.11-2012|Clause 8.4.2.24.4}}.
This specifies the current maximum size, in {{units}}, of the MPDU
that can be delivered to the PHY. This parameter is based on
''dot11FragmentationThreshold'' from {{bibref|802.11-2012}}.
This indicates the number of {{units}} in an MPDU, below which an
RTS/CTS handshake is not performed. This parameter is based on
''dot11RTSThreshold'' from {{bibref|802.11-2012}}.
This indicates the maximum number of transmission attempts of a
frame, the length of which is greater than {{param|RTSThreshold}},
that will be made before a failure condition is indicated. This
parameter is based on ''dot11LongRetryLimit'' from
{{bibref|802.11-2012}}.
Time interval between transmitting beacons (expressed in {{units}}).
This parameter is based on ''dot11BeaconPeriod'' from
{{bibref|802.11-2012}}.
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
{{bibref|802.11-2012}}.
This determines whether or not packet aggregation (commonly called
"frame aggregation") is enabled. This applies only to 802.11n.
The type of preamble. Longer preambles (more overhead) are needed by
802.11g to coexist with legacy systems 802.11 and 802.11b.
{{list}} The set of data rates, in ''Mbps'', that have to be
supported by all stations that desire to join this BSS. The stations
have to be able to receive and transmit at each of the data rates
listed in {{param}}. For example, a value of "1,2", indicates that
stations support 1 Mbps and 2 Mbps. Most control packets use a data
rate in {{param}}.
{{list}} Maximum access point data transmit rates in ''Mbps'' for
unicast frames (a superset of {{param|BasicDataTransmitRates}}).
Given the value of {{param|BasicDataTransmitRates}} from the example
above, {{param}} might be "1,2,5.5,11", indicating that unicast
frames can additionally be transmitted at 5.5 Mbps and 11 Mbps.
{{list}} Data transmit rates in ''Mbps'' for unicast frames at which
the access point will permit a station to connect (a subset of
{{param|OperationalDataTransmitRates}}). Given the values of
{{param|BasicDataTransmitRates}} and
{{param|OperationalDataTransmitRates}} from the examples above,
{{param}} might be "1,2,5.5", indicating that the AP will only permit
connections at 1 Mbps, 2 Mbps and 5.5 Mbps, even though it could
theoretically accept connections at 11 Mbps.
Enables or disables 802.11k Radio Resource Management (RRM).
Throughput statistics for this interface. Packet counters here count
802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further
details. The CPE MUST reset the interface's Stats parameters (unless
otherwise stated in individual object or parameter descriptions) either
when the interface becomes operationally down due to a previous
administrative down (i.e. the interface's {{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}}.
The total number of Request To Send (RTS) control frames that
received a Clear To Send (CTS) response.
The total number of Request To Send (RTS) control frames that did not
receive a Clear To Send (CTS) response.
The total number of received packets for which the PHY was able to
correlate the preamble but not the header.
The total number of received frames with a good Physical Layer
Convergence Protocol (PLCP) header.
The total number of Wi-Fi data packets received from other Basic
Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not
matching the receiver address, meaning that that the frame is
received at the MAC layer but is addressed to a different MAC.
The total number of Wi-Fi management packets received from other
Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and
not matching the receiver address, meaning that that the frame is
received at the MAC layer but is addressed to a different MAC.
The total number of Wi-Fi control packets received from other Basic
Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not
matching the receiver address, meaning that that the frame is
received at the MAC layer but is addressed to a different MAC.
The total number of received Clear to Send (CTS) packets not
addressed to the MAC address of this receiver.
The total number of received Request to Send (RTS) frames not
addressed to the MAC address of this receiver.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
The number of packets that were received with a detected Physical
Layer Convergence Protocol (PLCP) header error.
The number of packets that were received with a detected FCS error.
This parameter is based on dot11FCSErrorCount from
{{bibref|802.11-2012|Annex C}}.
The number of packets that were received with a detected invalid MAC
header error.
The number of packets that were received, but which were destined for
a MAC address that is not associated with this interface.
An indicator of average noise strength received at this radio,
measured in {{units}}. This measurement of non-IEEE 802.11 noise
power is made by sampling the channel when virtual carrier sense
indicates idle and this radio is neither transmitting nor receiving a
frame.
The total number of times that the {{param|#.Channel}} has changed
since the {{object|.WiFi.Radio}} entered its current operating state.
The number of times that the {{param|#.Channel}} has changed due to
manual channel selection since the {{object|.WiFi.Radio}} entered its
current operating state.
The number of times that the {{param|#.Channel}} has changed due to
automatic channel selection procedure launched at radio startup since
the {{object|.WiFi.Radio}} entered its current operating state.
The number of times that the {{param|#.Channel}} has changed due to
automatic channel selection procedure triggered by the user (e.g. via
a GUI) since the {{object|.WiFi.Radio}} entered its current operating
state.
The number of times that the {{param|#.Channel}} has changed due to
automatic channel selection procedure triggered by the
{{param|#.AutoChannelRefreshPeriod}} timer since the
{{object|.WiFi.Radio}} entered its current operating state.
The number of times that the {{param|#.Channel}} has changed due to
automatic channel selection procedure dynamically triggered to adjust
to environmental interference since the {{object|.WiFi.Radio}}
entered its current operating state.
The number of times that the {{param|#.Channel}} has changed due to
automatic channel selection procedure triggered by DFS
{{bibref|ETSIBRAN}} since the {{object|.WiFi.Radio}} entered its
current operating state.
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}}.
Enables or disables the SSID entry. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the SSID entry (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the SSID entry as assigned by the CPE.
The accumulated time in {{units}} since the SSID entered its current
operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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 MAC address of this interface. If this instance models an access
point SSID, {{param}} is the same as {{param|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 {{param|.Ethernet.Link.{i}.MACAddress}} parameter.
The current service set identifier in use by the connection. The SSID
is an identifier that is attached to packets sent over the wireless
LAN that functions as an ID for joining a particular radio network
(BSS).
Indicates whether the interface points towards the Internet
({{true}}) or towards End Devices ({{false}}). For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all
WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet
to an Internet Gateway Device, {{param}} will be {{true}} for the
Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
This parameter supersedes the deprecated
{{param|#.Radio.{i}.Upstream}} parameter. If both exist, the
parameter {{param|#.Radio.{i}.Upstream}} is ignored.
Enables or disables Air Time Fairness (ATF).
After this parameter is set to true, the ATF configuration of the
interface will be reset.
Configures the ATF setting for all associated devices on an
individual SSID. Expressed as percentage of airtime, such that no
station should exceed this percentage.
Throughput statistics for this interface. Packet counters here count
802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further
details. The CPE MUST reset the interface's Stats parameters (unless
otherwise stated in individual object or parameter descriptions) either
when the interface becomes operationally down due to a previous
administrative down (i.e. the interface's {{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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors. These can be due to the number of retransmissions
exceeding the retry limit, or from other causes.
The total number of transmitted packets which were retransmissions.
Two retransmissions of the same packet results in this counter
incrementing by two.
The number of packets that were not transmitted successfully due to
the number of retransmission attempts exceeding an 802.11 retry
limit. This parameter is based on dot11FailedCount from
{{bibref|802.11-2012}}.
The number of packets that were successfully transmitted after one or
more retransmissions. This parameter is based on dot11RetryCount from
{{bibref|802.11-2012}}.
The number of packets that were successfully transmitted after more
than one retransmission. This parameter is based on
dot11MultipleRetryCount from {{bibref|802.11-2012}}.
The number of expected ACKs that were never received. This parameter
is based on dot11ACKFailureCount from {{bibref|802.11-2012}}.
The number of aggregated packets that were transmitted. This applies
only to 802.11n and 802.11ac.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
The total number of discarded packets during transmission caused by
transmit buffer overflow.
The total number of discarded packets due to the station not being
associated.
The total number of frame-fragments transmitted out of the interface.
The total number of transmitted data packets that did not receive an
ACK when expected.
The total number of received packets whose Sequence Control field
indicates it is a duplicate.
The total number of received packets longer than the maximum allowed
packet length.
The total number of received packets that did not contain enough
bytes for the packet type.
The total number of unicast ACKs received, with good Frame Check
Sequence (FCS).
This object models an 802.11 connection from the perspective of a
wireless access point. Each {{object}} entry is associated with a
particular {{object|#.SSID}} interface instance via the
{{param|SSIDReference}} parameter. For enabled table entries, if
{{param|SSIDReference}} is not a valid reference then the table entry
is inoperable and the CPE MUST set {{param|Status}} to
{{enum|Error_Misconfigured|Status}}. Note: The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables this access point.
Indicates the status of this access point. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
{{reference}}
Indicates whether or not beacons include the SSID name.
The maximum number of retransmission for a packet. This corresponds
to IEEE 802.11 parameter ''dot11ShortRetryLimit''. This parameter was
DEPRECATED because it is really a {{object|#.Radio}} attribute. Use
{{param|#.Radio.{i}.RetryLimit}}. This parameter is OBSOLETED in
2.14.
Indicates whether this access point supports WiFi Multimedia (WMM)
Access Categories (AC).
Indicates whether this access point supports WMM Unscheduled
Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies
WMM support.
Whether WMM support is currently enabled. When enabled, this is
indicated in beacon frames.
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.
{{numentries}}
The maximum number of devices that can simultaneously be connected to
the access point. A value of 0 means that there is no specific limit.
This parameter has been DEPRECATED in favor of
{{param|MaxAllowedAssociations}}. This parameter is OBSOLETED in
2.14.
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).
Indicates whether or not MAC Address Control is enabled on this
{{object|#}}. MAC Address Control limits client devices to those
whose hardware addresses match the {{param|AllowedMACAddress}} list.
Hardware addresses of client devices that are allowed to associate
with this {{object|#}} if {{param|MACAddressControlEnabled}} is
{{true}}.
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
{{param|#.Radio.{i}.MaxSupportedAssociations}} exists, the value MUST
be less than or equal to the maximum number specified in
{{param|#.Radio.{i}.MaxSupportedAssociations}}.
Reports information about the CPE operation mode (router or
bridge/range extender).
Indicates indicates operation as a router.
Indicates operation as a range extender or acess point in
bridge mode.
This object contains security related parameters that apply to a CPE
acting as an Access Point {{bibref|802.11-2007}}.
{{list}} Indicates which security modes this {{object|#}} instance is
capable of supporting. The {{enum|WPA3-Personal}} value is the same
as WPA3-SAE. The {{enum|WPA3-Personal-Transition}} value is the same
as WPA2-PSK-WPA3-SAE.
Indicates which security mode is enabled.
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.
A WEP key expressed as a hexadecimal string. {{param}} is used only
if {{param|ModeEnabled}} is set to {{enum|WEP-64|ModeEnabled}} or
{{enum|WEP-128|ModeEnabled}}. A 5 byte {{param}} corresponds to
security mode {{enum|WEP-64|ModeEnabled}} and a 13 byte {{param}}
corresponds to security mode {{enum|WEP-128|ModeEnabled}}.
A literal PreSharedKey (PSK) expressed as a hexadecimal string.
{{param}} is only used if {{param|ModeEnabled}} is set to
{{enum|WPA-Personal|ModeEnabled}} or
{{enum|WPA2-Personal|ModeEnabled}} or
{{enum|WPA-WPA2-Personal|ModeEnabled}}. If {{param|KeyPassphrase}} is
written, then {{param}} is immediately generated. The Controller
SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}}
directly (the result of doing this is undefined).
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}}).
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}}.
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}}.
The IP Address of the 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 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 port number of the 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 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 secret used for handshaking with the RADIUS server
{{bibref|RFC2865}}.
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.
Management Frame Protection configuration applicable when
{{param|ModeEnabled}} is set to {{enum|WPA2-Personal|ModeEnabled}},
{{enum|WPA2-Enterprise|ModeEnabled}},
{{enum|WPA3-Personal|ModeEnabled}}, or
{{enum|WPA3-Enterprise|ModeEnabled}}. When in WPA3 modes, {{param}}
MUST be set to {{enum|Required}}.
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}}.
This object contains parameters related to Wi-Fi Protected Setup for
this access point (as specified in {{bibref|WPSv1.0}} or
{bibref|WPSv2.0}}).
Enables or disables WPS functionality for this access point.
WPS configuration methods supported by the device. {{enum}} This
parameter corresponds directly to the "Config Methods" attribute of
{{bibref|WPS 2.0}}. The {{enum|USBFlashDrive}} and {{enum|Ethernet}}
are only applicable in WPS 1.0 and are deprecated in WPS 2.x. The
{{enum|PhysicalPushButton}}, {{enum|VirtualPushButton}},
{{enum|PhysicalDisplay}} and {{enum|VirtualDisplay}} are applicable
to WPS 2.x only.
{{list}} Indicates WPS configuration methods enabled on the device.
{{list}} Indicates the current status of WPS. If the device goes to
{{enum|SetupLocked}} the WPS needs to be disabled and re-enabled to
come out of state.
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.
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}}
A table of the devices currently associated with the access point.
Associated device type (Laptop, iPhone, Android, etc.).
Configures the Air Time Fairness (ATF) setting of this individual
associated device. Expressed as percentage of airtime, such that this
associated device should not exceed this percentage. Setting this
value overrides {{param|Device.WiFi.SSID.{i}.SetATF}} for this
associated device.
The MAC address of an associated device.
The operating standard that this associated device is connected with.
{{bibref|802.11a-1999}}
{{bibref|802.11b-1999}}
{{bibref|802.11g-2003}}
{{bibref|802.11n-2009}}
{{bibref|802.11ac-2013}}
{{bibref|802.11ax}}
Whether an associated device has authenticated ({{true}}) or not
({{false}}).
The data transmit rate in {{units}} that was most recently used for
transmission from the access point to the associated device.
The data transmit rate in {{units}} that was most recently used for
transmission from the associated device to the access point.
Date and time in UTC when the device was associated
An indicator of radio signal strength of the uplink from the
associated device to the access point, measured in {{units}}, as an
average of the last 100 packets received from the device.
An indicator of radio noise on the uplink from the associated device
to the access point, measured in {{units}}, as an average of the last
100 packets received from the device (see ANPI definition in
{{bibref|802.11-2012|Clause 10.11.9.4}})
The number of {{units}} that had to be re-transmitted, from the last
100 packets sent to the associated device. Multiple re-transmissions
of the same packet count as one.
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.
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}}.
The total number of bytes transmitted to the Associated Device,
including framing characters.
The total number of bytes received from the Associated Device,
including framing characters.
The total number of packets transmitted to the Associated Device.
The total number of packets received from the Associated Device.
The total number of outbound packets that could not be transmitted
because of errors. These might be due to the number of
retransmissions exceeding the retry limit, or from other causes.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
The total number of transmitted packets which were retransmissions.
Two retransmissions of the same packet results in this counter
incrementing by two.
The number of packets that were not transmitted successfully due to
the number of retransmission attempts exceeding an 802.11 retry
limit. This parameter is based on ''dot11FailedCount'' from
{{bibref|802.11-2012}}.
The number of packets that were successfully transmitted after one or
more retransmissions. This parameter is based on ''dot11RetryCount''
from {{bibref|802.11-2012}}.
The number of packets that were successfully transmitted after more
than one retransmission. This parameter is based on
''dot11MultipleRetryCount'' from {{bibref|802.11-2012}}.
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
{{param|AccessCategory}} parameter as follows:
* BE (Best Effort)
* BK (Background)
* VI (Video)
* VO (Voice)
This identifies the access category.
{{datatype|expand}}
Arbitration Inter Frame Spacing (Number). This is the number of time
slots in the arbitration interframe space.
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 {{units}}).
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 {{units}}).
Maximum transmit opportunity, in multiples of {{units}}. A TXOP time
interval of 0 means it is limited to a single MAC protocol data unit
(MPDU).
Ack Policy, where False="Do Not Acknowledge" and True="Acknowledge"
{{list}} Definition of the histogram intervals for counting the
transmit queue length in packets. Each value indicates the maximum
value of the interval. For example, "0,1,4,8," defines the five
intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in
queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No
value after the last comma means no upper bound.) If this parameter
is set to {{empty}}, no {{param|Stats.OutQLenHistogram}} stats will
be collected.
The time between recording samples of the current transmit queue in
{{units}}.
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 {{bibref|TR-181i2|Section 4.2.2}}.
The total number of {{units}} transmitted in this access category,
including framing characters.
The total number of {{units}} received in this access category,
including framing characters.
The total number of {{units}} transmitted in this access category.
The total number of {{units}} received in this access category.
The total number of outbound {{units}} in this access category that
could not be transmitted because of errors. These might be due to the
number of retransmissions exceeding the retry limit, or from other
causes.
The total number of inbound {{units}} in this access category that
contained errors preventing them from being delivered to a
higher-layer protocol.
The total number of outbound {{units}} in this access category which
were chosen to be discarded even though no errors had been detected
to prevent their being transmitted. One possible reason for
discarding such a packet could be to free up buffer space.
The total number of inbound {{units}} in this access category which
were chosen to be discarded even though no errors had been detected
to prevent their being delivered. One possible reason for discarding
such a packet could be to free up buffer space.
The total number of transmitted {{units}} in this access category
which were retransmissions. Two retransmissions of the same packet
results in this counter incrementing by two.
{{list}} Histogram of the total length of the transmit queue of this
access category in packets (1 packet, 2 packets, etc.) according to
the intervals defined by {{param|#.OutQLenHistogramIntervals}}, with
samples taken each {{param|#.OutQLenHistogramSampleInterval}}.
Example: "12,5,1,0,2,0,0,1".
This object contains the parameters related to RADIUS accounting
functionality for the access point.
Enables or disables accounting functionality for the access point.
The IP Address of the RADIUS accounting server.
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 port number of the RADIUS server used for accounting. The default
port is 1813 as defined in {{bibref|RFC2866}}.
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 secret used for handshaking with the RADIUS accounting server
{{bibref|RFC2865}}.
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.
Specifies the default interim accounting interval in {{units}}, which
is used for service accounting when the ''Acct-Interim-Interval''
attribute is not configured. {{bibref|RFC2869|Section 2.1}} 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 {{bibref|RFC2869|Section 5.16}}. A value of 0 means
no interim accounting messages are sent.
This object models an 802.11 connection from the perspective of a
wireless end point. Each {{object}} entry is associated with a
particular {{object|#.SSID}} interface instance via the
{{param|SSIDReference}} parameter, and an associated active
{{object|Profile}} instance via the {{param|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 {{param|SSIDReference}} or {{param|ProfileReference}} is
not a valid reference then the table entry is inoperable and the CPE
MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Note:
The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables this end point.
Indicates the status of this end point. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
{{reference}} This is the currently active profile, which specifies
the SSID and security settings to be used by the end point.
{{reference}} {{param}} is determined based on the
{{param|Profile.{i}.SSID}} within the associated
{{param|ProfileReference}}) endpoint profile. {{param}} MUST be
{{empty}} if {{param|ProfileReference}} is {{empty}} (i.e. only when
an active profile is assigned can the associated SSID interface be
determined).
{{numentries}}
Throughput statistics for this end point.
The data transmit rate in {{units}} that was most recently used for
transmission from the access point to the end point device.
The data transmit rate in {{units}} that was most recently used for
transmission from the end point to the access point device.
An indicator of radio signal strength of the downlink from the access
point to the end point, measured in {{units}}, as an average of the
last 100 packets received from the device.
The number of {{units}} that had to be re-transmitted, from the last
100 packets sent to the access point. Multiple re-transmissions of
the same packet count as one.
This object contains security related parameters that apply to a WiFi
end point {{bibref|802.11-2007}}.
{{list}} Indicates which security modes this {{object|#}} instance is
capable of supporting.
EndPoint Profile table.
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.
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.
{{datatype|expand}}
The profile identifier in use by the connection. The SSID is an
identifier that is attached to packets sent over the wireless LAN
that functions as an ID for joining a particular radio network (BSS).
Location of the profile. This value serves as a reminder from the
user, describing the location of the profile. For example: "Home",
"Office", "Neighbor House", "Airport", etc. An empty string is also
valid.
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.
This object contains security related parameters that apply to a WiFi
End Point profile {{bibref|802.11-2007}}.
Indicates which security mode is enabled.
A WEP key expressed as a hexadecimal string. {{param}} is used only
if {{param|ModeEnabled}} is set to {{enum|WEP-64|ModeEnabled}} or
{{enum|WEP-128|ModeEnabled}}. A 5 byte {{param}} corresponds to
security mode {{enum|WEP-64|ModeEnabled}} and a 13 byte {{param}}
corresponds to security mode {{enum|WEP-128|ModeEnabled}}.
A literal PreSharedKey (PSK) expressed as a hexadecimal string.
{{param}} is only used if {{param|ModeEnabled}} is set to
{{enum|WPA-Personal|ModeEnabled}} or
{{enum|WPA2-Personal|ModeEnabled}} or
{{enum|WPA-WPA2-Personal|ModeEnabled}}. If {{param|KeyPassphrase}} is
written, then {{param}} is immediately generated. The Controller
SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}}
directly (the result of doing this is undefined).
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 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}}.
Management Frame Protection configuration applicable when
{{param|ModeEnabled}} is set to {{enum|WPA2-Personal|ModeEnabled}},
{{enum|WPA2-Enterprise|ModeEnabled}},
{{enum|WPA3-Personal|ModeEnabled}}, or
{{enum|WPA3-Enterprise|ModeEnabled}}. When in WPA3 modes, {{param}}
MUST be set to {{enum|Required}}.
This object contains parameters related to Wi-Fi Protected Setup
{{bibref|WPSv1.0}} for this end point.
Enables or disables WPS functionality for this end point.
WPS configuration methods supported by the device. {{enum}} This
parameter corresponds directly to the "Config Methods" attribute of
{{bibref|WPS 2.0}}. The {{enum|USBFlashDrive}} and {{enum|Ethernet}}
are only applicable in WPS 1.0 and are deprecated in WPS 2.x. The
{{enum|PhysicalPushButton}}, {{enum|VirtualPushButton}},
{{enum|PhysicalDisplay}} and {{enum|VirtualDisplay}} are applicable
to WPS 2.x only.
{{list}} Indicates the WPS configuration methods enabled on the
device.
{{list}} Indicates the current status of WPS in EndPoint.
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.
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}}
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
{{param|AccessCategory}} parameter as follows:
* BE (Best Effort)
* BK (Background)
* VI (Video)
* VO (Voice)
This identifies the access category.
{{datatype|expand}}
Arbitration Inter Frame Spacing (Number). This is the number of time
slots in the arbitration interframe space.
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 {{units}}).
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 {{units}}).
Maximum transmit opportunity, in multiples of {{units}}. A TXOP time
interval of 0 means it is limited to a single MAC protocol data unit
(MPDU).
Ack Policy, where False="Do Not Acknowledge" and True="Acknowledge"
{{list}} Definition of the histogram intervals for counting the
transmit queue length in packets. Each value indicates the maximum
value of the interval. For example, "0,1,4,8," defines the five
intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in
queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No
value after the last comma means no upper bound.) If this parameter
is set to an empty string, no {{param|Stats.OutQLenHistogram}} stats
will be collected.
The time between recording samples of the current transmit queue
{{units}}.
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 {{bibref|TR-181i2|Section 4.2.2}}.
The total number of {{units}} transmitted in this access category,
including framing characters.
The total number of {{units}} received in this access category,
including framing characters.
The total number of {{units}} transmitted in this access category.
The total number of {{units}} received in this access category.
The total number of outbound {{units}} in this access category that
could not be transmitted because of errors. These might be due to the
number of retransmissions exceeding the retry limit, or from other
causes.
The total number of inbound {{units}} in this access category that
contained errors preventing them from being delivered to a
higher-layer protocol.
The total number of outbound {{units}} in this access category which
were chosen to be discarded even though no errors had been detected
to prevent their being transmitted. One possible reason for
discarding such a packet could be to free up buffer space.
The total number of inbound {{units}} in this access category which
were chosen to be discarded even though no errors had been detected
to prevent their being delivered. One possible reason for discarding
such a packet could be to free up buffer space.
The total number of transmitted {{units}} in this access category
which were retransmissions. Two retransmissions of the same packet
results in this counter incrementing by two.
{{list}} Histogram of the total length of the transmit queue of this
access category in packets (1 packet, 2 packets, etc.) according to
the intervals defined by {{param|#.OutQLenHistogramIntervals}}, with
samples taken each {{param|#.OutQLenHistogramSampleInterval}}.
Example: "12,5,1,0,2,0,0,1"
Top level object for ZigBee capabilities based on the
{{bibref|ZigBee2007}} specification.
{{numentries}}
{{numentries}}
ZigBee interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This table models the ZigBee
interface of a ZigBee end device, ZigBee router or ZigBee coordinator.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
The IEEE address assigned to this interface. A value of
"FF:FF:FF:FF:FF:FF:FF:FF" indicates that this address is unknown.
This parameter has the same value as the
{{param|.ZigBee.ZDO.{i}.IEEEAddress}} parameter of the ZDO instance
{{param|ZDOReference}} is pointing to.
The ZigBee network address assigned to this interface. This parameter
has the same value as the {{param|.ZigBee.ZDO.{i}.NetworkAddress}}
parameter of the ZDO instance {{param|ZDOReference}} is pointing to.
The ZigBee Device Object assigned to this interface.
{{numentries}}
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}}.
The total number of {{units}} transmitted out of the interface,
including framing characters.
The total number of {{units}} received on the interface, including
framing characters.
The total number of {{units}} sent transmitted out of the interface.
The total number of {{units}} received by the interface.
The total number of {{units}} discarded by interface due to any
error.
The total number of {{units}} received that contained errors
preventing them from being delivered to a higher-layer protocol.
The total number of {{units}} requested for transmission which were
not addressed to a multicast or broadcast address at this layer,
including those that were discarded or not sent.
The total number of {{units}} received which were not addressed to a
multicast or broadcast address at this layer.
The total number of {{units}} requested for transmission which were
chosen to be discarded even though no errors had been detected to
prevent the {{units}} being transmitted.
The total number of {{units}} received which were chosen to be
discarded even though no errors had been detected to prevent their
being delivered.
The total number of {{units}} requested for transmission which were
addressed to a multicast address at this layer, including those that
were discarded or not sent.
The total number of {{units}} received which were addressed to a
multicast address at this layer and delivered by this layer to a
higher layer.
The total number of {{units}} requested for transmission which were
addressed to a broadcast address at this layer, including those that
were discarded or not sent.
The total number of {{units}} received which were addressed to a
broadcast address at this layer and delivered by this layer to a
higher layer.
The total number of {{units}} received which were discarded because
of an unknown or unsupported protocol.
This table provides information about other ZigBee devices that are
directly accessible via this interface. {{keys}} It is possible that
instances of this object have the same key value when the value of
{{param|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 {{param|NetworkAddress}}. This is because the ZigBee
specification describes only intra-area network topologies
{{bibref|ZigBee2007|Section 1.1.4 Network Topology}}. As such if two or
more {{object}} instances have the same key value the implemenation is
undefined.
The IEEE address assigned to this device. A value of
"FF:FF:FF:FF:FF:FF:FF:FF" indicates that this address is unknown.
The ZigBee network address assigned to this device.
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.
The ZigBee Device Object assigned to this interface.
ZigBee Device Object (ZDO) provides management capabilities of the
ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee
Device as defined in {{bibref|ZigBee2007|section 2.5}}. {{keys}} It is
possible that instances of this object have the same key value when the
value of {{param|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 {{param|NetworkAddress}}. This is because
the ZigBee specification describes only intra-area network topologies
{{bibref|ZigBee2007|Section 1.1.4 Network Topology}}. As such if two or
more {{object}} instances have the same key value the implemenation is
undefined
{{datatype|expand}}
The IEEE address assigned to this device. A value of
"FF:FF:FF:FF:FF:FF:FF:FF" indicates that this address is unknown.
The ZigBee network address assigned to this device.
{{numentries}}
{{numentries}}
{{numentries}}
The {{object}} object describes the node capabilities of the ZigBee
device as defined in {{bibref|ZigBee2007|section 2.3.2.3 Node
Descriptor}}.
The type of ZigBee device that is extracted from the Logical Type
Field as defined in {{bibref|ZigBee2007|Table 2.29}}. {{enum}}
ZigBee Coordinator
ZigBee Router
ZigBee End Device
When {{true}}, specifies that the {{object|#.ComplexDescriptor}}
object is supported for this ZigBee device.
When {{true}}, specifies that the {{object|#.UserDescriptor}} object
is supported for this ZigBee device.
Specifies the frequency bands that are supported by the underlying
IEEE 802.15.4 radio utilized by the ZigBee device. {{list}} {{enum}}
The 868-868.6 MHz Band
The 902-928 MHz Band
The 2400-2483.5 MHz Band
Specifies the IEEE 802.15.4-2003 MAC sub-layer capabilities for this
ZigBee device. {{list}} {{enum}}
Alternate PAN Coordinator
Full Function Device
The current power source is mains power
The receiver is on when idle
Secure communication is enabled
Specifies a manufacturer code that is allocated by the ZigBee
Alliance, relating the manufacturer to the device.
Specifies the maximum buffer size, in {{units}}, of the network
sub-layer data unit (NSDU) for this ZigBee device.
Specifies the maximum size, in {{units}}, of the application
sub-layer data unit (ASDU) that can be transferred to this ZigBee
device in one single message transfer.
Specifies the maximum size, in {{units}}, of the application
sub-layer data unit (ASDU) that can be transferred from this ZigBee
device in one single message transfer.
Specifies the system server capabilities of this ZigBee device.
{{list}} {{enum}}
Specifies the descriptor capabilities of this ZigBee device. {{list}}
{{enum}}
The {{object}} object describes the power capabilities of the ZigBee
device as defined in {{bibref|ZigBee2007|section 2.3.2.4 Node Power
Descriptor}}.
Specifies the current sleep/power-saving mode of the ZigBee device.
{{enum}}
Specifies the power sources available on this ZigBee device. {{list}}
{{enum}}
Constant (mains) power
Rechargable battery
Disposable battery
The current power source field specifies the current power source
being utilized by the node. {{enum}}
Constant (mains) power
Rechargable battery
Disposable battery
Specifies the level of charge of the current power source. {{enum}}
Critical battery state
Battery state is 33 percent
Battery state is 66 percent
Battery state is 100 percent
The {{object}} object is an optional descriptor that describes user
defined capabilities of the ZigBee device as defined in
{{bibref|ZigBee2007|section 2.3.2.7 User Descriptor}}. The {{object}}
object contains information that allows the user to identify the device
using a user-friendly character string, such as "Bedroom TV" or "Stairs
Light".
When {{true}}, the User Descriptor recorded has been received from
the target device.
Specifies the information that allows the user to identify the ZigBee
device using a user-friendly character string, such as "Bedroom TV"
or "Stairs light".
The {{object}} object is an optional descriptor that describes extended
capabilities of the ZigBee device as defined in
{{bibref|ZigBee2007|section 2.3.2.6 Complex Descriptor}}.
When {{true}}, the Complex Descriptor recorded has been received from
the target device.
Specifies the ISO 639-1 language code as defined in
{{bibref|ISO639-1}}.
Specifies the ISO 646 character set as defined in
{{bibref|ISO646-1991}}.
Specifies the name of the manufacturer of the ZigBee device.
Specifies the name of the manufacturer's model of the ZigBee device.
Specifies the manufacturer's serial number of the ZigBee device.
Specifies the {{datatype}} through which more information relating to
the ZigBee device can be obtained.
The icon field contains an octet string which carries the data for an
icon that can represent the ZigBee device. The format of the icon
MUST be a 32-by-32-pixel PNG image.
Specifies the {{datatype}} through which the icon for the ZigBee
device can be obtained.
The {{object}} object provides the configuration capabilities needed to
perform the Security Management functionality defined in
{{bibref|ZigBee2007|section 4 Security Management}}.
Specifies the IEEE address of a special device trusted by devices
within a ZigBee network to distribute keys for the purpose of network
and end-to-end application configuration management.
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}}
The period of time, in {{units}}, that this ZigBee device will wait
for an expected security protocol frame.
The {{object}} object provides the configuration capabilities needed to
by a ZigBee Device to operate within a ZigBee Area Network as defined
in {{bibref|ZigBee2007|section 2.5.2.4 Network Manager}}.
{{numentries}}
The {{object}} object provides the configuration capabilities needed to
by a ZigBee Device to operate within a ZigBee Area Network as defined
in {{bibref|ZigBee2007|section 2.5.2.4 Network Manager}}.
Neighbor of this ZigBee device. The value MUST be the path name of a
row in the ZigBee.ZDO table. If the referenced row is deleted then
this entry MUST be deleted.
The LQI field specified link quality identification (LQI) for
neighbor ZigBee device.
The relationship between the neighbor and this device.{{enum}}
An indication of whether the neighbor device is accepting join
requests.{{enum}}
The tree depth of the neighbor device. A value of 0x00 indicates that
the device is the ZigBee coordinator for the network.
The {{object}} object describes the configuration capabilities related
for remote management of the ZigBee Area Network as defined in
{{bibref|ZigBee2007|section 2.5.2.6 Node Manager}}.
{{numentries}}
The {{object}} object describes the route table as defined in
{{bibref|ZigBee2007|table 3.51 Routing Table Entry}}.
The ZigBee network address of this route.
Specifies the network address of the next hop ZigBee device on the
way to the destination ZigBee device.
The status of the route entry. {{enum}}
A flag indicating whether the device is a memory constrained
concentrator.
A flag indicating that the destination is a concentrator that issued
a many to-one request.
A flag indicating that a route record command frame should be sent to
the destination prior to the next data packet.
The {{object}} object describes the configuration capabilities related
to maintaining a ZigBee Device's Binding Table as defined in
{{bibref|ZigBee2007|section 2.2.8.2 Binding}}.
Enables or disables the use of this binding on the device.
{{datatype|expand}}
Specifies the source endpoint used in this binding entry.
Specifies the source address used in this binding entry.
Specifies the cluster identifier used in this binding entry.
Specifies the type of destination address used for this binding
entry. {{enum}}
Specifies the destination endpoint for the binding entry. The value
of this field is valid when the value of the
{{param|DestinationAddressMode}} is
{{enum|Endpoint|DestinationAddressMode}}.
Specifies the IEEE destination address for this binding entry. The
value of this field is valid when the value of the
{{param|DestinationAddressMode}} is
{{enum|Endpoint|DestinationAddressMode}}.
Specifies the group destination address for this binding entry. The
value of this field is valid when the value of the
{{param|DestinationAddressMode}} is
{{enum|Group|DestinationAddressMode}}.
The {{object}} object describes the configuration capabilities related
to maintaining a ZigBee Device's Group Table as defined in
{{bibref|ZigBee2007|section 2.5.2.7 Group Manager}}.
Enables or disables the use of this group on the device.
{{datatype|expand}}
The Group Identifier for this object as defined in
{{bibref|ZigBee2007|table 2.25 Group Table Entry Format}}.
The list of application endpoints assigned as a member of this
{{object}} object.
The {{object}} object describes the application endpoint as defined in
{{bibref|ZigBee2007|section 2.1.2 Application Framework}}.
Enables or disables the use of this application endpoint on the
device.
{{datatype|expand}}
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 {{object}} object contains the attributes of the Simple Descriptor
of an application endpoint, as defined in {{bibref|ZigBee2007|section
2.3.2.5 Simple Descriptor}}.
Specifies the application profile that is supported on this endpoint.
Application profiles are agreements for messages, message formats,
andprocessing actions that enable developers to create an
interoperable, distributed application employing application entities
that reside on separate ZigBee devices. These application profiles
enable applications to send commands, request data, and process
commands and requests as defined in {{bibref|ZigBee2007|section
2.1.2.1 Application Profiles}}.
Application device identifier, as defined in
{{bibref|ZigBee2007|section 2.3.2.5.3 Application Device Identifier
Field}}.
Application device version, as defined in {{bibref|ZigBee2007|section
2.3.2.5.4 Application Device Version Field}}.
{{list}} Specifies the input cluster identifiers to be matched by the
ZigBee coordinator by remote Zigbee device's output cluster list for
this {{object}} object.
{{list}} Specifies the output cluster identifiers to be matched by
the ZigBee coordinator by remote Zigbee device's input cluster list
for this {{object}} object.
This object is used for managing the discovery of ZigBee devices within
a ZigBee Area Network. ZigBee Devices are discovered via the
{{object|#.ZDO}} instance associated with the ZigBee Coordinator of an
Area Network.
{{numentries}}
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.
Enables or disables discovery of the ZigBee devices in this
{{object}}.
The date and time when this {{object}} or its member devices (i.e.,
the devices with ZDOs listed in {{param|ZDOList}}) were updated due
to a discovery operation.
The status of the current discovery operation. {{enum}}
The discovery operation has not been executed and there are no
valid discovery results available)
{{datatype|expand}}
The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee
Coordinator. The coordinator MAY be located within the CPE. In this
scenario the Controller or CPE MAY use the value of "localhost".
The ZDO object for this device that is used to discover the ZigBee
capabilities of attached devices. {{reference}}
The list of ZDO objects discovered in this Area Network by the ZigBee
Coordinator. {{reference}}
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 {{bibref|802.1D-2004}} and 802.1Q
{{bibref|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 {{bibref|802.1Q-2011}} bridges incorporate
802.1Q {{bibref|802.1Q-2005}} customer and 802.1ad
{{bibref|802.1ad-2005}} provider bridges.
The maximum number of entries available in the
{{object|.Bridging.Bridge}} table.
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.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 {{bibref|802.1Q-2011}} VLANs supported
per {{object|.Bridging.Bridge}} table entry.
The maximum number of entries available in the
{{object|.Bridging.ProviderBridge}} table. A non-zero value for this
parameter implies support for 802.1Q Provider Bridges.
{{numentries}}
The maximum number of entries available in the {{object|Filter}}
table.
{{numentries}}
{{numentries}}
Bridge table.
Enables or disables this {{object}}.
The status of this {{object}}. {{enum}} The {{enum|Error}} value MAY
be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
Selects the standard supported by this Bridge table entry.
{{bibref|802.1D-2004}}
{{bibref|802.1Q-2005}}
The {{object}} provides support for at least one feature
defined in {{bibref|802.1Q-2011}} that was not defined in
{{bibref|802.1Q-2005}}.
{{numentries}}
{{numentries}}
{{numentries}}
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.
Enables or disables the bridge port. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the bridge port (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then this parameter SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
this parameter SHOULD change to {{enum|Up}} if and only if the
interface is able to transmit and receive network traffic; it SHOULD
change to {{enum|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 {{enum|Up}} if
still operable when the expected actions have completed); it SHOULD
change to {{enum|LowerLayerDown}} if and only if the interface is
prevented from entering the {{enum|Up}} state because one or more of
the interfaces beneath it is down; it SHOULD remain in the
{{enum|Error}} state if there is an error or other fault condition
detected on the interface; it SHOULD remain in the
{{enum|NotPresent}} state if the interface has missing (typically
hardware) components; it SHOULD change to {{enum|Unknown}} if the
state of the interface can not be determined for some reason. This
parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the bridge port as assigned by the CPE.
The accumulated time in {{units}} since the bridge port entered its
current operational state.
{{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.
If {{true}} then the entry is a management (upward facing) bridge
port rather than a non-management (downward facing) bridge port. For
a given {{object|##.Bridge}} instance, each management bridge port
appears in the interface stack above all non-management bridge ports.
The concept of Management Port is discussed in
{{bibref|802.1Q-2005|chapter 8}}.
The type of bridge port as defined in 802.1Q
{{bibref|802.1Q-2011|Section 17 IEEE8021BridgePortType}}. Enumeration
of: {{enum}}
Indicates this {{object}} is an S-TAG aware port of a
{{object|##.ProviderBridge}}.
Indicates this {{object}} is an S-TAG aware port of a
{{object|##.ProviderBridge}}.
Indicates this {{object}} is an C-TAG aware port of a
{{object|##.ProviderBridge}}.
Indicates this {{object}} is an C-TAG aware port of a Customer
Bridge.
Indicates this {{object}} is a VLAN unaware member of an
{{enum|802.1D-2004|#.Standard}} bridge.
Bridge Port Default User Priority.
{{list}} List items represent user priority regeneration values for
each ingress user priority on this Bridge Port.
Bridge Port state as defined in 802.1D {{bibref|802.1D-2004}} and
802.1Q {{bibref|802.1Q-2011}}.
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.
The Tag Protocol Identifier (TPID) assigned to this {{object}}. The
TPID is an EtherType value used to identify the frame as a tagged
frame. Standard {{bibref|802.1Q-2011|Table 9.1}} TPID values are:
*S-TAG 0x88A8 = 34984
*C-TAG 0x8100 = 33024 Non-Standard TPID values are:
*S-TAG 0x9100 = 37120
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}}.
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}}.
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}}.
{{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}}.
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
{{param|.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.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
{{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.
This parameter identifies the row in the {{param|PCPEncoding}} and
{{param|PCPDecoding}} parameter lists. The value of 1 points to the
8P0D row in the corresponding parameter lists.
This parameter controls the processing of the drop_eligible field and
is described in {{bibref|802.1Q-2011|section 6.9.3}}.
This parameter controls the processing of the encoding or decoding of
the drop_eligible component in the PCP field and is described in
{{bibref|802.1Q-2011|section 8.6.7}}.
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 {{bibref|802.1Q-2011|section 6.9.3 Priority Code
Point Encoding}} and {{bibref|802.1Q-2011|Table 6-3}}. 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: {{pattern}} The value of this parameter MUST use square
brackets to protect comma separators within nested lists. For
example, this corresponds to Table 6-3 (mentioned above):
:
[7,7,6,6,5,5,4,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,0,1,0]
PCP for each priority and drop_eligible field (7, 7DE, 6, 6DE,
..., 1, 1DE, 0, 0DE)
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 {{bibref|802.1Q-2011|section 6.9.3 Priority Code
Point Encoding}} and {{bibref|802.1Q-2011|Table 6-4}}. 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: {{pattern}} The value of this parameter MUST use square
brackets to protect comma separators within nested lists. For
example, this corresponds to Table 6-4 (mentioned above):
:
[7,0,6,0,5,0,4,0,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,0,0,0,1]
Priority (0-7) and drop_eligible field (0-1) for each PCP value
(7, 6, ..., 1, 0).
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.
Enables or disables this VLAN table entry.
{{datatype|expand}}
Human-readable name for this VLAN table entry.
VLAN ID of the entry.
Bridge VLAN egress port and untagged port membership table. This table
only applies to an 802.1Q {{bibref|802.1Q-2011}} Bridge. 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.
Enables or disables this {{object}} entry.
{{datatype|expand}}
{{reference}} Specifies the VLAN for which port membership is
expressed.
{{reference}} Specifies the bridge port that is member of the VLAN.
Enables or disables untagged port membership to the VLAN and
determines whether egress frames for this VLAN are sent untagged or
tagged.
Filter table containing classification filter entries, each of which
expresses a set of classification criterion to classify ingress frames
as member of a {{object|#.Bridge}} instance or a
{{object|#.Bridge.{i}.VLAN}} instance. Bridge VLAN classification only
applies for 802.1Q {{bibref|802.1Q-2011}} Bridges. For enabled table
entries, if {{param|Bridge}} or {{param|Interface}} is {{empty}} then
the table entry is inoperable and the CPE MUST set {{param|Status}} to
{{enum|Error_Misconfigured|Status}}. 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 {{param|DHCPType}} parameter.
Enables or disables this Filter table entry.
{{datatype|expand}}
The status of this Filter table entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
If the Bridge Port table is supported, but none of its entries
correspond to {{param|Interface}}, or if such an entry exists but is
disabled, {{param}} MUST NOT indicate {{enum|Enabled}}. If the Bridge
VLAN table is supported, but none of its entries correspond to
{{param|VLANIDFilter}}, or if such an entry exists but is disabled,
{{param}} MUST NOT indicate {{enum|Enabled}}.
{{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.
Position of the {{object}} entry in the order of precedence. A value
of ''1'' indicates the first entry considered (highest precedence).
For each ingress frame on the {{param|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 {{param}} value for the
existing entry and all lower {{param}} entries is incremented
(lowered in precedence) to ensure uniqueness of this value. A
deletion causes {{param}} values to be compacted. When a value is
changed, incrementing occurs before compaction. The value of
{{param}} on creation of a {{object}} table entry MUST be one greater
than the largest current value (initially assigned the lowest
precedence).
{{reference}} This MUST relate to the same bridge as does
{{param|Bridge}}. Defines the Bridge Port on which ingress frame
classification will occur.
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.
Classification criterion. The 802.1Q {{bibref|802.1Q-2011}} VLAN ID.
For an 802.1D {{bibref|802.1D-2004}} Bridge, which has no concept of
VLANs, the VLAN ID MUST be ''0''.
Classification criterion. {{list}} Each list item represents an
Ethertype value. Note that neither 802.1D {{bibref|802.1D-2004}} nor
802.1Q {{bibref|802.1Q-2011}} support classification based on
Ethertype.
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 {{param|EthertypeFilterList}} entries (in either the
Ethernet or SNAP Type header). If the {{param|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
{{param|EthertypeFilterList}} entries (in either the Ethernet or SNAP
Type header). If the {{param|EthertypeFilterList}} is empty, packets
are admitted regardless of Ethertype. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2011}} support
classification based on Ethertype.
Classification criterion. {{list|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 {{bibref|802.1D-2004}}
nor 802.1Q {{bibref|802.1Q-2011}} support classification based on
source MAC address.
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 {{param|SourceMACAddressFilterList}} entries. If
the {{param|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
{{param|SourceMACAddressFilterList}} entries. If the
{{param|SourceMACAddressFilterList}} is empty, packets are admitted
regardless of MAC address. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2011}} support
classification based on source MAC address.
Classification criterion. {{list}} 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''
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.
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 {{bibref|RFC2132}}) in the most
recent DHCP lease acquisition or renewal matches the specified value
according to the match criterion in
{{param|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 {{bibref|802.1D-2004}} nor 802.1Q
{{bibref|802.1Q-2011}} support classification based on source MAC
address. Note: This parameter is DHCPv4-specific. It only applies
when {{param|DHCPType}} is {{enum|DHCPv4|DHCPType}}.
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
{{bibref|RFC3315}}) was equal to the specified value. The option
value is binary, so an exact match is REQUIRED. Note that neither
802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2011}}
support classification based on source MAC address. Note: This
parameter is DHCPv6-specific. It only applies when {{param|DHCPType}}
is {{enum|DHCPv6|DHCPType}}.
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
{{param|SourceMACFromVendorClassIDFilter}} (for
{{enum|DHCPv4|DHCPType}}) or
{{param|SourceMACFromVendorClassIDFilterv6}} (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 source MAC Address matches that of a LAN
device previously identified as described in
{{param|SourceMACFromVendorClassIDFilter}} (for
{{enum|DHCPv4|DHCPType}}) or
{{param|SourceMACFromVendorClassIDFilterv6}} (for
{{enum|DHCPv6|DHCPType}}). If this corresponding filter parameter is
{{empty}}, packets are admitted regardless of MAC address. Note that
neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q
{{bibref|802.1Q-2011}} support classification based on source MAC
address
{{param|SourceMACFromVendorClassIDFilter}} pattern match criterion.
{{enum}} For example, if {{param|SourceMACFromVendorClassIDFilter}}
is "Example" then an Option 60 value of "Example device" will match
with this parameter values of {{enum|Prefix}} or {{enum|Substring}},
but not with {{enum|Exact}} or {{enum|Suffix}}. Note that neither
802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2011}}
support classification based on source MAC address.
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 {{bibref|RFC2132}}) in the most
recent DHCP lease acquisition or renewal matches the specified value
according to the match criterion in
{{param|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 {{param|DHCPType}} is {{enum|DHCPv4|DHCPType}}.
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
{{bibref|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 {{param|DHCPType}} is
{{enum|DHCPv6|DHCPType}}.
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.
{{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}}.
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 {{bibref|RFC2132}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 1 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. The option value is
binary, so an exact match is REQUIRED. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|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 {{param|DHCPType}}. Note: DHCPv6 Option 1 (Client
Identifier) is sometimes referred to as ''DUID''.
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
{{param|SourceMACFromClientIDFilter}}. If
{{param|SourceMACFromClientIDFilter}} 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 that of a LAN device previously identified
as described in {{param|SourceMACFromClientIDFilter}}. If the
{{param|SourceMACFromClientIDFilter}} is {{empty}}, packets are
admitted regardless of MAC address. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2011}} support
classification based on source MAC address.
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 {{bibref|RFC2132}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 1 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. 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 {{param|DHCPType}}. Note: DHCPv6 Option 1 (Client
Identifier) is sometimes referred to as ''DUID''.
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.
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 {{bibref|RFC3004}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 15 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. The option value is
binary, so an exact match is REQUIRED. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|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 {{param|DHCPType}}.
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
{{param|SourceMACFromUserClassIDFilter}}. If
{{param|SourceMACFromUserClassIDFilter}} 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 that of a LAN device previously identified
as described in {{param|SourceMACFromUserClassIDFilter}}. If the
{{param|SourceMACFromUserClassIDFilter}} is {{empty}}, packets are
admitted regardless of MAC address. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2011}} support
classification based on source MAC address.
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 {{bibref|RFC3004}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 15 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. 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 {{param|DHCPType}}.
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.
Classification criterion. Destination IP address. {{empty}} indicates
this criterion is not used for classification.
Destination IP address mask, represented as an IP routing prefix
using CIDR notation [RFC4632]. The IP address part MUST be {{empty}}
(and, if specified, MUST be ignored).
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.
Classification criterion. Source IP address. {{empty}} indicates this
criterion is not used for classification.
Source IP address mask, represented as an IP routing prefix using
CIDR notation [RFC4632]. The IP address part MUST be an empty string
(and, if specified, MUST be ignored).
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.
Classification criterion. Protocol number. A value of -1 indicates
this criterion is not used for classification.
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.
Classification criterion. Destination port number. A value of -1
indicates this criterion is not used for classification.
Classification criterion. If specified, indicates the classification
criterion is to include the port range from {{param|DestPort}}
through {{param}} (inclusive). If specified, {{param}} MUST be
greater than or equal to {{param|DestPort}}. A value of -1 indicates
that no port range is specified.
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.
Classification criterion. Source port number. A value of -1 indicates
this criterion is not used for classification.
Classification criterion. If specified, indicates the classification
criterion is to include the port range from {{param|SourcePort}}
through {{param}} (inclusive). If specified, {{param}} MUST be
greater than or equal to SourcePort. A value of -1 indicates that no
port range is specified.
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.
Provider Bridge table. A Provider Bridge is described in
{{bibref|802.1Q-2011|section 5.10 Provider Bridge conformance}} 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 {{object|#.Bridge}} objects. When {{param|Type}} is
configured with value of {{enum|PE|Type}} 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 {{param|Type}}
is configured with value of {{enum|S-VLAN|Type}} only VLAN tags from
the S-VLAN component are utilized.
Enables or disables this {{object}}.
The status of this {{object}}. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. For example when the
{{param|Type}} is configured with value of {{enum|PE|Type}} but
{{param|CVLANcomponents}} is {{empty}}. The {{enum|Error}} value MAY
be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
Selects the standard supported by this {{object}} table entry.
Provider Bridge conforming to {{bibref|802.1Q-2011|5.10.1
S-VLAN Bridge conformance}}
Provider Bridge conforming to {{bibref|802.1Q-2011|5.10.2
Provider Edge Bridge conformance}}
{{reference|a {{object|#.Bridge}} instance that specifies the S-VLAN
component for the {{object}}}}
{{list}} {{reference|a {{object|#.Bridge}} instance that specifies a
C-VLAN component for the {{object}}}}
Point-to-Point Protocol {{bibref|RFC1661}}. This object contains the
{{object|Interface}} table.
{{numentries}}
The Network Control Protocols (NCPs) that are supported by the
device. {{enum}} Note that {{enum|IPv6CP}} is an IPv6 capability.
AppleTalk Control Protocol {{bibref|RFC1378}}
{{bibref|RFC1332}}
{{bibref|RFC1552}}
{{bibref|RFC2097}}
{{bibref|RFC5072}}
PPP interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}).
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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).
Current status of the connection.
The cause of failure for the last connection setup attempt.
The time in {{units}} since the establishment of the connection after
which connection termination is automatically initiated by the CPE.
This occurs irrespective of whether the connection is being used or
not. A value of 0 (zero) indicates that the connection is not to be
shut down automatically.
The time in {{units}} that if the connection remains idle, the CPE
automatically terminates the connection. A value of 0 (zero)
indicates that the connection is not to be shut down automatically.
Time in {{units}} the {{param|ConnectionStatus}} remains in the
{{enum|PendingDisconnect|ConnectionStatus}} state before
transitioning to disconnecting state to drop the connection.
Username to be used for authentication.
Password to be used for authentication.
Describes the PPP encryption protocol.
Describes the PPP compression protocol.
{{bibref|RFC1332}}
{{bibref|RFC1974}}
Describes the PPP authentication protocol.
The maximum allowed size of frames sent from the remote peer.
The current MRU in use over this connection.
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.
If this PPP connection is disconnected for any reason, it is to
remain disconnected until the CPE has one or more packets to
communicate over this connection, at which time the CPE
automatically attempts to reestablish the connection.
If this PPP connection is disconnected for any reason, the CPE
automatically attempts to reestablish the connection (and
continues to attempt to reestablish the connection as long it
remains disconnected).
If this PPP connection is disconnected for any reason, it is to
remain disconnected until the user of the CPE explicitly
instructs the CPE to reestablish the connection.
PPP LCP Echo period in {{units}}.
Number of PPP LCP Echo retries within an echo period.
Enables or disables IPCP ({{bibref|RFC1332}}) on this interface. If
this parameter is present, {{enum|IPCP|#.SupportedNCPs}} MUST be
included in {{param|#.SupportedNCPs}}.
Enables or disables IPv6CP ({{bibref|RFC5072}}) on this interface. If
this parameter is present, {{enum|IPv6CP|#.SupportedNCPs}} MUST be
included in {{param|#.SupportedNCPs}}.
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.
Represents the PPPoE Session ID.
PPPoE Access Concentrator.
PPPoE Service Name.
IP Control Protocol (IPCP) client object for this PPP interface
{{bibref|RFC1332}}. {{object}} only applies to IPv4.
The local IPv4 address for this connection received via IPCP.
The remote IPv4 address for this connection received via IPCP.
{{list}} Items represent DNS Server IPv4 address(es) received via
IPCP {{bibref|RFC1877}}.
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'').
{{reference}}When {{param}} is set to {{empty}},
{{param|PassthroughEnable}} MUST be set to {{false}} (i.e.
passthrough can not be enabled without a pool reference specified).
IPv6 Control Protocol (IPv6CP) client object for this PPP interface
{{bibref|RFC5072}}. {{object}} only applies to IPv6.
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 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).
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
PPPoA object that functionally groups PPPoA related parameters. This
object is OBSOLETED because it contains no standard parameters and its
existence causes confusion.
IP object that contains the {{object|Interface}},
{{object|ActivePort}}, and {{object|Diagnostics}} objects.
Indicates whether the device is IPv4 capable.
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).
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 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.
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).
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.
The ULA /48 prefix {{bibref|RFC4193|Section 3}}.
{{numentries}}
{{numentries}}
IP interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). 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
{{object|IPv4Address}}, {{object|IPv6Address}} and
{{object|IPv6Prefix}} tables. Note that support for manipulating
{{param|Loopback}} interfaces is OPTIONAL, so the implementation MAY
choose not to create (or allow the Controller to create) {{object}}
instances of type {{enum|Loopback|Type}}. When the Controller
administratively disables the interface, i.e. sets {{param|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 {{param|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 {{enum|Tunneled|Type}} 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. {{param|Status}}, MUST return the same information as
for the corresponding {{enum|Tunnel|Type}} interface. The reason for
these rules is that {{enum|Tunneled|Type}} 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
{{enum|Tunnel|Type}} IP interfaces. Note that {{enum|Tunnel|Type}} and
{{enum|Tunneled|Type}} IP interfaces are part of a legacy mechanism
that is only used for {{object|##.IPv6rd}}, {{object|##.DSLite}} and
{{object|##.IPsec}} tunnels and MUST NOT be used in any other context.
For all other tunneling mechanisms {{enum|Normal|Type}} IP interfaces
are stacked above technology-specific Tunnel Interfaces, e.g. above
{{object|##.GRE.Tunnel.{i}.Interface}} or
{{object|##.MAP.Domain.{i}.Interface}} objects.
Enables or disables the interface (regardless of {{param|IPv4Enable}}
and {{param|IPv6Enable}}). This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
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 {{param}} is not present this interface SHOULD be permanently
attached to the IPv4 stack. Note that {{param}} is independent of
{{param|Enable}}, and that to administratively enable an interface
for IPv4 it is necessary for both {{param|Enable}} and {{param}} to
be {{true}}.
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 {{param}} is not present this interface SHOULD be permanently
attached to the IPv6 stack. Note that {{param}} is independent of
{{param|Enable}}, and that to administratively enable an interface
for IPv6 it is necessary for both {{param|Enable}} and {{param}} to
be {{true}}.
Controls whether or not ULAs {{bibref|RFC4193}} are generated and
used on this interface.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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}}.
{{reference}} The ''Router'' instance that is associated with this IP
Interface entry.
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).
The maximum transmission unit (MTU); the largest allowed size of an
IP packet (including IP headers, but excluding lower layer headers
such as Ethernet, PPP, or PPPoE headers) that is allowed to be
transmitted by or through this device.
IP interface type. {{enum}} For {{enum|Loopback}}, {{enum|Tunnel}},
and {{enum|Tunneled}} IP interface objects, the {{param|LowerLayers}}
parameter MUST be {{empty}}.
Only used with legacy ({{enum|Tunnel}},{{enum|Tunneled}}) IP
interface pairs
Only used with legacy ({{enum|Tunnel}},{{enum|Tunneled}}) IP
interface pairs
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.
{{numentries}}
{{numentries}}
{{numentries}}
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.
{{numentries}}
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.
Enables or disables this IPv4 address.
The status of this {{object}} table entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}} This parameter can only be modified if
{{param|AddressingType}} is {{enum|Static|AddressingType}}.
IPv4 address. This parameter can only be modified if the
{{param|AddressingType}} is {{enum|Static|AddressingType}}.
Subnet mask. This parameter can only be modified if the
{{param|AddressingType}} is {{enum|Static|AddressingType}}.
Addressing method used to assign the IP address. {{enum}}
Assigned by IKEv2 {{bibref|RFC5996}}.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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 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 packets received via the interface which were
discarded because of an unknown or unsupported protocol.
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 {{bibref|TR-390}}.
Enables or disables the TWAMP reflector.
The current operational state of the TWAMP reflector.
{{datatype|expand}}
The port used to listen for the TWAMP test packets.
The maximum TTL of a received packet that this TWAMP reflector will
reflect to the TWAMP controller.
{{list}} List items represent source IP addresses and subnets from
which test packets MUST always be received. {{empty}} 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
{{bibref|RFC4632}}. An IP prefix is specified as an IP address
followed (with no intervening white space) by "/n", where ''n'' (the
prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for
IPv6) that indicates the number of (leftmost) '1' bits of the prefix.
IPv4 example:
* 1.2.3.4 specifies a single IPv4 address, and 1.2.3.4/24 specifies a
class C subnet with subnet mask 255.255.255.0.
* 1.2.0.0/22 represents the 1024 IPv4 addresses from 1.2.0.0 to
1.2.3.255. IPv6 example:
* fec0::220:edff:fe6a:f76 specifies a single IPv6 address.
* 2001:edff:fe6a:f76::/64 represents the IPv6 addresses from
2001:edff:fe6a:f76:0:0:0:0 to
2001:edff:fe6a:f76:ffff:ffff:ffff:ffff.
{{list}} List items represent source port ranges from which test
packets MUST always be received. {{empty}} 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.
This table contains the IP interface's IPv6 unicast addresses. There
MUST be an entry for each such address, including anycast addresses.
There are several ways in which entries can be added to and deleted
from this table, including:
* Automatically via SLAAC {{bibref|RFC4862}}, which covers generation
of link-local addresses (for all types of device) and global
addresses (for non-router devices).
* Automatically via DHCPv6 {{bibref|RFC3315}}, which covers generation
of any type of address (subject to the configured DHCP server
policy).
* Manually via a GUI or some other local management interface.
* Manually via factory default configuration.
* By the Controller. This table MUST NOT include entries for the
Subnet-Router anycast address {{bibref|RFC4291|Section 2.6.1}}. Such
entries would be identical to others but with a zero interface
identifier, and would add no value. A loopback interface will always
have address ''::1'' {{bibref|RFC4291|Section 2.5.3}} and MAY also
have link-local address ''fe80::1''. This object is based on
''ipAddressTable'' from {{bibref|RFC4293}}.
Enables or disables this {{object}} entry.
The status of this {{object}} table entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
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}}.
Valid address that can appear as the destination or source
address of a packet.
Valid but deprecated address that is not intended to be used as
a source address.
Invalid address that is not intended to appear as the
destination or source address of a packet.
Valid address that is not accessible because the interface to
which it is assigned is not operational.
Address status cannot be determined for some reason.
The uniqueness of the address on the link is being verified.
Invalid address that has been determined to be non-unique on
the link.
Valid address that is available for use, subject to
restrictions, while its uniqueness on a link is being verified.
{{datatype|expand}} This parameter can only be modified if
{{param|Origin}} is {{enum|Static|Origin}}.
IPv6 address. This parameter can only be modified if the
{{param|Origin}} is {{enum|Static|Origin}}. This parameter is based
on ''ipAddressAddr'' from {{bibref|RFC4293}}.
Mechanism via which the IP address was assigned. {{enum}} This
parameter is based on ''ipOrigin'' from {{bibref|RFC4293}}.
Automatically generated. For example, a link-local address as
specified by SLAAC {{bibref|RFC4862|Section 5.3}}, a global
address as specified by SLAAC {{bibref|RFC4862|Section 5.5}},
or generated via CPE logic (e.g. from delegated prefix as
specified by {{bibref|RFC3633}}), or from ULA /48 prefix as
specified by {{bibref|RFC4193}}.
Assigned by DHCPv6 {{bibref|RFC3315}}.
Assigned by IKEv2 {{bibref|RFC5996}}.
Assigned by MAP {{bibref|RFC7597}}, i.e. is this interface's
''MAP IPv6 address''
Specified by a standards organization, e.g. the ''::1''
loopback address, which is defined in {{bibref|RFC4291}}.
For example, present in the factory default configuration (but
not {{enum|WellKnown}}), created by the Controller, or created
by some other management entity (e.g. via a GUI).
IPv6 address prefix. Some addresses, e.g. addresses assigned via the
DHCPv6 IA_NA option, are not associated with a prefix, and some
{{enum|WellKnown|#.IPv6Prefix.{i}.Origin}} prefixes might not be
modeled. In both of these cases {{param}} will be {{null}}. This
parameter can only be modified if the {{param|Origin}} is
{{enum|Static|Origin}}. This parameter is based on
''ipAddressPrefix'' from {{bibref|RFC4293}}.
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}}.
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}}.
Indicates whether this is an anycast address {{bibref|RFC4291|Section
2.6}}. Anycast addresses are syntactically identical to unicast
addresses and so need to be configured explicitly. This parameter can
only be modified if the {{param|Origin}} is {{enum|Static|Origin}}.
This parameter is based on ''ipAddressType'' from {{bibref|RFC4293}}.
This table contains the interface's IPv6 prefixes. There MUST be an
entry for each such prefix, not only for prefixes learned from router
advertisements. There are several ways in which entries can be added to
and deleted from this table, including:
* Automatically via {{bibref|RFC4861}} Router Advertisements. See also
{{object|.RouterAdvertisement}}.
* Automatically via DHCPv6 {{bibref|RFC3315}} prefix delegation
{{bibref|RFC3633}}. See also {{object|.DHCPv6.Client}}.
* Automatically via internal CPE logic, e.g. creation of child prefixes
derived from a parent prefix.
* Manually via a GUI or some other local management interface.
* Manually via factory default configuration.
* By the Controller. The CPE MAY choose not to create {{object}}
entries for {{enum|WellKnown|Origin}} prefixes or for the ULA /48
prefix {{bibref|RFC4193}}. If an {{object}} entry exists for the ULA
/48 prefix, it MUST be on a downstream interface (i.e. an interface
for which the physical layer interface object has ''Upstream'' =
{{false}}). This object is based on ''ipAddressPrefixTable'' from
{{bibref|RFC4293}}.
Enables or disables this {{object}} entry.
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 {{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}}.
Valid prefix.
Valid but deprecated prefix.
Invalid prefix.
Valid prefix that is not accessible because the interface to
which it is assigned is not operational.
Prefix status cannot be determined for some reason.
{{datatype|expand}} This parameter can only be modified if
{{param|Origin}} is {{enum|Static|Origin}}.
IPv6 address prefix. This parameter can only be modified if the
{{param|Origin}} is {{enum|Static|Origin}}. This parameter is based
on ''ipAddressPrefixPrefix'' from {{bibref|RFC4293}}.
Mechanism via which the prefix was assigned or most recently updated.
{{enum}} Note that:
* {{enum|PrefixDelegation}} and {{enum|RouterAdvertisement}} prefixes
can exist only on upstream interfaces (i.e. interfaces for which
the physical layer interface object has ''Upstream'' = {{true}}),
* {{enum|AutoConfigured}} and {{enum|WellKnown}} prefixes can exist
on any interface, and
* {{enum|Static}} and {{enum|Child}} prefixes can exist only on
downstream interfaces (i.e. interfaces for which the physical layer
interface object has ''Upstream'' = {{false}}). Also note that a
{{enum|Child}} prefix's {{param|ParentPrefix}} will always be an
{{enum|AutoConfigured}}, {{enum|PrefixDelegation}}, or
{{enum|RouterAdvertisement}} prefix. This parameter is based on
''ipAddressOrigin'' from {{bibref|RFC4293}}.
Generated via internal CPE logic (e.g. the ULA /48 prefix) or
derived from an internal prefix that is not modeled in any
{{object}} table.
Delegated via DHCPv6 {{bibref|RFC3633}} or some other protocol,
e.g. IPv6rd {{bibref|RFC5969}}. Also see {{param|StaticType}}.
Discovered via router advertisement {{bibref|RFC4861}} Prefix
Information Option.
Specified by a standards organization, e.g. ''fe80::/10'' for
link-local addresses, or ''::1/128'' for the loopback address,
both of which are defined in {{bibref|RFC4291}}.
Created by the Controller, by some other management entity
(e.g. via a GUI), or present in the factory default
configuration (but not {{enum|WellKnown}}). Unrelated to any
shorter length prefix that might exist on the CPE. Also see
{{param|StaticType}}. Can be used for RA (Prefix Information),
DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation
(IA_PD).
Derived from an associated {{enum|AutoConfigured}} or
{{enum|PrefixDelegation}} parent prefix. Also see
{{param|StaticType}}, {{param|ParentPrefix}} and
{{param|ChildPrefixBits}}. Can be used for RA (Prefix
Information), DHCPv6 address assignment (IA_NA) or DHCPv6
prefix delegation (IA_PD).
Static prefix sub-type. For a {{enum|Static|Origin}} prefix, this can
be set to {{enum|PrefixDelegation}} or {{enum|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. {{enum}} This mechanism works as follows:
* When this parameter is set to {{enum|PrefixDelegation}} or
{{enum|Child}}, the instance becomes a "prefix slot" of the
specified type.
* Such an instance can be administratively enabled ({{param|Enable}}
= {{true}}) but will remain operationally disabled
({{param|Status}} = {{enum|Disabled|Status}}) until it has been
populated.
* When a new prefix of of type T is needed, the CPE will look for a
matching unpopulated instance, i.e. an instance with
({{param|Origin}},{{param}},{{param|Prefix}}) =
({{enum|Static|Origin}},T,""). If the CPE finds at least one such
instance it will choose one and populate it. If already
administratively enabled it will immediately become operationally
enabled. If the CPE finds no such instances, it will create and
populate a new instance with ({{param|Origin}},{{param}}) = (T,T).
If the CPE finds more than one such instance, the algorithm via
which it chooses which instance to populate is
implementation-specific.
* When a prefix that was populated via this mechanism becomes
invalid, the CPE will reset {{param|Prefix}} to {{empty}}. This
does not affect the value of the {{param|Enable}} parameter. The
prefix {{param}} can only be modified if {{param|Origin}} is
{{enum|Static|Origin}}.
Prefix is a "normal" {{enum|Static|Origin}} prefix.
Prefix is not {{enum|Static|Origin}}, so this parameter does
not apply.
Prefix will be populated when a
{{enum|PrefixDelegation|Origin}} prefix needs to be created.
Prefix will be populated when a {{enum|Child|Origin}} prefix
needs to be created. In this case, the Controller needs also to
set {{param|ParentPrefix}} and might want to set
{{param|ChildPrefixBits}} (if parent prefix is not set, or goes
away, then the child prefix will become operationally
disabled).
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}}).
A prefix that specifies the length of {{enum|Static|Origin}}
{{enum|Child|StaticType}} prefixes and how they are derived from
their {{param|ParentPrefix}}. It will be used if and only if it is
not {{empty}} 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
{{param|Origin}} is {{enum|Static|Origin}}.
On-link flag {{bibref|RFC4861|Section 4.6.2}} 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
{{param|Origin}} is {{enum|Static|Origin}}. This parameter is based
on ''ipAddressPrefixOnLinkFlag'' from {{bibref|RFC4293}}.
Autonomous address configuration flag {{bibref|RFC4861|Section
4.6.2}} as received (in the RA) for RouterAdvertisement. Indicates
whether this prefix can be used for generating global addresses as
specified by SLAAC {{bibref|RFC4862}}. This parameter can only be
modified if {{param|Origin}} is {{enum|Static|Origin}}. This
parameter is based on ''ipAddressPrefixAutonomousFlag'' from
{{bibref|RFC4293}}.
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 ''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 table lists the ports on which TCP connections are listening or
established.
Connection local IP address.
Connection local port.
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 port of the source of inbound packets. This will be
{{null}} for listening connections (only connections in
{{enum|ESTABLISHED|Status}} state have remote addresses).
Current operational status of the connection. {{enum}}
The IP Diagnostics object.
Indicates that Ping over IPv4 is supported.
Indicates that Ping over IPv6 is supported.
Indicates that TraceRoute over IPv4 is supported.
Indicates that TraceRoute over IPv6 is supported.
Indicates that Download Diagnostics over IPv4 is supported.
Indicates that Download Diagnostics over IPv6 is supported.
Indicates that Upload Diagnostics over IPv4 is supported.
Indicates that Upload Diagnostics over IPv6 is supported.
Indicates that UDPEcho Diagnostics over IPv4 is supported.
Indicates that UDPEcho Diagnostics over IPv6 is supported.
Indicates that IP Layer Capacity measurement is supported.
Indicates that ServerSelection Diagnostics over IPv4 is supported.
Indicates that ServerSelection Diagnostics over IPv6 is supported.
This command provides access to an IP-layer ping test.
{{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.
Indicates the IP protocol to be used.
Use either IPv4 or IPv6 depending on the system preference
Use IPv4 for the Ping requests
Use IPv6 for the Ping requests
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.
Number of repetitions of the ping test to perform before
reporting the results.
Timeout in {{units}} for the ping test.
Size of the data block in bytes to be sent for each ping.
DiffServ codepoint to be used for the test packets. By default
the CPE SHOULD set this value to zero.
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.
The CPE can not reach the requested Ping host address
Indicates which IP address was used to send the Ping request.
Result parameter indicating the number of successful pings (those
in which a successful response was received prior to the timeout)
in the most recent ping test.
Result parameter indicating the number of failed pings in the
most recent ping test.
Result parameter indicating the average response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the minimum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the maximum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the average response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the minimum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
Result parameter indicating the maximum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test. If there were no successful responses,
this value MUST be zero.
This command defines access to an IP-layer trace-route test for the
specified IP interface.
{{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.
Indicates the IP protocol to be used.
Use either IPv4 or IPv6 depending on the system preference
Use IPv4 for the TraceRoute
Use IPv6 for the TraceRoute
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.
Number of tries per hop. Set prior to running Diagnostic. By
default, the CPE SHOULD set this value to 3.
Timeout in {{units}} for each hop of the trace route test. By
default the CPE SHOULD set this value to 5000.
Size of the data block in bytes to be sent for each trace route.
By default, the CPE SHOULD set this value to 38.
DiffServ codepoint to be used for the test packets. By default
the CPE SHOULD set this value to 0.
The maximum number of hop used in outgoing probe packets (max
TTL). By default the CPE SHOULD set this value to 30.
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.
The CPE can not reach the requested TraceRoute host address
Indicates which IP address was used for TraceRoute.
Result parameter indicating the response time in {{units}} the
most recent trace route test. If a route could not be determined,
this value MUST be zero.
Contains the array of hop results returned. If a route could not
be determined, this array will be empty
Result parameter indicating the Host Name if DNS is able to
resolve or IP Address of a hop along the discovered route.
If this parameter is not {{empty}} it will contain the last IP
address of the host returned for this hop and the
{{param|Host}} will contain the Host Name returned from the
reverse DNS query.
Contains the error code returned for this hop. This code is
directly from the ICMP CODE field.
{{list}} Each list item contains one or more round trip times
in {{units}} (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 {{units}} MUST be
rounded up to 1. The number of list entries is determined by
the value of {{param|#.NumberOfTries}}.
Supported ''DownloadDiagnostics'' transport protocols for a CPE
device.
Indicates the maximum number of connections that are supported by
Download Diagnostics.
The maximum number of rows in
{{object|DownloadDiagnostics().IncrementalResult}} that the CPE will
store.
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.
{{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 {{datatype}} for the CPE to perform the download on. This
parameter MUST be in the form of a valid HTTP {{bibref|RFC2616}}
or FTP {{bibref|RFC959}} URL.
* When using FTP transport, FTP binary transfer MUST be used.
* When using HTTP transport, persistent connections MUST be used
and pipelining MUST NOT be used.
* When using HTTP transport the HTTP Authentication MUST NOT be
used. Note: For time based tests
({{param|TimeBasedTestDuration}} > 0) the Controller MAY add
a hint to duration of the test to the URL. See
{{bibref|TR-143|Section 4.3}} for more details.
The DiffServ code point for marking packets transmitted in the
test. The default value SHOULD be zero.
Ethernet priority code for marking packets transmitted in the
test (if applicable). The default value SHOULD be zero.
Controls time based testing {{bibref|TR-143|Section 4.3}}. When
{{param}} > 0, {{param}} is the duration in {{units}} of a
time based test. If {{param}} is 0, the test is not based on
time, but on the size of the file to be downloaded. The default
value SHOULD be 0.
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.
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.
Indicates the IP protocol version to be used. The default value
SHOULD be {{enum|Any}}.
Use either IPv4 or IPv6 depending on the system preference.
Use IPv4 for the requests
Use IPv6 for the requests.
The number of connections to be used in the test. The default
value SHOULD be 1. {{param}} MUST NOT be set to a value greater
than {{param|#.DownloadDiagnosticMaxConnections}}.
The results must be returned in the
{{object|PerConnectionResult}} table for every connection when
set to {{true}}. The default value SHOULD be {{false}}.
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 which IP address was used to send the request.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the client sends the GET
command.
* For FTP this is the time at which the client sends the RTRV
command. If multiple connections are used, then {{param}} is
set to the earliest {{param}} across all connections.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the first data packet is
received.
* For FTP this is the time at which the client receives the first
data packet on the data connection. If multiple connections are
used, then {{param}} is set to the earliest {{param}} across
all connections.
End of transmission in UTC, which MUST be specified to
microsecond precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the last data packet is
received.
* For FTP this is the time at which the client receives the last
packet on the data connection. If multiple connections are
used, then {{param}} is set to the latest {{param}} across all
connections.
The number of {{units}} received during the FTP/HTTP transaction
including FTP/HTTP headers, between {{param|BOMTime}} and
{{param|EOMTime}} across all connections.
The total number of {{units}} (at the IP layer) received on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesReceived on the
{{param|Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesSent on the
{{param|Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
The number of {{units}} of the test file received between the
latest {{param|PerConnectionResult.{i}.BOMTime}} and the earliest
{{param|PerConnectionResult.{i}.EOMTime}} across all connections.
The total number of {{units}} (at the IP layer) received in
between the latest {{param|PerConnectionResult.{i}.BOMTime}} and
the earliest {{param|PerConnectionResult.{i}.EOMTime}}. This MAY
be calculated by sampling Stats.bytesReceived on the
{{param|Interface}} object at the latest
{{param|PerConnectionResult.{i}.BOMTime}} and at the earliest
{{param|PerConnectionResult.{i}.EOMTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent between the
latest {{param|PerConnectionResult.{i}.BOMTime}} and the earliest
{{param|PerConnectionResult.{i}.EOMTime}}. This MAY be calculated
by sampling Stats.bytesSent on the {{param|Interface}} object at
the latest {{param|PerConnectionResult.{i}.BOMTime}} and at the
earliest {{param|PerConnectionResult.{i}.EOMTime}} and
subtracting.
The period of time in {{units}} between the latest
{{param|PerConnectionResult.{i}.BOMTime}} and the earliest
{{param|PerConnectionResult.{i}.EOMTime}} of the test.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP socket open (SYN)
was sent for the HTTP connection.
* For FTP this is the time at which the TCP socket open (SYN) was
sent for the data connection. Note: Interval of 1 microsecond
SHOULD be supported. If multiple connections are used, then
{{param}} is set to the latest {{param}} across all
connections.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP ACK to the socket
opening the HTTP connection was received.
* For FTP this is the time at which the TCP ACK to the socket
opening the data connection was received. Note: Interval of 1
microsecond SHOULD be supported. If multiple connections are
used, then {{param}} is set to the latest {{param}} across all
connections.
Results for individual connections. This table is only populated
when {{param|#.EnablePerConnectionResults}} is {{true}}. A new
object is created for each connection specified in
{{param|#.NumberOfConnections}}. Instance numbers MUST start at 1
and sequentially increment as new instances are created.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the client sends the GET
command.
* For FTP this is the time at which the client sends the RTRV
command.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the first data packet is
received.
* For FTP this is the time at which the client receives the
first data packet on the data connection.
End of transmission in UTC, which MUST be specified to
microsecond precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the last data packet is
received.
* For FTP this is the time at which the client receives the
last packet on the data connection.
The number of {{units}} of the test file received during the
FTP/HTTP transaction including FTP/HTTP headers, between
{{param|BOMTime}} and {{param|EOMTime}}.
The total number of {{units}} (at the IP layer) received on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesReceived on the
{{param|#.Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesSent on the
{{param|#.Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP socket open (SYN)
was sent for the HTTP connection.
* For FTP this is the time at which the TCP socket open (SYN)
was sent for the data connection.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP ACK to the socket
opening the HTTP connection was received.
* For FTP this is the time at which the TCP ACK to the socket
opening the data connection was received.
Results for time segmented tests (tests where
{{param|#.TimeBasedTestDuration}} > 0 and
{{param|#.TimeBasedTestMeasurementInterval}} > 0). This data
is totaled across all connections in the test. A new object is
created every {{param|#.TimeBasedTestMeasurementInterval}} after
that interval has completed. Instance numbers MUST start at 1 and
sequentially increment as new instances are created.
Change in the value of
{{param|#.TestBytesReceivedUnderFullLoading}} between
{{param|StartTime}} and {{param|EndTime}}.
The total number of {{units}} (at the IP layer) received on the
Interface between {{param|StartTime}} and {{param|EndTime}}.
This MAY be calculated by sampling Stats.bytesReceived on the
{{param|#.Interface}} object at {{param|StartTime}} and at
{{param|EndTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent on the
Interface between {{param|StartTime}} and {{param|EndTime}}.
This MAY be calculated by sampling Stats.bytesSent on the
{{param|#.Interface}} object at {{param|StartTime}} and at
{{param|EndTime}} and subtracting.
The start 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
Supported ''UploadDiagnostics'' transport protocols for a CPE device.
Indicates the maximum number of connections that are supported by
Upload Diagnostics.
The maximum number of rows in
{{object|UploadDiagnostics().IncrementalResult}} that the CPE will
store.
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.
{{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 {{datatype}} for the CPE to Upload to. This parameter MUST be
in the form of a valid HTTP {{bibref|RFC2616}} or FTP
{{bibref|RFC959}} URL.
* When using FTP transport, FTP binary transfer MUST be used.
* When using HTTP transport, persistent connections MUST be used
and pipelining MUST NOT be used.
* When using HTTP transport the HTTP Authentication MUST NOT be
used.
DiffServ code point for marking packets transmitted in the test.
The default value SHOULD be zero.
Ethernet priority code for marking packets transmitted in the
test (if applicable). The default value SHOULD be zero.
The size of the file (in bytes) to be uploaded to the server. The
CPE MUST insure the appropriate number of bytes are sent.
Controls time based testing {{bibref|TR-143|Section 4.3}}. When
{{param}} > 0, {{param}} is the duration in {{units}} of a
time based test. If {{param}} is 0, the test is not based on
time, but on the size of the file to be uploaded. The default
value SHOULD be 0.
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.
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.
Indicates the IP protocol version to be used. The default value
SHOULD be {{enum|Any}}.
Use either IPv4 or IPv6 depending on the system preference.
Use IPv4 for the requests
Use IPv6 for the requests.
The number of connections to be used in the test. The default
value SHOULD be 1. {{param}} MUST NOT be set to a value greater
than {{param|#.UploadDiagnosticsMaxConnections}}.
The results must be returned in the
{{object|PerConnectionResult}} table for every connection when
set to {{true}}. The default value SHOULD be {{false}}.
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 which IP address was used to send the request.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the client sends the GET
command.
* For FTP this is the time at which the client sends the RTRV
command. If multiple connections are used, then {{param}} is
set to the earliest {{param}} across all connections.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the first data packet is
received.
* For FTP this is the time at which the client receives the first
data packet on the data connection. If multiple connections are
used, then {{param}} is set to the earliest {{param}} across
all connections.
End of transmission in UTC, which MUST be specified to
microsecond precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the last data packet is
received.
* For FTP this is the time at which the client receives the last
packet on the data connection. If multiple connections are
used, then {{param}} is set to the latest {{param}} across all
connections.
The number of {{units}} of the test file sent during the FTP/HTTP
transaction including FTP/HTTP headers, between {{param|BOMTime}}
and {{param|EOMTime}} acrosss all connections.
The total number of {{units}} (at the IP layer) received on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesReceived on the
{{param|Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesSent on the
{{param|Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
The number of {{units}} of the test file sent between the latest
{{param|PerConnectionResult.{i}.BOMTime}} and the earliest
{{param|PerConnectionResult.{i}.EOMTime}} across all connections.
The total number of {{units}} (at the IP layer) received between
the latest {{param|PerConnectionResult.{i}.BOMTime}} and the
earliest {{param|PerConnectionResult.{i}.EOMTime}} across all
connections in the test. This MAY be calculated by sampling
Stats.bytesReceived on the {{param|Interface}} object at the
latest {{param|PerConnectionResult.{i}.BOMTime}} and at the
earliest {{param|PerConnectionResult.{i}.EOMTime}} and
subtracting.
The total number of {{units}} (at the IP layer) sent between the
latest {{param|PerConnectionResult.{i}.BOMTime}} and the earliest
{{param|PerConnectionResult.{i}.EOMTime}} across all connections
in the test. This MAY be calculated by sampling Stats.bytesSent
on the {{param|Interface}} object at the latest
{{param|PerConnectionResult.{i}.BOMTime}} and at the earliest
{{param|PerConnectionResult.{i}.EOMTime}} and subtracting.
The period of time in {{units}} between the latest
{{param|PerConnectionResult.{i}.BOMTime}} and the earliest
{{param|PerConnectionResult.{i}.EOMTime}} of the test.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP socket open (SYN)
was sent for the HTTP connection.
* For FTP this is the time at which the TCP socket open (SYN) was
sent for the data connection. Note: Interval of 1 microsecond
SHOULD be supported. If multiple connections are used, then
{{param}} is set to the latest {{param}} across all
connections.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP ACK to the socket
opening the HTTP connection was received.
* For FTP this is the time at which the TCP ACK to the socket
opening the data connection was received. Note: Interval of 1
microsecond SHOULD be supported. If multiple connections are
used, then {{param}} is set to the latest {{param}} across all
connections.
Results for individual connections. This table is only populated
when {{param|#.EnablePerConnectionResults}} is {{true}}. A new
object is created for each connection specified in
{{param|#.NumberOfConnections}}. Instance numbers MUST start at 1
and sequentially increment as new instances are created.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the client sends the GET
command.
* For FTP this is the time at which the client sends the RTRV
command.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the first data packet is
received.
* For FTP this is the time at which the client receives the
first data packet on the data connection.
End of transmission in UTC, which MUST be specified to
microsecond precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the last data packet is
received.
* For FTP this is the time at which the client receives the
last packet on the data connection.
The number of {{units}} of the test file sent during the
FTP/HTTP transaction including FTP/HTTP headers, between
{{param|BOMTime}} and {{param|EOMTime}}.
The total number of {{units}} (at the IP layer) received on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesReceived on the
{{param|#.Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent on the
Interface between {{param|BOMTime}} and {{param|EOMTime}}. This
MAY be calculated by sampling Stats.bytesSent on the
{{param|#.Interface}} object at {{param|BOMTime}} and at
{{param|EOMTime}} and subtracting.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP socket open (SYN)
was sent for the HTTP connection.
* For FTP this is the time at which the TCP socket open (SYN)
was sent for the data connection.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456Z
* For HTTP this is the time at which the TCP ACK to the socket
opening the HTTP connection was received.
* For FTP this is the time at which the TCP ACK to the socket
opening the data connection was received.
Results for time segmented tests (tests where
{{param|#.TimeBasedTestDuration}} > 0 and
{{param|#.TimeBasedTestMeasurementInterval}} > 0). This data
is totaled across all connections in the test. A new object is
created every {{param|#.TimeBasedTestMeasurementInterval}} after
that interval has completed. Instance numbers MUST start at 1 and
sequentially increment as new instances are created.
Change in the value of {{param|#.TestBytesSent}} between
{{param|StartTime}} and {{param|EndTime}}.
The total number of {{units}} (at the IP layer) received on the
Interface between {{param|StartTime}} and {{param|EndTime}}.
This MAY be calculated by sampling Stats.bytesReceived on the
{{param|#.Interface}} object at {{param|StartTime}} and at
{{param|EndTime}} and subtracting.
The total number of {{units}} (at the IP layer) sent on the
Interface between {{param|StartTime}} and {{param|EndTime}}.
This MAY be calculated by sampling Stats.bytesSent on the
{{param|#.Interface}} object at {{param|StartTime}} and at
{{param|EndTime}} and subtracting.
The start 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
The maximum number of rows in
{{object|UDPEchoDiagnostics().IndividualPacketResult}} that the CPE
will store. If a test would create more rows than {{param}} only the
first {{param}} rows are present in
{{object|UDPEchoDiagnostics().IndividualPacketResult}}.
This command defines the diagnostics configuration for a UDP Echo
test {{bibref|TR-143|Appendix A.1}} defined in {{bibref|RFC862}} or a
UDP Echo Plus test defined in {{bibref|TR-143|Appendix A.1}}.
{{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.
Host name or address of the host to perform tests to.
Port on the host to perform tests to.
Number of repetitions of the test to perform before reporting the
results. The default value SHOULD be 1.
Timeout in {{units}} for the test. That is, the amount of time to
wait for the return of a packet that was sent to the
{{param|Host}}.
Size of the data block in {{units}} to be sent for each packet.
The default value SHOULD be 24.
DiffServ codepoint to be used for the test packets. The default
value SHOULD be zero.
The time in {{units}} between the {{param|NumberOfRepetitions}}
of packets sent during a given test. The default value SHOULD be
1000.
Indicates the IP protocol version to be used. The default value
SHOULD be {{enum|Any}}.
Use either IPv4 or IPv6 depending on the system preference.
Use IPv4 for the requests
Use IPv6 for the requests.
The results must be returned in the
{{object|IndividualPacketResult}} table for every repetition of
the test when set to {{true}}. The default value SHOULD be
{{false}}.
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 which IP address was used to send the request.
Result parameter indicating the number of successful packets
(those in which a successful response was received prior to the
timeout) in the most recent test.
Result parameter indicating the number of failed packets (those
in which a successful response was not received prior to the
timeout) in the most recent test.
Result parameter indicating the average response time in
{{units}} over all repetitions with successful responses of the
most recent test. If there were no successful responses, this
value MUST be zero.
Result parameter indicating the minimum response time in
{{units}} over all repetitions with successful responses of the
most recent test. If there were no successful responses, this
value MUST be zero.
Result parameter indicating the maximum response time in
{{units}} over all repetitions with successful responses of the
most recent test. If there were no successful responses, this
value MUST be zero.
This object provides the results from individual UDPEchoPlus test
packets collected during a test if
{{param|#.EnableIndividualPacketResults}} is set to true. It
should contain {{param|#.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.
Indicates that the response to this UDP Echo Plus packet sent
was received by the client. When this value is {{true}}, then
all the remaining parameters in this instance are valid.
Otherwise only the values originally set by the CPE client
(e.g. {{param|PacketSendTime}} and {{param|TestGenSN}}) MAY be
set to valid values.
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 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,
{{param}} SHOULD be set to the Unknown Time value as specified
in {{bibref|TR-106|Section 3.2.2}}.
The TestGenSN field in the UDPEcho Plus packet
{{bibref|TR-143|Section A.1.4}} sent by the CPE client.
The TestRespSN field in the response packet
{{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server
(i.e. {{param|#.Host}}) for this Echo Plus packet sent by the
CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}}
SHOULD be 0.
The TestRespRcvTimeStamp 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 reception time of this
UDP Echo Plus packet sent from the CPE client. If
{{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0.
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 count value that was set by the UDP Echo Plus server (i.e.
{{param|#.Host}}) to record the number of dropped echo response
packets by the server. This count is incremented if a valid
echo request packet is received at a UDP EchoPlus server but
for some reason cannot be responded to (e.g. due to local
buffer overflow, CPU utilization, etc...). If
{{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0.
Indicates the maximum number of connections that are supported for an
IP-Layer Capacity test.
The maximum number of rows in
{{object|IPLayerCapacity().IncrementalResult}} that the device will
store.
Indicates the test metrics from {{bibref|TR-471|Section 5.2}} that
are supported by the device.
IP packet Loss Ratio
Sampled Round Trip Time
IP packet Delay Variation
IP packet Reordering Ratio
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.
Note that {{bibref|TR-471}} mandates support for and use of IPLR
and Sampled RTT. {{reference}} The IP-layer interface over which
the test is to be performed. Example: Device.IP.Interface.1 If
{{empty}} is specified, the device MUST use the interface as
directed by its routing policy (''Forwarding'' table entries) to
determine the appropriate interface.
Indicates whether the device will act as Sender or Receiver of
test packets.
The device will act as the Receiver.
The device will act as the Sender.
The Fully Qualified Domain Name (FQDN) or IP address of the Test
Endpoint to perform the UDP Capacity tests with.
Port on the Test Endpoint host.
If {{true}}, jumbo frames are allowed. Default SHOULD be
{{false}}.
The number of connections to be used in the test. The default
value SHOULD be 1. {{param}} MUST NOT be set to a value greater
than {{param|#.IPLayerMaxConnections}}.
Ethernet priority code for marking packets transmitted in the
test (if applicable). The default value SHOULD be zero.
The DiffServ code point for marking packets transmitted in the
test. The default value SHOULD be zero.
Indicates the IP protocol version to be used. The default value
SHOULD be {{enum|Any}}.
Use either IPv4 or IPv6 depending on the system preference.
Use IPv4 for the requests
Use IPv6 for the requests.
Minimum reference size of UDP payload in {{units}}. 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).
Maximum reference size of UDP payload in {{units}}. 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
{{param|JumboFramesPermitted}} is {{false}}, the maximum value
MUST be 1472 octets. If {{param|JumboFramesPermitted}} is
{{true}}, this value can be as large as 9000 octets. {{param}}
MUST be greater than or equal to {{param|UDPPayloadMin}}.
Starting value for range of Dynamic Ports supported for test
traffic and status feedback messages.
Indicates the upper bound of the supported Dynamic Port range,
where {{param|PortMin}} indicates the starting port number.
{{param}} MUST be greater than or equal to {{param|PortMin}}.
Starting value for range of User Ports supported for test traffic
and status feedback messages. A value of zero (0) indicates no
User Ports are used for test traffic or status feedback messages.
Indicates the upper bound of the supported User Port range, where
{{param|PortOptionalMin}} indicates the starting port number.
{{param}} MUST be greater than or equal to
{{param|PortOptionalMin}}. A value of zero (0) indicates no User
Ports are used for test traffic or status feedback messages.
Indicates the type of IP-Layer Capacity test being run. The
default value SHOULD be {{enum|Search}}.
Search algorithm will be used to determine sending rate.
Fixed sending rate will be used.
Enables IPDV (IP packet Delay Variation) metric. Default SHOULD
be {{false}}.
Enables IPRR (IP packet Reordering Ratio) metric. Default SHOULD
be {{false}}.
Duration of the preamble testing, when traffic is being sent
and/or received but the test clock has not been started. This is
done to ensure all network elements in the path are "awake". The
default value SHOULD be 2 {{units}}. Value specified in
{{units}}.
The Sending Rate for a {{enum|Fixed|TestType}} test or the
initial Sending Rate value for a {{enum|Search|TestType}} test.
Value specified in {{units}}. The default SHOULD be 500
{{units}}.
Number of intermediate measurement reporting intervals. The value
MUST NOT be greater than {{param|#.IPLayerMaxIncrementalResult}}.
The default value SHOULD be 10.
Duration of intermediate measurement reporting intervals.
{{param}} * {{param|NumberTestSubIntervals}} MUST result in an
integer value in seconds, in the range 5 seconds <= {{param}}
* {{param|NumberTestSubIntervals}} <= 60 seconds. The default
value SHOULD be 1000 {{units}}. Value specified in {{units}}.
Period of status feedback message (receiver of offered load
returns messages to the sender with results of measured metrics).
Value specified in {{units}}. The default SHOULD be 50 {{units}}.
Timeout value. Value specified in {{units}}. The default value
SHOULD be 5 {{units}}.
Maximum waiting time for packets to arrive. Value specified in
{{units}}. The default SHOULD be 1000 {{units}}.
Maximum Round Trip Time waiting time for packets to arrive. Value
specified in {{units}}. The default SHOULD be 3000 {{units}}.
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 {{param|#.IPLayerCapSupportedMetrics}}
protocols being used are able to provide the requested
resolution, this resolution SHOULD be provided. Value specified
in {{units}}. The default SHOULD be 1 {{units}}.
This parameter is only meaningful if {{param|TestType}} is
{{enum|Search|TestType}}. The lower threshold on the range of
Round Trip Time (RTT) variation. Value specified in {{units}}.
The default SHOULD be 30 {{units}}.
This parameter is only meaningful if {{param|TestType}} is
{{enum|Search|TestType}}. The upper threshold on the range of
Round Trip Time (RTT) variation. Value specified in {{units}}.
The default SHOULD be 90 {{units}}.
This parameter is only meaningful if {{param|TestType}} is
{{enum|Search|TestType}}. The number of rows to move in a single
adjustment when initially increasing offered load (to ramp up
quickly). The default SHOULD be 10.
This parameter is only meaningful if {{param|TestType}} is
{{enum|Search|TestType}}. Threshold on the measured number of
consecutive status reports indicating loss and/or delay variation
above {{param|UpperThresh}} (SlowAdjCount). The default SHOULD be
2.
This parameter is only meaningful if {{param|TestType}} is
{{enum|Search|TestType}}. Threshold for transition between low
and high sending rate step sizes (such as 1Mbps and 100 Mbps). If
{{param|JumboFramesPermitted}} is {{true}} this may result in use
of jumbo frames. The default SHOULD be 1 {{units}}.
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.
Beginning of transmission send/receive time in UTC, which MUST be
specified to {{param|TimestampResolution}} precision. If multiple
connections are used, then {{param}} is set to the earliest value
across all connections. For example: 2008-04-09T15:01:05.123456Z
End of transmission in UTC, which MUST be specified to
{{param|TimestampResolution}} precision. If multiple connections
are used, then {{param}} is set to the latest value across all
connections. For example: 2008-04-09T15:01:05.123456Z
Configured value of {{param|Tmax}} used in the test. This value
is expressed in {{units}}.
Duration of the test (either downlink or uplink). This value is
expected to equal {{param|TestSubInterval}} *
{{param|NumberTestSubIntervals}}. This value is expressed in
{{units}}.
The maximum IP-Layer Capacity metric from among all
{{param|IncrementalResult.{i}.IPLayerCapacity}} values measured
between {{param|BOMTime}} and {{param|EOMTime}} across all
connections for this test. This is calculated according to
{{bibref|TR-471}} Equation 1. Result is expressed in {{units}}
with 3 digits beyond the decimal. 10^6 bits/second = 1 Mbps.
Time in UTC of end of the sub-interval when
{{param|MaxIPLayerCapacity}} was measured. If the value of
{{param|MaxIPLayerCapacity}} occurred in multiple sub-intervals,
this MUST be the earliest of these sub-intervals. Value MUST be
specified to {{param|TimestampResolution}} precision. For
example: 2008-04-09T15:01:05.123456Z
Ratio of lost packets to total packets during sub-interval of
{{param|MaxIPLayerCapacity}}. This value is expressed as a
decimal to 9 decimal digits.
The range of Round Trip Time (RTT) during sub-interval of
{{param|MaxIPLayerCapacity}}. This value is expressed in
{{units}}. This value is expressed as a decimal to 9 decimal
digits.
The range of Packet Delay Variation (PDV) during sub-interval of
{{param|MaxIPLayerCapacity}}. This value is expressed in
{{units}}. This value is expressed as a decimal to 9 decimal
digits.
The minimum one-way delay during the sub-interval of
{{param|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 {{units}}. This value is expressed as a decimal
to 9 decimal digits.
Ratio of reordered packets to total packets during the
sub-interval of {{param|MaxIPLayerCapacity}}. This value is
expressed as a decimal to 9 decimal digits.
Configured value of {{param|TmaxRTT}} used in the test. This
value is expressed in {{units}}.
Indicates the timestamp resolution of reported results. Value
specified in {{units}}.
Results for time segmented tests (tests where
{{param|#.NumberTestSubIntervals}} > 1). This data is
calculated across all connections in the test. A new object is
created every {{param|#.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.
Results of measurements using the maximum IP-Layer Capacity
metric calculation for a single interval from {{bibref|TR-471}}
Equation 1, for time interval of duration
{{param|#.TestSubInterval}} ending at
{{param|TimeOfSubInterval}} across all connections for this
test. Result is expressed in {{units}} with 3 digits beyond the
decimal. 10^6 bits/second = 1 Mbps.
Time in UTC of end of sub-interval when
{{param|IPLayerCapacity}} was measured. Value MUST be specified
to {{param|#.TimestampResolution}} precision. For example:
2008-04-09T15:01:05.123456Z
Ratio of lost packets to total packets, for time interval of
duration {{param|#.TestSubInterval}} ending at
{{param|TimeOfSubInterval}} across all connections for this
test. This value is expressed as a decimal to 9 decimal digits.
The range of Round Trip Time (RTT), for time interval of
duration {{param|#.TestSubInterval}} ending at
{{param|TimeOfSubInterval}} across all connections for this
test. See {{bibref|TR-471}} for description of how value is
calculated. This value is expressed in {{units}}. This value is
expressed as a decimal to 9 decimal digits.
The range of Packet Delay Variation (PDV), for time interval of
duration {{param|#.TestSubInterval}} ending at
{{param|TimeOfSubInterval}} across all connections for this
test. See {{bibref|TR-471}} for description of how value is
calculated. This value is expressed in {{units}}. This value is
expressed as a decimal to 9 decimal digits.
The minimum one-way delay, for time interval of duration
{{param|#.TestSubInterval}} ending at
{{param|TimeOfSubInterval}} across all connections for this
test. 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
{{units}}. This value is expressed as a decimal to 9 decimal
digits.
Ratio of reordered packets to total packets, for time interval
of duration {{param|#.TestSubInterval}} ending at
{{param|TimeOfSubInterval}} across all connections for this
test. This value is expressed as a decimal to 9 decimal digits.
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.
{{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.
Indicates the IP protocol version to be used.
Use either IPv4 or IPv6 depending on the system preference.
Use IPv4 for the requests.
Use IPv6 for the requests.
The protocol over which the test is to be performed.
Each entry is a Host name or address of a host to ping.
Number of repetitions of the ping test to perform for each
{{param|HostList}} entry before reporting the results.
Timeout in {{units}} for each iteration of the ping test where
the total number of iterations is the value of
{{param|NumberOfRepetitions}} times the number of entities in the
{{param|HostList}} Parameter.
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.
Result parameter indicating the Host (one of the items within the
{{param|HostList}} Parameter) with the smallest average response
time.
Result parameter indicating the minimum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test for the Host identified in
{{param|FastestHost}}. Success is defined by the underlying
protocol used. If there were no successful responses across all
Hosts, this value MUST be zero.
Result parameter indicating the average response time in
{{units}} over all repetitions with successful responses of the
most recent ping test for the Host identified in
{{param|FastestHost}}. Success is defined by the underlying
protocol used. If there were no successful responses across all
Hosts, this value MUST be zero.
Result parameter indicating the maximum response time in
{{units}} over all repetitions with successful responses of the
most recent ping test for the Host identified in
{{param|FastestHost}}. Success is defined by the underlying
protocol used. If there were no successful responses across all
Hosts, this value MUST be zero.
Indicates which IP address was used to send the request to the
host identified in {{param|FastestHost}}.
This object allows the CPE to be configured to perform the UDP Echo
Service defined in {{bibref|RFC862}} and UDP Echo Plus Service defined
in {{bibref|TR-143|Appendix A.1}}.
MUST be enabled to receive UDP echo. When enabled from a disabled
state all related timestamps, statistics and UDP Echo Plus counters
are cleared.
{{reference|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 {{empty}}. An attempt to set this
parameter to a different value MUST be rejected as an invalid
parameter value. If {{empty}} 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.
The Source IP address of the UDP echo packet. The CPE MUST only
respond to a UDP echo from this source IP address.
The UDP port on which the UDP server MUST listen and respond to UDP
echo requests.
If {{true}} the CPE will perform necessary packet processing for UDP
Echo Plus packets.
{{true}} if UDP Echo Plus is supported.
Incremented upon each valid UDP echo packet received.
Incremented for each UDP echo response sent.
The number of UDP received bytes including payload and UDP header
after the UDPEchoConfig is enabled.
The number of UDP responded bytes, including payload and UDP header
sent after the UDPEchoConfig is enabled.
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.
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.
This object contains Link Layer Discovery Protocol (LLDP)
{{bibref|802.1AB-2009}} related objects and parameters.
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.
{{numentries}}
This table contains information about discovered LLDP devices.
{{reference|the interface via which the LLDP device was discovered}}
The chassis identifier subtype, which is included in the value of the
''LLDPDU's'' Chassis ID TLV (TLV Type = 1). The following subtype
values are defined:
* ''0'' (Reserved)
* ''1'' (Chassis component)
* ''2'' (Interface alias)
* ''3'' (Port component)
* ''4'' (MAC address)
* ''5'' (Network address)
* ''6'' (Interface name)
* ''7'' (Locally assigned)
* ''8-255'' (Reserved) Note: It is assumed that this integer might be
used for HTIP (Home-network Topology Identifying Protocol)
{{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the
Chassis ID is set to the representative MAC address (chassis ID
subtype = 4) for ''HTIP-Ethernet Bridge''.
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
''LLDPDU''s are sent and received from two or more LLDP agents of the
same ''HTIP-Ethernet Bridge'', this value is same in all ''LLDPDU''s.
{{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.
{{numentries}}
This table contains information about ports on discovered LLDP devices.
The port identifier subtype, which is included in the value of the
''LLDPDU's'' Port ID TLV (TLV Type = 2). The following subtype values
are defined:
* ''0'' (Reserved)
* ''1'' (Interface alias)
* ''2'' (Port component)
* ''3'' (MAC address)
* ''4'' (Network address)
* ''5'' (Interface name)
* ''6'' (Agent circuit ID)
* ''7'' (Locally assigned)
* ''8-255'' (Reserved)
The port identifier, which is included in the value of the
''LLDPDU's'' Port ID TLV (TLV Type = 2).
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 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 device's MAC addresses, which are included in the value of the
''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127), or
{{empty}} 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) {{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 3 (''MAC
Address List'').
The date and time at which the last LLDPDU was received for this
({{object|#}},{{object}}).
The port's link information, which is included in the value of the
''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127). Note: It
is assumed that this object might be used for HTIP (Home-network
Topology Identifying Protocol) {{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 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) {{bibref|JJ-300.00}} and
{{bibref|G.9973}}. In this case, it's an IANA interface type
{{bibref|IANAifType}}. For example, IANAifType defines the following
interface types for wired line (UTP cable), wireless line, power
line, and coaxial cable:
* ''6'' (Wired line)
* ''71'' (Wireless)
* ''174'' (PLC)
* ''236'' (Coaxial cable)
The port's MAC forwarding table, or the value is {{empty}} if no
forwarding table was supplied.
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'').
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.
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}}
{{empty}}
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}}.
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}}.
{{numentries}}
The vendor-specific device information, which is included in the value
of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
{{keys}} 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''), 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'').
The vendor-specific organization code, which is included in the value
of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
The vendor-specific device information type, which is included in the
value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type =
127).
The vendor-specific device information, which is included in the
value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type =
127).
IPsec {{bibref|RFC4301}} object that supports the configuration of
Encapsulating Security Payload (ESP) {{bibref|RFC4303}} and
Authentication Header (AH) {{bibref|RFC4302}} in tunnel mode
{{bibref|RFC4301|Section 3.2}}. Use of IKEv2 {{bibref|RFC5996}} is
assumed. The IPsec object does not currently support static
configuration of tunnels and child Security Associations (SAs). See the
IPsec Theory of Operation {{bibref|TR-181i2|Appendix IX}} for a
description of the working of this IPsec data model.
Enables or disables IPsec.
IPsec status. {{enum}} The {{enum|Error}} value MAY be used by the
CPE to indicate a locally defined error condition.
Indicates whether or not Authentication Header (AH)
{{bibref|RFC4302}} is supported.
Supported IKEv2 encryption algorithms {{bibref|IKEv2-params|Transform
Type 1}}. {{enum}} Note that these are the names from the above
reference, transformed as follows:
* Leading ''ENCR_'' (when present) discarded because they are all
encryption algorithms so it's not needed.
* Underscores changed to hyphens to preserve names used in existing
data models (and because of inconsistent conventions).
* Phrases collapsed where unambiguous, e.g. "with a(n) NN octet ICV"
-> "-NN". As additional algorithms are added to the above
reference, this data model will be extended according to the above
conventions.
Supported ESP encryption algorithms {{bibref|IKEv2-params|Transform
Type 1}} {{bibref|RFC4835|Section 3.1.1}}. {{enum}} Note that these
are the names from the above reference, transformed as follows:
* Leading ''ENCR_'' (when present) discarded because they are all
encryption algorithms so it's not needed.
* Underscores changed to hyphens to preserve names used in existing
data models (and because of inconsistent conventions).
* Phrases collapsed where unambiguous, e.g. "with a(n) NN octet ICV"
-> "-NN".
* Some algorithms with apparently rather specialised application are
omitted, e.g. ''ENCR_NULL_AUTH_AES_GMAC''. As additional algorithms
are added to the above reference, this data model will be extended
according to the above conventions.
Supported IKEv2 pseudo-random functions
{{bibref|IKEv2-params|Transform Type 2}}. {{enum}} Note that these
are the names from the above reference, transformed as follows:
* Leading ''PRF_'' (when present) discarded because they all
pseudo-random functions so it's not needed.
* Underscores changed to hyphens to preserve names used in existing
data models.
* Hyphen inserted after ''AES'' (or other acronym) when immediately
followed by a key length. As additional functions are added to the
above reference, this data model will be extended according to the
above conventions.
Supported integrity algorithms {{bibref|IKEv2-params|Transform Type
3}}. {{enum}} Note that these are the names from the above reference,
transformed as follows:
* Leading ''AUTH_'' (when present) discarded because they all
authentication (integrity) algorithms so it's not needed.
* Underscores changed to hyphens to preserve names used in existing
data models. As additional algorithms are added to the above
reference, this data model will be extended according to the above
conventions.
Supported Diffie-Hellman group transforms
{{bibref|IKEv2-params|Transform Type 4}}. {{enum}} Note that these
are the names from the above reference, transformed as follows:
* Name (other than ''NONE'') always starts with the type of group,
currently ''MODP'' or ''ECP'' (implies ECP random).
* This is followed by ''-NN'', where ''NN'' is the group length in
bits.
* this is followed by ''-PRIME-NN'' for groups with prime order
subgroups, where ''NN'' is the subgroup length in bits. As
additional algorithms are added to the above reference, this data
model will be extended according to the above conventions.
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 {{object|Profile}} table. A
value of 0 means no specific limit.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
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}}).
The total number of times an IPsec negotiation failure has occurred.
The total number of {{units}} sent by IPsec.
The total number of {{units}} received by IPsec.
The total number of {{units}} sent by IPsec.
The total number of {{units}} received by IPsec.
The total number of {{units}} discarded by IPsec due to any error.
This can include packets dropped due to a lack of transmit buffers.
The total number of {{units}} discarded by IPsec due to an unknown
SPI (Security Parameter Index).
The total number of {{units}} discarded by IPsec due to ESP
decryption errors.
The total number of {{units}} discarded by IPsec due to integrity
errors.
The total number of {{units}} discarded by IPsec due to replay
errors.
The total number of {{units}} discarded by IPsec due to policy
errors.
The total number of {{units}} discarded by IPsec due to errors other
than unknown SPI, decryption, integrity, replay or policy errors.
This can include packets dropped due to a lack of receive buffers.
Filter table that represents the IPsec Security Policy Database (SPD)
{{bibref|RFC4301|Section 4.4.1}} selection criteria. Each (ordered)
entry defines a set of selection criteria and references a
{{object|#.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 {{bibref|RFC4301|Section 3.1}}.
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 {{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}}.
Enables or disables this IPsec Filter table entry.
The status of this IPsec Filter table entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}}
entries is incremented (lowered in precedence) to ensure uniqueness
of this value. A deletion causes {{param}} values to be compacted.
When a value is changed, incrementing occurs before compaction. The
value of {{param}} on creation of a {{object}} table entry MUST be
one greater than the largest current value (initially assigned the
lowest precedence).
{{datatype|expand}}
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. 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. Destination IP address. {{empty}} indicates
this criterion is not used, i.e. is ''ANY''.
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.
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.
SPD selection criterion. Source IP address. {{empty}} indicates this
criterion is not used, i.e. is ''ANY''.
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.
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.
SPD selection criterion. Protocol number. A value of -1 indicates
this criterion is not used, i.e. is ''ANY''. Note that
{{bibref|RFC4301}} refers to this as the ''Next Layer Protocol''. It
is obtained from the IPv4 ''Protocol'' or the IPv6 ''Next Header''
fields.
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.
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).
SPD selection criterion. If specified, indicates a destination port
address range from {{param|DestPort}} through {{param}} (inclusive),
in which case {{param}} MUST be greater than or equal to
{{param|DestPort}}. A value of -1 indicates that no destination port
range is specified.
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.
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).
SPD selection criterion. If specified, indicates a source port
address range from {{param|SourcePort}} through {{param}}
(inclusive), in which case {{param}} MUST be greater than or equal to
{{param|SourcePort}}. A value of -1 indicates that no source port
range is specified.
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.
Indicates how packets that match this rule will be processed
{{bibref|RFC4301|Section 4.4.1}}.
Packet is not allowed to traverse the IPsec boundary; packet
will be discarded
Packet is allowed to bypass traverse the IPsec boundary without
protection
Packet is afforded protection as specified by {{param|Profile}}
The profile that defines the IPsec treatment for matching packets.
{{reference}} If {{param|ProcessingChoice}} is
{{enum|Protect|ProcessingChoice}}, {{param}} MUST NOT be {{empty}}.
In this case, if it ever becomes {{empty}}, e.g. because the
referenced profile is deleted, this IPsec Filter table entry is
invalid and {{param|Status}} MUST be set to
{{enum|Error_Misconfigured|Status}}. If {{param|ProcessingChoice}} is
not {{enum|Protect|ProcessingChoice}}, {{param}} 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.
Profile table that represents the IPsec Security Policy Database (SPD)
{{bibref|RFC4301|Section 4.4.1}} processing info. Each entry defines
the IPsec treatment for packets that match the {{object|#.Filter}}
entries that reference the entry.
{{datatype|expand}}
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 {{param}}
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 {{bibref|RFC5996|Section 1.3}}.
The host name or IP address of the remote IPsec 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.
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.
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.
Authentication Header {{bibref|RFC4302}}; can only be selected
if {{param|#.AHSupported}} is {{true}}
Encapsulating Security Payload {{bibref|RFC4303}}
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.
Allowed IKEv2 encryption algorithms.
Allowed ESP encryption algorithms.
Allowed IKEv2 pseudo-random functions.
Allowed IKEv2 integrity algorithms.
Allowed AH integrity algorithms {{bibref|IKEv2-params|Transform Type
3}} {{bibref|RFC4835|Section 3.2}}.
Allowed ESP integrity algorithms {{bibref|IKEv2-params|Transform Type
3}} {{bibref|RFC4835|Section 3.1.1}}.
Allowed IKEv2 Diffie-Hellman group transforms.
IKEv2 Dead Peer Detection (DPD) timeout in {{units}}.
{{bibref|RFC5996|section 2.4}}
IKEv2 NAT traversal (NAT-T) keepalive timeout in {{units}}.
{{bibref|RFC3948|Section 4}}
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.
Controls the value of the ''Do Not Fragment'' (DF) bit.
{{bibref|RFC4301|Section 8.1}}
Copy from inner header; applies only when both inner and outer
headers are IPv4
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.
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 {{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.
Action to take when an IKEv2 SA expires, whether as a result of
hitting a traffic limit or a time limit.
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 {{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.
Action to take when a Child SA expires, whether as a result of
hitting a traffic limit or a time limit.
{{numentries}}
Each instance of this object represents an IKEv2 Configuration Payload
(CP) {{bibref|RFC5996|Section 3.15}} Attribute that MUST, if enabled,
be sent in IKEv2 CP CFG_REQUEST messages. All such Attributes MUST be
listed.
Enables or disables this {{object}} entry.
{{datatype|expand}}
CP Attribute Type as described in {{bibref|RFC5996|Section 3.15.1}}
and defined in {{bibref|IKEv2-params|IKEv2 Configuration Payload
Attribute Types}}.
A hexbinary encoded CP Attribute Value as described in
{{bibref|RFC5996|Section 3.15.1}} and defined in
{{bibref|IKEv2-params|IKEv2 Configuration Payload Attribute Types}}.
Represents an IPsec tunnel, i.e. a virtual IP interface that models an
IPsec tunnel entry point and exit point. A {{object}} instance always
references (and has the same lifetime as) a
({{enum|Tunnel|.IP.Interface.{i}.Type}},{{enum|Tunneled|.IP.Interface.{i}.Type}})
{{object|.IP.Interface}} pair. The {{object}} instance models the
IPsec-specific concepts, the {{enum|Tunnel|.IP.Interface.{i}.Type}}
{{object|.IP.Interface}} instance models the generic concepts, and the
{{enum|Tunneled|.IP.Interface.{i}.Type}} {{object|.IP.Interface}}
instance exists only so it can be referenced by forwarding or filter
rules. {{object}} instances are automatically created (as needed) when
{{object|#.Filter}} instances are enabled and disabled. Each instance's
{{param|Filters}} parameter references the {{object|#.Filter}}
instances that require the {{object}} instance to exist. If this list
ever becomes {{empty}}, e.g. because all the referenced
{{object|#.Filter}} instances have been disabled or deleted, the CPE
MAY choose not to delete the {{object}} instance (and its associated
({{enum|Tunnel|.IP.Interface.{i}.Type}},{{enum|Tunneled|.IP.Interface.{i}.Type}})
{{object|.IP.Interface}} pair). This can be desirable, because
{{object|.QoS.Classification}},
{{object|.Routing.Router.{i}.IPv4Forwarding}},
{{object|.Routing.Router.{i}.IPv6Forwarding}} etc instances might be
referencing the {{object|.IP.Interface}} instances.
{{datatype|expand}}
The corresponding auto-created
{{enum|Tunnel|Device.IP.Interface.{i}.Type}} {{object|.IP.Interface}}
instance. {{reference||delete}}
The corresponding auto-created
{{enum|Tunneled|Device.IP.Interface.{i}.Type}}
{{object|.IP.Interface}} instance. {{reference||delete}}
The {{object|#.Filter}} instances that require this {{object}}
instance to exist. {{reference}}
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
{{param|.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
{{param|.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 {{object|.IP.Interface.{i}.Stats}}
object.
The total number of inbound {{units}} discarded due to ESP decryption
errors.
The total number of inbound {{units}} discarded due to integrity
errors.
The total number of inbound {{units}} discarded due to replay errors.
The total number of inbound {{units}} discarded due to policy errors.
The total number of inbound {{units}} discarded due to errors other
than decryption, integrity, replay or policy errors. This can include
packets dropped due to a lack of receive buffers.
Represents an IKEv2 Security Association (SA), corresponding to an
IKEv2 session. Instances are automatically created and deleted as IKEv2
SAs are created and deleted.
The current operational state of the IKEv2 SA.
{{datatype|expand}}
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 local IP address that this IKEv2 SA was negotiated with. This is
assigned via IKEv2 and will also be available via the associated
{{object|#.Tunnel}}'s {{param|#.Tunnel.{i}.TunnelInterface}}
{{object|##.IP.Interface.{i}.IPv4Address}} or
{{object|##.IP.Interface.{i}.IPv6Address}} table (as appropriate).
The IP address of the peer that this IKEv2 SA was negotiated with.
This will be the IP address of one of the security gateways
configured via {{param|#.Profile.{i}.RemoteEndpoints}}.
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 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 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 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 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.
When this IKEv2 SA was set up.
Whether NAT traversal is supported by the device and, if so, whether
a NAT was detected.
{{numentries}}
{{numentries}}
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.
The total number of {{units}} handled in the outbound direction by
the IKEv2 SA.
The total number of {{units}} handled in the inbound direction by the
IKEv2 SA.
The total number of {{units}} handled in the outbound direction by
the IKEv2 SA.
The total number of {{units}} handled in the inbound direction by the
IKEv2 SA.
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 inbound {{units}} to this IKEv2 SA discarded due
to decryption errors. Note that this refers to IKEv2 protocol
{{units}}, and not to {units}} carried by other SAs.
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 {{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.
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.
CP Attribute Type as described in {{bibref|RFC5996|Section 3.15.1}}
and defined in {{bibref|IKEv2-params|IKEv2 Configuration Payload
Attribute Types}}.
A hexbinary encoded CP Attribute Value as described in
{{bibref|RFC5996|Section 3.15.1}} and defined in
{{bibref|IKEv2-params|IKEv2 Configuration Payload Attribute Types}}.
Represents a child Security Association (SA) pair, i.e. an inbound
child SA and an outbound child SA.
The current operational state of the child SA pair.
{{datatype|expand}}
The inbound child SA's Security Parameter Index (SPI).
The outbound child SA's Security Parameter Index (SPI).
The date and time when the child SA was created.
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.
The number of {{units}} handled by the outbound child SA.
The number of {{units}} handled by the inbound child SA.
The number of {{units}} handled by the outbound child SA.
The number of {{units}} handled by the inbound child SA.
The number of {{units}} discarded by the outbound child SA due to any
error. This can include compression errors or errors due to a lack of
transmit buffers.
The number of {{units}} discarded by the inbound child SA due to
decryption errors.
The number of {{units}} discarded by the inbound child SA due to
integrity errors.
The number of {{units}} discarded by the inbound child SA due to
replay errors.
The number of {{units}} discarded by the inbound child SA due to
policy errors.
The number of {{units}} discarded by the inbound child SA due to
errors other than decryption, integrity, replay or policy errors.
This can include decompression errors or errors due to a lack of
receive buffers.
This object contains parameters associated with the Generic Routing
Encapsulation (GRE) Tunnel ({{bibref|RFC2784}}) with Key and Sequence
Number extensions ({{bibref|RFC2890}}). This object also provides a
means to treat packets that are encapsulated within a GRE Tunnel by
using a set of {{object|Filter}} objects to determine the treatment of
the packet.
{{numentries}}
{{numentries}}
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 {{object}} object has one or more {{object|Interface}}
objects that further define the sessions or flows within the tunnel.
Enables or disables the tunnel.
The current operational state of the tunnel.
{{datatype|expand}}
The Fully Qualified Domain Name (FQDN) or IP address of the remote
GRE tunnel endpoint. If more than one name/address is supplied, they
will be tried in turn, i.e. they are in decreasing order of
precedence.
The mechanism used to keep the tunnel from timing out at the
{{param|ConnectedRemoteEndpoint}}.
The tunnel keepalive timeout in {{units}}.
Number of KeepAlive messages unacknowledged by the
{{param|ConnectedRemoteEndpoint}} before the {{object}} is perceived
failed.
The protocol used for the delivery header.
If the specified entries in the {{object|#.Filter}} table do not
match this {{object}} object or an instance of the
{{object|Interface}} object for this {{object}} object, then the
value of this parameter is applied to the delivery header of the
packets in this {{object}}.
The Fully Qualified Domain Name (FQDN) name or IP address of the
connected remote GRE tunnel endpoint.
{{numentries}}
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}}).
The total number of KeepAlive {{units}} sent out the tunnel.
The total number of KeepAlive {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} discarded by the tunnel due to any
error. This can include packets dropped due to a lack of transmit
buffers.
The total number of {{units}} received by the tunnel that contained
errors preventing them from being delivered to a higher-layer
protocol.
GRE Interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). The {{object}} object models the GRE
Header as defined in {{bibref|RFC2784}} and extensions to the GRE
Header as defined in {{bibref|RFC2890}}. The {{object}} object provides
a way to discriminate how sessions or flows are encapsulated within the
GRE Tunnel. In addition the {{object}} object represents the entry
point and exit point of the tunnel in relation to the LAN interface.
Unless the Key Identifier of {{bibref|RFC2890}} is supported there is
only one instance of this {{object}} object per tunnel.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
The Protocol ID assigned to this {{object}}. The Protocol Id is the
EtherType value used to identify the encapsulated payload. When set
to {{null}} the CPE determines the Protocol Id.
When {{true}}, includes the "Checksum" field in the GRE header as
defined in {{bibref|RFC2784}}.
The method used to generate the Key Identifier extension as defined
in.{{bibref|RFC2890}}.
The generation of the Key field is CPE specific implementation.
When the value of {{param|KeyIdentifierGenerationPolicy}} is
{{enum|Provisioned|KeyIdentifierGenerationPolicy}} this {{param}}
parameter is used to identify an individual traffic flow within a GRE
tunnel, as defined in {{bibref|RFC2890}}.
When {{true}}, includes the "SequenceNumber" field in the GRE header
as defined in {{bibref|RFC2890}}
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}}).
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} discarded by this interface due to any
error. This can include packets dropped due to a lack of transmit
buffers.
The total number of {{units}} received by this interface that
contained errors preventing them from being delivered to a
higher-layer protocol.
The total number of {{units}} received by the tunnel interface that
are discarded because of Checksum errors.
The total number of {{units}} received by the tunnel interface that
are discarded because of Sequence Number errors.
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:
* If the value of the {{param|AllInterfaces}} is {{true}}, then this
entry will be applied to all {{object|#.Tunnel}} and
{{object|#.Tunnel.{i}.Interface}} instances.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of
{{param|Interface}} parameter is a reference to a row in the
{{object|#.Tunnel}} table then this entry is applied to all
{{object|#.Tunnel.{i}.Interface}} instances of the
{{object|#.Tunnel}} reference.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of
{{param|Interface}} parameter is a reference to a row in the
{{object|#.Tunnel.{i}.Interface}} table then this entry is applied to
the {{object|#.Tunnel.{i}.Interface}} reference.
* If no entries are matched for the packet, then the default treatment
(e.g., {{param|#.Tunnel.{i}.DefaultDSCPMark}}) is applied to the
packet. 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}}.
Enables or disables this filter.
The status of this filter. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}}
entries is incremented (lowered in precedence) to ensure uniqueness
of this value. A deletion causes {{param}} values to be compacted.
When a value is changed, incrementing occurs before compaction. The
value of {{param}} on creation of a {{object}} table entry MUST be
one greater than the largest current value (initially assigned the
lowest precedence).
{{datatype|expand}}
Filter criterion. {{reference}}
Filter criterion. This specifies that all ingress GRE tunnel
interfaces are associated with the entry. If {{true}}, the value of
{{param|Interface}} is ignored since all ingress GRE tunnel
interfaces are indicated.
Filter criterion. Current outer Ethernet VLAN ID as defined in
802.1Q. A value of -1 indicates this criterion is not used for
filtering.
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.
DSCP with which to mark the outer IP header for traffic that is
associated with the interface criterion. Automatic DSCP marking
behavior is a local matter to the device, possibly influenced by
other Broadband Forum standards that it supports.
* A value of -1 indicates copy from the upstream packet.
* A value of -2 indicates automatic marking of DSCP.
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.
{{numentries}}
{{numentries}}
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.
Enables or disables the tunnel.
The current operational state of the tunnel.
{{datatype|expand}}
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 mechanism used to keep the tunnel from timing out at the
{{param|ConnectedRemoteEndpoint}}.
The version of the ICMP packet used for this {{param}} is based
on the value of the {{param|DeliveryHeaderProtocol}} parameter
(Either ICMP for IPv4 or ICMPv6 for IPv6).
The tunnel keepalive timeout in {{units}}.
Number of KeepAlive messages unacknowledged by the
{{param|ConnectedRemoteEndpoint}} before the {{object}} is perceived
failed.
The protocol used for the delivery header.
If the specified entries in the {{object|#.Filter}} table do not
match this {{object}} object or an instance of the
{{object|Interface}} object for this {{object}} object, then the
value of this parameter is applied to the delivery header of the
packets in this {{object}}.
The protocol that this {{object}} will be encapsulated
The Fully Qualified Domain Name (FQDN) name or IP address of the
connected remote L2TPv3 tunnel endpoint.
{{numentries}}
This {{object}} provides the parameters when the value of the
{{param|##.Tunnel.{i}.TunnelEncapsulation}} parameter is
{{enum|UDP|##.Tunnel.{i}.TunnelEncapsulation}}.
The source (local) port used to transmit PDUs. A value of 0 indicates
that the port selection is performed by the device.
The remote port used to by the remote endpoint to transmit PDUs.
Enables or disables checksum processing.
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}}).
The total number of KeepAlive {{units}} sent out the tunnel.
The total number of KeepAlive {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} discarded by the tunnel due to any
error. This can include packets dropped due to a lack of transmit
buffers.
The total number of {{units}} received by the tunnel that contained
errors preventing them from being delivered to a higher-layer
protocol.
L2TPv3 Interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). The {{object}} object models the
L2TPv3 Header as defined in {{bibref|RFC3931}} and the transport of L2
frames across over L2TPv3 as defined in {{bibref|RFC4719}}. The
{{object}} object provides a way to discriminate how sessions or flows
are encapsulated within the L2TPv3 Tunnel. In addition the {{object}}
object represents the entry point and exit point of the tunnel in
relation to the LAN interface.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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 policy that defines how the Cookie is handled in this {{object}}
instance.
The device does not perform Cooking processing.
The value of the {{param|Cookie}} parameter is transmitted in
the L2TPv3 header.
The device generates the value of the Cookie transmitted in the
L2TPv3 header.
The Cookie transmitted in the L2TPv3 header. The default is to set
the Cookie to the device's MAC address that is encoded in the low
order 6 bytes.
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}}).
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} discarded by this interface due to any
error. This can include packets dropped due to a lack of transmit
buffers.
The total number of {{units}} received by this interface that
contained errors preventing them from being delivered to a
higher-layer protocol.
The total number of {{units}} received by the tunnel interface that
are discarded because of Checksum errors.
The total number of {{units}} received by the tunnel interface that
are discarded because of Sequence Number errors.
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:
* If the value of the {{param|AllInterfaces}} is {{true}}, then this
entry will be applied to all {{object|#.Tunnel}} and
{{object|#.Tunnel.{i}.Interface}} instances.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of
{{param|Interface}} parameter is a reference to a row in the
{{object|#.Tunnel}} table then this entry is applied to all
{{object|#.Tunnel.{i}.Interface}} instances of the
{{object|#.Tunnel}} reference.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of
{{param|Interface}} parameter is a reference to a row in the
{{object|#.Tunnel.{i}.Interface}} table then this entry is applied to
the {{object|#.Tunnel.{i}.Interface}} reference.
* If no entries are matched for the packet, then the default treatment
(e.g., {{param|#.Tunnel.{i}.DefaultDSCPMark}}) is applied to the
packet.
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}}.
Enables or disables this filter.
The status of this filter. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}}
entries is incremented (lowered in precedence) to ensure uniqueness
of this value. A deletion causes {{param}} values to be compacted.
When a value is changed, incrementing occurs before compaction. The
value of {{param}} on creation of a {{object}} table entry MUST be
one greater than the largest current value (initially assigned the
lowest precedence).
{{datatype|expand}}
Filter criterion. {{reference}}
Filter criterion. This specifies that all ingress L2TPv3 tunnel
interfaces are associated with the entry. If {{true}}, the value of
{{param|Interface}} is ignored since all ingress L2TPv3 tunnel
interfaces are indicated.
Filter criterion. Current outer Ethernet VLAN ID as defined in
802.1Q. A value of -1 indicates this criterion is not used for
filtering.
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.
DSCP with which to mark the outer IP header for traffic that is
associated with the interface criterion. Automatic DSCP marking
behavior is a local matter to the device, possibly influenced by
other Broadband Forum standards that it supports.
* A value of -1 indicates copy from the upstream packet.
* A value of -2 indicates automatic marking of DSCP.
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.
{{numentries}}
{{numentries}}
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.
Enables or disables the tunnel.
The current operational state of the tunnel.
{{datatype|expand}}
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 mechanism used to keep the tunnel from timing out at the
{{param|ConnectedRemoteEndpoint}}.
The version of the ICMP packet used for this {{param}} is based
on the value of the {{param|DeliveryHeaderProtocol}} parameter
(Either ICMP for IPv4 or ICMPv6 for IPv6).
The tunnel keepalive timeout in {{units}}.
Number of KeepAlive messages unacknowledged by the
{{param|ConnectedRemoteEndpoint}} before the {{object}} is perceived
failed.
The protocol used for the delivery header.
If the specified entries in the {{object|#.Filter}} table do not
match this {{object}} object or an instance of the
{{object|Interface}} object for this {{object}} object, then the
value of this parameter is applied to the delivery header of the
packets in this {{object}}.
The Fully Qualified Domain Name (FQDN) name or IP address of the
connected remote VXLAN tunnel endpoint.
{{numentries}}
The source (local) port used to transmit PDUs. A value of 0 indicates
that the port selection is performed by the device. In such case, it
is recommended that the UDP source port number be calculated using a
hash of fields from the inner packet and that it is in the
dynamic/private port range 49152-65535.
The remote port used to by the remote endpoint to transmit PDUs. The
well-known port allocated by IANA is 4789, but it should be
configurable.
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}}).
The total number of KeepAlive {{units}} sent out the tunnel.
The total number of KeepAlive {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} discarded by the tunnel due to any
error. This can include packets dropped due to a lack of transmit
buffers.
The total number of {{units}} received by the tunnel that contained
errors preventing them from being delivered to a higher-layer
protocol.
VXLAN Interface table (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). The {{object}} object models the
VXLAN Header as defined in {{bibref|RFC7348}} for the transport of L2
frames across over VXLAN. The {{object}} object provides a way to
discriminate how multiple LAN segments are encapsulated within the
VXLAN Tunnel. In addition the {{object}} object represents the entry
point and exit point of the tunnel in relation to the LAN interface.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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.
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}}).
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} discarded by this interface due to any
error. This can include packets dropped due to a lack of transmit
buffers.
The total number of {{units}} received by this interface that
contained errors preventing them from being delivered to a
higher-layer protocol.
The total number of {{units}} received by the tunnel interface that
are discarded because of Checksum errors.
The total number of {{units}} received by the tunnel interface that
are discarded because of Sequence Number errors.
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:
* If the value of the {{param|AllInterfaces}} is {{true}}, then this
entry will be applied to all {{object|#.Tunnel}} and
{{object|#.Tunnel.{i}.Interface}} instances.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of
{{param|Interface}} parameter is a reference to a row in the
{{object|#.Tunnel}} table then this entry is applied to all
{{object|#.Tunnel.{i}.Interface}} instances of the
{{object|#.Tunnel}} reference.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of
{{param|Interface}} parameter is a reference to a row in the
{{object|#.Tunnel.{i}.Interface}} table then this entry is applied to
the {{object|#.Tunnel.{i}.Interface}} reference.
* If no entries are matched for the packet, then the default treatment
(e.g., {{param|#.Tunnel.{i}.DefaultDSCPMark}}) is applied to the
packet.
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}}.
Enables or disables this filter.
The status of this filter. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}}
entries is incremented (lowered in precedence) to ensure uniqueness
of this value. A deletion causes {{param}} values to be compacted.
When a value is changed, incrementing occurs before compaction. The
value of {{param}} on creation of a {{object}} table entry MUST be
one greater than the largest current value (initially assigned the
lowest precedence).
{{datatype|expand}}
Filter criterion. {{reference}}
Filter criterion. This specifies that all ingress VXLAN tunnel
interfaces are associated with the entry. If {{true}}, the value of
{{param|Interface}} is ignored since all ingress VXLAN tunnel
interfaces are indicated.
Filter criterion. Current outer Ethernet VLAN ID as defined in
802.1Q. A value of -1 indicates this criterion is not used for
filtering.
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.
DSCP with which to mark the outer IP header for traffic that is
associated with the interface criterion. Automatic DSCP marking
behavior is a local matter to the device, possibly influenced by
other Broadband Forum standards that it supports.
* A value of -1 indicates copy from the upstream packet.
* A value of -2 indicates automatic marking of DSCP.
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.
Enables or disables MAP.
{{numentries}}
MAP domain settings {{bibref|RFC7597}} {{bibref|RFC7599}}. Each
instance models a MAP domain. MAP supports two transport modes, both of
which use NAPT44 (modified to use a restricted port range):
* MAP-E ({{param|TransportMode}} =
{{enum|Encapsulation|TransportMode}}) uses an IPv4-in-IPv6 tunnel.
* MAP-T ({{param|TransportMode}} = {{enum|Translation|TransportMode}})
uses stateless NAT64. Note: There is an n:1 relationship between a
MAP domain and the associated {{param|WANInterface}}, i.e. in theory
multiple MAP domains can be associated with a single WAN IP interface
(each domain would have its own ''End-user IPv6 prefix'' and ''MAP
IPv6 address''). Note: The {{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 set {{param|Status}} to
{{enum|Error_Misconfigured|Status}} and disable the offending
{{object}} row.
Enables or disables the MAP domain.
The current operational state of the MAP domain. The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid.
{{datatype|expand}}
The transport mode to use. Corresponds to the {{bibref|RFC7598}}
''S46_CONT_MAPE'' and ''S46_CONT_MAPT'' container options.
MAP-E {{bibref|RFC7597}}
MAP-T {{bibref|RFC7599}}
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'' {{param|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
{{param|##.IP.Interface.{i}.IPv6Address.{i}.Origin}} of
{{enum|MAP|##.IP.Interface.{i}.IPv6Address.{i}.Origin}}.
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 Border Relay (BR) address or prefix.
* For MAP-E this is the BR address and therefore MUST be a /128
{{bibref|RFC7597}}. Note this address can be an IPv6 anycast
address. This address corresponds to the {{bibref|RFC7598}}
''OPTION_S46_BR'' (Border Relay) option.
* For MAP-T this is the BR prefix {{bibref|RFC7599}}. This address
prefix corresponds to the {{bibref|RFC7598}} ''OPTION_S46_DMR''
(Default Mapping Rule) option. Note: There will be a corresponding
{{object|.Routing.Router.{i}.IPv4Forwarding}} default rule.
DSCP with which to mark the outer IP header for traffic that is
associated with this MAP domain. Downstream packets are never
re-marked. Automatic DSCP marking behavior is a local matter to the
device, possibly influenced by other Broadband Forum standards that
it supports.
* A value of -1 indicates copy from the incoming packet.
* A value of -2 indicates automatic marking of DSCP.
''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. This
parameter was DEPRECATED 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|Rule.{i}.}} object.
This parameter is OBSOLETED in 2.14.
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.
This parameter was DEPRECATED 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|Rule.{i}.}}
object. This parameter is OBSOLETED in 2.14.
''Port-set ID'' (PSID) to use in preference to the value extracted
from the ''Embedded Address'' (EA) bits. Only the high order
{{param|PSIDLength}} bits of the {{param}} value are used, so the
parameter is ignored when {{param|PSIDLength}} is zero. Corresponds
to the {{bibref|RFC7598}} ''S46_PORTPARAMS'' (Port Parameters)
option's ''PSID'' field. This parameter was DEPRECATED 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|Rule.{i}.}} object. This parameter is OBSOLETED
in 2.14.
Whether to include low-numbered (system) ports in the Port-sets.
Normally ports in the range [0:2^(16-{{param|PSIDOffset}})-1] are
excluded, e.g. for the default {{param|PSIDOffset}} value of 4, ports
[0:4095] are not included in the Port-sets. This parameter is related
to {{bibref|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|PSIDOffset}} is 0; {{false}}
corresponds to ''N=1024'' and {{true}} corresponds to ''N=0''.
{{numentries}}
The MAP domain's Mapping Rules {{bibref|RFC7597}}. The rule with the
longest match between its {{param|IPv6Prefix}} and the end-user
{{param|#.IPv6Prefix}} is the Basic Mapping Rule (BMR). Any of the
rules (including the BMR) can be a Forwarding Mapping Rule.
Enable or disable this {{object}} instance.
The status of this {{object}} instance. {{enum}} The {{enum|Error}}
value MAY be used by the CPE to indicate a locally defined error
condition.
{{datatype|expand}}
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.
Created via a {{bibref|RFC7598}} ''S46_RULE'' option.
Present in the factory default configuration, created by the
Controller, or created by some other management entity (e.g.
via a GUI)
The ''Rule IPv6 prefix''. The Rule IPv6 prefix is a leading part of
the end-user {{param|#.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
{{bibref|RFC7598}} ''S46_RULE'' option's ''ipv6-prefix'' field.
The ''Rule IPv4 prefix''. Corresponds to the {{bibref|RFC7598}}
''S46_RULE'' option's ''ipv4-prefix'' field.
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.
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''.
''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.
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.
''Port-set ID'' (PSID) to use in preference to the value extracted
from the ''Embedded Address'' (EA) bits. Only the high order
{{param|PSIDLength}} bits of the {{param}} value are used, so the
parameter is ignored when {{param|PSIDLength}} is zero. Corresponds
to the {{bibref|RFC7598}} ''S46_PORTPARAMS'' (Port Parameters)
option's ''PSID'' field.
MAP interface (a stackable interface object as described in
{{bibref|TR-181i2|Section 4.2}}). This models the LAN side MAP domain
interface.
Enables or disables the interface. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Down}} (or
{{enum|NotPresent}} or {{enum|Error}} if there is a fault condition
on the interface). When {{param|Enable}} is changed to {{true}} then
{{param}} SHOULD change to {{enum|Up}} if and only if the interface
is able to transmit and receive network traffic; it SHOULD change to
{{enum|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 {{enum|Up}} if still
operable when the expected actions have completed); it SHOULD change
to {{enum|LowerLayerDown}} if and only if the interface is prevented
from entering the {{enum|Up}} state because one or more of the
interfaces beneath it is down; it SHOULD remain in the {{enum|Error}}
state if there is an error or other fault condition detected on the
interface; it SHOULD remain in the {{enum|NotPresent}} state if the
interface has missing (typically hardware) components; it SHOULD
change to {{enum|Unknown}} if the state of the interface can not be
determined for some reason. This parameter is based on
''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its
current operational state.
{{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.
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}}.
The total number of bytes transmitted out of the interface, including
framing characters.
The total number of bytes received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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 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 packets received via the interface which were
discarded because of an unknown or unsupported protocol.
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 {{param|AllowedList}}; traffic to all other destinations
MUST be redirected to the {{param|URL}}.
Enables or disables the captive portal.
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.
{{param|URL}} is {{empty}}
{{list}} List items represent 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 IP
address, or an IP prefix specified using Classless Inter-Domain
Routing (CIDR) notation {{bibref|RFC4632}}. An IP prefix is specified
as an IP address followed (with no intervening white space) by "/n",
where ''n'' (the prefix size) is an integer in the range 0-32 (for
IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1'
bits of the prefix. IPv4 example:
* 1.2.3.4 specifies a single IPv4 address, and 1.2.3.4/24 specifies a
class C subnet with subnet mask 255.255.255.0.
* 1.2.0.0/22 represents the 1024 IPv4 addresses from 1.2.0.0 to
1.2.3.255. IPv6 example:
* fec0::220:edff:fe6a:f76 specifies a single IPv6 address.
* 2001:edff:fe6a:f76::/64 represents the IPv6 addresses from
2001:edff:fe6a:f76:0:0:0:0 to
2001:edff:fe6a:f76:ffff:ffff:ffff:ffff.
Captive portal {{datatype}} to which upstream HTTP (port 80) traffic
to destinations not listed in the {{param|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 {{empty}},
which has the effect of disabling the captive portal (if
{{param|Enable}} is {{true}} and the captive portal URL is {{empty}},
{{param|Status}} MUST be {{enum|Error_URLEmpty|Status}}).
Routing object that contains the {{object|Router}} table and
{{object|RIP}} protocol object.
{{numentries}}
This object allows the handling of the routing and forwarding
configuration of the device.
Enables or disables this ''Router'' entry.
The status of this ''Router'' entry. {{enum}} The {{enum|Error}}
value MAY be used by the CPE to indicate a locally defined error
condition.
{{datatype|expand}}
{{numentries}}
{{numentries}}
Layer 3 IPv4 forwarding table. In addition to statically configured
routes, this table MUST include dynamic routes learned through layer 3
routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4,
and IPCP. The CPE MAY reject attempts to delete or modify a dynamic
route entry. For each incoming packet, the layer 3 forwarding decision
is conceptually made as follows:
* Only enabled table entries with a matching {{param|ForwardingPolicy}}
are considered, i.e. those that either do not specify a
{{param|ForwardingPolicy}}, or else specify a
{{param|ForwardingPolicy}} that matches that of the incoming packet.
* Next, table entries that also have a matching destination
address/mask are considered, and the matching entry with the longest
prefix is applied to the packet (i.e. the entry with the most
specific network). An unspecified destination address is a wild-card
and always matches, but with a prefix length of zero. For enabled
table entries, if {{param|Interface}} is not a valid reference to an
IPv4-capable interface (that is attached to the IPv4 stack), then the
table entry is inoperable and the CPE MUST set {{param|Status}} to
{{enum|Error_Misconfigured|Status}}. Note: The {{object}} 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 {{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.
Enables or disables the forwarding entry. On creation, an entry is
disabled by default.
Indicates the status of the forwarding entry. {{enum}} The
{{enum|Error}} value MAY be used by the CPE to indicate a locally
defined error condition. The {{enum|Error_Misconfigured}} value
indicates that a necessary configuration value is undefined or
invalid.
{{datatype|expand}}
If {{true}}, this route is a Static route.
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 subnet mask. {{empty}} indicates no destination subnet
mask is specified. If a destination subnet mask is specified, the
{{param}} is ANDed with the destination address before comparing with
the {{param|DestIPAddress}}. Otherwise, the full destination address
is used as is. A Forwarding table entry for which
{{param|DestIPAddress}} and {{param}} are both {{empty}} is a default
route.
Identifier of a set of classes or flows that have the corresponding
{{param}} value as defined in the {{object|Device.QoS}} object. A
value of -1 indicates no {{param}} is specified. If specified, this
forwarding entry is to apply only to traffic associated with the
specified classes and flows.
IPv4 address of the gateway. Only one of {{param}} and Interface
SHOULD be configured for a route. If both are configured, {{param}}
and {{param|Interface}} MUST be consistent with each other.
{{reference}} Specifies the egress layer 3 interface associated with
this entry. Example: Device.IP.Interface.1. Only one of
{{param|GatewayIPAddress}} and {{param}} SHOULD be configured for a
route. If both are configured, {{param|GatewayIPAddress}} and
{{param}} MUST be consistent with each other. For a route that was
configured by setting {{param|GatewayIPAddress}} but not {{param}},
read access to {{param}} MUST return the full hierarchical parameter
name for the routes egress interface.
Protocol via which the IPv4 forwarding rule was learned. {{enum}}
For example, present in the factory default configuration,
created by the Controller, or created by some other management
entity (e.g. via a GUI).
Forwarding metric. A value of -1 indicates this metric is not used.
Layer 3 IPv6 forwarding table. In addition to statically configured
routes, this table MUST include dynamic routes learned through layer 3
routing protocols, including RIPng, OSPF, DHCPv6, and RA. The CPE MAY
reject attempts to delete or modify a dynamic route entry. For each
incoming packet, the layer 3 forwarding decision is conceptually made
as follows:
* Only enabled table entries with a matching {{param|ForwardingPolicy}}
are considered, i.e. those that either do not specify a
{{param|ForwardingPolicy}}, or else specify a
{{param|ForwardingPolicy}} that matches that of the incoming packet.
* Next, table entries that also have a matching destination prefix are
considered, and the matching entry with the longest prefix length is
applied to the packet (i.e. the entry with the most specific
network). An unspecified destination address is a wild-card and
always matches, but with a prefix length of zero. For enabled table
entries, if {{param|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 {{param|Status}} to
{{enum|Error_Misconfigured|Status}}. This object is based on
''inetCidrRouteTable'' from {{bibref|RFC4292}}.
Enables or disables this {{object}} entry.
Indicates the status of the forwarding entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
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.
Identifier of a set of classes or flows that have the corresponding
{{param}} value as defined in the {{object|.QoS}} object. A value of
-1 indicates no {{param}} is specified. If specified, this forwarding
entry is to apply only to traffic associated with the specified
classes and flows.
IPv6 address of the next hop. Only one of {{param}} and
{{param|Interface}} SHOULD be configured for a route. {{empty}}
indicates no {{param}} is specified. If both are configured,
{{param}} and {{param|Interface}} MUST be consistent with each other.
{{reference}} Specifies the egress layer 3 interface associated with
this entry. Example: ''Device.IP.Interface.1''. Only one of
{{param|NextHop}} and {{param}} SHOULD be configured for a route.
{{empty}} indicates no {{param}} is specified. If both are
configured, {{param|NextHop}} and {{param}} MUST be consistent with
each other. For a route that was configured by setting
{{param|NextHop}} but not {{param}}, read access to {{param}} MUST
return the full hierarchical parameter name for the route's egress
interface.
Protocol via which the IPv6 forwarding rule was learned. {{enum}}
Router Advertisement Route Information Option
{{bibref|RFC4191}}.
RIPng for IPv6 {{bibref|RFC2080}}
For example, present in the factory default configuration,
created by the Controller, or created by some other management
entity (e.g. via a GUI).
Forwarding metric. A value of -1 indicates this metric is not used.
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.
Routing Information Protocol (RIP) object.
Enables or disables RIP on the device.
The supported RIP protocol modes. {{enum}}
{{numentries}}
IP Interface RIP configuration 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}}. Note: The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} 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 {{param|Interface}}.
Enables or disables this entry.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
{{reference}} This is the IP interface associated with this
{{object}} entry.
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.
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}}.
Received Router Advertisement (RA) route information
{{bibref|RFC4191}}.
Enables or disables receiving route information from the RA.
{{numentries}}
IP Interface RA route information table. Contains received RA route
information {{bibref|RFC4191}}. As such, the data in this table cannot
be modified.
The status of this entry. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{reference}} This is the IP interface associated with this
{{object}} entry.
IPv6 Address of the router that sent the RA that included this route
info.
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.
IPv6 address prefix, as received in an instance of the Route
Information Option of a RA message.
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 Neighbor Discovery Protocol (NDP) object {{bibref|RFC4861}}. This
object applies only to IPv6. It contains an {{object|InterfaceSetting}}
table that defines the NDP configuration for individual IP interfaces.
Enables or disables Neighbor Discovery.
{{numentries}}
Per-interface Neighbor Discovery Protocol (NDP) configuration
{{bibref|RFC4861}}. For enabled table entries, if {{param|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 {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Note: The
{{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables this {{object}} entry.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
This is the IP interface associated with this {{object}} entry.
The number of consecutive Neighbor Solicitation messages sent while
performing Duplicate Address Detection on a tentative address
(see{{bibref|RFC4862|5.1}}). 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,
{{param|RetransTimer}} defines the delay between consecutive
messages.
Retransmission interval in {{units}}, as defined in
{{bibref|RFC4861}}. For auto-configuration purposes, {{param}}
specifies the delay between consecutive Neighbor Solicitation
transmissions performed during Duplicate Address Detection (DAD)
{{bibref|RFC4862|Section 5.4}}, as well as the time a node waits
after sending the last Neighbor Solicitation before ending the DAD
process.
Retransmission interval in {{units}}, as defined in
{{bibref|RFC4861|6.3.7}}. For auto-configuration purposes, {{param}}
specifies the delay between consecutive Router Solicitation
transmissions.
Maximum Number of Router Solicitation Transmission messages, as
defined in {{bibref|RFC4861}}. For auto-configuration purposes
{{param}} specifies the Maximum Number of Router Solicitation
Transmission messages to help the host to conclude that there are no
routers on the link.
Enables or disables Neighbor Unreachability Detection (NUD)
{{bibref|RFC4861|Section 7}}.
Enables or disables Router Solicitation (RS) on {{param|Interface}}
{{bibref|RFC4861|Section 4.1}}.
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.
Enables or disables Router Advertisement.
{{numentries}}
Per-interface Router Advertisement (RA) configuration
{{bibref|RFC4861}}. Table entries are created for use in sending Router
Advertisements. For enabled table entries, if {{param|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 {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Note: The
{{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables this {{object}} entry. Defines the value of the
''IsRouter'' and ''AdvSendAdvertisements'' flags from
{{bibref|RFC4861|Section 4.2}}
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
This is the IP interface associated with this {{object}} entry.
{{list}} {{reference}} Manually-configured prefixes that will be sent
in Router Advertisement messages. Each referenced prefix MUST have a
{{param|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}} of
{{enum|Static|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}} or
{{enum|Child|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}}. Router
Advertisement messages MUST include Prefix Information Options
{{bibref|RFC4861}} for all ''Valid''
({{param|.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 {{param|Interface}}.
{{list}} {{reference}} All prefixes that will be included in Router
Advertisement (RA) messages sent out this interface. This list can
include:
* Prefixes from {{param|ManualPrefixes}} that are included in RA
messages.
* Prefixes with {{param|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} =
{{enum|Child|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} or
{{enum|AutoConfigured|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}
associated with the interface instance referenced by
{{param|Interface}}.
The maximum time allowed between sending unsolicited multicast Router
Advertisements from the interface, in {{units}} (see
{{bibref|RFC4861|Section 4.2}}).
The minimum time allowed between sending unsolicited multicast Router
Advertisements from the interface, in {{units}} (see
{{bibref|RFC4861|Section 4.2}}). The value MUST be no greater than
3/4 * {{param|MaxRtrAdvInterval}}. Note: The ''1350'' maximum was
derived from the RFC, based on 3/4 times the maximum value of
{{param|MaxRtrAdvInterval}}. Similarly, the ''200'' default was
derived from the RFC, based on 1/3 times the default value of
{{param|MaxRtrAdvInterval}}.
The value placed in the "Router Lifetime" field of Router
Advertisement messages on this interface, in {{units}} (see
{{bibref|RFC4861|Section 4.2}}). The value can be zero or between
{{param|MaxRtrAdvInterval}} and 9000 {{units}}, 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
{{param|MaxRtrAdvInterval}}.
The value placed in the "Managed address configuration" (M) flag
field of Router Advertisement messages on this interafce (see
{{bibref|RFC4861|Section 4.2}}, and {{bibref|RFC4862}}).
The value placed in the "Other configuration" (O) flag field of
Router Advertisement messages on this interface (see
{{bibref|RFC4861|Section 4.2}}, and {{bibref|RFC4862}}).
The value placed in the "Home agent" (H) flag field of Router
Advertisement messages on this interface (see
{{bibref|RFC3775|Section 7.1}}).
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 "Proxy" (P) flag field of Router
Advertisement messages on this interface (see
{{bibref|RFC4389|Section 4.1.3.3}}).
The value placed in MTU options of Router Advertisement messages on
this interface. A value of zero indicates that no MTU options are
included (see {{bibref|RFC4861|Section 4.6.4}}).
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 "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 "Cur Hop Limit" field of Router Advertisement
messages on this interface (see {{bibref|RFC4861|Section 4.2}}). The
value zero means unspecified (by the router). Note: The default can
be overridden with the value specified in {{bibref|RFC3232}} that was
in effect at the time of implementation.
{{numentries}}
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}}).
Enables or disables this {{object}} entry.
{{datatype|expand}}
Option tag (type) {{bibref|RFC4861|Section 4.6}}.
A hexbinary encoded option value {{bibref|RFC4861|Section 4.6}}.
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.
Enables or disables IPv6rd.
{{numentries}}
6rd {{bibref|RFC5969}} settings. A 6rd delegated prefix is expected to
be of maximum length 64 bits, and is the concatenation of the following
two items:
* Service provider IPv6 prefix: specified via the
{{param|SPIPv6Prefix}} parameter
* IPv4 address suffix: the IPv4 address with the first
{{param|IPv4MaskLength}} bits removed This object definition is
derived from {{bibref|RFC5969}} with some minor nomenclature changes.
Enable or disable this {{object}} instance.
The status of this entry. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
List items are the IPv4 addresses (possibly anycast) of the 6rd
Relay(s).
If {{true}}, the destination address for all 6rd traffic will be set
(IPv4 destination address) to one of the
{{param|BorderRelayIPv4Addresses}}. If {{false}}, traffic whose
destination address begins with the same prefix as
{{param|SPIPv6Prefix}} will be sent directly to the destination IPv4
address of the endpoint, which is in the same 6rd domain. See 6rd
Theory of Operation for further explanation
{{bibref|TR-181i2|Appendix VI}}.
The Service Provider's 6rd IPv6 prefix for this deployment and this
6rd RG.
The number of high-order {{units}} that are identical across all IPv4
addresses within a given 6rd domain. This number of {{units}} 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
{{units}} 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
{{units}} of the IPv4 address are used in the encoding.
{{reference}} Points to the IPv4 address that is the source of the
IPv4 address embedded in the IPv6 6rd prefix, and used as the source
encapsulating IPv4 address. If the value is {{empty}} or this
parameter is not present, the device will use internal logic to
determine which IPv4 source address to use.
{{reference}} This is an IP interface of ''Type''
{{enum|Tunnel|.IP.Interface.{i}.Type}} 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
{{param}} from the LAN is expected to continue on through
{{param|TunneledInterface}}, and traffic from the WAN is expected to
come from {{param|TunneledInterface}} into {{param}}. {{param}} 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 {{object|.QoS.}} object.
{{param}} can be used also to represent the 6rd virtual interface
defined in {{bibref|RFC5969}}. Note: In 6rd, IPv6 packets arriving
over one or more device LAN IP interfaces are logically fed into this
{{param}}. Likewise, 6rd traffic from the WAN gets logically sent
from this {{param}} to LAN IP interfaces.
{{reference}} This is an IP interface of ''Type''
{{enum|Tunneled|.IP.Interface.{i}.Type}} that provides information
about the IPv4 headers used to encapsulate the IPv6 packets.
Encapsulated IPv6 traffic that enters {{param}} from the WAN is
expected to continue on through {{param|TunnelInterface}}, and
traffic from the LAN is expected to come from
{{param|TunnelInterface}} into {{param}}. {{param}} 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
{{object|.QoS.}} object. Note: In 6rd, {{param}} 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
{{param}}.
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.
Enables or disables DSLite.
{{numentries}}
DSLite {{bibref|DSLite}} settings.
Enable or disable this {{object}} instance.
The status of this entry. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
Indicates the preferred method to be used in assigning values to
{{param|EndpointName}} when both static and dynamic values are
available. See {{param|EndpointName}} for further clarification.
Indicates the preferred method to be used to assign the address of
the DS-Lite Endpoint when both {{param|EndpointName}} and
{{param|EndpointAddress}} values are available and the
{{enum|Static|EndpointAssignmentPrecedence}} method is used. See
{{param|EndpointName}} and {{param|EndpointAddress}} for further
clarification.
Derive from {{param|EndpointName}} via a DNS lookup.
Use {{param|EndpointAddress}} directly.
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.
The Fully Qualified Domain Name (FQDN) of the tunnel concentrator
(remote endpoint). This parameter is based on ''OPTION_DS_LITE_NAME''
from {{bibref|DSLite-options|Section 4}} 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
{{param|EndpointAssignmentPrecedence}} indicates whether it is the
static configuration or the DHCPv6 configuration that is actually
applied to {{param}}. Note: {{param}} is only writable when
{{param|EndpointAssignmentPrecedence}} is
{{enum|Static|EndpointAssignmentPrecedence}}; otherwise, {{param}} is
automatically configured via the DHCPv6 received option.
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).
Method used to assign {{param|EndpointAddressInUse}}.
Assigned by DHCPv6 {{bibref|RFC3315}}.
For example, present in the factory default configuration, set
by the Controller, or set by some other management entity (e.g.
via a GUI).
{{reference}} This is an IP interface of ''Type''
{{enum|Tunnel|.IP.Interface.{i}.Type}} 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
{{param}} is expected to continue on through
{{param|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 {{param}}. Likewise, DS-Lite traffic from the WAN gets
logically sent from this {{param}} to LAN IP interfaces.
{{reference}} This is an IP interface of ''Type''
{{enum|Tunneled|.IP.Interface.{i}.Type}} that provides information
about the IPv6 headers used to encapsulate the IPv4 packets.
Encapsulated IPv4 traffic that enters {{param}} from the WAN is
expected to continue on through {{param|TunnelInterface}}, and
traffic from the LAN is expected to come from
{{param|TunnelInterface}} into {{param}}. {{param}} 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
{{object|.QoS.}} object. Note: In DS-Lite, {{param}} 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 {{param}}.
Queue management configuration object.
The maximum number of entries available in the Classification table.
{{numentries}}
The maximum number of entries available in the {{object|App}} table.
{{numentries}}
The maximum number of entries available in the {{object|Flow}} table.
{{numentries}}
The maximum number of entries available in the {{object|Policer}}
table.
{{numentries}}
The maximum number of entries available in the {{object|Queue}}
table.
{{numentries}}
{{numentries}}
The maximum number of entries available in the {{object|Shaper}}
table.
{{numentries}}
Identifier of the forwarding policy associated with traffic not
associated with any specified classifier.
Identifier of the traffic class associated with traffic not
associated with any specified classifier.
{{reference}} Indicates the ''Policer'' table entry for traffic not
associated with any specified classifier. {{empty}} indicates a null
policer.
{{reference}} Indicates the ''Queue'' table entry for traffic not
associated with any specified classifier. Note: The interpretation of
{{empty}} value is implementation specific.
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
{{bibref|TR-181i2|Annex A}}.
Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark
traffic not associated with any specified classifier. A value of -1
indicates no change from the incoming packet. A value of -2 indicates
automatic marking of EthernetPriority based upon the DSCP value of
the incoming packet as defined in {{bibref|TR-181i2|Annex A}}.
Ethernet priority code (as defined in {{bibref|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 {{bibref|TR-181i2|Annex A}}.
{{list}} List items represent URNs, each indicating a protocol
supported for use as a ProtocolIdentifier in the App table. This list
MAY include any of the URNs defined in {{bibref|TR-181i2|Annex A}} as
well as other URNs defined elsewhere.
Classification table. 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}}. 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 {{param|DHCPType}} parameter.
Enables or disables this classifier.
The status of this classifier. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
Position of the {{object}} 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 {{param}} value for the existing entry and all
lower {{param}} entries is incremented (lowered in precedence) to
ensure uniqueness of this value. A deletion causes {{param}} values
to be compacted. When a value is changed, incrementing occurs before
compaction. The value of {{param}} on creation of a {{object}} table
entry MUST be one greater than the largest current value (initially
assigned the lowest precedence).
{{datatype|expand}}
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.
Classification 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
''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 {{object|.GRE.Tunnel}} or a {{object|.MAP.Domain}}
instance.
Classification 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.
Classification criterion. Destination IP address. {{empty}} indicates
this criterion is not used for classification.
Destination IP address mask, represented as an IP routing prefix
using CIDR notation [RFC4632]. The IP address part MUST be {{empty}}
(and, if specified, MUST be ignored).
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.
Classification criterion. Source IP address. {{empty}} indicates this
criterion is not used for classification.
Source IP address mask, represented as an IP routing prefix using
CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and,
if specified, MUST be ignored).
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.
Classification criterion. Protocol number. A value of -1 indicates
this criterion is not used for classification.
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.
Classification criterion. Destination port number. A value of -1
indicates this criterion is not used for classification.
Classification criterion. If specified, indicates the classification
criterion is to include the port range from {{param|DestPort}}
through {{param}} (inclusive). If specified, {{param}} MUST be
greater than or equal to {{param|DestPort}}. A value of -1 indicates
that no port range is specified.
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.
Classification criterion. Source port number. A value of -1 indicates
this criterion is not used for classification.
Classification criterion. If specified, indicates the classification
criterion is to include the port range from {{param|SourcePort}}
through {{param}} (inclusive). If specified, {{param}} MUST be
greater than or equal to SourcePort. A value of -1 indicates that no
port range is specified.
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.
Classification criterion. Source MAC Address. {{empty}} indicates
this criterion is not used for classification.
Bit-mask for the MAC address, where matching of a packet's MAC
address with the {{param|SourceMACAddress}} is only to be done for
bit positions set to one in the mask. A mask of ''FF:FF:FF:FF:FF:FF''
or {{empty}} indicates all bits of the {{param|SourceMACAddress}} are
to be used for classification.
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.
Classification criterion. Destination MAC Address. {{empty}}
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.
Bit-mask for the MAC address, where matching of a packet's MAC
address with the {{param|DestMACAddress}} is only to be done for bit
positions set to one in the mask. A mask of ''FF:FF:FF:FF:FF:FF'' or
{{empty}} indicates all bits of the {{param|DestMACAddress}} are to
be used for classification.
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.
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.
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.
Classification criterion. SSAP element in the LLC header. A value of
-1 indicates this criterion is not used for classification.
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.
Classification criterion. DSAP element in the LLC header. A value of
-1 indicates this criterion is not used for classification.
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.
Classification criterion. Control element in the LLC header. A value
of -1 indicates this criterion is not used for classification.
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.
Classification criterion. OUI element in the SNAP header. A value of
-1 indicates this criterion is not used for classification.
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.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCPv4 Vendor Class Identifier (Option 60) as defined in
{{bibref|RFC2132}}, matched according to the criterion in
{{param|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. {{empty}} indicates this criterion is not used for
classification. Note: This parameter is DHCPv4-specific. It only
applies when {{param|DHCPType}} is {{enum|DHCPv4|DHCPType}}.
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 {{bibref|RFC3315}}. The option value is binary, so
an exact match is REQUIRED. {{empty}} indicates this criterion is not
used for classification. Note: This parameter is DHCPv6-specific. It
only applies when {{param|DHCPType}} is {{enum|DHCPv6|DHCPType}}.
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.
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}}.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCPv4 Vendor Class Identifier (Option 60) as defined in
{{bibref|RFC2132}}, matched according to the criterion in
{{param|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. {{empty}} indicates this criterion is not used for
classification. Note: This parameter is DHCPv4-specific. It only
applies when {{param|DHCPType}} is {{enum|DHCPv4|DHCPType}}.
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 {{bibref|RFC3315}}. The option value is binary, so
an exact match is REQUIRED. {{empty}} indicates this criterion is not
used for classification. Note: This parameter is DHCPv6-specific. It
only applies when {{param|DHCPType}} is {{enum|DHCPv6|DHCPType}}.
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.
{{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}}.
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 {{bibref|RFC2132}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 1 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. The option value is
binary, so an exact match is REQUIRED. {{empty}} 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 {{param|DHCPType}}. Note: DHCPv6 Option 1 (Client
Identifier) is sometimes referred to as ''DUID''.
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.
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 {{bibref|RFC2132}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 1 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. The option value is
binary, so an exact match is REQUIRED. {{empty}} 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 {{param|DHCPType}}. Note: DHCPv6 Option 1 (Client
Identifier) is sometimes referred to as ''DUID''.
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.
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 {{bibref|RFC3004}})
for {{enum|DHCPv4|DHCPType}}, or is Option 15 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. The option value is
binary, so an exact match is REQUIRED. {{empty}} 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 {{param|DHCPType}}.
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.
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 {{bibref|RFC3004}})
for {{enum|DHCPv4|DHCPType}}, or is Option 15 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. The option value is
binary, so an exact match is REQUIRED. {{empty}} 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 {{param|DHCPType}}.
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.
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
{{param|SourceVendorSpecificInfoEnterprise}} and
{{param|SourceVendorSpecificInfoSubOption}}. The DHCP Vendor-specific
Information is Option 125 (as defined in {{bibref|RFC3925}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 17 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. {{empty}} 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 {{param|DHCPType}}.
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.
{{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.
{{param|SourceVendorSpecificInfo}} Sub Option Code as defined in
{{bibref|RFC3925}}.
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
{{param|DestVendorSpecificInfoEnterprise}} and
{{param|DestVendorSpecificInfoSubOption}}. The DHCP Vendor-specific
Information is Option 125 (as defined in {{bibref|RFC3925}}) for
{{enum|DHCPv4|DHCPType}}, or is Option 17 (as defined in
{{bibref|RFC3315}}) for {{enum|DHCPv6|DHCPType}}. {{empty}} 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 {{param|DHCPType}}.
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.
{{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.
{{param|DestVendorSpecificInfo}} Sub Option Code as defined in
{{bibref|RFC3925}}.
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.
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.
Classification criterion. Minimum IP Packet Length (including header)
in bytes.
Classification criterion. Maximum IP Packet Length (including header)
in bytes. A value of zero indicates that no maximum is specified (an
umlimited maximum length).
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}}.
Classification criterion. DiffServ codepoint (defined in
{{bibref|RFC2474}}). If set to a Class Selector Codepoint (defined in
{{bibref|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.
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.
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 {{bibref|TR-181i2|Annex A}}.
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.
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.
Classification result. Ethernet priority code (as defined in
{{bibref|802.1Q-2011}}) to mark traffic with that falls into this
classification entry associated with the
{{param|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 {{bibref|TR-181i2|Annex A}}.
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.
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.
Classification result. Ethernet priority code to mark traffic with
that falls into this classification entry associated with the
{{param|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 {{bibref|TR-181i2|Annex A}}.
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.
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.
Classification criterion. Current Ethernet VLAN ID as defined in
802.1Q. A value of -1 indicates this criterion is not used for
classification.
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.
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.
Classification result. Identifier of the forwarding policy associated
with traffic that falls in this classification.
Classification result. Identifier of the traffic class associated
with traffic that falls in this classification. If specified, at
least one {{object|#.Queue}} table entry MUST include this traffic
class in its {{param|#.Queue.{i}.TrafficClasses}} parameter (which is
a comma-separated list). A value of -1 indicates a null traffic
class. {{param}} and {{param|App}} are mutually exclusive and one of
the two MUST be specified. If {{param}} is {{null}}, {{param|App}}
MUST be specified, and vice versa.
Classification result. {{reference}} Indicates the ''Policer'' table
entry for traffic that falls in this classification. {{empty}}
indicates a null policer. {{param}} MAY optionally be specified in
conjunction with {{param|TrafficClass}}. {{param}} and {{param|App}}
are mutually exclusive.
Classification result. {{reference}} Indicates the ''App'' table
entry for traffic that falls in this classification. {{empty}}
indicates a null ''App''. {{param|TrafficClass}} and {{param}} are
mutually exclusive and one of the two MUST be specified. If
{{param|TrafficClass}} is null, {{param}} MUST be specified, and vice
versa.
Application table.
Enables or disables this App table entry.
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.
{{datatype|expand}}
URN identifying the protocol associated with the given application. A
set of defined URNs is given in {{bibref|TR-181i2|Annex A}}.
Human-readable name associated with this entry in the App table.
Identifier of the forwarding policy associated with traffic
associated with this App table entry, but not associated with any
specified flow.
Identifier of the traffic class associated with traffic associated
with this App table entry, but not associated with any specified
flow.
{{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.
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 {{bibref|TR-181i2|Annex A}}.
Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark
traffic associated with this App table entry, but not associated with
any specified flow. A value of -1 indicates no change from the
incoming packet. A value of -2 indicates automatic marking of
EthernetPriority based upon the DSCP value of the incoming packet as
defined in {{bibref|TR-181i2|Annex A}}.
Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark
the inner VLAN Tags as defined in 802.1Q with this {{object}} 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
{{bibref|TR-181i2|Annex A}}.
Flow table.
Enables or disables this Flow table entry.
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.
{{datatype|expand}}
URN identifying the type of flow to be associated with the specified
policer. A set of defined URNs is given in {{bibref|TR-181i2|Annex
A}}.
List of name-value pairs representing additional criteria to identify
the flow type. The use and interpretation is specific to the
particular FlowType URN.Encoded using the "x-www-form-urlencoded"
content type defined in {{bibref|HTML4.01}}.
Human-readable name associated with this entry in the Flow table.
{{reference}} Indicates the ''App'' table entry associated with this
flow. {{empty}} indicates the flow table is not associated with any
App table entry.
Identifier of the forwarding policy associated with this flow.
Identifier of the traffic class associated with this flow.
{{reference}} Indicates the ''Policer'' table entry for traffic that
falls in this flow. {{empty}} indicates a null policer.
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 {{bibref|TR-181i2|Annex A}}.
Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark
traffic with that falls into this flow. A value of -1 indicates no
change from the incoming packet. A value of -2 indicates automatic
marking of EthernetPriority based upon the DSCP value of the incoming
packet as defined in {{bibref|TR-181i2|Annex A}}.
Ethernet priority code (as defined in {{bibref|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
{{bibref|TR-181i2|Annex A}}.
Policer table.
Enables or disables this policer.
The status of this policer. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
Committed rate allowed for this policer in {{units}}.
Committed Burstsize in bytes.
Excess Burstsize in bytes. Applied for a
{{enum|SingleRateThreeColor|MeterType}} meter.
Peak rate allowed for this Meter in {{units}}. Applied for
{{enum|TwoRateThreeColor|MeterType}} meters.
Peak Burstsize in bytes. Applied for
{{enum|TwoRateThreeColor|MeterType}} meters.
Identifies the method of traffic measurement to be used for this
policer. {{enum|SimpleTokenBucket}} makes use of
{{param|CommittedRate}} and {{param|CommittedBurstSize}}.
{{enum|SingleRateThreeColor}} makes use of {{param|CommittedRate}},
{{param|CommittedBurstSize}}, and {{param|ExcessBurstSize}} as
defined in {{bibref|RFC2697}}. {{enum|TwoRateThreeColor}} makes use
of {{param|CommittedRate}}, {{param|CommittedBurstSize}},
{{param|PeakRate}}, and {{param|PeakBurstSize}} as defined in
{{bibref|RFC2698}}.
{{list}} Indicates supported meter types.
Instructions for how to handle traffic that is conforming.
{{pattern}} {{pattern|Null}} corresponds with no action. ''<DSCP
Value>'' is an unsigned integer that corresponds with a mark
action overwriting the traffic's DSCP with the configured DSCP.
''<:Ethernet Priority>'' is a colon (":") followed by an
unsigned integer (no white space). It corresponds with a mark action
overwriting the traffic's Ethernet Priority with the configured
Ethernet Priority. ''<DSCP Value:Ethernet Priority>'' is an
unsigned integer followed by a colon (":") and a second unsigned
integer (no white space). It corresponds with a mark action
overwriting the traffic's DSCP and Ethernet Priority with the
configured values. For example, "24" specifies a DSCP value of 24,
":3" specifies an Ethernet Priority of 3, and "24:3" specifies both.
<DSCP Value>
<Ethernet Priority>
<DSCP Value:Ethernet Priority>
Instructions for how to handle traffic that is partially conforming
(colored yellow). {{pattern}} {{pattern|Null}} corresponds with no
action. ''<DSCP Value>'' is an unsigned integer that
corresponds with a mark action overwriting the traffic's DSCP with
the configured DSCP.Only applies for three-color meters.
''<:Ethernet Priority>'' is a colon (":") followed by an
unsigned integer (no white space). It corresponds with a mark action
overwriting the traffic's Ethernet Priority with the configured
Ethernet Priority. ''<DSCP Value:Ethernet Priority>'' is an
unsigned integer followed by a colon (":") and a second unsigned
integer (no white space). It corresponds with a mark action
overwriting the traffic's DSCP and Ethernet Priority with the
configured values. For example, "24" specifies a DSCP value of 24,
":3" specifies an Ethernet Priority of 3, and "24:3" specifies both.
<DSCP Value>
<Ethernet Priority>
<DSCP Value:Ethernet Priority>
Instructions for how to handle traffic that is non-conforming.
{{pattern}} {{pattern|Null}} corresponds with no action. ''<DSCP
Value>'' is an unsigned integer that corresponds with a mark
action overwriting the traffic's DSCP with the configured DSCP.
''<:Ethernet Priority>'' is a colon (":") followed by an
unsigned integer (no white space). It corresponds with a mark action
overwriting the traffic's Ethernet Priority with the configured
Ethernet Priority. ''<DSCP Value:Ethernet Priority>'' is an
unsigned integer followed by a colon (":") and a second unsigned
integer (no white space). It corresponds with a mark action
overwriting the traffic's DSCP and Ethernet Priority with the
configured values. For example, "24" specifies a DSCP value of 24,
":3" specifies an Ethernet Priority of 3, and "24:3" specifies both.
<DSCP Value>
<Ethernet Priority>
<DSCP Value:Ethernet Priority>
Total number of Packets counted by this policer, regardless of meter
action.
Total number of Bytes counted by this policer, regardless of meter
action.
Number of conforming Packets counted by this policer, regardless of
meter action.
Number of conforming Bytes counted by this policer, regardless of
meter action.
Number of partially conforming Packets counted by this policer,
regardless of meter action.
Number of partially conforming Bytes counted by this policer,
regardless of meter action.
Number of non-conforming Packets counted by this policer, regardless
of meter action.
Number of non-conforming Bytes counted by this policer, regardless of
meter action.
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}}.
Enables or disables this queue.
The status of this queue. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
{{list}} Each list item identifies the set of traffic classes
associated with this queue. Traffic is sent to this queue if a
{{object|#.Classification}}, {{object|#.App}} or {{object|#.Flow}}
table entry specifies a traffic class, e.g. via the
{{param|#.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.
{{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.
Indicates that the specified queue MUST exist for all egress
interfaces (i.e. this queue entry is to apply to all egress
interfaces). If {{true}}, the value of {{param|Interface}} is ignored
since all egress interfaces are indicated.
Indicates whether ''all'' the queues corresponding to this table
entry are hardware assisted. If any of the queues corresponding to
this table entry are not hardware assisted, the parameter value MUST
be {{false}}.
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.
Weight of this queue in case of {{enum|WFQ|SchedulerAlgorithm}} or
{{enum|WRR|SchedulerAlgorithm}}, but only used for queues of equal
precedence.
Precedence of this queue relative to others. Lower numbers imply
greater precedence.
Random Early Detection threshold, used only when
{{param|DropAlgorithm}} is {{enum|RED|DropAlgorithm}}. 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.
Random Early Detection percentage, used only when
{{param|DropAlgorithm}} is {{enum|RED|DropAlgorithm}}. 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.
Dropping algorithm used for this queue if congested.
Random Early Detection {{bibref|RED}}
Drop Tail
Weighted RED
{{bibref|BLUE}}
Scheduling Algorithm used by scheduler.
Weighted Fair Queueing
Weighted Round Robin
Strict Priority
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.
Burst size in bytes. For both leaky bucket (constant rate shaping)
and token bucket (variable rate shaping) this is the bucket size and
is therefore the maximum burst size.
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.
Enables or disables this object.
The status of this object.
Enabled and {Queue,Interface} is valid
Enabled but {Queue,Interface} is invalid
{{datatype|expand}}
{{reference}} Indicates ''Queue'' entry with which this object is
associated.
{{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.
Number of packets output through the queue.
Number of bytes output through the queue.
Number of packets dropped by the queue.
Number of bytes dropped by the queue.
Queue occupancy in packets (gives a measure of queue latency).
Queue occupancy measured as a {{units}}, i.e. 100 * queue occupancy
in bytes / queue size in bytes (gives a measure of queue usage).
Shaper table. Used to shape the queue(s) associated with
{{param|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
{{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}}. Note: The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables this shaper.
The status of this shaper. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
{{reference}}The interface object associated with this ''Shaper''
entry. It MAY be a layer 1, 2 or 3 interface, however, the types of
interfaces for which ''Shapers'' can be instantiated is a local
matter to the CPE.
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.
Burst size in bytes. For both leaky bucket (constant rate shaping)
and token bucket (variable rate shaping) this is the bucket size and
is therefore the maximum burst size.
This object contains generic device configuration information.
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
{{param|.UserInterface.PasswordUserSelectable}} is {{true}}.
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.
{{numentries}}
{{numentries}}
Host table.
{{datatype|expand}} This parameter was DEPRECATED because {{object}}
is a transient object. This parameter is OBSOLETED in 2.14.
Unique physical identifier of the host. For many layer 2 technologies
this is typically a MAC address.
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.
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. {{enum}} This parameter was
DEPRECATED because only {{enum|None}} and {{enum|DHCP}} made sense
(the CPE doesn't know whether the address is {{enum|Static}} or
{{enum|AutoIP}}). The {{enum|DHCP}} case is now handled via the
{{param|DHCPClient}} reference. This parameter is OBSOLETED in 2.14.
{{reference}} Each list item is the DHCPv4 or DHCPv6 server's client
entry that corresponds to the host.
DHCP lease time remaining in {{units}}. A value of -1 indicates an
infinite lease. The value MUST be 0 (zero) if the
{{param|AddressSource}} is not {{enum|DHCP|AddressSource}}. This
parameter was DEPRECATED because DHCP lease/lifetime information can
be accessed via the {{param|DHCPClient}} reference. This parameter is
OBSOLETED in 2.14.
{{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''
{{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''
{{reference}} If either the layer 3 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}}.
Type of physical interface through which this host is connected.
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 {{param|AddressSource}} is
{{enum|DHCP|AddressSource}}. {{empty}} 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 because host-supplied DHCP options can be
accessed via the {{param|DHCPClient}} reference. This parameter is
OBSOLETED in 2.14.
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
{{param|AddressSource}} is {{enum|DHCP|AddressSource}}. {{empty}}
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 because
host-supplied DHCP options can be accessed via the
{{param|DHCPClient}} reference. This parameter is OBSOLETED in 2.14.
A hexbinary string, User Class Identifier DHCP option (Option 77) of
the host. It MAY be defined when {{param|AddressSource}} is
{{enum|DHCP|AddressSource}}. {{empty}} 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 because host-supplied DHCP options can be
accessed via the {{param|DHCPClient}} reference.
The device's host name or {{empty}} if unknown.
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, {{param}} 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
{{object|WANStats}} statistics collected for the entry in the past
seven days.
The datetime when {{param|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 {{object|WANStats}} statistics collected for the entry in
the past seven days.
{{numentries}}
{{numentries}}
The host's known IPv4 addresses. This includes any addresses assigned
via DHCP, which can also be accessed via the {{param|#.DHCPClient}}
reference.
IPv4 address.
The host's known IPv6 addresses. This includes any addresses assigned
via DHCP, which can also be accessed via the {{param|#.DHCPClient}}
reference.
IPv6 address.
These count bytes or packets at the IP layer sent to the WAN, or
received from the WAN.
The total number of bytes transmitted to the WAN from the Host device
at the IP layer.
The total number of bytes received from the WAN and sent to the Host
device at the IP layer.
The total number of IP packets transmitted to the WAN from the Host
device.
The total number of IP packets received from the WAN and sent to the
Host device.
The total number of outbound IP packets to the WAN from the Host
device that could not be transmitted because of errors. These may be
due to the number of retransmissions exceeding the retry limit, or
from other causes.
The total number of transmitted IP packets to the WAN from the Host
device which were retransmissions. Two retransmissions of the same
packet results in this counter incrementing by two.
The total number of outbound IP packets which were chosen to be
discarded even though no errors had been detected to prevent their
being transmitted. One possible reason for discarding such a packet
could be to free up buffer space.
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.
{{datatype|expand}}
Unique physical identifier of the device. For many layer 2
technologies this is typically a MAC address.
Any user defined name for the device.
Enables or disables this {{object}} entry.
Allows or denies access for a device. If {{param}} is set to "Allow",
device access is allowed based on the {{object|Schedule}} objects.
Access is enabled if there is no {{object|Schedule}} object defined.
If {{param}} is set to "Deny", defined {{object|Schedule}} objects
are ignored and no access is allowed for the device.
{{numentries}}
Each instance of this object provides a schedule where access is
enabled.
{{datatype|expand}}
Enables or disables this {{object}} entry.
Comma-separated list of days which access is enabled. {{enum}}
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.
The duration, in {{units}}, which the access is enabled. If the
{{param|StartTime}} is not defined, duration is the total time access
is allowed during a calendar day. If a {{param|StartTime}} is
defined, access is allowed for the {{param}} period starting from
{{param|StartTime}}.
Properties for Domain Name Service (DNS).
The DNS record types that are supported by the device. {{enum}}
{{bibref|RFC1035}}
{{bibref|RFC3596}}
{{bibref|RFC2782}}
{{bibref|RFC1035}}
Client properties for Domain Name Service (DNS). The DNS client
resolves FQDN on behalf of device internal (client) applications.
Enables or disables the DNS client.
The status of the DNS client. {{enum}} The {{enum|Error}} value MAY
be used by the CPE to indicate a locally defined error condition.
{{numentries}}
This table contains the DNS Server IP address to be used by the DHCP
Client (it does ''not'' model a DNS Server). Entries are either
automatically created as result of DHCP (v4 or v6), IPCP, or RA
received DNS server information, or are statically configured by the
Controller.
Enables or disables this entry.
The status of this entry. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
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.
{{reference}} This parameter specifies the IP interface over which
the DNS query is sent. If {{empty}} is specified, the CPE MUST use
its routing policy (Forwarding table entries), if necessary, to
determine the appropriate interface. 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.
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}}.
Replaced by {{enum|DHCPv4}}.
DNS Relay object. The DNS proxy (or relay) function allows the
forwarding of local network DNS queries to local or external DNS
server(s) {{bibref|RFC5625}}.
Enables or disables the DNS Relay function.
The status of the DNS relay. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{numentries}}
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.
Enables or disables this entry.
The status of this entry. {{enum}} The {{enum|Error}} value MAY be
used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
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.
{{reference}} Specifies the IP interface over which the DNS query is
sent. If {{empty}} is specified, the CPE MUST use its routing policy
(IP Forwarding table entries), if necessary, to determine the
appropriate interface. 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.
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}}.
Replaced by {{enum|DHCPv4}}.
The DNS Diagnostics object containing the
{{object|NSLookupDiagnostics()}} test.
This command defines access to an IP-layer NS Lookup test for the
specified IP interface. When initiated, the NS Lookup test will
contact {{param|DNSServer}} and look up {{param|HostName}}
{{param|NumberOfRepetitions}} times. There will be a
{{object|Result}} instance for each time the device performs a DNS
lookup, which is determined by the value of
{{param|NumberOfRepetitions}}. Any previous {{object|Result}}
instances are removed when a new test is initiated.
{{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.
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.
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.
Timeout in {{units}} that indicates that a request has failed.
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.
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.
Unable to resolve DNSServer Name
Number of successfully executed repetitions.
Results from the most recent invocation of the test, one instance
per repetition.
Result Parameter to represent whether the NS Lookup was
successful or not.
Result parameter to represent whether the answer is
Authoritative or not.
Indicates that the NS Lookup failed to find the host.
Result parameter to represent the fully qualified name for the
Host Name in the calling parameter (e.g. HostName.DomainName);
if no response was provided, then this parameter is {{empty}}.
{{list}} Indicates the IP Address results returned by the NS
Lookup; if no response was provided, then this parameter is
{{empty}}.
Result parameter to represent the actual DNS Server IP address
that the NS Lookup used.
Response time (for the first response packet) in {{units}}, or
0 if no response was received.
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.
The parameter, when {{true}}, enables the discovery of DNS-SD
services hosted by other devices.
{{numentries}}
{{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.
The {{object}} table contains discovered DNS-SD services. DNS.SD
service information is provided in DNS RR SRV records
{{bibref|RFC2782}}. The Service Instance Name {{bibref|DNS-SD|Section
4.1 Structured Instance Names}} further specifies information about the
service name (RFC2782 Service field) and domain name (RFC2782 Name
field) in the form: Service Instance Name = <InstanceName> .
<Service> . <Domain> <Service> =
_<ApplicationProtocol> . _<TransportProtocol> RFC2782
Service field will always be equal to <InstanceName>.
<Service> RFC2782 Name field will always be equal to
<Domain> For example, an SSH service might have:
*{{param|InstanceName}} = "Secure Shell (SSH))"
*{{param|ApplicationProtocol}} = "ssh"
*{{param|TransportProtocol}} = "TCP"
*{{param|Domain}} = "example.com"
*{{param|Port}} = 22
*{{param|Target}} = "ssh.example.com."
Human-readable instance name {{bibref|DNS-SD|Section 4.1.1 Instance
Names}} (i.e. The "<{{param}}>" portion of the '"Service
Instance Name'").
The Application Protocol, without the leading underscore, associated
with the service (e.g., daap) as defined by the DNS-SD service
{{bibref|DNS-SD|Section 7 Application Protocol Names}}.
The Transport Protocol associated with the service as defined by the
DNS-SD service {{bibref|DNS-SD|Section 4.1.2 Service Names}}.
The value extracted from the Name field of the DNS SRV record
{{bibref|RFC2782}} which represents the fully qualified domain name
(FQDN) associated with the service as defined by the DNS-SD service
{{bibref|DNS-SD|Section 4.1.3 Domain Names}}.
The value extracted from the Port field of the DNS SRV record
{{bibref|RFC2782}} that is used to contact the service.
The fully qualified domain name (FQDN) with the trailing dot "." of
the target host implementing the service as in the DNS SRV record
{{bibref|RFC2782}}.
The status of the discovered {{object}} at {{param|LastUpdate}} time.
{{enum}} The ability to instantiate an inactive {{object}} is
OPTIONAL. The time an inactive {{object}} remains listed in this
table is a local matter to the device.
The {{object}} has received a response record with TTL > 0
and the {{param|#.Service.{i}.TimeToLive}} has not expired yet.
The {{object}} is considered active.
The device has received a response record containing TTL=0
indicating a goodbye message and the
{{param|#.Service.{i}.TimeToLive}} has not expired yet. The
{{object}} is considered inactive.
The {{param|#.Service.{i}.TimeToLive}} has expired. The
{{object}} is considered inactive
The date and time at which the last advertisement for this {{object}}
was received.
{{list}} {{reference|all Host table entries, active or inactive, that
correspond to this discovered DNS.SD service. As such, when entries
are added or removed from the Host tables the value of this parameter
MUST be updated accordingly|ignore}}
The value extracted from the TTL field of the DNS SRV record
{{bibref|RFC2782}}.
The value extracted from the Priority field of the DNS SRV record
{{bibref|RFC2782}}.
A server selection mechanism. The value extracted from the Weight
field of the DNS SRV record {{bibref|RFC2782}} that specifies the
relative weight for entries with the same {{param|Priority}}.
{{numentries}}
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.
The key that identifies the text record
The value of the text record.
Properties for Network Address Translation (NAT). The entire {{object}}
object only applies to IPv4.
{{numentries}}
{{numentries}}
NAT settings for an associated IP Interface on which NAT is enabled.
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}}. Note: The
{{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables the {{object}} entry, indicating if NAT is
enabled for the referenced IP Interface instance. On creation, an
{{object}} entry is disabled by default.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
NAT enabled but forced by a third party to be operationally
disabled, e.g. because a {{object|##.MAP.Domain}} is enabled
but there is no Basic Mapping Rule {{bibref|RFC7597}}.
NAT enabled but port mapping has been operationally disabled by
a third party, e.g. because this is REQUIRED by the current
{{object|##.Firewall}} level.
{{datatype|expand}}
{{reference}} The associated IP interface on which NAT is to be
enabled.
Determines the timeout, in {{units}}, of NAT translations for TCP
sessions. It is the time after which a NAT entry is removed from the
NAT table if there is no activity. A value of -1 represents an
infinite duration.
Determines the timeout, in {{units}}, of NAT translations for UDP
bindings. It is the time after which a NAT entry is removed from the
NAT table if there is no activity. A value of -1 represents an
infinite duration.
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
{{param|InternalClient}} is {{empty}}, or 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}}.
Enables or disables the port mapping instance. On creation, an entry
is disabled by default.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{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.
{{reference}} Specifies the IP interface to which this port mapping
applies.
Indicates whether this port mapping applies to all IP interfaces that
support port mappings. If {{true}}, the value of {{param|Interface}}
is ignored since all supported IP interfaces are indicated.
Determines the time to live, in {{units}}, of a port mapping lease,
where "time to live" means the number of {{units}} 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 {{param}} 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 {{object}} table entry.
This parameter is the IP address of the source of inbound packets.
{{empty}} indicates a "wildcard", i.e. any IP address (this will be
{{empty}} in most cases). CPE are REQUIRED only to support {{empty}}.
When {{param}} is {{empty}}, all traffic sent to the
{{param|ExternalPort}} on the WAN interface of the gateway is
forwarded to the {{object|.IP.Interface}} associated with the
{{param|InternalClient}} on the {{param|InternalPort}}. When
{{param}} is specified as one external IP address, the NAT will only
forward inbound packets from this {{param}} to the
{{param|InternalClient}}, all other packets will be dropped. If a CPE
supports non-empty values for {{param}}, it MAY additionally support
the ability to have more than one port mapping with the same
{{param|ExternalPort}} and {{param|Protocol}}, but with differing
values of {{param}}. When wildcard values are used for {{param}}
and/or {{param|ExternalPort}}, the following precedence order applies
(with the highest precedence listed first):
# Explicit {{param}}, explicit {{param|ExternalPort}}
# Explicit {{param}}, zero {{param|ExternalPort}}
# Empty {{param}}, explicit {{param|ExternalPort}}
# Empty {{param}}, zero {{param|ExternalPort}} If an incoming packet
matches the criteria associated with more than one entry in this
table, the CPE MUST apply the port mapping associated with the
highest precedence entry.
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
{{param|InternalPort}}. Inbound packets to this external port on the
WAN interface SHOULD be forwarded to the {{object|.IP.Interface}}
associated with the {{param|InternalClient}} on the
{{param|InternalPort}}. A value of zero ({{null}}) represents a
"wildcard", i.e. any port number. If this value is {{null}}, traffic
on all external ports (that are not otherwise mapped) will be
forwarded to {{param|InternalClient}}, and the value(s) of
{{param|InternalPort}} on {{param|InternalClient}} are ignored. When
wildcard values are used for {{param|RemoteHost}} and/or {{param}},
the following precedence order applies (with the highest precedence
listed first):
# Explicit {{param|RemoteHost}}, explicit {{param}}
# Explicit {{param|RemoteHost}}, zero {{param}}
# Empty {{param|RemoteHost}}, explicit {{param}}
# Empty {{param|RemoteHost}}, zero {{param}} If an incoming packet
matches the criteria associated with more than one entry in this
table, the CPE MUST apply the port mapping associated with the
highest precedence entry.
Indicates the last port of the external port range that starts with
{{param|ExternalPort}}. If an external port range is specified, then
the behavior described for {{param|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 {{param|ExternalPort}}. If {{param|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 {{param|ExternalPort}}.
The port on {{param|InternalClient}} that the gateway SHOULD forward
traffic to.
The protocol of the port mapping. {{enum}}
The IP address or DNS host name of an internal client (on the LAN).
Support for an IP address is mandatory. If {{param}} 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 {{param}} 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 {{object|.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 {{param}} 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.
User-readable description of this port mapping.
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.
{{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}}.
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}}.
{{list}} The list of the PCP Options supported by the PCP Client.
{{numentries}}
Client properties for Port Control Protocol (PCP). The PCP Client
interacts with a PCP Server as defined in {{bibref|RFC6887}} for
internal device applications or LAN device applications via
Interworking functions.
Enables or disables the PCP Client.
{{datatype|expand}}
{{reference|the interface stack instance representing the WAN
interface this client operates on}} See {{object|.InterfaceStack.}}
The status of the PCP Client. {{enum}} The {{enum|Error}} value MAY
be used by the CPE to indicate a locally defined error condition.
Enables or disables the MAP OpCode.
Enables or disables the PEER OpCode.
Enables or disables the ANNOUNCE OpCode. When {{false}} the PCP
Client does not support unsolicited ANNOUNCE messages.
Enables or disables the THIRD_PARTY Option.
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.
Enables or disables the FILTER option.
{{numentries}}
Properties for the Port Control Protocol (PCP) Proxy, as specified in
{{bibref|PCPProxy}}.
Enables or disables the PCP Proxy for this PCP Client.
A string identifying the highest version of PCP that the proxy
supports. This parameter is based on Version from {{bibref|RFC6887}}.
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.
Properties for the interworking function between UPnP IGD (Internet
Gateway Device) and PCP, as specified in {{bibref|RFC6970}}.
Enables or disables the UPnP IGD-PCP Interworking Function for this
PCP Client.
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.
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.
Enables or disables this PCP Server.
The status of the PCP Server. {{enum}} The {{enum|Error}} value MAY
be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
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.
{{param|ServerNameOrAddress}} is an IPv4 address that was
received via OPTION_V4_PCP_SERVER
{{param|ServerNameOrAddress}} is an IPv6 address that was
received via OPTION_V6_PCP_SERVER
{{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6
address that was created by the Controller, by some other
management entity (e.g. via a GUI), or is present in the
factory default configuration
The FQDN or IP address of the PCP Server, assigned as described under
{{param|Origin}}.
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.
PCP Server addresses in addition to {{param|ServerNameOrAddress}}.
This can be non-empty only if {{param|Origin}} is
{{enum|DHCPv4|Origin}} or {{enum|DHCPv6|Origin}} and if more than one
PCP Server address was received.
The external IP address of the PCP-controlled device hosting this
server.
This is the version of PCP resulting from client-server Version
Negotiation. This parameter is based on Version from
{{bibref|RFC6887}}.
Indicates the maximum number of inbound filters allowed to be
associated with a mapping entry on this server.
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 preferred lifetime (in {{units}}) to be used for
mappings with this server when no preference is selected by an
application/user.
Indicates the capabilities supported by the PCP Server. {{enum}}
{{numentries}}
{{numentries}}
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
{{bibref|RFC6887|Section 11}}. 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 {{param|Origin}} parameter indicates which mechanism
requested the mapping. For non-{{enum|Static|Origin}} mappings (here
''Static'' refers to the mechanism that created the mapping, not to the
{{param|Lifetime}}), the Controller MAY modify the {{param|Enable}}
parameter but MUST NOT modify any other parameters in the mapping or
its sub-objects.
Enables or disables this {{object}} instance.
The status of this entry. {{enum}} The
{{enum|Error_PCPErrorCodeReceived}} value indicates that the PCP
Client received an error code from the PCP Server. The {{enum|Error}}
value MAY be used by the CPE to indicate a locally defined error
condition.
Provides the PCP error code when {{param|Status}} is
{{enum|Error_PCPErrorCodeReceived|Status}}. Error code values are
defined in {{bibref|RFC6887|Section 7.4}}.
{{datatype|expand}}
Mechanism via which the mapping was requested. {{enum}}
Requested via internal device application
Requested via UPnP IGD interworking function
Requested via PCP proxy
Requested via static configuration, i.e. created by the
Controller, by some other management entity (e.g. via a GUI),
or is present in the factory default configuration
Determines the time to live, in {{units}}, 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 {{bibref|RFC6887}}). When a dynamic Inbound Mapping
lease expires, the CPE MUST automatically delete the corresponding
{{object}} table entry.
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 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.
Indicates the last port of the external port range that starts with
{{param|SuggestedExternalPort}}. If an external port range is
specified, then the behavior described for
{{param|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
{{param|SuggestedExternalPort}}. If {{param|SuggestedExternalPort}}
is zero (wildcard), the value of {{param}} MUST be ignored. If
specified, the value of this parameter MUST be zero or be greater
than or equal to the value of {{param|SuggestedExternalPort}}.
The port on this PCP Client's {{param|##.WANInterface}} that the
PCP-controlled device forwards incoming packets to.
The protocol number of the {{object}}. Values are taken from
{{bibref|IANA-protocolnumbers}}. The value -1 means ''all
protocols''.
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}}.
User-readable description of this {{object}}.
The external IPAddress returned by the PCP Server. The IP address
that the PCP-controlled device is listening on for incoming packets
to a corresponding PCP Client.
The external port returned by the PCP Server. The external port (or
the first port of a range of external ports) that the PCP-controlled
device is listening on for incoming packets to a corresponding
{{param|InternalPort}}. Inbound packets to this external port on the
External interface of the PCP-controlled device is forwarded to the
on the {{param|InternalPort}}.
Indicates the last port of the external port range that starts with
{{param|AssignedExternalPort}}. If an external port range is
specified, then the behavior described for
{{param|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
{{param|AssignedExternalPort}}.
{{numentries}}
Filter table. This table contains all Filters restricting this Inbound
Mapping, as defined in {{bibref|RFC6887|}}.
{{datatype|expand}}
Permitted remote peer IP address for this filter.
Indicates how many bits of {{param|RemoteHostIPAddress}} are relevant
for this filter.
Permitted remote peer port number for this filter. The value 0
indicates ''all ports''.
Indicates the last port of the remote port range that starts with
{{param|RemotePort}}. If an external port range is specified, then
the behavior described for {{param|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
{{param|RemotePort}}.
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
{{bibref|RFC6887|Section 12}}. 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 {{param|Origin}} parameter indicates which mechanism
requested the mapping. For non-{{enum|Static|Origin}} mappings (here
''Static'' refers to the mechanism that created the mapping, not to the
{{param|Lifetime}}), the Controller MAY modify the {{param|Enable}}
parameter but MUST NOT modify any other parameters in the mapping or
its sub-objects.
Enables or disables this {{object}} instance.
The status of this entry. {{enum}} The
{{enum|Error_PCPErrorCodeReceived}} value indicates that the PCP
Client received an error code from the PCP Server. The {{enum|Error}}
value MAY be used by the CPE to indicate a locally defined error
condition.
Provides the PCP Error code when {{param|Status}} is
{{enum|Error_PCPErrorCodeReceived|Status}}. Error code values are
defined in {{bibref|RFC6887|Section 7.4}}.
{{datatype|expand}}
Mechanism via which the mapping was requested. {{enum}}
Requested via internal device application
Requested via UPnP IGD interworking function
Requested via PCP proxy
Requested via static configuration, i.e. created by the
Controller, by some other management entity (e.g. via a GUI),
or is present in the factory default configuration
Determines the time to live, in {{units}}, 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 {{bibref|RFC6887}}). When a dynamic Outbound
Mapping lease expires, the CPE MUST automatically delete the
corresponding {{object}} table entry.
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 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 remote peer's IP address, as seen from the PCP Client, for this
Outbound Mapping.
The port on PCP Client WAN Interface that the PCP-controlled device
SHOULD listen to for this mapping.
The remote peer's port, as seen from the PCP Client, for this
Outbound Mapping.
The protocol number of the {{object}}. Values are taken from the
{{bibref|IANA-protocolnumbers}}. The value -1 means ''all
protocols''.
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}}.
User-readable description of this {{object}}.
The external IP address returned by the PCP Server. The IP address
that the PCP-controlled device uses to send outgoing packets
corresponding to this mapping.
The external port returned by the PCP Server. The port that the
PCP-controlled device uses to send outgoing packets corresponding to
this mapping.
The Dynamic Host Configuration Protocol (DHCP) IPv4 object
{{bibref|RFC2131}}. This entire object applies to IPv4 only. It
contains the {{object|Client}}, {{object|Server}}, and {{object|Relay}}
objects.
{{numentries}}
This object contains DHCP client settings for an associated ''IP
Interface'' indicated by {{param|Interface}}. 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}}. Note: The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables the DHCP Client entry.
{{datatype|expand}}
{{reference}} The IP Interface associated with the ''Client'' entry.
The status of this table entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
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}}).
The DHCP client will renew its DHCP lease.
IPv4 Address option received from the DHCP Server. {{empty}} when
{{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}.
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.
{{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.
{{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.
DHCP lease time remaining in {{units}}. A value of -1 indicates an
infinite lease.
The IPv4 address of the current DHCP server.
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'').
{{reference}}When {{param}} is set to {{empty}},
{{param|PassthroughEnable}} MUST be set to {{false}} (i.e.
passthrough can not be enabled without a pool reference specified).
{{numentries}}
{{numentries}}
Each instance of this object represents a DHCP option that MUST, if
enabled, be sent in DHCP client requests. All sent DHCP options MUST be
listed.
Enables or disables this SentOption table entry.
{{datatype|expand}}
Option tag as defined in {{bibref|RFC2132}}.
A hexbinary encoded option value.
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.
Enables or disables this ReqOption table entry.
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 {{param}} value for the
existing entry and all lower {{param}} entries is incremented to
ensure uniqueness of this value. A deletion causes {{param}} values
to be compacted. When a value is changed, incrementing occurs before
compaction. The value of {{param}} on creation of a {{object}} table
entry MUST be one greater than the largest current value.
{{datatype|expand}}
Option tag as defined in {{bibref|RFC2132}}.
A hexbinary encoded, most recently received DHCP option value. If no
option value has been received, then the value MUST represent
{{empty}}. Received DHCP option values MAY, but need not, persist
across CPE reboots.
DHCP server configuration.
Enables or disables the DHCP server.
{{numentries}}
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 {{param|Interface}} is not a valid
reference, or {{param|MinAddress}}, {{param|MaxAddress}}, or
{{param|SubnetMask}} is not a valid value, then the table entry is
inoperable and the CPE MUST set {{param|Status}} to
{{enum|Error_Misconfigured|Status}}.
Enables or disables the Pool entry.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
Position of the {{object}} 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 {{param}} value for the existing entry and all lower
{{param}} entries is incremented (lowered in precedence) to ensure
uniqueness of this value. A deletion causes {{param}} values to be
compacted. When a value is changed, incrementing occurs before
compaction. The value of {{param}} on creation of a {{object}} table
entry MUST be one greater than the largest current value (initially
assigned the lowest precedence).
{{reference}} The IP Interface associated with the ''Pool'' entry.
Pool association criterion. Used to identify one or more LAN devices,
value of the DHCP Vendor Class Identifier (Option 60) as defined in
{{bibref|RFC2132}}, matched according to the criterion in
{{param|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.
{{empty}} indicates this criterion is not used for conditional
serving.
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.
{{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}}.
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 {{bibref|RFC2132}}. The option value is binary, so an
exact match is REQUIRED. {{empty}} indicates this criterion is not
used for conditional serving.
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.
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 {{bibref|RFC3004}}. {{empty}} indicates this
criterion is not used for conditional serving.
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.
Pool association criterion. Hardware address (MAC address) of the
physical interface of the DHCP client. {{empty}} indicates this
criterion is not used for conditional serving.
Bit-mask for the MAC address, where matching of a packet's MAC
address with the {{param|Chaddr}} is only to be done for bit
positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or
{{empty}} indicates all bits of the {{param|Chaddr}} are to be used
for conditional serving classification.
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.
Pool association criterion. Determines which devices are allowed,
{{enum}}
All clients are served.
Only clients, whose MAC address is listed in the
{{object|Client.{i}.}} table (parameter
{{param|Client.{i}.Chaddr}}) or in the
{{object|StaticAddress.{i}.}} table (parameter
{{param|StaticAddress.{i}.Chaddr}}) are served. The parameter
{{param|#.Chaddr}} is not used, if this value is set.
Only clients, whose MAC address is '''not''' listed in the
{{object|Client.{i}.}} table (parameter
{{param|Client.{i}.Chaddr}}) or in the
{{object|StaticAddress.{i}.}} table (parameter
{{param|StaticAddress.{i}.Chaddr}}) are served.
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 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}}.
{{list}} List items represent addresses marked reserved from the
address allocation pool.
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}}.
{{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}}.
Sets the domain name to provide to clients on the LAN interface.
{{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}}.
Specifies the lease time in {{units}} of client assigned addresses. A
value of -1 indicates an infinite lease.
{{numentries}}
{{numentries}}
{{numentries}}
DHCP static address table. Entries in this table correspond to what
{{bibref|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.
Enables or disables the StaticAddress table entry. Disabling an entry
does not return the IP address to the pool.
{{datatype|expand}}
Hardware address (MAC address) of the physical interface of the DHCP
client.
IPv4 address to be assigned by the DHCP server to the DHCP client
with the specified hardware address (MAC address).
This object specifies the DHCP options that MUST, if enabled, be
returned to clients whose DHCP requests are associated with this pool.
Enables or disables this Option table entry.
{{datatype|expand}}
Option tag as defined in {{bibref|RFC2132}}.
A hexbinary encoded option value.
DHCPv4 client table. This table lists details of DHCPv4 clients that
matched the filter criteria of this {{object|#}} entry.
{{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.
MAC address of the DHCPv4 client.
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.
{{numentries}}
{{numentries}}
IPv4 addresses assigned to this client.
IPv4 address.
The time at which the DHCP lease will expire or {{null}} if not
known. For an infinite lease, the parameter value MUST be
9999-12-31T23:59:59Z.
DHCPv4 options supplied by this client, e.g. ''VendorClassID'' (Option
60), ''ClientID'' (option 61) or ''UserClassID'' (Option 77).
Option tag as defined in {{bibref|RFC2132}}.
A hexbinary encoded option value.
DHCP Relay Agent (conditional relaying).
Enables or disables the DHCP Relay Agent function.
The status of the DHCP relay. {{enum}} The {{enum|Error}} value MAY
be used by the CPE to indicate a locally defined error condition.
{{numentries}}
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}}.
Enables or disables the Forwarding entry.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
Position of the {{object}} 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 {{param}} value for the existing entry and all lower
{{param}} entries is incremented (lowered in precedence) to ensure
uniqueness of this value. A deletion causes {{param}} values to be
compacted. When a value is changed, incrementing occurs before
compaction. The value of {{param}} on creation of a {{object}} table
entry MUST be one greater than the largest current value (initially
assigned the lowest precedence).
{{reference}} The IP Interface associated with the ''Forwarding''
entry.
Pool association criterion. Used to identify one or more LAN devices,
value of the DHCP Vendor Class Identifier (Option 60) as defined in
{{bibref|RFC2132}}, matched according to the criterion in
{{param|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.
{{empty}} indicates this criterion is not used as a relay
classification criterion.
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.
{{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}}.
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 {{bibref|RFC2132}}. The option value is binary, so an
exact match is REQUIRED. {{empty}} indicates this criterion is not
used as a relay classification criterion.
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.
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 {{bibref|RFC3004}}. {{empty}} indicates this
criterion is not used as a relay classification criterion.
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.
Pool association criterion. Hardware address (MAC address) of the
physical interface of the DHCP client. {{empty}} indicates this
criterion is not used as a relay classification criterion.
Bit-mask for the MAC address, where matching of a packet's MAC
address with the {{param|Chaddr}} is only to be done for bit
positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or
{{empty}} indicates all bits of the {{param|Chaddr}} are to be used
for relay classification.
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.
If {{true}}, incoming DHCP requests will be forwarded to the CPE DHCP
Server. If {{false}}, incoming DHCP requests will be forwarded to the
{{param|DHCPServerIPAddress}} configured for this forwarding entry.
IPv4 address of the DHCP server, where the request has to be sent to
when there is a conditional match with this forwarding entry and
{{param|LocallyServed}} is {{false}}. If {{param|LocallyServed}} is
{{false}} and this parameter is not configured, then the DHCP request
is dropped.
The Dynamic Host Configuration Protocol (DHCP) IPv6 object
{{bibref|RFC3315}}. This entire object applies to IPv6 only. It
contains the {{object|Client}} and {{object|Server}} objects.
{{numentries}}
This object contains DHCPv6 client settings for an associated ''IP
Interface'' indicated by {{param|Interface}}. For enabled table
entries, if {{param|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 {{param|Status}} to
{{enum|Error_Misconfigured|Status}}. Note: The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
Enables or disables this {{object}} entry.
{{datatype|expand}}
{{reference}} The IP Interface associated with the {{object}} entry.
This will reference an IPv6-capable interface (that is attached to
the IPv6 stack), otherwise the table entry will be inoperable.
The status of this table entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
The client's DHCP Unique Identifier (DUID) {{bibref|RFC3315|Section
9}}. {{param}} is set by the CPE.
Enables or disables inclusion of the ''Identity Association (IA) for
Non-Temporary Address'' option OPTION_IA_NA(3)
{{bibref|RFC3315|Section 22.4}} in Solicit messages.
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 ''Rapid Commit'' option
OPTION_RAPID_COMMIT(14) {{bibref|RFC3315|Section 22.14}} in Solicit
messages.
The {{object}} will renew its DHCPv6-supplied information (i.e. the
Agent will do a renew or information request as needed, updating both
stateful and stateless parameter values discovered by this Client
instance).
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.
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.
{{list}} The options that the client is able to process in server
responses. This list MUST include both top-level and encapsulated
options, e.g. if the client is able to process OPTION_IA_NA (3) with
an encapsulated OPTION_IAADDR (5), the list would be expected to
include both 3 and 5.
{{list}} 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 {{bibref|RFC3646}} but is not appropriate for
OPTION_SERVERID (which is part of the protocol), OPTION_IA_NA (which
is modeled via {{param|RequestAddresses}}) or OPTION_IA_PD (which is
modeled via {{param|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
{{bibref|RFC3315}} but the client is free to decide (in accordance
with {{bibref|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 {{param|SupportedOptions}}.
{{numentries}}
{{numentries}}
{{numentries}}
This is a transitory table that lists the discovered DHCPv6 servers (it
does ''not'' model a local DHCP server). Table entries are
automatically created to correspond with these servers. However, it is
a local matter to the CPE when to delete old table entries.
The IP address from which the message most recently received from
this server was sent.
The server's DHCP Unique Identifier (DUID) {{bibref|RFC3315|Section
9}} as received via OPTION_SERVERID.
The OPTION_INFORMATION_REFRESH_TIME value {{bibref|RFC4242}} that was
most recently received from this server, converted to the
''dateTime'' at which the associated information will expire. If no
such option has been received, the parameter value MUST be the
"Unknown Time" {{null}}. If the information will never expire, the
parameter value MUST be infinite time 9999-12-31T23:59:59Z.
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}}).
Enables or disables this {{object}} entry.
{{datatype|expand}}
Option tag (code) {{bibref|RFC3315|Section 22.1}}.
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}}.
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.
Option tag (code) {{bibref|RFC3315|Section 22.1}}.
A hexbinary encoded option data {{bibref|RFC3315|Section 22.1}}.
{{reference}} This is the server that sent the option to the client.
Each {{object}} entry MUST have an associated server.
DHCPv6 server configuration.
Enables or disables the DHCPv6 server function.
{{numentries}}
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 {{param|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 {{param|Status}} to
{{enum|Error_Misconfigured|Status}}.
Enables or disables this {{object}} entry.
The status of this entry. {{enum}} The {{enum|Error_Misconfigured}}
value indicates that a necessary configuration value is undefined or
invalid. The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
Position of the {{object}} 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 {{param}} value for the existing entry and all lower
{{param}} entries is incremented (lowered in precedence) to ensure
uniqueness of this value. A deletion causes {{param}} values to be
compacted. When a value is changed, incrementing occurs before
compaction. The value of {{param}} on creation of a {{object}} table
entry MUST be one greater than the largest current value (initially
assigned the lowest precedence).
{{reference}} The IP Interface associated with the {{object}} entry.
Pool association criterion. A hexbinary string used to identify one
or more LAN devices, value of the DHCPv6 Client Identifier (Option 1)
{{bibref|RFC3315|Section 22.2}}. The option value is binary, so an
exact match is REQUIRED. {{empty}} indicates this criterion is not
used. Note: DHCPv6 Option 1 (DUID) is sometimes referred to as
''Client Identifier''.
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.
Pool association criterion. A hexbinary string used to identify one
or more LAN devices, value of the DHCPv6 Vendor Class Identifier
(Option 16) {{bibref|RFC3315|Section 22.16}}. The option value is
binary, so an exact match is REQUIRED. {{empty}} indicates this
criterion is not used.
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.
Pool association criterion. A hexbinary string used to identify one
or more LAN devices, value of the DHCPv6 User Class Identifier
(Option 15) {{bibref|RFC3315|Section 22.15}}. {{empty}} indicates
this criterion is not used.
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.
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. {{empty}}
indicates this criterion is not used for serving.
Bit-mask for the source address, where matching of a packet's source
address with the {{param|SourceAddress}} is only to be done for bit
positions set to one in the mask. A mask of {{empty}} indicates all
bits of the {{param|SourceAddress}} are to be used.
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.
Enables or disables IANA offers.
{{list}} {{reference}} Manually-configured prefixes from which IA_NA
addresses will be assigned. Each referenced prefix MUST have a
{{param|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}} of
{{enum|Static|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}} or
{{enum|Child|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}}. All
clients that request IA_NA and match filter criteria on this
{{param|Interface}} MUST be offered IA_NA addresses from all of the
''Valid'' ({{param|.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
{{param|Interface}}.
{{list}} {{reference}} All prefixes from which IA_NA addresses will
be assigned. This list can include:
* Prefixes from {{param|IANAManualPrefixes}} that are used for IA_NA
offers.
* Prefixes with {{param|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} =
{{enum|Child|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} or
{{enum|AutoConfigured|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}
associated with the interface instance referenced by
{{param|Interface}}.
Enables or disables IAPD offers.
{{list}} {{reference}} Manually-configured prefixes from which IA_PD
prefixes will be derived. This list can include:
* Prefixes with {{param|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} =
{{enum|Static|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} or
{{enum|PrefixDelegation|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}
associated with upstream interfaces (i.e. interfaces for which the
physical layer interface object has ''Upstream'' = {{true}}).
* Prefixes with {{param|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}}
= {{enum|Static|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}} or
{{enum|Child|.IP.Interface.{i}.IPv6Prefix.{i}.StaticType}}
associated with with the interface instance referenced by
{{param|Interface}}. All clients that request IA_PD and match
filter criteria on this {{param|Interface}} MUST be offered IA_PD
prefixes derived from all of the ''Valid''
({{param|.IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime}} is
infinite or in the future) prefixes in this list.
{{list}} {{reference}} All prefixes for which IA_PD prefixes will be
assigned. This list can include:
* Prefixes from {{param|IAPDManualPrefixes}} that are used for IA_PD
offers.
* Prefixes with {{param|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} =
{{enum|PrefixDelegation|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}
or {{enum|AutoConfigured|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}
associated with upstream interfaces (i.e. interfaces for which the
physical layer interface object has ''Upstream'' = {{true}}).
* Prefixes with {{param|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} =
{{enum|Child|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} or
{{enum|AutoConfigured|.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}
associated with the interface instance referenced by
{{param|Interface}}.
The RECOMMENDED minimum number of bits to add to
{{param|IAPDManualPrefixes}} or {{param|IAPDPrefixes}} in order to
determine the length of prefixes that are offered in an IA_PD. The
device is responsible for ensuring that it does not delegate a prefix
longer than /64. The device can have additional logic that is used
(in conjunction with this parameter) to determine the actual length
of prefixes offered in an IA_PD.
{{numentries}}
{{numentries}}
DHCPv6 client table. This table lists details of DHCPv6 clients that
matched the filter criteria of this {{object|#}} entry.
{{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.
Source address of the DHCPv6 client.
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.
{{numentries}}
{{numentries}}
{{numentries}}
IPv6 addresses assigned to this client via IA_NA.
IPv6 address.
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.
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.
IPv6 prefixes delegated to this client via IA_PD.
IPv6 address prefix.
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.
The time at which this prefix 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.
DHCPv6 options supplied by this client, e.g. ''DUID'' (Option 1),
''UserClassID'' (Option 15) or ''VendorClassID'' (option 16).
Option tag (code) {{bibref|RFC3315|Section 22.1}}.
A hexbinary encoded option value.
This object specifies the DHCPv6 options that MUST, if enabled, be
offered to clients whose DHCPv6 requests are associated with this pool.
If {{param|PassthroughClient}} is specified, and the referenced client
has a value for a given option then the {{param|PassthroughClient}}
option value will be sent instead of {{param|Value}}. Otherwise,
{{param|Value}} will be sent.
Enables or disables this {{object}} entry.
{{datatype|expand}}
Option tag (code) {{bibref|RFC3315|Section 22.1}}.
A hexbinary encoded option value.
{{reference}} Indicates whether this {{object}} entry is configured
for passthrough. If {{param}} is specified, and the referenced client
(since boot) has received a value from an associated upstream DHCPv6
server for the given {{param|Tag}} option, then the referenced
client's option value will be sent instead of {{param|Value}}.
Otherwise, {{param|Value}} will be sent. {{empty}} indicates that
passthrough is not configured for this {{object}} entry.
IEEE 802.1x object {{bibref|802.1x-2004}}, where {{object|Supplicant}}
models authentication supplicants.
{{numentries}}
802.1x supplicant authentication provisioning and status information
associated with an interface to be authenticated (e.g. an
{{object|.Ethernet.Link}} instance). 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}}. Note: The {{object}} 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 {{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 set
{{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the
offending {{object}} row.
This parameter controls whether this resource will utilize the 802.1x
protocol as a supplicant for device authentication purposes.
The current operational status of this 802.1x supplicant. {{enum}}
The {{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
{{reference}} The interface on which authentication is to be
performed. Example: Device.Ethernet.Link.1
The current supplicant state machine as defined in
{{bibref|802.1x-2004|9.5.1}}, Supplicant PAE (Port Access Entity)
State. {{enum}}
The identity to be exchanged between the supplicant and
authenticator.
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 period in {{units}} a supplicant will wait before the device will
attempt to re-send an EAP start message as defined in
{{bibref|802.1x-2004|9.5.1}}, startPeriod.
The hold-off period in {{units}} a supplicant will wait before
re-attempting authentication as defined in
{{bibref|802.1x-2004|9.5.1}}, heldPeriod.
The period in {{units}} after which a request will be considered
timed out as defined in {{bibref|802.1x-2004|9.5.1}}, authPeriod.
{{list}} Indicates the authentication methods supported by the
device. {{enum}}
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 succeeds and a connection
has already received an address and/or policy settings. {{enum}}
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 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.
802.1x Authentication Supplicant EAP statistics information for this
resource.
The number of EAPOL frames of any type that have been received by
this Supplicant; {{bibref|802.1x-2004|9.5.2}}, EAPOL frames received.
The number of EAPOL frames of any type that have been transmitted by
this Supplicant; {{bibref|802.1x-2004|9.5.2}}, EAPOL frames
transmitted.
The number of EAPOL Start frames that have been transmitted by this
Supplicant; {{bibref|802.1x-2004|9.5.2}}, EAPOL Start frames
transmitted.
The number of EAPOL Logoff frames that have been transmitted by this
Supplicant; {{bibref|802.1x-2004|9.5.2}}, EAPOL Logoff frames
transmitted.
The number of EAP Resp/Id frames that have been transmitted;
{{bibref|802.1x-2004|9.5.2}}, EAP Resp/Id frames transmitted.
The number of valid EAP Response frames (other than Resp/Id frames)
that have been transmitted by this Supplicant;
{{bibref|802.1x-2004|9.5.2}}, EAP Resp frames transmitted.
The number of EAP Req/Id frames that have been received by this
Supplicant; {{bibref|802.1x-2004|9.5.2}}, EAP Req/Id frames received.
The number of EAP Request frames (other than Rq/Id frames) that have
been received by this Supplicant; {{bibref|802.1x-2004|9.5.2}}, EAP
Req frames received.
The number of EAPOL frames that have been received by this Supplicant
in which the frame type is not recognized;
{{bibref|802.1x-2004|9.5.2}}, EAP Req frames received.
The number of EAPOL frames that have been received by this Supplicant
in which the Packet Body Length field is invalid;
{{bibref|802.1x-2004|9.5.2}}, EAP length error frames received.
The protocol version number carried in the most recently received
EAPOL frame; {{bibref|802.1x-2004|9.5.2}}, Last EAPOL frame version
The source MAC address carried in the most recently received EAPOL
frame; {{bibref|802.1x-2004|9.5.2}}, Last EAPOL frame source.
802.1x Authentication Supplicant provisioning information used for MD5
shared secret exchange. This object will not exist if EAP-MD5 is not a
supported authentication type.
This parameter enables or disables the supplicant's support for
EAP-MD5.
The shared secret to be exchanged between the supplicant and
authenticator.
802.1x Authentication Supplicant provisioning information used for TLS
certificate authentication. This object will not exist if the EAP-TLS
is not a supported authentication type.
This parameter enables or disables the supplicant's support for
EAP-TLS.
The parameter controls if the supplicant will authenticate the
authenticator.
Users object that contains the {{object|User}} table.
{{numentries}}
This object contains parameters relating to the user characteristics.
{{datatype|expand}}
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.
Allows this user to remotely access the UserInterface via the
mechanism defined in {{object|.UserInterface.RemoteAccess.}}
Name of the current user. MUST NOT be {{empty}} for an enabled entry.
The user's password.
String describing the default language for the local configuration
interface, specified according to {{bibref|RFC3066}}. If {{empty}},
{{param|.UserInterface.CurrentLanguage}} is used.
SmartCardReaders object that contains the {{object|SmartCardReader}}
table.
{{numentries}}
This object describes the characteristics of the smart card reader.
{{datatype|expand}}
Enables or disables this smart card reader.
Indicates the status of this smart card reader.
Indicates the smart card reader is enabled and functioning
properly.
Indicates the smart card reader is enabled and not functioning
properly.
Human-readable name associated with this smart card reader.
Reset the SmartCard Reader and the associated SmartCard.
The time at which this SmartCard Reader was reset. Reset can be
caused by:
* {{param|Status}} transition from Disabled to Enabled
* {{param|Reset}} set to {{true}}.
* An internal reset of the SmartCard Reader (including a reboot of
the device). Unknown Time value indicates that this SmartCard
Reader has never been reset, which can only happen if it has never
been enabled.
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|Reset}} parameter is used
and not when a Smart Card is inserted or removed.
Counter incremented once each time the key is not available to
decrypt it. This is a subset of the more general
{{param|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|Reset}} parameter is used and not when a Smart Card
is inserted or removed.
Status of currently associated smart card.
Status of the Smart Card.
Indicates that no Smart Card is inserted.
Indicates a Smart Card is present and working normally.
Indicates the Smart Card is present and in an error condition.
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.
{{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.
The Smart Card Serial Number or {{empty}} if the Smart Card serial
Number is not available, e.g. in the case of IPTV due to restrictions
of the Service Delivery Platform.
The Smart Card answer to a reset action. Issued by the Smart Card
upon reset.
This object contains all UPnP related objects and parameters including
Device and Discovery related objects and parameters.
This object defines the UPnP devices and UPnP services that are
implemented by the CPE.
Enables/Disables UPnP support.
Enables/Disables UPnP Media Server.
Enables/Disables UPnP Media Renderer.
Enables/Disables UPnP Wireless Access Point.
Enables/Disables UPnP QoS Device.
Enables/Disables UPnP QoS Policy Holder.
Enables/Disables UPnP IGD.
Enables/Disables UPnP-DM Basic Management.
Enables/Disables UPnP-DM Configuration Management.
Enables/Disables UPnP-DM Software Management.
This object defines what UPnP capabilities this device has.
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.
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 {{param|UPnPArchitecture}} is 0 then
this parameter SHOULD be ignored.
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
Renderer. 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.
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 Qos Device.
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.
Numeric value indicating the supported revision for UPnP IGD. 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.
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 Software
Management. A value of 0 indicates no support.
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.
{{numentries}}
{{numentries}}
{{numentries}}
UPnP root device table. This table contains an entry for each UPnP root
device that has been discovered via SSDP.
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.
Device is active and UPnP lease has not expired.
Device is inactive because UPnP lease has expired.
Device is inactive because byebye message was received.
This UPnP root device's UUID (Universally Unique IDentifier)
{{bibref|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:
: ''02c29d2a-dbfd-2d91-99c9-306d537e9856'' {{pattern}}
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:
: ''uuid:device-UUID::urn:domain-name:device:deviceType:v'' SSDP is
an unreliable protocol and it is possible that no discovery message
containing the USN header of the above form was ever received. If
so, one of the other two forms MAY be used:
: ''uuid:device-UUID::upnp:rootdevice''
: ''uuid:device-UUID'' (for root device UUID)
The UPnP root device lease time in {{units}}, extracted from the
CACHE-CONTROL header.
The value of the LOCATION header for this UPnP root device, which is
the {{datatype}} of the root device's DDD (Device Description
Document).
The value of the SERVER header for this UPnP root device, which is a
string of the following form:
: ''OS/version UPnP/udaversion product/version'' where '''UPnP''' is
a literal string, '''udaversion''' is the version of the UPnP
Device Architecture.
{{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.
The date and time at which the last advertisement from this
{{object}} was received.
UPnP embedded device table. This table contains an entry for each UPnP
embedded device that has been discovered via SSDP.
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.
Device is active and UPnP lease has not expired.
Device is inactive because UPnP lease has expired.
Device is inactive because byebye message was received.
This UPnP embedded device's UUID (Universally Unique IDentifier)
{{bibref|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:
: ''02c29d2a-dbfd-2d91-99c9-306d537e9856'' {{pattern}}
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:
: ''uuid:device-UUID::urn:domain-name:device:deviceType:v'' SSDP is
an unreliable protocol and it is possible that no discovery message
containing the USN header of the above form was ever received. If
so, the other form MAY be used:
: ''uuid:device-UUID''
The UPnP embedded device lease time in {{units}}, extracted from the
CACHE-CONTROL header.
The value of the LOCATION header for this UPnP embedded device, which
is the {{datatype}} of the root device's DDD (Device Description
Document).
The value of the SERVER header for this UPnP embedded device, which
is a string of the following form:
: ''OS/version UPnP/udaversion product/version'' where '''UPnP''' is
a literal string, '''udaversion''' is the version of the UPnP
Device Architecture.
{{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.
The date and time at which the last advertisement from this
{{object}} was received.
UPnP embedded service table. This table contains an entry for each UPnP
embedded service that has been discovered via SSDP.
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.
Service is active and UPnP lease has not expired.
Service is inactive because UPnP lease has expired.
Service is inactive because byebye message was received.
The value of the USN (Unique Service Name) header for this UPnP
embedded service. This is of the following form:
: ''uuid:device-UUID::urn:domain-name:service:serviceType:v''
The UPnP embedded service lease time in {{units}}, extracted from the
CACHE-CONTROL header.
The value of the LOCATION header for this UPnP embedded service,
which is the {{datatype}} of the root device's DDD (Device
Description Document).
The value of the SERVER header for this UPnP embedded service, which
is a string of the following form:
: ''OS/version UPnP/udaversion product/version'' where '''UPnP''' is
a literal string, '''udaversion''' is the version of the UPnP
Device Architecture.
{{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.
The date and time at which the last advertisement from this
{{object}} was received.
{{reference|the {{object|#.RootDevice}} or {{object|#.Device}} table
entries that embeds this {{object}}}} This parameter is populated by
extracting the "device-UUID" from the service's USN and matching the
value against the root device or embedded device UUID value.
This object contains information from the Description Document
discovered from the UPnP Devices and Services.
{{numentries}}
{{numentries}}
{{numentries}}
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.
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 UPnP Device Architecture version extracted from the specVersion
element in the Device Description Document of the discovered root
device. The {{param}} is encoded as "major revison.minor revision".
{{pattern}}
{{list}} {{reference|the Host table entries associated with the root
device from which the device description was retrieved|ignore}}
This table contains the information from Device Description Document
retrieved for a discovered UPnP root or embedded device.
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.
{{reference|a {{object}} table entry (if this is an embedded device)
or {{empty}} (if this is a root device)}}
{{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 of the UPnP deviceType element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
The value of the UPnP friendlyName element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
Each list item is the value of an element in the Device Description
Document for this {{object}} that indicates 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 the
''htip:X_DeviceCategory'' Device Description Document element is 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. Note: {{param}} is different from
{{param|DeviceType}} and is included here for the purpose of HTIP
usage.
The value of the UPnP manufacturer element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
The value of an element in the Device Description Document for this
{{object}} that indicates the manufacturer OUI if this value is
provided by the device; or {{empty}} if this value is not provided by
the device. {{pattern}} Note: It is assumed that the
''htip:X_ManufacturerOUI'' element is used for HTIP (Home-network
Topology Identifying Protocol) {{bibref|JJ-300.00}} and
{{bibref|G.9973}}.
The value of the UPnP manufacturerURL element in the Device
Description Document for this {{object}}, or {{empty}} if this value
is not provided by the device.
The value of the UPnP modelDescription element in the Device
Description Document for this {{object}}, or {{empty}} if this value
is not provided by the device.
The value of the UPnP modelName element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
The value of the UPnP modelNumber element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
The value of the UPnP modelURL element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
The value of the UPnP serialNumber element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the device.
The value of the UPnP UPC element in the Device Description Document
for this {{object}}, or {{empty}} if this value is not provided by
the device.
The value of the UPnP presentationURL element in the Device
Description Document for this {{object}} and MUST be an absolute URL.
The way to obtain an absolute URL from the presentationURL element is
specified in {{bibref|UPnP-DAv1}} and {{bibref|UPnP-DAv11}}. If the
presentationURL is not provided by the device then this value MUST be
{{empty}}.
This table contains the information from Device Description Document
retrieved for a discovered UPnP service.
{{reference|a {{object|#.DeviceInstance}} table entry}}
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.
{{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 of the UPnP serviceType element in the Device Description
Document for this {{object}}, or {{empty}} if this value is not
provided by the service.
The value of the UPnP SCPDURL element in the Device Description
Document for this {{object}} and MUST be an absolute {{datatype}}.
The way to obtain an absolute URL from the SCPDURL element is
specified in {{bibref|UPnP-DAv1}} and {{bibref|UPnP-DAv11}}. If the
SCPDURL is not provided by the device then this value MUST be
{{empty}}.
The value of the UPnP controlURL element in the Device Description
Document for this {{object}} and MUST be an absolute {{datatype}}.
The way to obtain an absolute URL from the controlURL element is
specified in {{bibref|UPnP-DAv1}} and {{bibref|UPnP-DAv11}}. If the
controlURL is not provided by the device then this value MUST be
{{empty}}
The value of the UPnP eventSubURL element in the Device Description
Document for this {{object}} and MUST be an absolute {{datatype}}.
The way to obtain an absolute URL from the eventSubURLL element is
specified in {{bibref|UPnP-DAv1}} and {{bibref|UPnP-DAv11}}. If the
eventSubURL is not provided by the device then this value MUST be
{{empty}}
This object contains all DLNA related objects and parameters.
DLNA capabilities.
{{list}} Indicates the supported DLNA Home Network Device Classes
{{bibref|DLNA-NDIG|Table 4-1}}.
{{list}} Indicates the supported DLNA Device Capabilities
{{bibref|DLNA-NDIG|Table 4-2}}.
{{list}} Indicates the supported DLNA Home Infrastructure Device
Classes {{bibref|DLNA-NDIG|Table 4-4}}.
{{list}} Indicates the DLNA Image Class Profile IDs supported by this
device, from Tables 5-2 and 5-3 of {{bibref|DLNA-NDIG}}.
{{list}} Indicates the DLNA Audio Class Profile IDs supported by this
device, from Tables 5-4 through 5-10 of {{bibref|DLNA-NDIG}}.
{{list}} Indicates the DLNA AV Class Profile IDs supported by this
device, from Tables 5-11 through 5-15 of {{bibref|DLNA-NDIG}}.
{{list}} Indicates the DLNA Media Collection Profile IDs supported by
this device {{bibref|DLNA-NDIG|Table 5-16}}.
{{list}} Indicates the DLNA Printer Class Profile IDs supported by
this device {{bibref|DLNA-NDIG|Table 5-17}}.
Firewall configuration object. The {{param|Config}} parameter enables
and disables the Firewall, and can select either a predefined
configuration ({{enum|High|Config}} or {{enum|Low|Config}}) or an
explicitly-defined {{enum|Advanced|Config}} configuration. For an
{{enum|Advanced|Config}} configuration, {{param|AdvancedLevel}}
controls the currently active Firewall Level, and the Firewall Levels
are defined in the {{object|Level}}, {{object|Chain}} and
{{object|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 {{object|#.NAT}} processing on the
ingress packet occurs before Firewall rules are applied so, for
example, the Firewall rules will see the translated destination IP
address and port in a downstream packet that has passed through the
NAT. See {{bibref|TR-181i2|Appendix VIII}} for an example
{{enum|Advanced|Config}} configuration.
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.
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.
The firewall implements the "Traffic Denied Inbound" and
"Minimally Permit Common Services Outbound" components of the
ICSA residential certification's Required Services Security
Policy {{bibref|ICSA-Residential}}. If DoS and vulnerability
protections are implemented {{bibref|ICSA-Baseline}}, these are
enabled.
All Outbound traffic and pinhole-defined Inbound traffic is
allowed. If DoS and vulnerability protections are implemented
{{bibref|ICSA-Baseline}}, these are enabled.
All Inbound and Outbound traffic is allowed, and the CPE is
only protected by NAT settings (if supported and enabled). If
DoS and vulnerability protections are implemented
{{bibref|ICSA-Baseline}}, these are disabled. This value is
DEPRECATED because it is the same as setting {{param|Enable}}
to {{false}}.
Advanced firewall configuration applies, as specified by
{{param|AdvancedLevel}}.
Selects the currently active Firewall Level. {{param}} only applies
when {{param|Config}} is {{enum|Advanced|Config}}.
Firewall Type. {{enum}} A {{enum|Stateless}} Firewall treats each
packet individually and thus has no concept of sessions. Therefore a
{{enum|Stateless}} Firewall cannot distinguish between unsolicited
downstream traffic and downstream traffic in response to outbound
messages. This means that it has to accept all incoming downstream
traffic. Furthermore, because a {{enum|Stateless}} Firewall treats
each packet individually, it does not provide any DoS or
vulnerability protections. A {{enum|Stateful}} Firewall maintains
state about previous packets and thus supports sessions. Therefore a
{{enum|Stateful}} Firewall can distinguish between solicited and
unsolicited downstream traffic. In a {{enum|Stateful}} Firewall,
explicitly configured rules only apply to unsolicited traffic, and
can not cause packets received in response to an upstream request to
be dropped. Furthermore, because a {{enum|Stateful}} Firewall
maintains state, it can provide DoS and vulnerability protections. A
device that has a {{enum|Stateless}} Firewall depends on the NAT to
provide protection against unsolicited downstream IPv4 traffic. This
is because, as noted above, a {{enum|Stateless}} Firewall has to be
configured to accept all incoming downstream traffic. For IPv6 there
is no NAT, so a {{enum|Stateless}} Firewall can not provide simple
security protections against unsolicited downstream IPv6 traffic.
The Firewall only implements stateless packet inspection.
The Firewall implements stateful packet inspection.
A string identifying the firewall settings version currently used in
the CPE, or {{empty}} if the firewall settings are not associated
with a version.
The time at which the firewall settings most recently changed.
{{numentries}}
{{numentries}}
Firewall Level table. When an {{enum|Advanced|#.Config}} configuration
is selected, {{param|#.AdvancedLevel}} selects the currently active
entry in this table. Each {{object}} table entry references the
{{object|#.Chain}} that contains the rules for this level.
{{datatype|expand}}
Human-readable name associated with this {{object}} entry.
Human-readable description associated with this {{object}} entry.
Position of the {{object}} 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 {{param}} value for the existing entry and all
greater-valued {{param}} entries is incremented to ensure uniqueness
of this value. A deletion causes {{param}} values to be compacted.
When a value is changed, incrementing occurs before compaction. The
value of {{param}} on creation of a {{object}} table entry MUST be
one greater than the largest current value.
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.
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.
Default action for packets not matching any of the level rules.
{{enum}}
The firewall discards packets matching this rule.
The firewall forwards packets matching this rule.
The firewall discards packets matching this rule, and sends an
ICMP message to the originating host.
Enable or disable logging, in a
{{object|##.DeviceInfo.VendorLogFile}}, of packets not matching any
of the level rules.
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.
Enables or disables this {{object}} entry.
{{datatype|expand}}
Human-readable name associated with this {{object}} entry.
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.
The {{object}} entry is present in the factory default
configuration.
The {{object}} entry was created as a side-effect of a
{{bibref|UPnP-IGD:1}} or {{bibref|TR-064}} port mapping.
The {{object}} entry was created by {{bibref|UPnP-IGD:2}}
WANIPv6FirewallControl.
The {{object}} entry was created by the Auto Configuration
Server.
The {{object}} entry was created by device user interface or
command line interface.
The {{object}} entry was created by another entity.
{{numentries}}
Firewall Rule table. Each entry defines a Firewall packet selection
rule. The {{param|Target}} parameter defines the action to perform for
traffic matching this rule: the packet can be dropped, accepted,
rejected or passed to another {{object|#}}. This table MUST NOT contain
dynamic Firewall rules associated with {{enum|Stateful|##.Type}}
Firewall sessions. All entries are created by the creator of the parent
{{object|#}}, as indicated by its {{param|#.Creator}} parameter.
{{object}} entries in a {{object|#}} with a {{param|#.Creator}} of
{{enum|Defaults|#.Creator}}, {{enum|ACS|#.Creator}},
{{enum|UserInterface|#.Creator}} or (maybe) {{enum|Other|#.Creator}}
are referred to as ''Static'' {{object}}s. Whether or not a {{object}}
in a {{object|#}} with {{param|#.Creator}} {{enum|Other|#.Creator}} is
regarded as ''Static'' is a local matter to the CPE. Some of this
object's parameter descriptions refer to whether a {{object}} is
''Static'' when specifying whether or not the parameter value can be
modified. For enabled table entries, if {{param|SourceInterface}} is
not a valid reference and {{param|SourceAllInterfaces}} is {{false}},
or if {{param|DestInterface}} is not a valid reference and
{{param|DestAllInterfaces}} is {{false}}, then the table entry is
inoperable and the CPE MUST set {{param|Status}} to
{{enum|Error_Misconfigured|Status}}.
Enables or disables this {{object}} entry.
The status of this {{object}} entry. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}}
entries is incremented (lowered in precedence) to ensure uniqueness
of this value. A deletion causes {{param}} values to be compacted.
When a value is changed, incrementing occurs before compaction. The
value of {{param}} on creation of a {{object}} table entry MUST be
one greater than the largest current value (initially assigned the
lowest precedence).
{{datatype|expand}}
Human-readable description associated with this {{object}} entry.
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).
The firewall discards packets matching this rule.
The firewall forwards packets matching this rule.
The firewall discards packets matching this rule, and sends an
ICMP message to the originating host.
The firewall doesn't consider the remaining rules (if any) in
the current chain.
The rules in the chain referenced by the {{param|TargetChain}}
parameter are matched.
Specifies the chain to process when {{param|Target}} equals
{{enum|TargetChain|Target}}. If there are no matching rules in the
referenced chain, processing continues with the next rule in this
chain (if any). In other words, {{enum|TargetChain|Target}} behaves
like a subroutine call. {{empty}} indicates no {{param}} is
specified. This parameter can only be modified if the {{object}} is
''Static'' (as explained in the object description).
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.
Date and time when this {{object}} entry was created.
The time at which this {{object}} entry will expire, or {{null}} 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 {{object}}
table entry. This parameter can only be modified if the {{object}} is
''Static'' (as explained in the object description).
{{object}} 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 Rules can be
instantiated is a local matter to the CPE. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
If {{false}}, the rule matches only those packets that match the
{{param|SourceInterface}} entry, if specified. If {{true}}, the rule
matches all packets except those that match the
{{param|SourceInterface}} entry, if specified. This parameter can
only be modified if the {{object}} is ''Static'' (as explained in the
object description).
{{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).
{{object}} criterion. {{reference}} 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 {{object}} is ''Static'' (as explained in the object
description).
If {{false}}, the rule matches only those packets that match the
{{param|DestInterface}} entry, if specified. If {{true}}, the rule
matches all packets except those that match the
{{param|DestInterface}} entry, if specified. This parameter can only
be modified if the {{object}} is ''Static'' (as explained in the
object description).
{{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).
{{object}} 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 {{object}} is
''Static'' (as explained in the object description).
{{object}} criterion. Destination IP address. {{empty}} indicates
this criterion is not used for matching. Note that Firewall rules are
applied after any {{object|###.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 {{object}} is ''Static'' (as
explained in the object description).
Destination IP address mask, represented as an IP routing prefix
using CIDR notation [RFC4632]. The IP address part MUST be {{empty}}
(and, if specified, MUST be ignored).
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. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
{{object}} criterion. Source IP address. {{empty}} indicates this
criterion is not used for matching. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
Source IP address mask, represented as an IP routing prefix using
CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and,
if specified, MUST be ignored).
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. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
{{object}} criterion. Protocol number. A value of -1 indicates this
criterion is not used for matching. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
If {{false}}, the rule matches only those packets that match the
{{param|Protocol}} entry, if specified. If {{true}}, the rule matches
all packets except those that match the {{param|Protocol}} entry, if
specified. This parameter can only be modified if the {{object}} is
''Static'' (as explained in the object description).
{{object}} criterion. Destination port number. A value of -1
indicates this criterion is not used for matching. Note that Firewall
rules are applied after any {{object|###.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 {{object}} is
''Static'' (as explained in the object description).
{{object}} criterion. If specified, indicates the {{object}}
criterion is to include the port range from {{param|DestPort}}
through {{param}} (inclusive). If specified, {{param}} MUST be
greater than or equal to {{param|DestPort}}. A value of -1 indicates
that no port range is specified. Note that Firewall rules are applied
after any {{object|###.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 {{object}} is ''Static'' (as
explained in the object description).
If {{false}}, the rule matches only those packets that match the
{{param|DestPort}} entry (or port range), if specified. If {{true}},
the rule matches all packets except those that match the
{{param|DestPort}} entry (or port range), if specified. This
parameter can only be modified if the {{object}} is ''Static'' (as
explained in the object description).
{{object}} criterion. Source port number. A value of -1 indicates
this criterion is not used for matching. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
{{object}} criterion. If specified, indicates the {{object}}
criterion is to include the port range from {{param|SourcePort}}
through {{param}} (inclusive). If specified, {{param}} MUST be
greater than or equal to {{param|SourcePort}}. A value of -1
indicates that no port range is specified. This parameter can only be
modified if the {{object}} is ''Static'' (as explained in the object
description).
If {{false}}, the rule matches only those packets that match the
{{param|SourcePort}} entry (or port range), if specified. If
{{true}}, the rule matches all packets except those that match the
{{param|SourcePort}} entry (or port range), if specified. This
parameter can only be modified if the {{object}} is ''Static'' (as
explained in the object description).
{{object}} criterion. DiffServ codepoint (defined in
{{bibref|RFC2474}}). If set to a Class Selector Codepoint (defined in
{{bibref|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
{{object}} is ''Static'' (as explained in the object description).
If {{false}}, the rule matches only those packets that match the
{{param|DSCP}} entry, if specified. If {{true}}, the rule matchess
all packets except those that match the {{param|DSCP}} entry, if
specified. This parameter can only be modified if the {{object}} is
''Static'' (as explained in the object description).
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 <n>
samples. This object provides a single set of global settings that
affect the entire device unless overridden locally.
Minimum sample interval in {{units}} that the CPE is able to support.
A value of 0 indicates no specific minimum sample interval.
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.
{{numentries}}
Periodic statistics sample set table. Each sample set has its own
sample interval etc.
{{datatype|expand}}
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.
Indicates availability of Sample statistics. {{enum}} The
{{enum|Trigger}} value is only used for triggering the Controller to
fetch the collected data and can only be used when
{{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}].
The transition from {{enum|Enabled}} to {{enum|Trigger}} to
{{enum|Enabled}} MUST be instantaneous and so will result in only a
single value change for notification purposes.
Collection is disabled.
Collection is enabled.
Collection is enabled and the Controller SHOULD now fetch the
collected data.
The name of this sample set, which uniquely distinguishes each sample
set.
The sample interval in {{units}}. Each statistic is measured over
this sample interval. The CPE MAY reject a request to set {{param}}
to less than {{param|.PeriodicStatistics.MinSampleInterval}}. Sample
intervals MUST begin every {{param}} {{units}}, with no delay between
samples. If {{param}} is changed while collection of periodic
statistics is enabled, any stored samples are discarded, and the
first sample interval begins immediately. For example, if
{{param|ReportSamples}} is 24 and {{param}} is 3600 (an hour), the
CPE can store up to a day's worth of samples for each statistic.
The number of samples that the CPE will store and report for each
statistic. The CPE MUST permit {{param}} to be set to at least
{{param|.PeriodicStatistics.MaxReportSamples}}. If {{param}} 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
{{param}} is 24 and {{param|SampleInterval}} is 3600 (an hour), the
CPE can store up to a day's worth of samples for each statistic.
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 {{param|SampleInterval}}.
{{param}} is used only to set the "phase" of the sample and fetch
intervals. The actual value of {{param}} can be arbitrarily far into
the past or future. This time reference also determines when the
{{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}}
to {{enum|Enabled|Status}} transitions that are controlled by
{{param|FetchSamples}} will occur. If collection of periodic
statistics is enabled and {{param|FetchSamples}} is in the range
[1:{{param|ReportSamples}}] then each such {{param|Status}}
transition MUST occur at this reference time plus or minus an integer
multiple of {{param|FetchSamples}} * {{param|SampleInterval}} (the
fetch interval). If {{param}} is changed while collection of periodic
statistics is enabled, any stored samples are discarded, and the
first sample interval begins immediately. The Unknown Time value
defined in {{bibref|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
{{param}} parameter was set to the Unknown Time value. For example,
if {{param|SampleInterval}} is 3600 (an hour) and if {{param}} 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, {{param|FetchSamples}} is 24, then the fetch
interval is 86400 (a day) and {{param|Status}}
{{enum|Enabled|Status}} to {{enum|Trigger|Status}} to
{{enum|Enabled|Status}} transitions will occur every day at UTC
midnight. Note that, if {{param}} 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
{{param|SampleInterval}}). This is why {{param}} is defined in terms
of when sample intervals complete rather than start.
The number of sample intervals to be collected before transitioning
{{param|Status}} from {{enum|Enabled|Status}} to
{{enum|Trigger|Status}} to {{enum|Enabled|Status}}. If this SampleSet
is enabled and {{param}} is in the range [1:{{param|ReportSamples}}]
then {{param|Status}} MUST transition from {{enum|Enabled|Status}} to
{{enum|Trigger|Status}} to {{enum|Enabled|Status}} on completion of
every {{param}} sample intervals. Otherwise, the transition MUST NOT
occur. For example, if {{param|ReportSamples}} is 25 and {{param}} is
24, then the CPE will store 25 values for each monitored parameter
and the above {{param|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}}). To disable this trigger mechanism and still
collect sampled statistics, {{param}} can be set to either 0 or a
value greater than {{param|ReportSamples}}.
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 {{param|ReportEndTime}} and all
{{param|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 {{param|ReportEndTime}} and all
{{param|SampleSeconds}} parameters, MUST be updated accordingly. Note
that {{param}} 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 {{param|ReportEndTime}}
and all {{param|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.
The absolute time at which the sample interval for the first stored
sample (for each statistic) started.
The absolute time at which the sample interval for the last stored
sample (for each statistic) ended. If {{param|ForceSample}} has been
used to force statistics for the current sample to be calculated and
updated in the data model, then {{param}} MUST be updated to reflect
the actual time over which stored data was collected.
{{list}} Each entry indicates the number of {{units}} during which
data was collected during the sample interval. Individual {{param}}
values can be less than {{param|SampleInterval}}, for several
reasons, including:
: {{param|TimeReference}} has been set to a time other than the
Unknown Time and the current sample interval started part of the
way through a scheduled sample interval.
: {{param|ForceSample}} has been used to force statistics for the
current sample to be calculated and updated in the data model.
{{numentries}}
Periodic statistics parameter table for this sample set. This table
contains entries for parameters whose values are to be sampled. Note
that the comma-separated lists in this object (SampleSeconds,
SuspectData and Values) only ever change (a) when first enabled, (b)
when ForceSample is set to true (a "sneak preview" of the current
sample), or (c) at the end of the sample interval.
{{datatype|expand}}
Enables or disables this object instance.
{{reference}} This is the parameter being monitored by the Periodic
Statistics mechanism.
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.
Sampled value is current value
Sampled value is change in value since start of sample interval
Controls how this parameter's statistic is calculated from the
sampled value(s). {{enum}} Parameters of non-numeric types can only
support {{enum|Latest}}. The value of the {{param}} MUST be ignored
for such parameters. {{param|SampleMode}} MUST be applied before
{{param}}, i.e. the inputs to the calculation will have already
accounted for {{param|SampleMode}}.
Statistic is sampled value at end of sample interval
Statistic is minimum sampled value during sample interval
Statistic is maximum sampled value during sample interval
Statistic is average (mean) sampled value during sample
interval
The low threshold value that controls the calculation of
{{param|Failures}}. A value equal to {{param|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.
The high threshold value that controls the calculation of
{{param|Failures}}. A value equal to {{param|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.
{{list}} Each entry indicates the number of {{units}} during which
data was collected for this parameter during the sample interval.
Individual {{param}} values can be less than
{{param|.PeriodicStatistics.SampleSet.{i}.SampleInterval}}, for
several reasons, including:
: Any of the reasons for which
{{param|.PeriodicStatistics.SampleSet.{i}.SampleSeconds}} values
might be less than
{{param|.PeriodicStatistics.SampleSet.{i}.SampleInterval}}.
: The parameter doesn't exist, or was created or deleted during a
sample interval.
{{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.
{{list}} Each entry indicates the value of the referenced parameter,
as determined by {{param|SampleMode}}, during the sample interval.
The statistics values in this comma-separated lists MUST be in time
order, with the oldest one first and the most recent one last. If the
{{param|SampleMode}} parameter is not present, or is inappropriate
for the referenced parameter, the statistics values MUST be collected
in Current mode.
Counts the number of times (since this object instance was last
enabled) that a newly-calculated sample value (accounting for
{{param|SampleMode}}) transitioned from the "in range" state to the
"out of range" state, or between the "out of range (low)" and "out of
range (high)" states. The states are defined as follows:
* "in range" : current value is greater than {{param|LowThreshold}}
and less than {{param|HighThreshold}}.
* "out of range" : current value is less than or equal to
{{param|LowThreshold}}, or greater than or equal to
{{param|HighThreshold}}.
* "out of range (low)" : current value is less than or equal to
{{param|LowThreshold}}.
* "out of range (high)" : current value is greater than or equal to
{{param|HighThreshold}}. Note that, if {{param|LowThreshold}} and
{{param|HighThreshold}} are both the same, the threshold/failure
mechanism is disabled, so the value of this parameter will not
increment. This parameter can be incremented at any time during a
sample interval, and might be incremented more than once during a
single sample interval. For this reason, the CPE SHOULD place a
locally specified limit on the frequency at which it will notify
the Controller of such changes. Parameters of non-numeric types
cannot support the threshold/failure mechanism. The value of this
parameter MUST be ignored for such parameters.
This object contains parameters relating to Fault/Alarm Management.
{{numentries}}
The maximum number of entries allowed in the
{{object|.FaultMgmt.CurrentAlarm.{i}.}} table.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
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.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
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 unique
indexing of the table using {{param}}. The string can be set to "*"
to indicate the default case if only a subset of {{param}} are to be
contained within the table.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}} This will be {{empty}} if the device
doesn't support unique indexing of the table using {{param}}. The
string can be set to "*" to indicate the default case if only a
subset of {{param}} are to be contained within the table.
{{empty}}
Indicates the reporting mechanism setting of the alarm. {{enum}}
The device inserts the alarm into the
{{object|.FaultMgmt.ExpeditedEvent.{i}.}} table and the
{{object|.FaultMgmt.ExpeditedEvent.{i}.}} table.
The device inserts the alarm into the
{{object|.FaultMgmt.QueuedEvent.{i}.}} table and the
{{object|.FaultMgmt.QueuedEvent.{i}.}} table.
The device inserts the alarm into the
{{object|.FaultMgmt.HistoryEvent.{i}.}} table.
The device ignores the alarm.
Contains all currently active alarms (whose
{{param|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}} is not
{{enum|Cleared|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}}).
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 {{param|.FaultMgmt.MaxCurrentAlarmEntries}} is reached,
the next event overrides the object with the oldest
{{param|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).
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.
Indicates the date and time when the alarm was first raised by the
device.
Indicates the date and time when the alarm was last changed by the
device.
Specifies the instance of the Informational Object Class in which the
alarm occurred by carrying the Distinguished Name (DN) of this object
instance. The format of the DN is specific to the application that is
using this {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
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.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
Alarm events added or updated in
{{object|.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 {{param|.FaultMgmt.HistoryEventNumberOfEntries}}. If
maximum instance number
{{param|.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.
Indicates the date and time when the alarm event occurs.
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.
Indicates the reason for the specific alarm notification event.
{{enum}}
Specifies the instance of the Informational Object Class in which the
alarm occurred by carrying the Distinguished Name (DN) of this object
instance. The format of the DN is specific to the application that is
using this {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
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.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
Alarm events added or updated in
{{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into
the this table if their corresponding entry in
{{object|.FaultMgmt.SupportedAlarm.{i}.}} has
{{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to
{{enum|0 Expedited|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}.
This table also contains alarm clearing events. This object has a fixed
number of entries with instance numbers from 1 to
{{param|.FaultMgmt.ExpeditedEventNumberOfEntries}}. Initially the table
starts with all instances having {{param|EventTime}} set to the Unknown
Time value, as defined in {{bibref|TR-106}}. If maximum instance number
{{param|.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).
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}}.
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}}.
Indicates the reason for the specific alarm notification event.
{{enum}}
Specifies the instance of the Informational Object Class in which the
alarm occurred by carrying the Distinguished Name (DN) of this object
instance. The format of the DN is specific to the application that is
using this {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
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.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
Alarm events added or updated in
{{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into
the this table if their corresponding entry in
{{object|.FaultMgmt.SupportedAlarm.{i}.}} has
{{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to
{{enum|1 Queued|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}.
This table also contains alarm clearing events. This object has a fixed
number of entries with instance numbers from 1 to
{{param|.FaultMgmt.QueuedEventNumberOfEntries}}. Initially the table
starts with all instances having {{param|EventTime}} set to the Unknown
Time value, as defined in {{bibref|TR-106}}. If maximum instance number
{{param|.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).
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}}.
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}}.
Indicates the reason for the specific alarm notification event.
{{enum}}
Specifies the instance of the Informational Object Class in which the
alarm occurred by carrying the Distinguished Name (DN) of this object
instance. The format of the DN is specific to the application that is
using this {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
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.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
This object contains general information related to managing security
features on the device.
{{numentries}}
This table provides information about all types of public key-based
credentials, such as X.509 certificates, see {{bibref|RFC5280}}.
Enables or disables this certificate.
The last modification time of this certificate.
The Serial Number field in an X.509 certificate, see
{{bibref|RFC5280}}.
The Issuer field in an X.509 certificate, see {{bibref|RFC5280}};
i.e. the Distinguished Name (DN) of the entity who has signed the
certificate.
The beginning of the certificate validity period; i.e. the Not Before
field in an X.509 certificate, see {{bibref|RFC5280}}.
The end of the certificate validity period; i.e., the Not After field
in an X.509 certificate, see {{bibref|RFC5280}}.
The Distinguished Name (DN) of the entity associated with the Public
Key; i.e., the Subject field in an X.509 certificate, see
{{bibref|RFC5280}}.
{{list}} Each item is a DNS Name. The Subject Alternative Names
extension field in an X.509 certificate, see {{bibref|RFC5280}}.
The algorithm used in signing the certificate; i.e. the Signature
Algorithm field in an X.509 certificate, see {{bibref|RFC5280}}.
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.
This object contains the parameters relating to the GPS scan.
Enables or disables GPS scans during the device start up.
Enables or disables periodic GPS scans.
When {{param|ScanPeriodically}} is {{true}}, this value indicates the
interval in {{units}} which GPS scan is performed.
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 {{param|PeriodicInterval}}. {{param}} is used only to
set the "phase" of the GPS scan. The actual value of {{param}} can be
arbitrarily far into the past or future. For example, if
{{param|PeriodicInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers to a day in
the future. The Unknown Time value defined in {{bibref|TR-106|Section
3.2}} 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 {{param}} parameter was set to the Unknown Time value.
Whether or not the device SHOULD maintain a continuous GPS lock (e.g.
as a frequency stability source).
Specifies the time-out value in {{units}} since the scan started
after which the scan will time out. A timed out scan is to be
reported as {{enum|Error_TIMEOUT|ScanStatus}} with
{{param|ErrorDetails}} indicating "Timed out"
Indicates the current status of this scan.
The scan has not been executed and there are no valid scan
results available
Provides more detail when the {{param|ScanStatus}} is either
{{enum|Error|ScanStatus}} or {{enum|Error_TIMEOUT|ScanStatus}}.
The date and time when the last GPS scan completed.
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}}.
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
(13*1,000,000)+((19.43*1,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}}. If a scan has never
succeeded before, the value 0 is reported.
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 (13*1,000,000)+((19.43*1,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}}. 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 {{param|GPSReset}} is
set to {{true}}. If a scan has never succeeded before, the value 0 is
reported.
Reset the GPS Hardware.
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.
The value is {{true}} if the location fix is currently valid (i.e.
GPS receiver is currently tracking satellite signals), otherwise it
is {{false}}. After a reboot the value is {{false}} until the GPS
receivers has a valid current position.
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 the timing synchronization is good,
otherwise it is {{false}}. After a reboot the value is {{false}}
until the timing is synchronized again.
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
(13*1,000,000)+((19.43*1,000,000)/60). Latitude of 50 deg 00.00' S
would be represented as value -50,000,000. {{param}} is not valid
until {{param|GotFix}} is {{true}}. If the parameter has never been
set before, the value 0 is reported. The value SHOULD be maintained
over a reboot.
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
(13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00.00' W
would be represented as value -50,000,000. {{param}} is not valid
until {{param|GotFix}} is {{true}}. If the parameter has never been
set before, the value 0 is reported. The value SHOULD be maintained
over a reboot.
This parameter represents the most recent elevation reading for the
device's position in {{units}}, 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). {{param}} is not valid until
{{param|GotFix}} is {{true}}. If the parameter has never been set
before, the value 0 is reported. The value SHOULD be maintained over
a reboot.
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}}.
Number of {{units}} of continuous GPS fix time. After a reboot this
value is reset to 0.
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.
The number of satellites the receiver is tracking.
The interval in {{units}} at which the GPS tracking information gets
reported.
The output of the GPS receiver's status.
Indicates whether the {{param|Latitude}}, {{param|Longitude}}, and
{{param|Elevation}} values are determined via a GPS Fix (where the
value of this parameter would be {{enum|Real}}) or via some other
means (where the value of this parameter would be
{{enum|Reference}}).
The timer duration, in {{units}}, for which the device waits for GPS
to acquire lock.
This object contains parameters for the configuration of the Assisted
Global Positioning System (A-GPS) server. See also
{{bibref|3GPP-TS.25.171|Section 3.2}}
Enables or disables the {{object}} entry.
A-GPS server host name or IP address.
The port to use when communicating to the A-GPS Server.
Username to be used by the device to authenticate with the A-GPS
server. This string is set to {{empty}} if no authentication is used.
Password to be used by the device to authenticate with the A-GPS
server. This string is set to {{empty}} if no authentication is used.
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 (13*1,000,000)+((19.43*1,000,000)/60).
Latitude of 50d00.00' S would be represented as value -50,000,000.
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
(13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00'00'' W
would be represented as value -50,000,000.
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.
This object contains parameters relating to Performance Management in a
Femto-related environment.
{{numentries}}
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.
Enables or disables this entry. If this entry is disabled then its
periodic uploads are not performed.
{{datatype|expand}}
{{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.
Username to be used by the device to authenticate with the file
server. This string is set to {{empty}} if no authentication is used.
Password to be used by the device to authenticate with the file
server. This string is set to {{empty}} if no authentication is used.
The duration in {{units}} of the interval for which the device MUST
create a Performance File and attempt to upload the file to
{{param|URL}} if {{param|Enable}} is {{true}}.
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
{{param|PeriodicUploadInterval}}. {{param}} is used only to set the
"phase" of the periodic uploads. The actual value of {{param}} can be
arbitrarily far into the past or future. For example, if
{{param|PeriodicUploadInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers
to a day in the future. The Unknown Time value as defined in
{{bibref|TR-106|Section 3.2}} 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
{{param|PeriodicUploadInterval}}. If absolute time is not available
to the device, its periodic file upload behavior MUST be the same as
if the {{param}} parameter was set to the Unknown Time value.
This object defines the data model for the following Femtozone APIs.
* Femto Awareness
* SMS
* MMS
* Terminal Location Femto Awareness, SMS, MMS, and Terminal Location
APIs are defined in the Release 1 API Specifications of the Service
SIG in the Femto Forum (non public document).
{{bibref|TR-262|appendix I}} provides the "Theory of Operation" for
the usage of this object.
Version of Femto Application Platform running on this device
Enable or disable the Femto ApplicationPlatform
Current state of the Femto Application Platform.
The Femto Application Platform is not available
The Femto Application Platform is available
The FemtoApplicationPlatform is in the process of being reset
and will transition to the {{enum|Disabled}} state when the
reset operation is completed
The FemtoApplicationPlatform is being initialized and will
transition to the {{enum|Enabled}} state once the
initialization is completed
Determines how many Femtozone Applications can be supported by the
Femto Application Platform simultaneously.
Specifies how many Femtozone Applications are currently communicating
with the Femto Application Platform.
This object contains parameters related to the capabilities of the
Femtozone Application Platform and the Femtozone APIs.
Specifies whether the Femto Application Platform supports
Presence-Based Femtozone Applications
Specifies whether the Femto Awareness API is supported on this
device.
Specifies whether the SMS API is supported on this device.
Specifies whether the SubscribeToNotificationsOfSMSSentToApplication
functionality is supported by the FAP SMS API.
Specifies whether the QuerySMSDeliveryStatus functionality is
supported by the FAP SMS API.
Specifies whether the MMS API is supported on this device.
Specifies whether the QueryMMSDeliveryStatus functionality is
supported by the FAP MMS API.
Specifies whether the SubscribeToNotificationsOfMMSSentToApplication
functionality is supported by the FAP MMS API.
Specifies whether the Terminal Location API is supported on this
device.
Specifies the supported methods that 3rd Party Applications can use
to authenticate with the Femto Application Platform at
initialization. Comma separated list of strings.
Specifies the supported access levels that 3rd Party Applications can
request when authenticating with the Femto Application Platform at
initialization. This access level is with respect to resources within
the Femto Application Platform only (not to be confused with Access
Mode parameter in .FAPService.{i}.AccessMgmt).
Specifies the supported types of addresses SMSs can be sent to.
Specifies the supported types of addresses MMSs can be sent to.
This object contains parameters related to the operation of the
Femtozone APIs.
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.
This is the reference to the IPsec tunnel instance to be used by the
Application Platform traffic. The {{param}} 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.
This object contains parameters related to the Femto Awareness API.
Enable or disable FemtoAwareness API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to Femto Awareness API.
Determines the Max Number of different Applications that can send
Requests to Femto Awareness API.
Specifies Identifier of the Femtozone.
Specifies whether the Mobile Station International Subscriber
Directory Number (MSISDN) has to be used as UserIdentifier in Femto
Awareness Notifications. A value of {{true}} means that the MSISDN is
send as user identifier, a value of {{false}} means that an anonymous
reference is used.
Specifies whether the OPTIONAL Argument "Callback Data" has to be
used in Responses to Requests to "Subscribe To Femto Awareness
Notifications".
Specifies whether the OPTIONAL Argument "Timezone" has to be used in
Responses to Requests to "Query Femtocell Status".
This object contains parameters related to the SMS API.
Enable or disable SMS API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to SMS API.
Determines the Max Number of different Applications that can send
Requests to SMS API.
Determines the Minimum Time Interval in {{units}} between two
consecutive Send SMS Requests by the same Application.
Enable or disable "QuerySMSDeliveryStatus" Operation on SMS API. When
disabled, QuerySMSDeliveryStatus Requests to SMS API are ignored.
Enable or disable
"SubscribeToNotificationsOfMessageSentToApplication" Operation on SMS
API. When disabled, SubscribeTo
NotificationsOfMessageSentToApplication Requests to SMS API are
ignored.
This object contains parameters related to the MMS API.
Enable or disable MMS API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to MMS API.
Determines the Max Number of different Applications that can send
Requests to MMS API.
Determines the Minimum Time Interval in {{units}} between two
consecutive Send MMS Requests by the same Application.
Enable or disable "QuerySMSDeliveryStatus" Operation on MMS API. When
disabled, QuerySMSDeliveryStatus Requests to MMS API are ignored.
Enable or disable "SubscribeTo
NotificationsOfMessageSentToApplication" Operation on MMS API. When
disabled, SubscribeTo NotificationsOfMessageSentToApplication
Requests to MMS API are ignored.
This object contains parameters related to the TerminalLocation API.
Enable or disable TerminalLocation API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to TerminalLocation API.
Determines the Max Number of different Applications that can send
Requests to TerminalLocation API.
Specifies Terminal Address Format to be used in QueryMobileLocation
Responses.
Include or exclude FAP Longitude and Latitude arguments in Responses
to QueryMobileLocation Requests.
Include or exclude FAP Altitude argument in Responses to
QueryMobileLocation Requests .
Specifies Response Timestamp in {{units}}.
This object contains parameters related to the monitoring of the
Femtozone Application Platform and the Femtozone APIs.
Enables and disables this entry.
Specifies the interval in {{units}} used to collect the monitoring
measurements.
Specifies the total number of authentication requests received by the
Femto Application Platform. The counter will be reset whenever the
device reboots or the {{param|Enable}} parameter is set to {{true}}.
Specifies the number of authentication requests received by the Femto
Application Platform that were rejected. The counter will be reset
whenever the device reboots or the {{param|Enable}} parameter is set
to {{true}}.
This object contains parameters related to the Monitoring of the
FemtoAwareness API.
Specifies whether the FemtoAwareness API is currently available on
this device (the API could be disabled or could have exhausted its
resources)
Specifies the current number of Applications using the Femto
Awareness API.
Specifies the state of the Femto Awareness API Queue.
Specifies the current number of requests waiting in the Femto
Awareness API Queue.
Specifies the number of requests in the Femto Awareness API Queue
that have been received. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
Specifies the number of requests in the Femto Awareness API Queue
that have been discarded. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
This object contains parameters related to the Monitoring of the SMS
API.
Specifies whether the SMS API is currently available on this device
(the API could be disabled or could have exhausted its resources)..
Specifies the current number of Applications using the SMS API.
Specifies the state of the SMS API Queue.
Specifies the current number of requests waiting in the SMS API
Queue.
Specifies the number of requests in the SMS API Queue that have been
received. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
Specifies the number of requests in the SMS API Queue that have been
discarded. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
This object contains parameters related to the Monitoring of the MMS
API.
Specifies whether the MMS API is currently available on this device
(the API could be disabled or could have exhausted its resources)..
Specifies the current number of Applications using the MMS API.
Specifies the state of the MMS API Queue.
Specifies the current number of requests waiting in the MMS API
Queue.
Specifies the number of requests in the MMS API Queue that have been
received. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
Specifies the number of requests in the MMS API Queue that have been
discarded. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
This object contains parameters related to the Monitoring of the
TerminalLocation API.
Specifies whether the TerminalLocation API is currently available on
this device (the API could be disabled or could have exhausted its
resources)..
Specifies the current number of Applications using the Terminal
Location API.
Specifies the state of the Terminal Location API Queue.
Specifies the current number of requests waiting in the Terminal
Location API Queue.
Specifies the number of requests in the Terminal Location API Queue
that have been received. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
Specifies the number of requests in the Terminal Location API Queue
that have been discarded. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
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 {{bibref|TR-232}}. The HTTP
solution is based on transfer mechanisms described in
{{template|BULK-DATA-HTTP-REF}}. {{template|BULK-DATA-OPT-SOLNS}} 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.
Enables or disables all collection profiles. If {{false}}, bulk data
will not be collected or reported.
Indicates the status of the Bulk Data Collection mechanism.
Bulk Data Collection is enabled and working as intended.
Bulk Data Collection is disabled.
Bulk Data Collection is enabled, but there is an error
condition preventing the successful collection of bulk data.
Minimum reporting interval in {{units}} that the CPE is capable of
supporting. A value of 0 indicates no minimum reporting interval.
Represents the IPDR and transport protocols that this device is
capable of supporting.
IPDR Streaming Protocol {{bibref|IPDR-SP}}
IPDR File Transfer Protocol {{bibref|IPDR-FTP}}
Hypertext Transfer Protocol {{bibref|RFC2616}}
User Services Platform (USP - {{bibref|TR-369|Annex A}}) Event
Notification
Represents the Encoding Types for the protocols that this device is
capable of supporting.
Used with the IPDR Streaming and File Protocols.
{{bibref|IPDR-XML}}
Used with the IPDR Streaming and File Protocols.
{{bibref|IPDR-XDR}}
Comma Separated Values. Used with the HTTP and USPEventNotif
Protocols. {{bibref|RFC4180}}
JavaScript Object Notation. Used with the HTTP and
USPEventNotif Protocols. {{bibref|RFC7159}}
When {{true}}, the Device supports the use of wildcards to determine
the parameters that are reported using a Profile.
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 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.
{{numentries}}
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.
Enables or disables this specific bulk data profile. If {{false}},
this profile will not be collected or reported.
{{datatype|expand}}
The name of the profile.
{{reference|the {{object|Device.LocalAgent.Controller.}} instance
that created or last updated this {{object}}}} 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 of this parameter is automatically updated by the
USP Agent upon {{object}} alteration using the reference to the USP
Controller that changed the instance.
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 {{param|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.
The Bulk Data Protocol being used for this collection profile.
The Bulk Data encoding type being used for this collection profile.
The reporting interval in {{units}}. Each report is generated based
on this interval and {{param|TimeReference}}. The CPE MAY reject a
request to set {{param}} to less than
{{param|#.MinReportingInterval}}. Reporting intervals MUST begin
every {{param}} {{units}}. If {{param}} is changed while collection
is enabled, the first reporting interval begins immediately. For
example, if {{param}} is 86400 (a day) and if {{param|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}}) its report at
midnight every 24 hours.
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
{{param|ReportingInterval}}, unless unable to due to higher
prioritized operations. {{param}} is used only to set the "phase" of
the reporting intervals. The actual value of {{param}} can be
arbitrarily far into the past or future. If {{param}} is changed
while collection of bulk data is enabled, the first reporting
interval begins immediately. The Unknown Time value as defined in
{{bibref|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 {{param}} parameter was set to
the Unknown Time value. For example, if {{param|ReportingInterval}}
is 86400 (a day) and if {{param}} 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 {{param}} 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
{{param|ReportingInterval}}). This is why {{param}} is defined in
terms of when reporting intervals complete rather than start.
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 {{bibref|IPDR-SP}} (the
{{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
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 {{bibref|IPDR-SP}} (the
{{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
This is the unique identification of an IPDR Session to be used when
this collection profile is configured for the IPDR Streaming Protocol
{{bibref|IPDR-SP}} (the {{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}). A Controller MUST NOT configure
multiple IPDR Streaming Protocol collection profiles with the same
{{param}}. 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'.
This is the {{datatype}} 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 {{bibref|IPDR-FTP}}
(the {{param|Protocol}} parameter has a value of
{{enum|File|#.Protocols}}).
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}}).
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}}).
If 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}}) then the control file names will
be of the following format:
:
<ControlFilePrefix>_<ControlFilePolicy>.<ControlFileSuffix>
Where the following rules apply:
* ControlFilePrefix MUST NOT contain an underscore '_' or any other
character not suitable for a file name.
* ControlFilePolicy MUST contain one or more 'N' characters, where
the number of 'N' characters denotes the number of digits in the
sequence number, including leading zeros as necessary to match the
number of 'N' characters.
* ControlFileSuffix is a file extension. For example,
BulkData_NNNN.log where "BulkData" would be the prefix, "NNNN"
would be the policy, and "log" would be the suffix. Files adhering
to this file format would look like: BulkData_0000.log,
BulkData_0001.log, etc.
{{numentries}}
Bulk Data Push event for delivering a bulk data report within a USP
Notification message.
The contents of the bulk data report in the configured CSV or JSON
Encoding Type.
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.
Name of the parameter in the report body. If the value of this
parameter is {{empty}}, then the value of the {{param|Reference}}
parameter is used as the name. When the value {{param|Reference}}
parameter contains wildcards and/or partial parameter names, the
rules for determining the value of this parameter are specified in
{{template|BULK-DATA-WILD-REF}}.
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 {{param|##.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 a partial parameter path 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 '.'.
This object defines the properties to be used when the
{{object|##.Profile}} object's {{param|#.EncodingType}} parameter value
is {{enum|CSV|##.EncodingTypes}}.
Field separator to use when encoding CSV data.
Row separator to use when encoding CSV data.
Escape character to use when encoding CSV data.
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}}.
Reports are formatted with each parameter formatted as a row
entry.
Reports are formatted with each parameter formatted as a column
entry.
The format of the timestamp to use for data inserted into the row.
Timestamp is inserted using the UNIX epoch time (milliseconds
since Jan 1, 1970 UTC) timestamp format. If the CPE is unable
to acquire a time, then the time that has elapsed since the
last reboot of the device is used.
Timestamp is inserted using the ISO-8601 timestamp
format{{template|BULK-DATA-TIMESTAMP}}.
Timestamp is not inserted in the row.
This object defines the properties to be used when the
{{object|##.Profile}} object's {{param|#.EncodingType}} parameter value
is {{enum|JSON|##.EncodingTypes}}.
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}}.
Reports are formatted with each object in the object hierarchy
of the data model encoded as a corresponding hierarchy of JSON
Objects with the parameters of the object specified as
name/value pairs of the JSON Object.
Reports are formatted with each parameter of the data model
encoded as a corresponding array of JSON Objects with the
parameters specified as name/value pairs.
The format of timestamp to use for the JSON Object named
"CollectionTime" as described in {{template|BULK-DATA-JSON-REF}}.
Timestamp is inserted using the UNIX epoch time (milliseconds
since Jan 1, 1970 UTC) timestamp format. If the CPE is unable
to acquire a time, then the time that has elapsed since the
last reboot of the device is used.
Timestamp is inserted using the ISO-8601 timestamp
format{{template|BULK-DATA-TIMESTAMP}}.
Timestamp is not inserted.
This object defines the properties to be used when transporting bulk
data using the HTTP/HTTPS protocol. This object is used when the
{{param|#.Protocol}} parameter has a value of
{{enum|HTTP|##.Protocols}}. For authentication purposes the CPE MUST
support HTTP Basic and Digest Access Authentication as defined in
{{bibref|RFC2616}}.
The {{datatype}} for the collection server to receive the Bulk Data
transmitted by the CPE.
Username used to authenticate the CPE when making a connection to the
collection server.
Password used to authenticate the CPE when making a connection to the
collection server.
Indicates the HTTP Compression mechanism(s) supported by this CPE for
the purposes of transferring bulk data.
As defined in {{bibref|RFC2616|Section 3.5}}
As defined in {{bibref|RFC2616|Section 3.5}}
As defined in {{bibref|RFC2616|Section 3.5}}
The value of this parameter represents the HTTP Compression mechanism
to be used by the CPE when transferring data to the collection
server.
Indicates the HTTP method(s) supported by this CPE for the purposes
of transferring bulk data.
As defined in {{bibref|RFC2616|Section 9.5}}
As defined in {{bibref|RFC2616|Section 9.6}}
The value of this parameter represents the HTTP method to be used by
the CPE when transferring data to the collection server.
When {{true}}, the CPE encodes the HTTP Date Header
{{bibref|RFC2616|Section 14.18}} in the HTTP client request.
When {{true}}, the CPE retries unsuccessful attempts to transfer
data.
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 retry interval multiplier as specified in
{{template|BULK-DATA-HTTP-RETRY-REF}}. 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
{{param|RetryMinimumWaitInterval}} and
({{param|RetryMinimumWaitInterval}} * {{param}} / 1000) as the first
retry wait interval. Other values in the retry pattern MUST be
calculated using this value as a starting point.
{{numentries}}
Determines whether or not data transfers that have failed are
required to be persisted across reboots. If {{param}} is {{true}},
then failed data transfers MUST be persisted across reboots. If
{{param}} is {{false}}, then failed data transfers are not required
to be persisted across reboots.
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 {{template|BULK-DATA-HTTP-QUERY-REF}}.
Name of the Request-URI parameter. If {{param}} is {{empty}}, the
name of the Request-URI parameter is the value of
{{param|Reference}}.
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 {{object}} represents the XMPP capabilities of the
device{{template|XMPP-APP-REF}}.
{{numentries}}
The algorithms supported by the CPE for resolving XMPP server
addresses and ports. {{enum}}
Use the preferred connection algorithm as specified in
{{bibref|RFC6120|Section 3.2.1}} where the value of the
{{param|Connection.{i}.Domain}} parameter is used to look up
the server address and port to use.
Use the fallback connection mechanism as specified in
{{bibref|RFC6120|Section 3.2.2}}, where the value of the
{{param|Connection.{i}.Domain}} parameter is used to look up
the server address, and the port is the ''xmpp-client'' port
(5222).
Use the instances of the {{object|Connection.{i}.Server}} table
based on the values of the
{{param|Connection.{i}.Server.{i}.Priority}} and
{{param|Connection.{i}.Server.{i}.Weight}} parameters as the
basis for reconnect. Instances MUST be reachable and reachable
instances with the lowest value MUST be preferred.
Use the discovery and connection algorithm as specified in
{{bibref|RFC7395|Section 4}} where the value of the
{{param|Connection.{i}.Domain}} parameter is used to create a
secure HTTP request to discover the URL to use for the XMPP
over WebSocket connection.
The {{object}} represents a XMPP connection between the device and a
server. The {{param|Username}}, {{param|Domain}} and {{param|Resource}}
comprise the full identity (JabberID) of this {{object}} for this
device.
Enables or disables this {{object}}. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The proposed local-part of the Jabber ID of this {{object}}, and the
value to be used to authenticate this {{object}} when making a
connection to the Server using the procedure outlined in
{{bibref|RFC6120|Section 6}}.
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.
The proposed domain-part of the Jabber ID of this {{object}}.
The proposed resource-part of the Jabber ID of this {{object}}.
The complete Jabber ID as determined by the first-hop XMPP server at
time of connection establishment. This Jabber ID will usually be the
standard concatentation of the local-part (Username), domain-part
(Domain), and resource-part (Resource) as defined in
{{bibref|RFC6120|Section 2.1}}
(local-part@domain-part/resource-part), but since the Jabber ID is
owned by the first-hop XMPP Server there are cases where the value
will be different.
The current operational state of this {{object}} (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Disabled}} or
{{enum|Error}} if there is a fault condition on the interface). When
{{param|Enable}} is changed to {{true}} then {{param}} SHOULD change
to {{enum|Enabled}} if and only if the interface is able to transmit
and receive PDUs; it SHOULD change to {{enum|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 {{enum|Enabled}} if still operable when the expected actions have
completed); it SHOULD change to {{enum|Unknown}} if the state of the
interface can not be determined for some reason.
The date and time at which this {{object}} entered into its current
operational state.
The algorithm the {{object}} uses when connecting with the associated
lists of servers.
The number of {{units}} that keep alive events as specified in
{{bibref|RFC6120|Section 4.6.1}} are sent by this {{object}}. A value
of 0 disables the keep alive functionality. A value of -1 indicates
that the keep alive interval is a vendor specific implementation.
{{bibref|RFC6120|Section 4.6.4}} recommends not checking more
frequently than every 5 minutes (or 300 {{units}}).
The number of times that this {{object}} 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 {{param}}, {{param|ServerRetryInitialInterval}},
{{param|ServerRetryIntervalMultiplier}} and
{{param|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 {{object}} fails to
connect to any of the servers' IP addresses, fallback behavior SHOULD
be as specified in {{bibref|RFC6120|Section 3.2}}. NOTE: If the value
of this parameter is 0, server connection and reconnection behavior
is implementation-dependent.
The maximum first reconnection wait interval, in
{{units}}{{template|XMPP-REF}}. The Device MUST use a random value
between ''0'' and {{param}} as the first reconnection wait interval.
NOTE: If the value of the {{param|ServerConnectAttempts}} parameter
is 0, the value of this parameter is ignored.
The reconnection interval multiplier{{template|XMPP-REF}}. This value
is expressed in units of 0.001. Hence the values of the multiplier
range between 1.000 and 65.535. For the ''n''th reconnection wait
interval, the Device MUST use a random value, in ''seconds'', between
''0'' and {{param|ServerRetryInitialInterval}} * ({{param}} / 1000)
** (''n'' - ''1''). NOTE: If the value of the
{{param|ServerConnectAttempts}} parameter is 0, the value of this
parameter is ignored.
The maximum reconnection wait interval, in {{units}}. If the ''n''th
reconnection wait interval calculated from
{{param|ServerRetryInitialInterval}} and
{{param|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
{{param|ServerConnectAttempts}} parameter is 0, the value of this
parameter is ignored.
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 {{param}} is {{true}} then
the CPE will initiate TLS negotiation if not required to by the XMPP
Server. If the value of {{param}} is {{false}} then the CPE will not
initiate TLS negotiation if not required to by the XMPP Server.
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}}.
{{numentries}}
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}}.
Enables or disables this {{object}}. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The priority of this {{object}} that is used by the
{{object|##.Connection}} when determining the {{object}} to connect.
The {{object|##.Connection}} MUST contact the {{object}} with the
lowest-numbered priority that the {{object|##.Connection}} 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|##.Connection}}.
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.
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.
Port number of the XMPP server for this {{object|##.Connection}}.
XMPP Connection statistics information for this resource.
The number of XMPP stanzas (iq, presence, or message) that have been
received on this {{object|##.Connection}}.
The number of XMPP stanzas (iq, presence, or message) that have been
transmitted by this {{object|##.Connection}}.
The number of XMPP stanzas (iq, presence, or message) that have been
received on this {{object|##.Connection}} where the type attribute
had a value of "error".
The number of XMPP stanzas (iq, presence, or message) that have been
transmitted by this {{object|##.Connection}} where the type attribute
had a value of "error".
This object represents the management functions for the 1905
capabilities as defined in {{bibref|IEEE1905.1a}}.
1905 profile version number of the AL as would be sent in a Higher
Layer response message as defined in {{bibref|IEEE1905.1a|Table 6-37:
1905 profile version TLV}}.
This object represents the management functions for the 1905
Abstraction Layer as defined in {{bibref|IEEE1905.1a|Section 4.4
Abstraction Layer}}.
1905 AL MAC Address.
The current operational state of the 1905 Abstraction Layer. {{enum}}
The {{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
NOT RECOMMENDED for use; if used it means {{enum|Enabled}}
NOT RECOMMENDED for use; if used it means {{enum|Disabled}}
NOT RECOMMENDED for use; if used it means {{enum|Error}}
NOT RECOMMENDED for use; if used it means {{enum|Error}}
NOT RECOMMENDED for use; if used it means {{enum|Error}}
NOT RECOMMENDED for use; if used it means {{enum|Error}}
This parameter is NOT RECOMMENDED to be used because IEEE1905 is not
an interface. The accumulated time in {{units}} since the 1905
Abstraction Layer entered its current operational state.
This parameter is NOT RECOMMENDED to be used because IEEE1905 is not
an interface. {{list}} {{reference}} See {{bibref|TR-181i2|Section
4.2.1}}.
{{list}} See {{bibref|IEEE1905.1a|Table 6-25: SupportedFreqBand
TLV}}. {{enum}}
{{numentries}}
The 1905 interface table (described in {{bibref|IEEE1905.1a|sub-clause
5 Abstraction Layer Management}}).
MAC Address of this interface. This is the value of the intfAddress
parameter defined in {{bibref|IEEE1905.1a|Table 5-2: intfDescriptor
elements}}
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
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} It SHOULD change to
{{enum|Up}} if and only if the interface is able to transmit and
receive network traffic; it SHOULD normally be {{enum|Down}} when the
interface cannot transmit and receive network traffic; it SHOULD
change to {{enum|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 {{enum|Up}} if
still operable when the expected actions have completed); it SHOULD
change to {{enum|LowerLayerDown}} if and only if the interface is
prevented from entering the {{enum|Up}} state because one or more of
the interfaces beneath it is down; it SHOULD remain in the
{{enum|Error}} state if there is an error or other fault condition
detected on the interface; it SHOULD remain in the
{{enum|NotPresent}} state if the interface has missing (typically
hardware) components; it SHOULD change to {{enum|Unknown}} if the
state of the interface can not be determined for some reason. This
parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}.
This parameter is NOT RECOMMENDED to be used because it is not a
parameter defined in a 1905 ALME primitive or protocol TLV. The
accumulated time in {{units}} since the interface entered its current
operational state.
This parameter is NOT RECOMMENDED to be used because it is not a
parameter defined in a 1905 ALME primitive or protocol TLV. {{list}}
{{reference|an interface object that is stacked immediately below
this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
Path name of an interface object described by this 1905 {{object}}.
Referenced interface object MUST have a MACAddress and the
InterfaceId MUST be the same as the interface object MACAddress.
Media type of this {{object}}. This is derived from the value of the
intfType parameter defined in {{bibref|IEEE1905.1a|Tables 5.2:
intfDescriptor elements}}. {{enum}}
IEEE 802.3u Fast Ethernet
IEEE 802.3ab Gigabit Ethernet
IEEE 802.11b (2.4GHz)
IEEE 802.11g (2.4GHz)
IEEE 802.11a (5GHz)
IEEE 802.11n (2.4GHz)
IEEE 802.11n (5GHz)
IEEE 802.11ac (5GHz)
IEEE 802.11ad (60GHz)
IEEE 802.11af
IEEE 1901 Wavelet
IEEE 1901 FFT
MoCAv1.1
OUI of the Generic Phy networking technology of the local interface
that would be included in a Generic Phy Device Information Type TLV
defined in {{bibref|IEEE1905.1a|Tables 6-29: Generic Phy Device
Information type TLV}}.
Variant Index of the Generic Phy networking technology of the local
interface that would be included in a Generic Phy Device Information
Type TLV defined in {{bibref|IEEE1905.1a|Tables 6-29: Generic Phy
Device Information type TLV}}.
{{datatype}} to the Generic Phy XML Description of the Generic Phy
networking technology of the local interface that would be included
in a Generic Phy Device Information Type TLV defined in
{{bibref|IEEE1905.1a|Table 6-29: Generic Phy device information type
TLV}}.
Enables or disables the Abstraction Layer's ability to set the power
state for the interface. Boolean can be {{true}} for "enabled" and
{{false}} for "disabled".
The Power State of this {{object}}. This is derived from the value of
the powerState parameter as defined in {{bibref|IEEE1905.1a|Tables
5.3: ALME-SET-INTF-PWR-STATE.request parameters and Table 5.7:
ALME-GET-INTF-PWR-STATE.response parameters}}. {{enum}}
not used when written
not used when written
{{numentries}}
{{numentries}}
This object defines the vendor specific properties (vendorSpecificInfo
field) of this {{object|##.Interface}} as defined in
{{bibref|IEEE1905.1a|Table 5-2: intfDescriptor elements}}.
Organizationally unique identifier of a manufacturer of this
{{object|##.Interface}}. Represented as a six hexadecimal-digit value
using all upper-case letters and including any leading zeros
according to {{bibref|IEEE1905.1a|Table 5-20: VendorSpecificInfo
information element}}. {{pattern}}
A hexbinary string used to to provide vendor specific information
about this {{object|##.Interface}}. This is the value of the
vendorSpecificInfo parameter defined in {{bibref|IEEE1905.1a|Table
5-20: VendorSpecificInfo information element}}.
This object defines the 1905 neighbors and link properties.
MAC Address of the interface of the Neighbor for this {{object}}.
This value comes from the neighbor’s Topology discovery message as
defined in {{bibref|IEEE1905.1a|Table 6-9: MAC address typeTLV}}.
MAC Address of the 1905 AL entity of the Neighbor device on this
{{object}}. This value comes from the neighbor’s Topology discovery
message as defined in {{bibref|IEEE1905.1a|Table 6-8: AL MAC address
type TLV}}.
Media type of this {{object}}. This value is derived from the
neighbor’s Topology response message 1905 device information type TLV
Media Type field as defined in {{bibref|IEEE1905.1a|Table 6-12: Media
type}}. {{enum}}
IEEE 802.3u Fast Ethernet
IEEE 802.3ab Gigabit Ethernet
IEEE 802.11b (2.4GHz)
IEEE 802.11g (2.4GHz)
IEEE 802.11a (5GHz)
IEEE 802.11n (2.4GHz)
IEEE 802.11n (5GHz)
IEEE 802.11ac (5GHz)
IEEE 802.11ad (60GHz)
IEEE 802.11af
IEEE 1901 Wavelet
IEEE 1901 FFT
MoCAv1.1
OUI of the Generic Phy networking technology of the interface of the
Neighbor for this {{object|#.Link}}. This value is from a Generic Phy
response message field as defined in {{bibref|IEEE1905.1a|Tables
6-29: Generic Phy Device Information type TLV}}.
Variant Index of the Generic Phy networking technology of the
interface of the Neighbor for this {{object|#.Link}}. This value is
from a Generic Phy response message variant index field as defined in
{{bibref|IEEE1905.1a|Tables 6-29: Generic Phy Device Information type
TLV}}.
{{datatype}} to the Generic Phy XML Description of the Generic Phy
networking technology of the interface of the Neighbor for this
{{object|#.Link}}. This value is from a Generic Phy response message
URL to Generic Phy field as defined in {{bibref|IEEE1905.1a|Table
6-29: Generic Phy device information type TLV}}.
This object represents the metrics for this {{object|##.Link}} as
defined in {{bibref|IEEE1905.1a|Tables 6-18: 1905 transmitter link
metrics and Table 6-20: 1905 receiver link metrics}}.
Indicates whether or not the 1905 link includes one or more IEEE
802.1 bridges. If {{false}}, the 1905 link does not include an IEEE
802.1 bridge. If {{true}}, the 1905 link does include one or more
IEEE 802.1 bridges.
Estimated number of lost {{units}} on the transmit side of the link
{{bibref|IEEE1905.1a|Table 6-18: 1905 transmitter link metrics}}
during a measurement period.
Estimated number of lost {{units}} on the receive side of the link
{{bibref|IEEE1905.1a|Table 6-20: 1905 receiver link metrics}} during
a measurement period.
Estimated number of {{units}} sent to the Neighbor on this
{{object|##.Link}}, in the same measurement period used to estimate
{{param|PacketErrors}}.
Estimated number of {{units}} received from this Neighbor on this
{{object|##.Link}} {{bibref|IEEE1905.1a|Table 6-20: 1905 receiver
link metrics}}, in the same measurement period used to estimate
{{param|PacketErrors}}.
The maximum MAC throughput in {{units}} between this
{{object|###.Interface}} and the Neighbor on this {{object|##.Link}}
that is estimated at this {{object|###.Interface}}.
The estimated average {{units}} of time that the {{object|##.Link}}
is available for data transmissions.
The Physical Layer (PHY) rate in {{units}} between this
{{object|###.Interface}} and the Neighbor on this {{object|##.Link}}
that is estimated at this {{object|###.Interface}}.
The estimated Received Signal Strength Indicator (RSSI) ratio in
{{units}} between this {{object|###.Interface}} and the Neighbor on
this {{object|##.Link}} that is estimated at the receive side of this
{{object|###.Interface}}.
This object represents the rules to forward PDUs between interfaces
within the 1905 Abstraction Layer.
Abstraction Layer ability to set, modify, and remove
{{object|ForwardingRule}} entries for interfaces. Boolean can be
{{true}} for "enabled" and {{false}} for "disabled".
{{numentries}}
The 1905 fowarding rule for the ALME-SET-FWD-RULE.request and
ALME-GET-FWD-RULES.response with classification criteria as defined in
{{bibref|IEEE1905.1a|Table 5-9: ClassificationSet elements}}.
The list of interfaces to which a frame satisfying the following
classification criteria should be forwarded (intfAddressList
parameter as defined in {{bibref|IEEE1905.1a|Table 5-8:
ALME-SET-FWD-RULE.request parameters and Table 5-12: fwdRuleList
elements}}). {{list}} Each list item MUST be the path name of an
object, which MUST be a row of an {{object|##.Interface}} object. If
the referenced item is deleted, the corresponding item MUST be
removed from the list. {{noreference}}
Classification criterion. The destination MAC address.
If {{false}}, the classification criterion
{{param|MACDestinationAddress}} is ignored. If {{true}}, the
classification criterion {{param|MACDestinationAddress}} is used.
Classification criterion. The source MAC address.
If {{false}}, the classification criterion {{param|MACSourceAddress}}
is ignored. If {{true}}, the classification criterion
{{param|MACSourceAddress}} is used.
Classification criterion. Ether Type Field in a frame.
If {{false}}, the classification criterion {{param|EtherType}} is
ignored. If {{true}}, the classification {{param|EtherType}} is used.
Classification criterion. IEEE 802.1Q VLAN ID in a frame.
If {{false}}, the classification criterion {{param|Vid}} is ignored.
If {{true}}, the classification {{param|Vid}} is used.
Classification criterion. IEEE 802.1Q Priority Code Point field.
If {{false}}, the classification criterion {{param|PCP}} is ignored.
If {{true}}, the classification {{param|PCP}} is used.
This object represents the 1905 Network Topology capabilities of this
device.
Enables or disables the 1905 Network Topology reporting (via a
Controller). When {{true}}, the device clears and (re)populates the
{{object|IEEE1905Device}} and {{object|ChangeLog}} tables. When
{{false}}, the contents of the {{object|IEEE1905Device}} and
{{object|ChangeLog}} tables have no meaning.
When {{param|Enable}} is set to {{true}}, this parameter indicates
the transient phase of the discovery of the {{object}}. {{enum}}
Indicates that the device is populating the topology object
during the transient phase.
Indicates that the transient phase is over and the device is
maintaining and updating the topology object as changes occur.
NOT RECOMMENDED for use; if used, indicates that a necessary
configuration value is undefined or invalid.
The maximum number of entries allowed in the {{object|ChangeLog}}
table.
{{reference}} If the {{object|ChangeLog}} is modified the parameter
is modified to reflect the last entry added to the
{{object|ChangeLog}}.
{{numentries}}
{{numentries}}
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 {{param|TimeStamp}} parameter) are
deleted once the log is full.
Date and Time at which the entry was added to the {{object}} table.
Type of event for this entry. {{enum}}
Entry represents a discovery of a Neighbor.
Entry represents the loss of a Neighbor.
1905 AL MAC Address of device which reported the change.
MAC Address of the interface of the reporting device on which the
change has been detected.
Type of Neighbor for this event. {{enum}}
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.
This object represents an instance of discovered 1905 Devices in the
network (received Topology discovery message as defined in
{{bibref|IEEE1905.1a|Clause 6.3.1}}).
1905 AL MAC Address.
1905 profile version number in Higher Layer Response message as
defined in {{bibref|IEEE1905.1a|Table 6-37: 1905 profile version
TLV}}.
{{list}} of frequency bands identified as supported for a registrar
role in an AP-autoconfiguration response message as defined in
{{bibref|IEEE1905.1a|Table 6-25: SupportedFreqBand TLV}} {{enum}}.
Friendly Name String received in Higher Layer response message as
defined in {{bibref|IEEE1905.1a|Table 6-30: Device Identification
Type TLV}}.
Manufacturer Name String received in Higher Layer response message as
defined in {{bibref|IEEE1905.1a|Table 6-30: Device Identification
Type TLV}}.
Manufacturer Model String received in Higher Layer response message
as defined in {{bibref|IEEE1905.1a|Table 6-30: Device Identification
Type TLV}}.
Control {{datatype}} received in Higher Layer response message as
defined in defined in {{bibref|IEEE1905.1a|Table 6-31: Control URL
Type TLV}}.
{{param}} is a reference to the Wi-Fi Network "APDevice". Since IEEE
1905.1 is the protocol used by the Wi-Fi Alliance's EasyMesh
specification for communications, this parameter allows the IEEE
1905.1 portion of the data model to reference the associated EasyMesh
portion of the data model.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
This object represents represents all IPv4 addresses reported for a MAC
address (AL or interface) in a Higher Layer response message for the
IEEE1905Device as defined in {{bibref|IEEE1905.1a|Table 6-32: IPv4 type
TLV}}.
MAC Address.
IPv4 Address.
The IPv4 Address Type of this {{param|IPv4Address}}. {{enum}}
Either IPv4 address of DHCPv4 server or IPv6 address of DHCPv6
server.
This object represents represents all IPv6 addresses reported for a MAC
address (AL or interface) in a Higher Layer response message for the
IEEE1905Device as defined in {{bibref|IEEE1905.1a|Table 6-34: IPv6 type
TLV}}.
MAC Address.
IPv6 Address.
The IPv6 Address Type of this {{param|IPv6Address}}. {{enum}}
"::" or the IPv6 address of the origin of this IPv6 address.
This object represents vendor specific information received in a
message with a Vendor specific TLV (as defined in in
{{bibref|IEEE1905.1a|Table 6-7: Vendor specific TLV}}).
The Message type of a message received from this IEEE1905Device that
contained a Vendor specific TLV, as defined in
{{bibref|IEEE1905.1a|Table 6-4: Message type}}.
This is the value of the Vendor specific OUI defined in
{{bibref|IEEE1905.1a|Table 6-7: Vendor specific TLV}}. {{pattern}}
A hexbinary string used to provide vendor specific information. This
is the value of the Vendor specific information parameter defined in
{{bibref|IEEE1905.1a|Table 6-7: Vendor specific TLV}}.
This object represents an instance of an interface for the
{{object|##.IEEE1905Device}}.
MAC Address of the interface. This comes from the Topology response
message as defined in {{bibref|IEEE1905.1a|Table 6-10: 1905 device
information type TLV}}.
Media type of this {{object}}. This comes from the Topology response
message as defined in {{bibref|IEEE1905.1a|Table 6-10: 1905 device
information type TLV}}. {{enum}}
IEEE 802.3u Fast Ethernet
IEEE 802.3ab Gigabit Ethernet
IEEE 802.11b (2.4GHz)
IEEE 802.11g (2.4GHz)
IEEE 802.11a (5GHz)
IEEE 802.11n (2.4GHz)
IEEE 802.11n (5GHz)
IEEE 802.11ac (5GHz)
IEEE 802.11ad (60GHz)
IEEE 802.11af
IEEE 1901 Wavelet
IEEE 1901 FFT
MoCAv1.1
The Power State of this {{object}}. "{{enum|Off}}" is used for
interfaces identified in a Power Off Interface TLV as defined in
{{bibref|IEEE1905.1a|Table 6-38}}. "{{enum|On}}" is used for all
other interfaces. "{{enum|Power_Save}}" and "{{enum|Unsupported}}"
are not used at this time. Updated as a result of a received
Interface Power Change response with “request completed” or
“alternate change made” Interface Power Change status as defined in
{{bibref|IEEE1905.1a|Table 6-40: Interface Power Change status TLV}}.
{{enum}}
{{param}} of this {{object|#.Interface}}. {{pattern}}
Variant Index of the Generic Phy networking technology of this
{{object|#.Interface}}. This value is from a Generic Phy response
message variant index field as defined in {{bibref|IEEE1905.1a|Table
6-29: Generic Phy device information type TLV}}.
{{datatype}} to the Generic Phy XML Description of the Generic Phy
networking technology of this {{object|#.Interface}}. This value is
from a Generic Phy response message URL to generic phy field as
defined in {{bibref|IEEE1905.1a|Table 6-29: Generic Phy device
information type TLV}}.
MACAddress Field from Media specific information for an 802.11
interface provided in a Topology response message 1905 device
information type TLV as defined in {{bibref|IEEE1905.1a|Table 6-13:
IEEE 802.11 specific information}}.
Field from Media specific information for an 802.11 interface
provided in a Topology response message 1905 device information type
TLV as defined in {{bibref|IEEE1905.1a|Table 6-13: IEEE 802.11
specific information}}. {{enum}}
Hexadecimal digit. Field from Media specific information for an
802.11 interface provided in a Topology response message 1905 device
information type TLV as defined in {{bibref|IEEE1905.1a|Table 6-13:
IEEE 802.11 specific information}}
Field from Media specific information for an 802.11 interface
provided in a Topology response message 1905 device information type
TLV as defined in {{bibref|IEEE1905.1a|Table 6-13: IEEE 802.11
specific information}}
Field from Media specific information for an 802.11 interface
provided in a Topology response message 1905 device information type
TLV as defined in {{bibref|IEEE1905.1a|Table 6-13: IEEE 802.11
specific information}}
This object represents an instance of a Non-IEEE1905 Neighbor for the
{{object|##.IEEE1905Device}}. These fields come from a Topology
response message as defined in {{bibref|IEEE1905.1a|Table 6-14:
Non-1905 neighbor device TLV}}.
{{reference}}
MAC Address of the interface for the {{object}}.
This object represents an instance of an L2 Neighbor for the
{{object|##.IEEE1905Device}}. These fields come from a Topology
response message as defined in {{bibref|IEEE1905.1a|Table 6-41: L2
neighbor device TLV}}.
{{reference}}
MAC Address of the {{object}}.
{{list}} Behind MAC Addresses of the {{object}}.
This object represents an instance of an {{object}} for the
{{object|##.IEEE1905Device}}. These values are from the Topology
response message as defined in {{bibref|IEEE1905.1a|Table 6-15: 1905
neighbor device TLV}}.
{{reference}}
1905 AL MAC Address of the Neighbor.
{{numentries}}
This object represents the metrics included in a Link metric response
from the IEEE1905Device where {{param|#.LocalInterface}} is the MAC
address of an interface in the receiving 1905 AL as defined in
{{bibref|IEEE1905.1a|Table 6-17: 1905 transmitter link metric TLV}}.
The MAC address of an interface in a neighbor 1905 device as defined
in {{bibref|IEEE1905.1a|Table 6-17: 1905 transmitter link metric TLV
or Table 6-19: 1905 receiver link metric TLV}}.
Indicates whether or not the 1905 link includes one or more IEEE
802.1 bridges. If {{false}}, the 1905 link does not include an IEEE
802.1 bridge. If {{true}}, the 1905 link does include one or more
IEEE 802.1 bridges.
Estimated number of lost {{units}} on the transmit side of the link
{{bibref|IEEE1905.1a|Table 6-18: 1905 transmitter link metrics}}
during a measurement period.
Estimated number of lost {{units}} on the receive side of the link
{{bibref|IEEE1905.1a|Table 6-20: 1905 receiver link metrics}} during
a measurement period.
Estimated number of {{units}} sent to the Neighbor on this link, in
the same measurement period used to estimate {{param|PacketErrors}}.
Estimated number of {{units}} received from this Neighbor
{{bibref|IEEE1905.1a|Table 6-20: 1905 receiver link metrics}} on this
link, in the same measurement period used to estimate
{{param|PacketErrors}}.
The maximum MAC throughput in {{units}} between this Interface and
the Neighbor on this link that is estimated at this Interface.
The estimated average {{units}} of time that this link is idle.
The Physical Layer (PHY) rate in {{units}} between this Interface and
the Neighbor on this link that is estimated at this Interface.
The estimated Received Signal Strength Indicator (RSSI) ratio in
{{units}} between this Interface and the Neighbor on this link that
is estimated at the receive side of this Interface. Note: This
parameter is valid only for IEEE 802.11 Neighbors.
This object represents an instance of an {{object}} for the
{{object|##.IEEE1905Device}}. These values come from the 1905 Device’s
Topology response message as defined in {{bibref|IEEE1905.1a|Table
6-11: Device bridging capability TLV}}.
{{list}} {{reference}}
This object represents the Security configuration for the 1905 device
as defined in {{bibref|IEEE1905.1a|Section 9.2 Security Setup
Methods}}.
{{list}} Supported security setup method(s) for the network. {{enum}}
User Configured Passphrase or Key
Push Button Configuration
Near-field Communication Network Key
1905 network passphrase for generating security keys.
This object represents the detected Network Registrars detection
function for the IEEE 1905 network. They are determined by received
AP-autoconfiguration response messages with Registrar role, with
supported band as defined in {{bibref|IEEE1905.1a|Table 6-25:
SupportedFreqBand TLV}}
{{list}} 1905 AL MAC addresses as determined by source MAC address in
received AP-autoconfiguration response messages with supported
frequency band of 802.11 2.4 GHz.
{{list}} 1905 AL MAC addresses as determined by source MAC address in
received AP-autoconfiguration response messages with supported
frequency band of 802.11 5 GHz.
{{list}} 1905 AL MAC addresses as determined by source MAC address in
received AP-autoconfiguration response messages with supported
frequency band of 802.11 60 GHz.
MQTT Base object describing all MQTT related parameters and objects.
{{numentries}}
{{numentries}}
Indicates the MQTT capabilities of the device.
Indicates the supported protocol versions. {{enum}}
Protocol according to {{bibref|MQTT31}}
Protocol according to {{bibref|MQTT31}}
Protocol according to {{bibref|MQTT50}}
Indicates the supported transport protocols. {{enum}}
Indicates the maximum number of subscriptions per MQTT client, which
can be stored in the {{object|#.Client.{i}.Subscription}} table. A
value of 0 means no limit.
Indicates the maximum number of bridges, which can be configured in
the {{object|#.Broker.{i}.Bridge}} table. A value of 0 means no
limit.
Indicates the maximum number of subscriptions, which can be stored
per bridge instance in the
{{object|#.Broker.{i}.Bridge.{i}.Subscription}} table. A value of 0
means no limit.
MQTT client table. Contains a list of configured MQTT clients.
{{datatype|expand}}
The textual name of the MQTT client.
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
{{object|Subscription.}} table. If the {{param|ProtocolVersion}} is
set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or
{{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}} and
{{param|CleanSession}} is set to {{false}} a subscription MUST only
be sent for topics which haven't been subscribed before (see
{{bibref|MQTT31|section 3.1.2.4}}). If the {{param|ProtocolVersion}}
is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}} and
{{param|CleanStart}} is set to {{false}} a subscription MUST only be
sent for topics which haven't been subscribed before (see
{{bibref|MQTT50|section 3.1.2.4}}). If a connected MQTT client gets
disabled ({{param|Status}} is either {{enum|Connecting|Status}} or
{{enum|Connected|Status}}) then the MQTT client has to send a MQTT
DISCONNECT packet to disconnect from the MQTT broker
({{bibref|MQTT31|section 3.14}},{{bibref|MQTT31|section 3.14}}) or
{{bibref|MQTT50|section 3.14}}), before setting the {{param|Status}}
to {{enum|Disabled|Status}}.
Indicates the status of this MQTT client. {{enum}} The
{{enum|Error_Misconfigured}} value indicates that a necessary
configuration value is undefined or invalid (e.g. The MQTT client can
not use the defined port, because it is blocked) The
{{enum|Error_BrokerUnreachable}} value indicates that the connection
to the MQTT broker could not be established. The {{enum|Error}} value
MAY be used by the CPE to indicate a locally defined error condition.
Specifies the MQTT protocol version used in the communication with
the MQTT broker.
When {{true}}, encryption MUST be used for this MQTT {{object}}
instance.
Host name or IP address of the MQTT Broker.
Port number of the MQTT broker.
Indicates the transport protocol to be used for the MQTT broker
connection.
The value of the MQTT clean session flag in the MQTT CONNECT packet
(see {{bibref|MQTT31|section 3.1}} and {{bibref|MQTT31|section
3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT
broker will delete all subscription information after a Disconnect.
{{template|MQTTReconnect}} This parameter only applies if
{{param|ProtocolVersion}} is set to
{{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or
{{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}.
The value of the MQTT Clean Start flag in the MQTT CONNECT packet
(see {{bibref|MQTT50|section 3.1.2.4}}. If this flag is set to
{{true}} (default), the MQTT broker will delete all subscription
information after a Disconnect. {{template|MQTTReconnect}}.
{{template|MQTT50ONLY}}
Enables or disables the will handling (see {{bibref|MQTT31|section
3.1}}, {{bibref|MQTT31|section 3.1.2.5}}) or {{bibref|MQTT50|section
3.1.2.5}}). If the connection gets enabled and this parameter is set
to {{true}} and either the parameter {{param|WillTopic}} or
{{param|WillValue}} are {{empty}}, the CPE MUST set the
{{param|Status}} to {{enum|Error_Misconfigured|Status}}.
{{template|MQTTReconnect}}.
The MQTT QoS level assigned with the will message (see
{{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.6}}) or
{{bibref|MQTT50|section 3.1.2.6}}). This parameter is only used if
{{param|WillEnable}} is set to {{true}}. {{template|MQTTWillChange}}
Indicate to the MQTT broker to retain the Will over a Disconnect (see
{{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.7}}) or
{{bibref|MQTT50|section 3.1.2.7}}). This parameter is only used if
{{param|WillEnable}} is set to {{true}}. {{template|MQTTWillChange}}
Keep Alive Time in {{units}} defines the maximum wait time after
which a packet has to be sent to the MQTT broker (see
{{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.10}}) or
{{bibref|MQTT50|section 3.1.2.10}}). 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. {{template|MQTTReconnect}}
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 {{param|Status|}}
is {{enum|Connected|Status}}). 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.
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}}
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
{{bibref|MQTT50|section 3.1.2.11.3}}). {{template|MQTTReconnect}}
{{template|MQTT50ONLY}}
The maximum packet size in {{units}} 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 {{bibref|MQTT50|section 3.1.2.11.4}}).
{{template|MQTTReconnect}} {{template|MQTT50ONLY}}
This value indicates the highest value that the MQTT client will
accept as a Topic Alias sent by the Server (see
{{bibref|MQTT50|section 3.1.2.11.5}}). 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. {{template|MQTTReconnect}} {{template|MQTT50ONLY}}
The MQTT client uses this value in a MQTT CONNECT packet to request
the Server to return Response Information in the MQTT CONNACK (see
{{bibref|MQTT50|section 3.1.2.11.6}}). {{template|MQTTReconnect}}
{{template|MQTT50ONLY}}
This value indicates whether the Reason String or User Properties are
sent in the case of failures.(see {{bibref|MQTT50|section
3.1.2.11.7}}). {{template|MQTTReconnect}} {{template|MQTT50ONLY}}
This value defines the extended authentication method to be used (see
{{bibref|MQTT50|section 3.1.2.11.9}}). If the parameter is empty, no
extended authentication is performed. {{template|MQTTReconnect}}
{{template|MQTT50ONLY}}
The MQTT client identifier used in the MQTT CONNECT packet (see
{{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.1}}) or
{{bibref|MQTT50|section 3.1.3.1}}). If {{param|ProtocolVersion}} is
set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or
{{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}, this
parameter MUST NOT be an empty string. If {{param|ProtocolVersion}}
is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}}, an
empty string is allowed. {{template|MQTTReconnect}}
The delay in {{units}} after the session is disconnected, before
sending the Will message {{bibref|MQTT50|section 3.1.3.2.2}}). A
value of 0 indicates that there is no delay.
{{template|MQTTWillChange}} {{template|MQTT50ONLY}}
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}}
Describes the type of the {{param|WillValue}} {{bibref|MQTT50|section
3.1.3.2.5}}). {{template|MQTTWillChange}} {{template|MQTT50ONLY}}
Topic Name for a will response message. The presence of a Response
Topic identifies the Will Message as a Request
{{bibref|MQTT50|section 3.1.3.2.6}}). If the {{param}} is an empty
string the will response topic will not be sent in a MQTT CONNECT
packet. {{template|MQTTWillChange}} {{template|MQTT50ONLY}}
The Topic sent in the Will Message (see {{bibref|MQTT31|section
3.1}}, {{bibref|MQTT31|section 3.1.3.3}}) or {{bibref|MQTT50|section
3.1.3.3}}). This parameter is only used if {{param|WillEnable}} is
set to {{true}}. {{template|MQTTWillChange}}
The value sent in the Will Message (see {{bibref|MQTT31|section
3.1}}, {{bibref|MQTT31|section 3.1.2.5}}) or {{bibref|MQTT50|section
3.1.3.4}}). This parameter is only used if {{param|WillEnable}} is
set to {{true}}. {{template|MQTTWillChange}}
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 {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section
3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). 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
{{empty}} no authentication parameters are sent in the MQTT CONNECT
packet.
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 {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section
3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). This password is
only sent in the MQTT CONNECT packet if {{param|Username}} is not
{{empty}}.
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}}
Message retry time in {{units}} 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 {{bibref|MQTT31|section 4.2}}).
This parameter only applies if {{param|ProtocolVersion}} is set to
{{enum|3.1|#.Capabilities.ProtocolVersionsSupported}}.
Connect retry time in {{units}} 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
{{param|ConnectRetryIntervalMultiplier}} is defined, the MQTT client
MUST use a random value between
{{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^(n-1) and
{{param}}*({{param|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
{{param|ConnectRetryIntervalMultiplier}} and
{{param|ConnectRetryMaxInterval}} are defined, the MQTT client MUST
use the value of {{param|ConnectRetryMaxInterval}} if the calculated
random value exceeds the value of {{param|ConnectRetryMaxInterval}}.
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.
The maximum reconnection wait interval, in {{units}}.
The value of the CONNACK Response Information property supplied by a
MQTT 5.0 server. This value is used by a MQTT 5.0 client as the basis
for the PUBLISH Response Topic property for all PUBLISH packets that
expect a response. If the value of {{param}} is not a subset
(wildcarded or precise match) of any of the
{{param|Subscription.{i}.Topic}} values the MQTT client MUST
subscribe to this Topic.
{{numentries}}
{{numentries}}
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.
{{datatype|expand}}
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}}.
Indicates the status of this subscription. {{enum}} The
{{enum|Subscribed}} value indicates that the topic was successfully
subscribed with the MQTT broker, the MQTT client received the SUBACK
message for this topic from the server. The {{enum|Subscribing}}
value MAY be used by the CPE to indicate that the a SUBSCRIBE message
for this topic was sent, and the CPE is waiting for a SUBACK message.
The {{enum|Unsubscribed}} value indicates that the topic is not
registered with the MQTT broker. The {{enum|Unsubscribing}} value MAY
be used by the CPE to indicate that the an UNSUBSCRIBE message for
this topic was sent, and the CPE is waiting for an UNSUBACK message.
If the {{param|Enable}} is set to {{false}} the status MUST be either
{{enum|Unsubscribed}} or if the unsubscription failed {{enum|Error}}.
Name of the subscribed topic. Topic names may contain wildcards
according to the rules specified in {{bibref|MQTT31|section Appendix
A}}, {{bibref|MQTT31|section 4.7}} or {{bibref|MQTT50|4.7}}.
The MQTT QoS level assigned with the subscription (see
{{bibref|MQTT31|section 4.1}}, {{bibref|MQTT31|section 4.3}}) or
{{bibref|MQTT50|4.3}}.
List of user properties used by the MQTT client. This table only
applies if {{param|#.ProtocolVersion}} is set to
{{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}.
{{datatype|expand}}
Setting Enable to {{true}} means the user property is used in the
indicated control packet(s). The user property will be applied to all
control packets of the same control packet type (e.g PUBLISH).
Name of the user property
Value of the user property
{{list}} Each entry defines the control packet type(s) in which the
user property is included.
User property will be added in the AUTH control packet (see
{{bibref|MQTT50|section 3.15.2.2.5}})
User property will be added in the CONNECT packet (see
{{bibref|MQTT50|section 3.1.3.2.8}})
User property will be added in the DISCONNECT packet (see
{{bibref|MQTT50|section 3.14.2.2.4}})
User property will be added in the PUBLISH packet (see
{{bibref|MQTT50|section 3.3.2.3.7}})
User property will be added in the PUBACK packet (see
{{bibref|MQTT50|section 3.4.2.2.3}})
User property will be added in the PUBREC packet (see
{{bibref|MQTT50|section 3.5.2.2.3}})
User property will be added in the PUBREL packet (see
{{bibref|MQTT50|section 3.6.2.2.3}})
User property will be added in the PUBCOMP packet (see
{{bibref|MQTT50|section 3.7.2.2.3}})
User property will be added in the SUBSCRIBE packet (see
{{bibref|MQTT50|section 3.8.2.1.3}})
User property will be added in the UNSUBSCRIBE packet (see
{{bibref|MQTT50|section 3.10.2.1.2}})
User property will be added in the WILL properties (see
{{bibref|MQTT50|section 3.1.3.2}})
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.
Time when the MQTT broker connection was established.
Time when the last publish message was sent to the MQTT broker.
Time when the last publish message was received from the MQTT broker.
Number of publish messages sent to the MQTT broker.
Number of publish messages received from to the MQTT broker.
Number of subscribe messages sent to the MQTT broker.
Number of unsubscribe messages sent to the MQTT broker.
Total number of MQTT messages sent to the MQTT broker.
Total number of MQTT messages received from the MQTT broker.
Number of connection errors.
Number of errors which prevented sending publish messages.
MQTT broker table. Contains a list of configured MQTT brokers.
{{datatype|expand}}
The textual name of the MQTT broker.
Allows to enable or disable the MQTT broker.
Indicates the status of the MQTT broker. {{enum}} The
"{{enum|Error_Misconfigured}}" value indicates that a necessary
configuration value is undefined or invalid. The "{{enum|Error}}"
value MAY be used by the CPE to indicate a locally defined error
condition.
Port used by the MQTT Broker.
If {{empty}} is specified, the CPE MUST bind the MQTT broker to all
available interfaces.
User name used to authenticate the MQTT clients, which connect to the
MQTT broker. If this parameter is {{empty}} no authentication is
used.
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}}.
{{numentries}}
Configures MQTT bridges, which are used to communicate with other MQTT
brokers.
{{datatype|expand}}
The textual name of the MQTT bridge used for identification.
Allows to enable or disable the MQTT Bridge.
Indicates the status of this MQTT Bridge. {{enum}} The
{{enum|Disabled}} value indicates that the MQTT bridge is not in
service; parameter {{param|Enable}} is set to {{false}}. The
{{enum|Connecting}} value indicates that the MQTT bridge is currently
established. The {{enum|Connected}} value indicates that the MQTT
bridge is currently active. The {{enum|Error_Misconfigured}} value
indicates that a necessary configuration value is undefined or
invalid (e.g. No active Server entry, the MQTT broker can not use the
defined bridge port, because it is blocked) The
{{enum|Error_BrokerUnreachable}} value indicates that the MQTT bridge
connection to the remote MQTT broker could not be established. The
{{enum|Error}} value MAY be used to indicate a locally defined error
condition.
Specifies the MQTT protocol version used in the MQTT bridge
connection.
Indicates the transport protocol to be used for the MQTT bridge
connection.
The value of the MQTT clean session flag in the MQTT CONNECT packet
(see {{bibref|MQTT31|section 3.1}} and {{bibref|MQTT31|section
3.1.2.4}}) 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.
{{template|MQTTReconnect}} This parameter only applies if
{{param|ProtocolVersion}} is set to
{{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or
{{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}.
The value of the MQTT Clean Start flag in the MQTT CONNECT packet
(see {{bibref|MQTT50|section 3.1.2.4}} 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. {{template|MQTTReconnect}}. This parameter only applies
if {{param|ProtocolVersion}} is set to
{{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}.
Keep Alive Time in {{units}} defines the maximum wait time after
which a packet has to be sent to the remote MQTT broker (see
{{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.10}}) or
{{bibref|MQTT50|section 3.1.2.10}}). 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. {{template|MQTTReconnect}}
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
{{param|Status|}} is {{enum|Connected|Status}}). 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.
The MQTT client identifier used in the CONNECT packet (see
{{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.1}}) or
{{bibref|MQTT50|section 3.1.3.1}}). If {{param|ProtocolVersion}} is
set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or
{{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}, this
parameter MUST NOT be an empty string. If {{param|ProtocolVersion}}
is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}, an
empty string is allowed. {{template|MQTTReconnect}}
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 {{bibref|MQTT31|section 3.1}},
{{bibref|MQTT31|section 3.1.3.4}} or {{bibref|MQTT50|section
3.1.3.5}}). 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 {{empty}} no authentication parameters
are sent in the MQTT CONNECT packet.
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 {{bibref|MQTT31|section 3.1}},
{{bibref|MQTT31|section 3.1.3.5}} or {{bibref|MQTT50|section
3.1.3.6}}). This password is only sent in the MQTT CONNECT packet if
{{param|Username}} is not {{empty}}.
Message retry time in {{units}} 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 {{bibref|MQTT31|section 4.2}}. This
parameter only applies if {{param|ProtocolVersion}} is set to
{{enum|3.1|##.Capabilities.ProtocolVersionsSupported}}.
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.
The algorithm used to select a server entry from the
{{object|Server}} table
Select the server from the {{object|Server.}} table according
to the sequence defined with the {{param|Server.{i}.Priority}}
and {{param|Server.{i}.Weight}} values.
Select the servers round robin.
Select the servers randomly.
{{reference|the {{object|Server.}} instance that is used for this
{{object}}, while the {{param|Status}} is {{enum|Connecting|Status}}
or {{enum|Connected|Status}}. If the MQTT bridge is not connected the
value MUST be an empty string}}
{{numentries}}
{{numentries}}
Each {{object}} instance represents a MQTT bridge server to be used for
a {{object|##.Bridge}}. A remote MQTT broker, which is connected by a
MQTT bridge can be reachable via several host addresses each
represented by its own {{object}} 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 {{param|##.Bridge.{i}.Enable}} to
{{true}}, which either has an empty {{object}} table or the {{object}}
table only contains instances whose {{param|Enable}} is set to
{{false}}, the {{param|##.Bridge.{i}.Status}} has to be set to
{{enum|Error_Misconfigured|##.Bridge.{i}.Status}}. Any attempt to
delete an instance, which is currently in use
({{param|##.Bridge.{i}.ServerConnection}} refers to the instance to be
deleted), has to be rejected.
Enables or disables this {{object}}.
{{datatype|expand}}
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}}.
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}}.
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.
Port number of the MQTT broker server this {{object|##.Bridge}}
connects to.
List of MQTT subscriptions handled over the bridge.
{{datatype|expand}}
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}}.
Indicates the status of this subscription. {{enum}} The
{{enum|Enabled}} value indicates that the this subscription is
active. In case of incoming directions ({{param|Direction}} is either
{{enum|in|Direction}} or {{enum|both|Direction}}) the topic was
successfully subscribed with the remote MQTT broker. The
{{enum|Disabled}} value indicates that this subscription is not used.
The {{enum|Error}} value indicates that an error occurred (e.g. an
subscription could not be made with the remote MQTT broker) and the
subscription is not in use.
Name of the subscribed topic. Topic names may contain wildcards
according to the rules specified in {{bibref|MQTT31|section Appendix
A}}, {{bibref|MQTT31|section 4.7}} or {{bibref|MQTT50|4.7}}.
The direction of the subscription. {{enum}}.
Indicates that all matching topics will be sent over the bridge
to the next MQTT broker.
Indicates that all matching topics will be received over the
bridge from the next MQTT broker.
Indicates that all matching topics will be sent and received
over the bridge.
The MQTT QoS level assigned with the subscription (see
{{bibref|MQTT31|section 4.1}}, {{bibref|MQTT31|section 4.3}}) or
{{bibref|MQTT50|4.3}}.
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.
* In incoming direction ({{param|Direction}} is either
{{enum|in|Direction}} or {{enum|both|Direction}}):
: For remote topics received over the bridge the MQTT broker adds the
LocalPrefix in front of the received topic, before processing it.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", Direction is "in"
:: MQTT broker receives message with topic "/bus/tr181" over bridge
=> MQTT broker uses topic "/local/bus/tr181" for internal
processing
* In outgoing direction ({{param|Direction}} is either
{{enum|out|Direction}} or {{enum|both|Direction}}):
: For selection of the topics to be sent over the bridge the MQTT
broker uses the combination of {{param}} and {{param|Topic}} to
match the topics to be sent over bridge, and removes the {{param}}
from the selected topic before sending it over the bridge.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", Direction is "out"
:: MQTT broker receives message with topic "/local/bus/tr181" from a
MQTT client => MQTT broker sends topic "/bus/tr181" to remote
MQTT broker
The remote prefix is used for remapping topics to the remote MQTT
broker topic lists.
* In incoming direction ({{param|Direction}} is either
{{enum|in|Direction}} or {{enum|both|Direction}}):
: For remote topics received over the bridge the MQTT broker removes
the remote prefix topic from the received topic (before handling
the {{param|LocalPrefix}}), before processing it.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", RemotePrefix is
"/remote", Direction is "in"
:: MQTT broker receives message with topic "/remote/bus/tr181" over
bridge => MQTT broker uses topic "/local/bus/tr181" for
internal processing
: During activation of the bridge, the MQTT broker prepends the
{{param|Topic}} with {{param}} topic and subscribes to the remote
MQTT broker with it, in order to receive all applicable remote
topics.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", RemotePrefix is "/remote", Direction is "in"
:: MQTT broker sends a subscription to the remote MQTT broker with
the topic "/remote/bus/+".
* In outgoing direction ({{param|Direction}} is either
{{enum|out|Direction}} or {{enum|both|Direction}}):
: For all topics to be sent over the bridge ({{param|Direction}} is
either {{enum|out|Direction}} or {{enum|both|Direction}}), the
RemotePrefix will be prepended to the topic after the
{{param|LocalPrefix}} has been processed and before sending the
message over the bridge.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", RemotePrefix is
"/remote" Direction is "out"
:: MQTT broker receives message with topic "/local/bus/tr181" from a
MQTT client => MQTT broker sends topic "/remote/bus/tr181" to
remote MQTT broker
The MQTT broker statistics values. These will reset with each MQTT
broker start, either after reboot or if the MQTT broker gets
(re-)enabled.
Total number of MQTT clients registered with the MQTT broker.
Number of MQTT clients, which have a connection with the MQTT broker
established.
Number of MQTT clients, which have no connection with the MQTT broker
established.
Number of subscriptions held by the MQTT broker.
Number of publish messages sent by the MQTT broker.
Number of publish messages received by the MQTT broker.
Total number of MQTT messages sent by the MQTT broker.
Total number of MQTT messages received by the MQTT broker.
Number of connection errors.
Number of errors which prevented sending publish messages
Properties for Dynamic DNS.
{{numentries}}
{{numentries}}
List of Dynamic DNS service names that are supported by the CPE.
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 {{param|Server}} is not a valid reference then the table entry is
inoperable and the CPE MUST set the {{param|Status}} to
{{enum|Error_Misconfigured|Status}}.
Enables or disables this Dynamic DNS Client.
Status of this Dynamic DNS Client.
The Dynamic DNS Client is trying to connect to the Server.
The Dynamic DNS Client is in the authentication phase.
The Dynamic DNS Client has performed an update request since
the last IP address change.
Error due to configuration.
An error has occurred during the communication with the Server.
The {{param|LastError}} parameter is updated with the detail of
this error.
The Client is disabled.
{{datatype|expand}}
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 DynamicDNS server associated with this Dynamic DNS Client.
{{reference}}
The IP interface over which update queries to the server are sent.
{{reference}} If an empty string is specified, the CPE MUST use its
routing policy (Forwarding table entries), to determine the
appropriate interface.
Username used by this Dynamic DNS Client to authenticate with the
Server.
Password used by this Dynamic DNS Client to authenticate with the
Server.
{{numentries}}
Each table entry represents a fully qualified domain name updated by
this Dynamic DNS Client.
Enables or disables this Hostname.
Status of this Hostname.
The Hostname has been updated with the current IP address.
The IP address has changed since last update.
The Client is trying to update this Hostname.
The Hostname doesn't exist for this Dynamic DNS account.
The Hostname is disabled.
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.
The date time of the last successful update of this name to the
Dynamic DNS Server.
Table of Dynamic DNS servers available for this CPE.
Enables or disables Dynamic DNS Server.
The textual name of the Dynamic DNS Server.
{{datatype|expand}}
Dynamic DNS service used to contact this server. {{reference}}
Host name or IP address of the Dynamic DNS server.
Port number of the Dynamic DNS server.
Indicates the protocols that are supported by the CPE for sending
requests to the Dynamic DNS server. {{list}} This list depends on the
Dynamic DNS service defined by the {{param|ServiceName}} parameter.
As defined in {{bibref|RFC2616}}
As defined in {{bibref|RFC2818}}
Indicates the protocol used to send requests to the Dynamic DNS
server.
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.
Initial retry interval (in {{units}}) after a failed request. This
parameter can be used as a fixed value or as part of a retry interval
calculation.
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.
This object describes the LEDs on the device.
{{numentries}}
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.,
{{param|CyclePeriodRepetitions}} = 0), the LED reverts back to its
default illumination characteristics. When the value of the
{{param|Status}} parameter is {{enum|Controlled|Status}}, then the
value of {{param|CycleElementNumberOfEntries}} and
{{param|CycleElementNumberOfEntries}} parameters SHOULD be 0. When the
value of the {{param|RelativeXPosition}} and
{{param|RelativeYPosition}} parameters are 0, this indicates that the
position of the LED is unknown.
{{datatype|expand}}
The internal name used to identify this LED.
The status of the LED.
The LED is currently not in use.
The LED is currently being used by the CPE.
Indicates that the LED is controlled from an electronic circuit
which cannot be monitored.
The LED status cannot be determined by the CPE.
The textual purpose that represents the visual display of the LED
(e.g., Broadband Down).
The number of cycle periods left for this LED. As each cycle period
is completed this parameter is reduced by 1. A value of -1 indicates
an infinite number of cycle period repetitions.
The location of the LED as the user looks at the front of the device
in its typical orientation (e.g., on-end, flat).
The relative x position of the LED from left to right (x) and top to
bottom (y) as the user looks at the device from the orientation
identified in the {{param|Location}} parameter in its typical
orientation (e.g., on-end, flat).
The relative y position of the LED from left to right (x) and top to
bottom (y) as the user looks at the device from the orientation
identified in the {{param|Location}} parameter in its typical
orientation (e.g., on-end, flat).
{{numentries}}
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 {{param|Order}}
parameter, with the duration for the portion of the LED illumination
corresponding to a given instance specified by the {{param|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 {{object}} instance. The length of the complete LED
cycle is the sum of the Duration parameters for all of the entries in
this table.
{{datatype|expand}}
Enables or disables this {{object}} instance.
The relative order of this {{object}} in the LED's cycle period.
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 duration, in {{units}}, for this element of the cycle period.
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.
This object describes the status of the current cycle element for this
LED.
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}}.
The color, formatted as RGB hexadecimal notation (e.g., FF0088), that
is currently being displayed by the LED.
The remaining duration, in {{units}}, for this element of the cycle
period.
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 {{bibref|TR-304}}.
{{numentries}}
This object represents the measurement endpoint that provides
additional contextual information regarding the measurement agent.
{{datatype|expand}}
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{reference|a {{object|##.LMAP.MeasurementAgent}} object that is
associated with this measurement endpoint.}}
This parameter describes the ownership of the device that hosts the
measurement endpoint. {{enum}}
ISP Owned Device
Customer Owned Device
This parameter describes the operational domain for this measurement
endpoint
The top level Internet domain used to identify this measurement
endpoint.
If the value of this parameter is {{false}} then the Measurement
Endpoint MUST not be included in measurement reports.
This object represents the information necessary to utilize an ISP
owned device within the measurement endpoint.
This parameter describes the measurement reference point of the
measurement endpoint. {{enum}}
Internet Source Test Point
Internet Drain Test Point
Regional Network Test Point
Internal Regional Test Point
Metro Test Point
Internal Access Test Point
User Network Interface Test Point
Customer End Device Test Point
{{reference|a {{object|###.DeviceInfo.Location}} object that
describes the geographic location of the measurement endpoint}}
This object represents the information necessary to utilize customer
owned device within the measurement endpoint.
This parameter describes the customer equipment identifier of the
measurement endpoint.
The unique customer identifier within the operational domain for this
measurement endpoint.
This object represents the objects necessary to manage and control the
functionality for Large-Scale Measurement of Broadband
Performance{{bibref|RFC7594}} as defined in by {{bibref|LMAPIFM}}.
{{numentries}}
{{numentries}}
{{numentries}}
This object represents the measurement agent that performs measurement
tasks and reporting functions defined in {{bibref|RFC7594}}.
{{datatype|expand}}
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
Version of the measurement agent.
Date and time, based on {{bibref|RFC3339}}, in UTC that the
measurement agent was successfully started.
Capabilities of the measurement agent that cannot be expressed
elsewhere in the data model.
Identifier of the {{object}} instance.
Identifier of the measurement group of interest to which the
measurement agent belongs.
Identifier of the measurement point indicating where the measurement
agent is located on a path as defined in [bibref|RFC7398}}.
If the value of the {{param|Identifier}} parameter is not {{empty}}
and the value of this parameter is {{false}} then the value of the
{{param|Identifier}} parameter MUST not be included in measurement
reports.
If the value of the {{param|GroupIdentifier}} parameter is not
{{empty}} and the value of this parameter is {{false}} then the value
of the {{param|GroupIdentifier}} parameter MUST not be included in
measurement reports.
If the value of the {{param|MeasurementPoint}} parameter is not
{{empty}} and the value of this parameter is {{false}} then the value
of the {{param|MeasurementPoint}} parameter MUST not be included in
measurement reports.
{{reference|a {{object|##.Security.Certificate}} object that is used
to identify this measurement agent}}
{{reference|a {{object|##.Security.Certificate}} object that is used
to contain the private keys for this measurement agent}}
{{reference|a {{object|##.DeviceInfo.VendorLogFile}} object that is
used to record events for this measurement agent}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
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.
Name of the supported task.
Version of the task.
{{numentries}}
This object represents a registry function and an associated list of
roles supported by this measurement agent
A URI ({{bibref|RFC3986}}) that is the value of the task registry
entry as defined in {{bibref|LMAPREG}} or a value for a task that is
understood by the measurement agent, measurement controller and
measurement collector.
{{list| representing the roles of the function}}
This objects represents the measurement controller that is assigned to
a measurement agent.
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.
{{list}} {{reference|a {{object|#.Schedule}} object}} This parameter
lists the available control schedules for invoking control tasks by
the measurement agent.
{{list}} {{reference|a {{object|#.Task}} object}} This parameter
lists the available control tasks that can be invoked by the
measurement agent.
{{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}}.
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.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
Name of the schedule.
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}}
{{reference|a {{object|##.Event}} object that is used define the
event to start an occurrence of this {{object}}}}
{{reference|a {{object|##.Event}} object that is used define the
event to gracefully terminate all actions associated with an
occurrence of this {{object}}}}.
When the {{param}} value is not 0, this parameter is used define the
duration, in {{units}}, where after this duration all actions
associated with an occurrence of this {{object}} are gracefully
terminated.
{{list|each entry represents tags that are to be reported together
with the measurement results.}}
{{list|representing the suppression tags to be matched}}
This parameter describes the execution method to apply to this
schedule for the associated Actions. {{enum}}
Actions are executed in sequence as defined by the value of
the {{param|Action.{i}.Order}} parameter. The first Scheduled
Action of the DestinationOutput is provided the input.
Actions are executed in parallel. The all Scheduled Actions of
the DestinationOutput are provided the input.
Actions are executed in sequence where the output of one Action
is used as the input of subsequent Action. The first Scheduled
Action of the DestinationOutput is provided the input.
Date and time, based on {{bibref|RFC3339}}, in UTC that the
{{object}} was invoked by the measurement agent.
The amount of secondary storage, in {{units}}, allocated to an
instance of this {{object}}. 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.
{{numentries}}
This object represents the statistics associated with this object.
Number of invocations of this schedule. This counter does not include
suppressed invocations or invocations that were prevented due to an
overlap with a previous invocation of this schedule.
Number of suppressed executions of this schedule.
Number of executions prevented due to overlaps with a previous
invocation of this schedule.
Number of failed executions of this schedule. A failed execution is
an execution where at least one action failed.
This object represents an action that is associated with the this
{{object|##.Schedule}} object.
Enables or disables this {{object|##.Schedule.{i}.Action}} object.
This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The current operational state of the {{object}}. {{enum}}
The order of the scheduled action.
{{reference|a {{object|##.Task}} object used in this scheduled
action}}
{{list}} {{reference|a {{object|##.Schedule}} object used to receive
the output(s) of this scheduled action}}
{{list|representing the suppression tags to be matched}}
{{list|each entry represents tags that are to be reported together
with the measurement results.}}
The amount of secondary storage, in {{units}}, allocated to an
instance of this {{object}}. 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.
Date and time, based on {{bibref|RFC3339}}, in UTC that the
{{object}} was invoked by the measurement agent.
Date and time, based on {{bibref|RFC3339}}, in UTC of a successful
completion of the {{object}}.
The status code returned by successful execution of the {{object}}. A
value of 0 indicates successful completion.
The message associated with the successful completion of the
{{object}}.
Date and time, based on {{bibref|RFC3339}}, in UTC of a failure to
complete the {{object}}.
The status code returned by failed execution of the {{object}}. A
value of 0 indicates successful completion.
The message associated with the failure to complete the task.
{{numentries}}
This object represents the statistics associated with this object.
Number of invocations of this action. This counter does not include
suppressed invocations or invocations that were prevented due to an
overlap with a previous invocation of this schedule.
Number of suppressed executions of this action.
Number of executions prevented due to overlaps with a previous
invocation of this action.
Number of failed executions of this action. A failed execution is an
execution where at least one action failed.
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.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The order of the Option.
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 value associated with the Option.
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.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
Name of the task.
{{list|each entry represents tags that are to be reported together
with the measurement results.}}
{{numentries}}
{{numentries}}
This object represents a registry function and an associated list of
roles for this task
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
A URI ({{bibref|RFC3986}}) that is the value of the task registry
entry as defined in {{bibref|LMAPREG}} or a value for a task that is
understood by the measurement agent, measurement controller and
measurement collector.
{{list| representing the roles of the function}}
This object represents an option associated with the task.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The order of the Option.
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 value associated with the Option.
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.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
Name of the channel.
Enables or disables the ability to use a bulk data profile for this
communication channel
{{reference|a {{object|###.BulkData.Profile}} object that is used to
represent communication channel}}
The {{datatype}} of the LMAP component that is the target of this
communication channel.
{{reference|a {{object|###.Security.Certificate}} object that is used
to identify the target of this channel}}
{{reference|an interface object used to restrict the data transmitted
or received using this channel to a specific interface}} If the value
of this parameter is {{empty}} the data that is transmitted or
received using this channel is able to use any available interface.
The {{object}} object defines the instruction to the measurement agent
by the measurement controller. At most one {{object}} object for the
{{object|##.MeasurementAgent}} instance is enabled at a time. .
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
Date and time, based on {{bibref|RFC3339}}, in UTC that the
{{object}} object or its sub-object's configuration was changed by a
measurement agent's controller.
{{list}} {{reference|a {{object|#.Schedule}} object}} This parameter
lists the available instruction schedules for invoking control tasks
by the measurement agent.
{{list}} {{reference|a {{object|#.Task}} object}} This parameter
lists the available instruction tasks that can be invoked by the
measurement agent.
{{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.
{{numentries}}
This object defines the schedules and actions that are suppressed based
on criteria defined in the {{param|SuppressionMatch}} parameter.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
Name of the suppression object.
The current operational state of the {{object}}. {{enum}}
When {{true}}, the measurement agent is instructed to stop running
schedules or actions that have been matched by this object.
{{reference|a {{object|###.Event}} object that is used define the
event that to start an occurrence of this {{object}}}} When {{empty}}
the default behavior is to perform the suspension event immediately.
{{reference|a {{object|###.Event}} object that is used define the
event to gracefully suspend all actions associated with an occurrence
of this {{object}}}} When {{empty}} the default behavior is for the
suspension period to be indefinite.
{{list|representing the match patterns to be used for applying
suppression to {{object|##.Schedule.{i}}} (and their actions) and all
{{object|##.Schedule.{i}.Action.{i}}} object instances that have a
matched using their SuppressionTags parameters}} The match pattern
syntax is defined in {{bibref|LMAPIFM}}.
This {{object}} object instance represents a report that is generated
by a reporting task where the reporting task is defined as a
{{object|#.MeasurementAgent.{i}.Task.{i}}} and executed as a scheduled
action ({{object|#.MeasurementAgent.{i}.Schedule.{i}.Action.{i}}}). The
{{object}} replicates the {{object|#.MeasurementAgent.{i}}} object
instance's data at the time of the action exection. When a
{{object|##.BulkData.Profile.{i}}} object instance is used to
communicate a {{object}} instance, the CPE adds a
{{object|##.BulkData.Profile.{i}.Parameter.{i}}} object instance
referring to this {{object}} object instance.
The report date and time, based on {{bibref|RFC3339}}, that the
report was sent to the collector.
Identifier of the measurement agent at the time the measurement was
run.
Identifier of the measurement group of interest to which the MA
belongs.
Identifier of the measurement point indicating where the measurement
agent is located on a path as defined in {{bibref|RFC7398}}.
{{numentries}}
The {{object}} object provides the meta-data of the result report of a
single executed action that produced the result.
Name of the task that produced the result.
Name of the schedule that produced the result.
Name of the action that produced the result.
The date and time, based on {{bibref|RFC3339}}, that the event that
triggered the schedule of the action that produced the reported
result values in UTC.
The date and time, based on {{bibref|RFC3339}}, that the action
started in UTC.
The date and time, based on {{bibref|RFC3339}}, that the action was
completed in UTC.
The cycle number derived from the {{param|EventTime}}. The cycle
number is the time, in UTC, closest to the {{param|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 {{empty}} value represent an invalid CycleNumber. {{pattern}}
The status code returned by the execution of the action.
{{list|each entry represents tags defined for the schedule, task and
action objects that produced this result}}
{{numentries}}
{{numentries}}
{{numentries}}
This object represents an option associated with the task or action
object that produced the result.
The order of the Option.
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 value associated with the Option.
This object represents actions that might have impacted the results
being reported.
Name of the task.
Name of the schedule.
Name of the action.
This {{object}} object instances represents a row of results.
{{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.
{{numentries}}
{{numentries}}
This {{object}} object instances represents a row of results for the
report.
{{list}} This parameter contains an ordered set of values that align
to the columns defined in the {{param|#.ColumnLabels}} parameter.
This object represents a registry function and an associated list of
roles for this result report.
A URI ({{bibref|RFC3986}}) that is the value of the registry entry as
defined in {{bibref|LMAPREG}} or a value for a task that is
understood by the measurement agent, measurement controller and
measurement collector.
{{list| representing the roles of the function}}
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.
Enables or disables this {{object}} instance. This parameter is based
on ''ifAdminStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
Name of the Event.
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}}
Periodic Timing Event. When selected one or more event
occurrences are emitted based on the parameters defined in the
{{object|PeriodicTimer}} object.
Calendar Timing Event. When selected one or more event
occurrences are emitted based on the parameters defined in the
{{object|CalendarTimer}} object.
One-off Timing Event. When selected a single event occurrence
is emitted based on the parameters defined in the
{{object|OneOff}} object.
Immediate Timing Event. When selected a single event occurrence
is emitted as soon as possible.
Startup Timing Event. When selected a single event occurrence
is emitted when the corresponding measurement agent starts up.
Controller Lost Event. When selected a single event occurrence
is emitted when the connectivity to the controller is lost.
Controller Connected Event. When selected a single event
occurrence is emitted when the connectivity to the controller
is established.
The spread, in {{units}}, of the Uniform Discrete random distribution
algorithm. A value of 0 means that the random algorithm is not
applied.
The duration of the time interval, in {{units}}, that used to
calculate cycle numbers.
This object defines a periodic timer instance. The periodic timer
instance has attributes for when the timer is to begin
({{param|StartTime}}) and end ({{param|EndTime}}) as well as the
interval to use.
Date and time, based on {{bibref|RFC3339}}, that the {{object}}
instance is to begin operation.
Date and time, based on {{bibref|RFC3339}}, that the {{object}}
instance is to end operation.
The tolerable duration, in {{units}}, of the interval for this
{{object}} instance.
This object defines a calendar timer instance. The calendar timer
instance has attributes for when the timer is to begin
({{param|StartTime}}) and end ({{param|EndTime}}) as well as the
schedule of the recurrence. The algrorithm that defines how the
schedule elements are evaluated is defined in {{bibref|LMAPIFM}}. If
the value of any of the {{param|ScheduleMonths}},
{{param|ScheduleDaysOfMonth}}, {{param|ScheduleDaysOfWeek}},
{{param|ScheduleHoursOfDay}}, {{param|ScheduleMinutesOfHour}} or
{{param|ScheduleSecondsOfMinute}} is {{empty}} then any actions that
use this object will not be invoked.
Date and time that the {{object}} instance is to begin this
operation.
Date and time that the {{object}} instance is to end this operation.
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 days of the month
(1-31) that are applied to the schedule or an asterisk (*) that
represents all the elements of the list.
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 hours of the day
(0-23) that are applied to the schedule or an asterisk (*) that
represents all the elements of the list.
This parameter represents either a list of the minutes of the hour
(0-59) that are applied to the schedule or an asterisk (*) that
represents all the elements of the list.
This parameter represents either a list of the minutes of the hour
(0-59) that are applied to the schedule or an asterisk (*) that
represents all the elements of the list.
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.
The timezone offset, in {{units}}, to be applied to the schedule
elements.
This object defines a one off timer instance.
Date and time, based on {{bibref|RFC3339}}, that the {{object}}
instance is to begin operation.
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.
{{list}} Wireline Wireless Convergence hardware capabilities
supported by the CPE. {{enum}}
Able to use the 5G Radio Access Network
Able to use the 4G (LTE) Radio Access Network
Able to use fixed access networks
{{list}} Wireline Wireless Convergence software capabilities
supported by the CPE. {{enum}}
Able to use PPPoE or IPoE as specified in {{bibref|TR-124i5}}
or earlier
Able to use 5G capabilities such as specified in
{{bibref|TR-124i6}}
Able to support multi access PDUs using Access Traffic Steering
Switching Splitting (ATSSS)
Sets the mode the CPE is operating in. Whilst the CPE is expected to
auto-negotiate, a service provider may need to lock the CPE in
{{enum|FN-RG}} or {{enum|5G-RG}} mode for stability. {{enum}}
The CPE only attempts to authenticate using PPPoE or IPoE
The CPE only attempts to register using 5G NAS
The CPE may operate in either mode
The mode the CPE is operating in. A CPE in {{enum|Negotiating}} is
deemed to be auto-negotiating its operational mode. {{enum}}
{{numentries}}
{{numentries}}
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.
{{datatype|expand}}
The textual name of the Access Network entry as assigned by the CPE.
{{reference}} Specifies the egress interface associated with this
"AccessNetwork" entry. This MUST be a layer 1 interface.
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 5G-RG has sucessfully authenticated and has been assigned
an AMF to manage it.
The 5G-RG is no longer managed by an AMF.
The access network will always start in this state and
indicates that the 5G-RG has never registered to the access
network. This state is only used by the 5G-RG and is never
present in the AMF.
The {{param|LastError}} parameter is updated with the detail of
this error.
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 5G-RG does not have a NAS connection over N1 to the AMF.
The 5G-RG does have a NAS connection over N1 to the AMF.
The access network will always start in this state and
indicates that the 5G-RG is not registered to the access
network. This state is only used by the 5G-RG and is never
present in the AMF.
The {{param|LastError}} parameter is updated with the detail of
this error.
The access network type of this entry. {{enum}}
Error code. See {{bibref|3GPP-TS.24.501|Clause 9.11.4.2}}
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}}.
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 {{bibref|3GPP-TS.23.003|Clause 12.1}}. For example, a PLMN
of 50101 refers to MCC 501 (Australia) and MNC 01 (Telstra).
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 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}}.
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.
{{datatype|expand}}
The precedence value of URSP rule field is used to specify the
precedence of the URSP rule among all URSP rules in the URSP. The
precedence value in the range from 0 to 255 (decimal). The higher the
value of the precedence value field, the lower the precedence of the
URP rule is. Multiple URSP rules in the URSP shall not have the same
precedence value.
{{numentries}}
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.
{{datatype|expand}}
Traffic Descriptor Type. See {{bibref|3GPP-TS.24.526|Clause 5.2}}.
Traffic descriptor value. See {{bibref|3GPP-TS.24.526|Clause 5.2}}.
{{numentries}}
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.
{{datatype|expand}}
The precedence value of route selection descriptor field is used to
specify the precedence of the route selection descriptor among all
route selection descriptors in the URSP rule. The precedence value in
the range from 0 to 255 (decimal). The higher the value of the
precedence value field, the lower the precedence of the route
selection descriptor is.
Session and Service Continuity (SSC) Mode: Indicates that the traffic
of the matching application shall be routed via a PDU Session
supporting the included SSC Mode. See {{bibref|3GPP-TS.24.501|Clause
9.11.4.16}}.
The DNN value contains an APN as defined in
{{bibref|3GPP-TS.23.003|Clause 9.1.1}}.
PDU session type. See {{bibref|3GPP-TS.24.501|Clause 9.11.4.11}}.
{{enum}}
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}}
Describes a S-NSSAI Information element providing network slice
specification. See {{bibref|3GPP-TS.24.501|Clause 9.11.2.8}}
The Slice Service Type (SST). {{enum}} See
{{bibref|3GPP-TS.23.501|Clause 5.15.2.2}}.
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 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.
{{numentries}}
Contains all the properties of a PDU session instance, ranging from
maximum bitrate through to assigned network slice. This object contains
the {{object}} table.
{{datatype|expand}}
{{reference}} The IP Interface associated with the ''PDU'' entry.
PDU session identity. See {{bibref|3GPP-TS.24.501|Clause 9.4}}.
Procedure transaction identity. See {{bibref|3GPP-TS.24.501|Clause
9.6}}.
The PDU session type indicating the protocol the PDU is capable of
carrying. See {{bibref|3GPP-TS.24.501|Clause 9.11.4.11}}. {{enum}}
Session and Service Continuity (SSC) Mode: Indicates that the traffic
of the matching application shall be routed via a PDU Session
supporting the included SSC Mode. See {{bibref|3GPP-TS.24.501|Clause
9.11.4.16}}
Downlink Aggregate Maximum Bit Rate in {{units}}. See
{{bibref|3GPP-TS.24.501|Clause 9.11.4.14}}.
Uplink Aggregate Maximum Bit Rate in {{units}}. See
{{bibref|3GPP-TS.24.501|Clause 9.11.4.14}}.
Error code. See {{bibref|3GPP-TS.24.501|Clause 9.11.4.2}}
The IPv4 address allocated to the PDU session by the SMF. This
parameter is only valid if {{param|SessionType}} has a value of
{{enum|IPv4|SessionType}} or {{enum|IPv4v6|SessionType}}. See
{{bibref|3GPP-TS.24.501|Clause 9.11.4.10}}.
The interface identifier for the IPv6 link local address allocated to
the PDU session by the SMF. This parameter is only valid if
{{param|SessionType}} has a value of {{enum|IPv6|SessionType}} or
{{enum|IPv4v6|SessionType}}. See {{bibref|3GPP-TS.24.501|Clause
9.11.4.10}}.
Reflective QoS timeout in {{units}}. See
{{bibref|3GPP-TS.24.501|Clause 9.11.2.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. See
{{bibref|3GPP-TS.24.501|clause 9.11.4.3}}.
The Data Network Name used by the PDU. The DNN value may be from the
optional S-NSSAI specified at the time of PDU establishment or a
default determined by the 5G core. A DNN is analagous to an LTE APN
used the same format defined in {{bibref|3GPP-TS.24.501|clause
9.11.2.1A}}.
{{numentries}}
{{numentries}}
Policy Configuration Options (PCO) is an optional set of configuration
parameters supplied by the network at the request of the 5G-RG as
defined in {{bibref|3GPP-TS.24.008|clause 10.5.6.3}}.
The IPv6 address of the P-CSCF used for VoLTE telephony.
A comma separated list of IPv6 DNS servers.
The IPv4 address of the P-CSCF used for VoLTE telephony.
A comma separated list of IPv4 DNS servers.
Describes a S-NSSAI Information element providing network slice
specification. See {{bibref|3GPP-TS.24.501|Clause 9.11.2.8}}
The Slice Service Type (SST). {{enum}} See
{{bibref|3GPP-TS.23.501|Clause 5.15.2.2}}.
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}}.
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:
* A QoS Rule with a default used for general traffic has the following
parameters.
* QFI=1
* DQR=1 - Default rule
* Filter 1 for rule
* Direction=bidirectional
* Type=1 - Match all
* A QoS Rule matchihg a voice service.
* QFI=32
* DQR=0
* Filter 1 for rule
* Direction=bidirectional
* Type=33 - Destination IPv6 range
* Value=2001:8000/48 - Destination IPv6 range
* Filter 2 for rule
* Direction=bidirectional
* Type=16 - Destination IPv4 address with netmask
* Value=203.1.0.0 255.255.255.0 - Destination IPv4 address with netmask
A full description can be found at {{bibref|3GPP-TS.24.501|clause
9.11.4.13}} QoS Rules
{{datatype|expand}}
The QoS rule identifier field is used to identify the QoS rule.
The QoS rule precedence field is used to specify the precedence of
the QoS rule among all QoS rules. The higher the value of the QoS
rule precedence field, the lower the precedence of that QoS rule is.
In the UE to network direction the segregation bit indicates whether
the UE is requesting the network to bind service data flows described
by the QoS rule to a dedicated QoS Flow. When {{true}} segregation is
requested.
QoS Flow identifier.
Default QoS rule flag. When {{true}} this QoS rule is the default QoS
rule.
{{numentries}}
This object describes the PDU QoS Rule Filter table. As each packet
filter is logically anded with the others, there shall not be more than
one occurrence of each packet filter component type.
{{datatype|expand}}
The packet filter direction field is used to indicate for what
traffic direction the filter applies. See
{{bibref|3GPP-TS.24.501|Clause 9.11.4.13}} {{enum}}
Packet filter component type identifier. See
{{bibref|3GPP-TS.24.501|Clause 9.11.4.13}}.
Matching value for the component type. See
{{bibref|3GPP-TS.24.501|Clause 9.11.4.13}}.
Table of all QoS Flow Indicators (QFI) and their properties supported
by the access network for this particular PDU. For example:
* A QoS Flow with a QFI of 1 used for general traffic has the following
parameters.
* FiveQI=8
* A QoS Flow with a QFI of 32 used for voice traffic with a guaranteed
bitrate of 150k has the following parameters.
* FiveQI=1
* GFBRUplink=150
* GFBRDownlink=150
{{datatype|expand}}
QoS Flow Identifier.
5G QoS Identifier. See {{bibref|3GPP-TS.23.501|Clause 5.7.4}} for a
table of standardised 5QI QoS characteristics.
Guaranteed Flow Bitrate - Upstream (expressed in {{units}}).
Guaranteed Flow Bitrate - Downstream (expressed in {{units}}).
Maximum Flow Bitrate - Upstream (expressed in {{units}}).
Maximum Flow Bitrate - Downstream (expressed in {{units}}).
Averaging window for both uplink and downlink in {{units}}.
EPS Bearer Identity. See {{bibref|3GPP-TS.24.301|Clause 9.3.2}}.
5G Wireline wireless Encapsulation transport for data plane. See
{{bibref|FWEREG}}.
{{numentries}}
5G Wireline wireless Encapsulation link layer table (a stackable
interface object as described in {{bibref|TR-181i2|Section 4.2}}).
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}}.
{{datatype|expand}}
The textual name of the link as assigned by the CPE.
The accumulated time in {{units}} since the link entered its current
operational state.
{{list}} {{reference|an interface object that is stacked immediately
below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
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}}.
The total number of {{units}} transmitted out of the interface,
including framing characters.
The total number of {{units}} received on the interface, including
framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted
because of errors.
The total number of inbound packets that contained errors preventing
them from being delivered to a higher-layer protocol.
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.
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.
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.
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.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a multicast address at this
layer.
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.
The total number of received packets, delivered by this layer to a
higher layer, which were addressed to a broadcast address at this
layer.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol.
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.
The unique USP identifier for this USP Agent.
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''.
Time in {{units}} since the USP Agent was last restarted (either via
a reset of the software or reboot of the underlying device).
Periodic event configured via the recipient Controller's
{{param|Controller.{i}.PeriodicNotifInterval}} and
{{param|Controller.{i}.PeriodicNotifTime}} parameters.
Wake-up event.
Indicates that a file has been transferred to or from the Device. The
event is sent when the transfer has either completed successfully (in
which case {{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.
The Path Name of the command that requested the transfer, or
{{empty}} if the transfer was not requested via a USP operation.
The ''command_key'' supplied when requesting the transfer, or
{{empty}} if the transfer was not requested via a USP operation.
The Endpoint ID of the Controller that requested the transfer, or
{{empty}} if no Controller requested it.
The type (direction) of the transfer.
Downstream transfer; to the Agent.
Upstream transfer; from the Agent.
The Path Name of the Object or Object Instance that was affected by
the transfer, or {{empty}} if no data model object was affected by
the transfer.
The {{datatype}} from or to which this transfer was performed, or
{{empty}} if no such URL is available.
The date and time in UTC at which the transfer was started. The
Device SHOULD record this information and report it in this
argument, but if this information is not available, the value of
this argument MUST be set to the ''Unknown Time'' value.
The date and time in UTC at which the transfer was fully completed.
This need only be filled in if the transfer has been fully
completed. The Device SHOULD record this information and report it
in this argument, but if this information is not available or the
transfer has not completed, the value of this argument MUST be set
to the ''Unknown Time'' value.
The numerical fault code as defined in {{bibref|TR-369}}. A value
of 0 (zero) indicates no fault.
A human-readable text description of the fault. This field SHOULD
be {{empty}} if the {{param|FaultCode}} equals 0 (zero).
This command is issued to allow a Controller (with the proper
permissions) to add a new certificate to
{{object|#.Certificate.{i}}}. This does not automatically produce a
trust relationship with the host identified by the Certificate. To
produce a trust relationship, an entry is required to exist in
{{param|#.Controller.{i}.Credential}} or
{{param|#.ControllerTrust.Credential.{i}.Credential}} that references
the new {{object|#.Certificate.{i}}} entry. The Agent will use the
Serial Number and Issuer fields from the input {{param|Certificate}}
to populate the {{param|#.Certificate.{i}.SerialNumber}} and
{{param|#.Certificate.{i}.Issuer}} parameters. If
{{object|#.Certificate}} already has an instance with the same
{{param|#.Certificate.{i}.SerialNumber}} and
{{param|#.Certificate.{i}.Issuer}} parameters, this command will
fail. To replace an instance with the same
{{param|#.Certificate.{i}.SerialNumber}} and
{{param|#.Certificate.{i}.Issuer}}, the existing instance must first
be deleted.
An optional input the Controller can use to specify the
{{param|##.Certificate.{i}.Alias}} value for the added entry. If
provided as an input and the value already exists in
{{object|##.Certificate.{i}}}, this commmand will fail.
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM)
{{bibref|RFC7468}} format.
USP Message Transfer Protocols supported by this USP Agent. The USP
Agent MUST support at least one Protocol.
See {{bibref|RFC7252}}
See {{bibref|RFC6455}}
See {{bibref|STOMP1.2}}
See {{bibref|MQTT311}} and {{bibref|MQTT50}}
{{list|each entry is an algorithm for calculating firgerprints that
is supported by the Agent}}
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
{{list|each entry is a threshold operation for
{{param|Threshold.{i}.ThresholdOperator}} supported by the Agent}}
Parameter value changes from below the
{{param|Threshold.{i}.ThresholdValue}} to a value above
Parameter value changes from above the
{{param|Threshold.{i}.ThresholdValue}} to a value below
Parameter value either changes from above the
{{param|Threshold.{i}.ThresholdValue}} to a value below or vice
versa
Parameter value changes from any value to the
{{param|Threshold.{i}.ThresholdValue}}
Parameter value changes from the
{{param|Threshold.{i}.ThresholdValue}} to any other value
{{list|each entry is a subtype component of the service type that is
advertised for the device using mDNS as defined in
{{bibref|RFC6762}}}}
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).
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Each instance of this table represents a MTP used by the local Agent.
{{datatype|expand}}
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.
The current operational state of the {{object}} instance.
Value when this {{object}} instance cannot establish
communication.
Value when this {{object}} instance is misconfigured.
The Message Transport Protocol (MTP) to be used for communications by
a USP Endpoint.
This parameter, when {{true}}, enables the advertisement of DNS-SD
services defined for this {{object}} instance using mDNS as defined
in {{bibref|RFC6762}}. This parameter cannot be set to {{true}} if
there are multiple {{object}} instances with the same value of the
{{param|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 {{object}} instance and the
interfaces defined by the {{param|##.DNS.SD.AdvertisedInterfaces}}
parameter.
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP),
then this object contains CoAP specific configuration parameters.
{{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.
The port number used by the CoAP Server to receive USP messages.
The path that is used by the CoAP Server in order to receive USP
messages.
This parameter represents whether or not communications that utilize
this {{object}} object instance are encrypted. This parameter is
DEPRECATED, because the {{param|EnableEncryption}} parameter will
dictate whether all connections to this CoAP server instance are or
are not encrypted.
When {{true}}, encryption MUST be used for this MTP instance.
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.
A reference to the STOMP Connection used by this Agent when
communicating via the STOMP MTP.
The STOMP destination where the Agent will be listening to incoming
USP messages.
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 {{empty}}. 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 {{param|Destination}} Parameter contains the STOMP
destination address for this Agent.
If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP)
as a WebSocket server, then this object contains WebSocket specific
configuration parameters.
{{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.
The port number used by the WebSocket Server to receive USP messages.
The path that is used by the WebSocket Server in order to receive USP
messages.
When {{true}}, encryption MUST be used for all connections to this
MTP instance.
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.
A reference to the MQTT Client used by this Agent when communicating
via the MQTT MTP.
The Agent's configured "reply to" topic. When MQTT 5.0 is being used,
this value is put in the PUBLISH Response Topic property for all
PUBLISH packets with a USP Record, if no Response Information (value
recorded in {{param|ResponseTopicDiscovered}}) is included in the
CONNACK. When MQTT 3.1.1 is being used, this value is put at the end
of the PUBLISH Topic Name property (as specified in
{{bibref|TR-369|Section "MQTT Binding"}}. If the value of {{param}}
is not a subset (wildcarded or precise match) of any of the
{{param|Reference}} {{param|.MQTT.Client.{i}.Subscription.{i}.Topic}}
values the Agent MUST subscribe to this Topic. The value MUST NOT
contain any wild card characters (“+”, “#”).
Duplicate of {{param|Reference}}
{{param|.MQTT.Client.{i}.ResponseInformation}}. This is the value of
the CONNACK Response Information property supplied by a MQTT 5.0
server and is used by a MQTT 5.0 client as the basis for the PUBLISH
Response Topic property for all PUBLISH packets that expect a
response. If a value is received from the MQTT 5.0 server, it will be
used instead of any value configured in
{{param|ResponseTopicConfigured}}.
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.
Each {{object}} instance of this table represents a Threshold Event.
{{param|ThresholdParam}} is monitored to determine if it has met the
{{param|ThresholdOperator}} condition against {{param|ThresholdValue}},
when it meets the condition a {{event|Triggered!}} Event is sent.
{{param|ThresholdParam}} may only reference integer parameters and
{{param|ThresholdValue}} only usese integer values.
For example:
{{param|ReferencePath}}:
Device.Ethernet.Interface.[Enable=="1"].Stats.
{{param|ThresholdParam}}: BytesSent {{param|ThresholdOperator}}:
Rise {{param|ThresholdValue}}: 100000
This would trigger a {{event|Triggered!}} Event whenever a value of a
parameter matching
Device.Ethernet.Interface.[Enable==1].Stats.BytesSent rises from below
to above 100000.
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.
{{datatype|expand}}
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
Determines whether to disable this {{object}} instance after the
{{event|Triggered!}} Event has been invoked.
The {{object}} will generate events as long as the
{{param|Enable}} is {{true}}
After invoking the {{event|Triggered!}} Event, the
{{param|Enable}} parameter will be automatically set to
{{false}}
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 {{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 operator used for the threshold test.
The Value used for the threshold test.
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.
The parameter ({{param|.LocalAgent.Threshold.{i}.ReferencePath}}
and {{param|.LocalAgent.Threshold.{i}.ThresholdParam}}) for which
the threshold has been triggered.
The new ({{param|.LocalAgent.Threshold.{i}.ReferencePath}} and
{{param|.LocalAgent.Threshold.{i}.ThresholdParam}}) Value.
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.
{{datatype|expand}}
The unique USP identifier for this USP Controller.
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.
Identifying information which MAY be used by the {{object}} instance
to determine {{object}} instance specific customization and
provisioning parameters.
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.
{{list|each entry is a Role that has been assigned to this {{object}}
instance by means other than the
{{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter}}
{{list|each entry is a Role that has been assigned to this {{object}}
instance from the
{{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter
associated with the CA credential
({{param|.LocalAgent.ControllerTrust.Credential.{i}.Credential}})
used to validate the Controller certificate}}
{{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.
If a Periodic Event Notification {{object|#.Subscription}} instance
is associated with this USP Controller, then this is the duration in
{{units}} of the interval for which the USP Agent MUST attempt to
issue a Periodic Notification to the USP Controller.
If a Periodic Event Notification {{object|#.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
{{param|PeriodicNotifInterval}}. {{param}} is used only to set the
''phase'' of the Periodic Event Notifications. The actual value of
{{param}} can be arbitrarily far into the past or future. For
example, if {{param|PeriodicNotifInterval}} is 86400 (a day) and if
{{param}} 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
{{param}} refers to a day in the future. The Unknown Time value
defined in {{bibref|TR-106|section 3.2}} 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
{{param|PeriodicNotifInterval}}. If absolute time is not available to
the USP Agent, its Periodic Notification behavior MUST be the same as
if the {{param}} parameter was set to the Unknown Time value.
This parameter is related to the retry mechanism for Notifications.
Configures the first retry wait interval, in {{units}}, as specified
in {{bibref|TR-369|Section "Responses to Notifications and
Notification Retry"}}. A value of 5 corresponds to the default
behavior. The USP Agent MUST use a random value between {{param}} and
({{param}} * {{param|USPNotifRetryIntervalMultiplier}} / 1000) as the
first retry wait interval. Other values in the retry pattern MUST be
calculated using this value as a starting point.
This parameter is related to the retry mechanism for Notifications.
Configures the retry interval multiplier as specified in
{{bibref|TR-369|Section "Responses to Notifications and Notification
Retry"}}. 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 {{param|USPNotifRetryMinimumWaitInterval}} and
({{param|USPNotifRetryMinimumWaitInterval}} * {{param}} / 1000) as
the first retry wait interval. Other values in the retry pattern MUST
be calculated using this value as a starting point.
Schedule a ''Timer!'' event on the associated {{object}}. This
command is DEPRECATED because it was replaced by a more flexible
asynchronous {{command|Device.ScheduleTimer()}} in 2.14.
The number of {{units}} from the time this command is invoked
until the Agent initiates a Timer! Event notification (based on
the associated subscriptions).
Timer event requested via a ScheduleTimer() command invoked on the
same Controller instance via an Operate USP message. This event is
DEPRECATED because the associated {{command|ScheduleTimer()}} was
replaced by a more flexible asynchronous
{{command|Device.ScheduleTimer()}} in 2.14.
The ''command_key'' supplied when requesting the timer event.
This command is issued to allow a Controller to add a new certificate
for itself. This can be useful when the current certificate is
expiring or has become compromised. This command creates a new entry
in {{object|#.Certificate}} and adds a reference to the new entry to
the Controller's {{param|#.Controller.{i}.Credential}}. The Agent
will use the Serial Number and Issuer fields from the input
{{param|Certificate}} to populate the
{{param|#.Certificate.{i}.SerialNumber}} and
{{param|#.Certificate.{i}.Issuer}} parameters. If
{{object|#.Certificate}} already has an instance with the same
{{param|#.Certificate.{i}.SerialNumber}} and
{{param|#.Certificate.{i}.Issuer}} parameters, this command will
fail. To replace an instance with the same
{{param|#.Certificate.{i}.SerialNumber}} and
{{param|#.Certificate.{i}.Issuer}}, the existing instance must first
be deleted.
This command can only be used by the Controller to whom the object
belongs. If the Controller issuing the USP Operate message is a
different Controller, the message MUST be denied.
An optional input the Controller can use to specify the
{{param|###.Certificate.{i}.Alias}} value for the added entry. If
provided as an input and the value already exists in
{{object|###.Certificate.{i}}}, this commmand will fail.
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM)
{{bibref|RFC7468}} format.
Requests the Agent to send an ''OnBoardRequest'' notification to this
Controller.
{{numentries}}
{{numentries}}
Each instance of this table represents a MTP used by this Controller.
{{datatype|expand}}
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.
The Message Transport Protocol (MTP) to be used for communications by
a USP Endpoint.
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP),
then this object contains CoAP specific configuration parameters.
The hostname or IP Address of the Controller's CoAP server.
The port number used by the Controller's CoAP Server to receive USP
messages.
The path that is used by the Controller's CoAP Server in order to
receive USP messages.
When {{true}}, encryption MUST be used as specified in
{{bibref|TR-369|Section "MTP Message Encryption"}}.
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.
A reference to the STOMP Connection used by this Controller when
communicating via the STOMP MTP.
The STOMP destination where the Controller will be listening to
incoming USP messages.
If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP)
as a WebSocket client, then this object contains WebSocket specific
configuration parameters.
The hostname or IP Address of the Controller's WebSocket server.
The port number used by the Controller's WebSocket server to receive
USP messages.
The path that is used by the Controller's WebSocket server in order
to receive USP messages.
This parameter represents whether or not communications that utilize
this {{object}} object instance are encrypted. This parameter is
DEPRECATED, because the {{param|EnableEncryption}} parameter will
dictate whether this {{object}} is or is not encrypted.
When {{true}}, encryption MUST be used for this MTP instance.
The the duration in {{units}} between when WebSocket ping control
frames are transmitted by the Agent to the WebSocket server for the
USP Controller.
The current retry count of the session. When zero (0), the session is
not in a retry state.
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 retry interval multiplier as specified in
{{bibref|TR-369|Section "WebSocket Session Retry"}}. 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 {{param|SessionRetryMinimumWaitInterval}} and
({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the
first retry wait interval. Other values in the retry pattern MUST be
calculated using this value as a starting point.
If enabled, this command will either request to start or restart an
WebSocket session with the Controller.
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.
A reference to the MQTT Client used by this Controller when
communicating via the MQTT MTP.
The topic name the USP Controller has subscribed to, to be used for
Notify messages send by the USP Agent.
If set to {{true}} the Agent MUST set the RETAIN flag in MQTT PUBLISH
messages carrying a USP Response Message 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).
If set to {{true}} the Agent MUST set the RETAIN flag in MQTT PUBLISH
messages carrying a USP Notify Message 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).
The policy defined in this object determines the conditions under which
the USP Agent notifies a USP Controller, that has an appropriate
Subscription, of the completion of file transfers.
Indicates the transfer results that MUST be included when the USP
Agent notifies a USP Controller of file transfers. Transfer results
omitted from this list MUST NOT be included when the USP Agent
notifies a USP Controller.
The autonomous file transfer completed successfully; i.e., the
{{event|##.TransferComplete!}} event's
{{param|##.TransferComplete!.FaultCode}} was zero
The autonomous file transfer did not complete successfully;
i.e., the the {{event|##.TransferComplete!}} event's
{{param|##.TransferComplete!.FaultCode}} was non-zero
Success and Failure
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.
{{datatype|expand}}
Enables or disables this {{object}}.
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.
The {{object}} object represents the End to End (E2E) Session Context
functionality for this {{object|##.Controller.{i}}} object instance.
Enable/Disable this {{object}} instance. When {{true}}, Session
Context is used when exchanging USP Records with the remote endpoint
represented by this {{object|##.Controller.{i}}} object instance.
When {{false}}, Session Context is not used when exchanging USP
Records with the remote endpoint represented by this
{{object|##.Controller.{i}}} object instance.
The current status of the Session Context.
A new Session Context is being negotiated (i.e., a USP Record
with sequence_id of 0 and session_id not previously used with
this remote endpoint was sent and response has not yet been
received).
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.
Configures the first retry wait interval, in {{units}}, as specified
in {{bibref|TR-369|Section "Failure Handling in the Session
Context"}}. A value of 5 corresponds to the default behavior that is
described in {{bibref|TR-369}}. 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 retry interval multiplier as specified in
{{bibref|TR-369|Section "Failure Handling in the Session Context"}}.
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
{{bibref|TR-369}}. The USP Agent MUST use a random value between
{{param|SessionRetryMinimumWaitInterval}} and
({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the
first retry wait interval. Other values in the retry pattern MUST be
calculated using this value as a starting point.
The current retry count of the Session Context. When zero (0), the
Session Context is not in a retry state.
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 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.
The security mechanism to use when exchanging the payload of the
Record with the remote endpoint.
The payload is encrypted at the originating endpoint and
decrypted at the receiving endpoint using TLS. The procedures
for using TLS in a Session Context is defined in
{{bibref|TR-369}}.
If the {{object}} is enabled then this command will either request to
start or restart a Session Context with the remote endpoint. If the
{{object}} is not enabled and there is an active Session Context then
this command will terminate that Session Context with the remote
endpoint. If the {{object}} is not enabled and there is no active
Session Context then this command does nothing.
A Subscription dictates how a USP Agent issues USP Notification
Messages to a USP Controller.
{{datatype|expand}}
Enables/disables this {{object}}. A disabled entry MUST NOT be
processed by the USP Agent.
{{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.
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.
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.
Type of Notification message that will be sent to the USP Controller
specified by {{param|Recipient}} when this {{object}} is triggered.
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 {{object}} is applicable to. Different values of
the {{param|NotifType}} parameter will cause the {{object}} to
interact with {{param}} differently. For example, an instance of
{{object}} with {{enum|ValueChange|NotifType}} will utilize the value
of this parameter differently than an instance with
{{enum|Event|NotifType}}. Once the value of the {{param}} is written,
the value cannot be changed as the {{object}} instance is considered
to be immutable. If the value of a non-empty {{param}} parameter
needs to change, the {{object}} instance MUST be deleted and a new
{{object}} instance created. The following bullet points describe
what is allowed as a value of {{param}} based on the different values
of the {{param|NotifType}} parameter:
* ValueChange: may be either a Path Name or Search Path; if an Object
Path (one type of Path Name) then it is treated like a filter match
such that all supported parameters in all objects below this point
will be relevant for the subscription.
* ObjectCreation: may be either a Path Name or Search Path as long as
it only refers to a Multi-Instance Object; only the referenced
Multi-Instance Objects will be relevant for the subscription.
* ObjectDeletion: may be either a Path Name or Search Path as long as
it only refers to instances of a Multi-Instance Object; only the
referenced instances (wildcard references all instances over time)
of the Multi-Instance Objects will be relevant for the
subscription.
* OperationComplete: may be either a Path Name, Search Path, or
Command reference; if an Object Path (one type of Path Name) then
it is treated like a filter match such that all supported data
model commands in all objects below this point will be relevant for
the subscription.
* Event: may be either a Path Name, Search Path, or Event reference;
if an Object Path (one type of Path Name) then it is treated like a
filter match such that all supported Events in all objects below
this point will be relevant for the subscription.
Determines whether or not this {{object}} remains after the USP Agent
is restarted (either via a reset of the software or reboot of the
underlying device). If {{true}}, this {{object}} stays in existence
until either a Delete message removes it or the {{param|TimeToLive}}
parameter expires. If {{false}}, this {{object}} is automatically
removed by the USP Agent whenever it is restarted.
Specifies the duration of time (in {{units}}) that this {{object}}
remains in existence. After {{param}} has expired, this {{object}}
instance is automatically removed by the USP Agent. If the value of
{{param}} is 0, then this parameter is ignored and this {{object}}
stays in existence until either a Delete message removes it or the
{{param|Persistent}} parameter determines that it needs to be
removed. If the value of {{param}} is greater than 0, then this
parameter determines the length of time (from {{object}} creation)
until it will be automatically removed by the USP Agent (unless the
{{param|Persistent}} parameter is {{false}} and the USP Agent is
restarted, in which case it will be removed before the {{param}}
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 {{param}} will automatically expire if the USP Agent is
restarted (either via a reset of the software or reboot of the
underlying device) before {{param}} expiration.
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 {{param}} 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 {{bibref|TR-369|Section "Responses to
Notifications and Notification Retry"}}. When {{param}} 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}}.
Specifies the duration of time (in {{units}}) that the Notification
associated with this {{object}} will continue to be retried. After
{{param}} has expired, if the Notification has still not been
successfully delivered then the USP Agent MUST stop attempting to
re-deliver the Notification. If {{param|NotifRetry}} is set to
{{false}} then this parameter is ignored. If {{param|NotifRetry}} is
set to {{true}} and the value of {{param}} 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
{{param|NotifRetry}} is set to {{true}} and the value of {{param}} 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.
{{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.
{{datatype|expand}}
The USP Endpoint Identifier that originated the command.
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_key'' from the USP ''Operate'' message.
The operational status of the request to execute the command.
The command has been requested but is currently not executing.
The command is currently executing.
The command has been requested to be canceled.
The command has successfully been canceled.
The command has successfully been completed its execution.
The command has unsuccessfully completed its execution or has
unsuccessfully been canceled.
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.
Each instance of this table represents information related to a X.509
certificate (see {{bibref|RFC5280}}) of a Controller or Certificate
Authority. Instances are referenced from
{{param|##.LocalAgent.Controller.{i}.Credential}} and
{{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}}.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
The Serial Number field in an X.509 certificate, see
{{bibref|RFC5280}}.
The Issuer field in an X.509 certificate, see {{bibref|RFC5280}};
i.e. the Distinguished Name (DN) of the entity who has signed the
certificate.
This command is issued to allow a Controller (with the proper
permissions) to delete an entry from the
{{object|##.Certificate.{i}}}. It also removes references to the
Certificate in {{param|##.LocalAgent.Controller.{i}.Credential}} or
{{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}} and
removes any X.509 certificate data the Agent had stored related to
the entry.
This command is issued to allow a Controller to request the value of
a fingerprint calculated for the specified table entry using the
input {{param|FingerprintAlgorithm}}.
The algorithm to be used to calculate the requested fingerprint.
The value MUST be one the Agent supports, as noted in
{{param|###.SupportedFingerprintAlgorithms}}.
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
The value of the fingerprint.
This object contains information that an Agent applies when
establishing a trust relationship with a Controller.
{{list|each entry is a Role that is associated with Controllers whose
identity cannot be authenticated. The value of the {{param}}
parameter is appended to the
{{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter}} In
some instances, this policy is set by the Agent and cannot be
modified by Controllers. If the Agent does not allow modification of
this parameter, the Agent MUST respond with an error to the request
to set this parameter.
The Role that is associated with Controllers indicate banned access.
When assigned to a Controller or associated with an entry in the
{{object|Credential}} table, this MUST be the only value of the
{{param}} parameter of the
{{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter. The
Agent SHOULD refuse to accept USP messages from, or send USP messages
to, any Controller that has this Role.
When {{true}}, Agent has active policy that allows for self-signed
certificates and certificates from unknown Certificate Authorities
(CAs) to be trusted on first use (TOFU).
Inactivity timer in {{units}}. 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.
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 {{param|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
{{param|ChallengeRef}} parameter defined in the RequestChallenge does
not exist, the Agent returns an "Invalid Value" error.
{{reference|the {{object|#.Challenge}} object instance for this
request}}
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 value of the {{param|##.Challenge.{i}.Instruction}} parameter
associated with the requested challenge in the
{{param|#.Input.ChallengeRef}} parameter.
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 {{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 challenge identifier the Controller uses in the
ChallengeResponse command to correlate this request with a
response.
This command is issued to return the response of challenge.
The challenge identifier the Controller uses to correlate the
challenge request with a response.
The value of the challenge that is specific to the type of
challenge. The challenge value is provided by the external party
to the Controller.
{{numentries}}
{{numentries}}
{{numentries}}
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.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
The Role assigned to this {{object}} instance.
{{numentries}}
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.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
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).
{{list|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
{{bibref|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 {{object}}
instance.
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:
# Read: Grants the capability to read the value of the Parameter via
Get and read the meta-information of the Parameter via
GetSupportedDM.
# Write: Grants the capability to update the value of the Parameter
via Add or Set.
# Execute: Grants no capabilities; Parameters can not be executed.
# Notify: Grants the capability to use this Parameter in the
ReferenceList of a ValueChange Subscription.
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:
# Read: Grants the capability to read the meta-information of the
Object via GetSupportedDM.
# Write: Grants no capabilities for Static Objects. Grants the
capability to create a new instance of a Multi-Instanced Object via
Add (e.g. Device.LocalAgent.Controller.).
# Execute: Grants no capabilities; Objects are not executable and
Commands are controlled by the CommandEventPermissions.
# Notify: Grants the capability to use this Object in the
ReferenceList of an ObjectCreation (for multi-instance objects
only) Subscription.
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:
# Read: Grants the capability to read the instance numbers and unique
keys of the Instantiated Object via GetInstances and read the value
of Parameters related to the Instantiated Object via a Get
containing a search expression or wildcard in place of the instance
identifier.
# Write: Grants the capability to remove an existing instance of an
Instantiated Object via Delete (e.g.
Device.LocalAgent.Controller.1.).
# Execute: Grants no capabilities; Object Instances are not
executable and Commands are controlled by the
CommandEventPermissions.
# Notify: Grants the capability to use this Instantiated Object in
the ReferenceList of an ObjectDeletion Subscription.
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:
# Read: Grants the capability to read the meta-information of the
Command (including input and output arguments) and Event (including
arguments) via GetSupportedDM.
# Write: Grants no capabilities; Commands are executed instead of
written to and Events are read only.
# Execute: Grants the capability to execute the Command via Operate,
but grants no capabilities to an Event.
# Notify: Grants the capability to use this Event or Command in the
ReferenceList of an Event or OperationComplete Subscription.
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.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
{{nolist}} Comma-separated list of strings, the (set of) Role(s)
applied to a Controller authenticated through this {{object}}
instance. The roles are added to the Controller's current list of
Roles by replacing the value of the
{{param|###.LocalAgent.Controller.{i}.InheritedRole}} parameter. If
the Controller is already known to the Agent, with an associated
Role, this parameter has no impact.
A reference to the {{object|##.Certificate.{i}}} instance for use in
the authentication of certificates provided by a Controller and
authorization of Controllers, and for authentication of certificates
used for MTP encryption.
Identifies what usages the Certificate Authority (CA) authenticated
by the associated credential is trusted to authorize.
The CA can only authorize MTP (domain) connectivity, and cannot
authenticate Controllers.
The CA can authorize MTP (domain) connectivity and authenticate
Controllers.
The CA can authorize MTP (domain) connectivity and the
presenter of this certificate is trusted to have authenticated
the identity of Endpoints whose Records it transmits such that
the from_id can be trusted without additional authentication.
See {{bibref|TR-369|"Authentication and Authorization"}} for
additional description of the Trusted Broker function.
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 {{param|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 {{param|Role}} parameter to the value of
the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter.
*Use the Controller's certificate to which the challenge response was
received in order to authenticate the identity of the Controller.
{{datatype|expand}}
The description of this {{object}} instance.
{{nolist}} Comma-separated list of strings, the (set of) role(s)
appended (non-duplicate values only) to the value of the
{{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter.
Enable/Disable this {{object}} instance.
The type of challenge that will be verified from the challenge
response provided by the third-party through the Controller.
The challenge uses a passphrase the third-party is expected to
match.
The value of the challenge that is specific to the type of challenge.
The media type with a format as defined by {{bibref|RFC6838}} of the
content of the {{param|Value}} parameter.
The instruction that is provided to the external party by the
Controller requesting the challenge.
The media type with a format as defined by {{bibref|RFC6838}} of the
content of the {{param|Instruction}} parameter.
The number of times a challenge is retried before the challenge
procedure is terminated.
The time, in {{units}} that a Controller that has failed the
challenge is locked out (based on the value of the {{param|Retries}}
parameter) prior to being provided the challenge again. A value of
zero means that a LockoutPeriod doesn't apply and the challenge can
be provided indefinitely.
The {{object}} represents the STOMP capabilities of the device as
described in {{bibref|TR-369}}.
{{numentries}}
The {{object}} represents a STOMP connection between the Agent and a
STOMP server.
{{datatype|expand}}
Enables or disables this {{object}}. This parameter is based on
''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of this {{object}} (see
{{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is
{{false}} then {{param}} SHOULD normally be {{enum|Disabled}} or
{{enum|Error}} if there is a fault condition on the interface). When
{{param|Enable}} is changed to {{true}} then {{param}} SHOULD change
to {{enum|Enabled}} if and only if the interface is able to transmit
and receive PDUs; it SHOULD change to {{enum|Unknown}} if the state
of the interface can not be determined for some reason.
The date and time at which this {{object}} entered into its current
operational state.
The hostname or IP Address of the STOMP Server.
The port number of the STOMP Server.
The username part of the credentials to be used when authenticating
this {{object}} during connection establishment with the STOMP
Server.
The password part of the credentials to be used when authenticating
this {{object}} during connection establishment with the STOMP
Server.
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.
Enable or disable the STOMP Heart-beating mechanism as described in
STOMP (for this {{object}}). When the STOMP Heart-beat mechanism is
enabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}}
determine how the heart-beat header within the CONNECT frame is
formatted. When the STOMP Heart-beat mechanism is disabled,
{{param|OutgoingHeartbeat}} and {{param|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.
Represents the Outgoing heart-beat timing of the STOMP Heart-beating
mechanism as described in STOMP (for this {{object}}). 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.
Represents the Incoming heart-beat timing of the STOMP Heart-beating
mechanism as described in STOMP (for this {{object}}). 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.
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 reconnection interval multiplier as specified in
{{bibref|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
''n''th reconnection wait interval, the Device MUST use a random
value, in ''seconds'', between ''0'' and
{{param|ServerRetryInitialInterval}} * ({{param}} / 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).
The maximum reconnection wait interval, in {{units}}. If the ''n''th
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.
This parameter represents whether or not communications that utilize
this {{object}} object instance are encrypted. This parameter is
DEPRECATED, because the {{param|EnableEncryption}} parameter will
dictate whether all connections for this STOMP instance are or are
not encrypted.
When {{true}}, encryption MUST be used for this STOMP Connection
{{object}}.
Capabilities of a Device as it pertains to entering a standby state.
Indicates that the device is capable of maintaining a network
connection and responding to communications via the network
connection while in a standby state.
Indicates that the device is capable of maintaining and responding to
timers while in a standby state.
Top level object for dynamically managed software applications.
Install one or more Deployment Units (DUs) to the associated
{{object}}.
The {{datatype}} that specifies the location of the DU to be
installed. The URL MUST NOT include the "userinfo" component, as
defined in {{bibref|RFC3986}}. HTTP and HTTPS transports MUST be
supported. Other optional transports MAY be supported.
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}}.
Username to be used by the device to authenticate with the file
server, if authentication is required.
Password to be used by the device to authenticate with the file
server, if authentication is required.
A reference to the Execution Environment upon which the DU to be
installed. If {{empty}} the device MUST choose the Execution
Environment to use.
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.
The UUID as defined in {{bibref|RFC4122}} of the DU that affected
by the state change.
A reference to the DU that was affected by the state change.
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.
The current state of the created DU.
The DU is in an Installed state due to one of the following:
successful Install, successful Update, failed Update, or
failed Uninstall. In the case of a failed Update or failed
Uninstall the Fault argument will contain an explanation of
the failure.
The DU was successfully uninstalled from the device.
The DU could not be installed in which case a DU instance
MUST NOT be created in the Data Model.
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}}.
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.
The date and time transfer was started in UTC. The device SHOULD
record this information and report it in this argument, but if this
information is not available, the value of this argument MUST be
set to the Unknown Time value.
The date and time the transfer was fully completed and applied in
UTC. This need only be filled in if the transfer has been fully
completed and applied. The device SHOULD record this information
and report it in this argument, but if this information is not
available or the transfer has not completed, the value of this
argument MUST be set to the Unknown Time value.
The operation that was performed against the DU causing the DU
state change.
The operation attempted was the Installation of a DU.
The operation attempted was the Update of an existing DU.
The operation attempted was the Un-Installation of an
existing DU.
Fault Structure. If the operation was successful, the
{{param|FaultCode}} MUST be zero. Otherwise a non-zero
{{param|FaultCode}} is specified along with a {{param|FaultString}}
indicating the failure reason.
The numerical fault code. Valid values are:
*If the operation was successful, the fault code is 0.
*If the device cannot complete the operation for some unknown
reason, it SHOULD reject the operation with a 9001 (Request
Denied) fault code.
*If the device detects the presence of the "userinfo" component
in the file source URL, it SHOULD reject the operation with a
9003 (Invalid Arguments) fault code.
*If the device cannot find the Execution Environment specified in
the Install or Update command, it SHOULD reject the operation
with a 9023 (Unknown Execution Environment) fault code.
*If the device determines that the Deployment Unit being
installed does not match either the Execution Environment
specified or any Execution Environment on the device, it SHOULD
reject the operation with a 9025 (Deployment Unit to Execution
Environment Mismatch) fault code
*If the device detects that the Deployment Unit being installed
already has the same version as one already installed on the
same Execution Environment, it SHOULD reject the operation with
a 9026 (Duplicate Deployment Unit) fault code.
*If the device detects that that there are no more system
resources (disk space, memory, etc.) to perform the Install or
Update of a Deployment Unit, it SHOULD reject the operation with
a 9027 (System Resources Exceeded) fault code.
*If a requested operation attempts to alter the State of a
Deployment Unit in a manner that conflicts with the Deployment
Unit State Machine Diagram {{bibref|TR-369|Appendix I "Software
Module Management"}}, it SHOULD reject the operation with a 9029
(Invalid Deployment Unit State) fault code.
*If a requested operation attempts to Uninstall a DU that caused
an EE to come into existence, where that EE has at least 1
installed DU or at least 1 child EE, then the device SHOULD
reject the operation with a 9029 (Invalid Deployment Unit State)
fault code.
A human-readable text description of the fault. This field SHOULD
be empty if the FaultCode equals 0 (zero).
{{numentries}}
{{numentries}}
{{numentries}}
The Execution Environments that are available on the device, along with
their properties and configurable settings.
Indicates whether or not this {{object}} 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
{{enum|Idle|#.ExecutionUnit.{i}.Status}}. If an Update or Uninstall
operation is attempted on a {{object|#.DeploymentUnit}} that is to be
applied against a disabled {{object}}, 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 {{object}} and a Controller disabled it, the Agent
might be terminated leaving the device unmanageable.
Indicates the status of this {{object}}.
{{datatype|expand}}
A Name provided by the device that adequately distinguishes this
{{object}} from all other {{object}} instances.
Indicates the complete type and specification version of this
{{object}}.
The run level that this {{object}} 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 {{param|CurrentRunLevel}} is
greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and
{{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. 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 this {{object}}.
The run level that this {{object}} is currently operating in. This
value is altered by executing the {{command|SetRunLevel()}} command.
Upon startup (whether that is caused by a device Boot or the
Execution Environment starting) {{param}} will be equal to
{{param|InitialRunLevel}}, unless Run Levels are not supported by
this {{object}} in which case {{param}} will be -1. Run levels
dictate which Execution Units will be started. Execution Units will
be started if {{param}} is greater than or equal to
{{param|#.ExecutionUnit.{i}.RunLevel}} and
{{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. If {{param}} is
-1 then Run Levels are not supported by this {{object}} and setting
{{param|InitialRunLevel}} or executing the command
{{command|SetRunLevel()}} will not impact the Run Level of this
{{object}}.
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.
The vendor that produced this {{object}}.
The Version of this {{object}} as specified by the Vendor that
implemented this {{object}}, not the version of the specification.
Represents the parent {{object}} of this {{object}}. If this value is
{{empty}} then this is the Primary Execution Environment.
The amount of disk space measured in {{units}} allocated to this
{{object}}. A value of -1 MUST be used for {{object}} instances where
this parameter is not applicable.
The amount of disk space measured in {{units}} currently available to
this {{object}}. This value changes as the {{object|#.ExecutionUnit}}
instances associated with this {{object}} consumes disk space. A
value of -1 MUST be used for {{object}} instances where this
parameter is not applicable.
The amount of physical RAM measured in {{units}} allocated to this
{{object}}. A value of -1 MUST be used for {{object}} instances where
this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently available
to this {{object}}. This value changes as the
{{object|#.ExecutionUnit}} instances associated with this {{object}}
are started/stopped and consume the physical RAM. A value of -1 MUST
be used for {{object}} instances where this parameter is not
applicable.
Represents the {{object|#.ExecutionUnit}} instances currently running
on this {{object}}. This parameter only contains
{{object|#.ExecutionUnit}} instances that currently have a
{{param|#.ExecutionUnit.{i}.Status}} of
{{enum|Active|#.ExecutionUnit.{i}.Status}}.
Represents the processors that this {{object}} has available to it.
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}}.
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 command causes this {{object}} 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:
# All Deployment Units that were installed after the last Boot (with
cause of a factory reset) event MUST be removed
# All persistent storage, configuration files, and log files that
were associated with the removed Deployment Units MUST be removed
# Any Deployment Unit that is still installed against the Execution
Environment MUST be restored to the version present when the last
Boot (with cause of a factory reset) event was issued
# Any Deployment Unit that was present when the last Boot (with cause
of a factory reset) event was issued, but was subsequently
uninstalled and is now not present, MUST be installed with the
version that was present when the last Boot (with cause of a
factory reset) event was issued
# The Execution Environment MUST be restored to the version and
configuration present when the last Boot (with cause of a factory
reset) event was issued
# The Execution Environment MUST be restarted after all other
restoration requirements have been met
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.
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 {{bibref|RFC4122}} Version 5
(Name-Based) and {{bibref|TR-181i2|Annex C}}. This value MUST NOT be
altered when the {{object}} is updated.
Deployment Unit Identifier chosen by the targeted
{{object|#.ExecEnv}}. The format of this value is Execution
Environment specific.
{{datatype|expand}}
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 status of this {{object}}.
This instance is in the process of being Installed and SHOULD
transition to the {{enum|Installed}} state.
This instance has been successfully Installed. The
{{param|Resolved}} flag SHOULD also be referenced for
dependency resolution.
This instance is in the process of being Updated and SHOULD
transition to the {{enum|Installed}} state.
This instance is in the process of being Uninstalled and SHOULD
transition to the {{enum|Uninstalled}} state.
This instance has been successfully Uninstalled. This status
will typically not be seen within a {{object}} instance.
Indicates whether or not this {{object}} has resolved all of its
dependencies.
Contains the {{datatype}} used by the most recent
{{command|#.InstallDU()}} or {{command|Update()}} to either Install
or Update this {{object}}.
Textual description of this {{object}}. The format of this value is
Execution Environment specific.
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}}.
Version of this {{object}}. The format of this value is Execution
Environment specific.
Represents the vendor log files that have come into existence because
of this {{object}}. This does not include any vendor log files that
have come into existence because of {{object|#.ExecutionUnit}}
instances that are contained within this {{object}}. When this
{{object}} is uninstalled the vendor log files referenced here SHOULD
be removed from the device. Not all {{object}} instances will
actually have a corresponding vendor log file, in which case the
value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence
because of this {{object}}. This does not include any vendor config
files that have come into existence because of
{{object|#.ExecutionUnit}} instances that are contained within this
{{object}}. When this {{object}} is uninstalled the vendor config
files referenced here SHOULD be removed from the device. Not all
{{object}} instances will actually have a corresponding vendor config
file, in which case the value of this parameter will be {{empty}}.
Represents the {{object|#.ExecutionUnit}} instances that are
associated with this {{object}} instance.
Represents the {{object|#.ExecEnv}} instance where this {{object}}
instance is installed.
Update the associated {{object}}.
The {{datatype}} that specifies the location of the DU to be
installed. The URL MUST NOT include the "userinfo" component, as
defined in {{bibref|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.
Username to be used by the device to authenticate with the file
server, if authentication is required.
Password to be used by the device to authenticate with the file
server, if authentication is required.
Uninstall the associated {{object}}.
This table serves as the Execution Unit inventory and contains both
status information about each Execution Unit as well as configurable
parameters for each Execution Unit. Each {{object|#.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 {{object}}
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 {{object}} to come into existence) is being updated, all
{{object}} 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 {{object}} to come into
existence) is uninstalled, this instance is removed. Each {{object}}
MAY also contain a set of vendor specific parameters displaying status
and maintaining configuration that reside under the
{{object|Extensions}} object.
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.
{{datatype|expand}}
The name of this {{object}} as it pertains to its associated
{{object|#.DeploymentUnit}}, which SHOULD be unique across all
{{object}} instances contained within its associated
{{object|#.DeploymentUnit}}.
The name of this {{object}} as provided by the {{object|#.ExecEnv}},
which SHOULD be unique across all {{object}} instances contained
within a specific {{object|#.ExecEnv}}.
Indicates the status of this {{object}}.
This instance is in an Idle state and not running.
This instance is in the process of Starting and SHOULD
transition to the {{enum|Active}} state.
This instance is currently running.
This instance is in the process of Stopping and SHOULD
transition to the {{enum|Idle}} state.
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 {{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 {{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.
Determines when this {{object}} will be started. If
{{param|AutoStart}} is {{true}} and
{{param|#.ExecEnv.{i}.CurrentRunLevel}} is greater than or equal to
{{param}}, then this {{object}} will be started. If the value of
{{param|#.ExecEnv.{i}.CurrentRunLevel}} is -1, then the associated
{{object|#.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 {{object}}.
Vendor of this {{object}}.
Version of the {{object}}. The format of this value is Execution
Environment specific.
Textual description of this {{object}}. The format of this value is
Execution Environment specific.
The amount of disk space measured in {{units}} currently being used
by this {{object}}. A value of -1 MUST be used for {{object}}
instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently being used
by this {{object}}. A value of -1 MUST be used for {{object}}
instances where this parameter is not applicable.
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 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 vendor log files that have come into existence because
of this {{object}}. When the {{object|#.DeploymentUnit}} (that caused
this {{object}} to come into existence) is uninstalled the vendor log
files referenced here SHOULD be removed from the device. Not all
{{object}} instances will actually have a corresponding vendor log
file, in which case the value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence
because of this {{object}}. When the {{object|#.DeploymentUnit}}
(that caused this {{object}} to come into existence) is uninstalled
the vendor config files referenced here SHOULD be removed from the
device. Not all {{object}} instances will actually have a
corresponding vendor config file, in which case the value of this
parameter will be {{empty}}.
Represents the {{object|#.ExecEnv}} that this {{object}} is
associated with.
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.
Indicates the requested state to transition this instance of the
{{object|##.}} object. {{enum}}
If this {{object|##.}} is currently in
{{enum|Starting|###.ExecutionUnit.{i}.Status}} or
{{enum|Active|###.ExecutionUnit.{i}.Status}} the device
will attempt to Stop the Execution Unit; otherwise this
requested state is ignored.
If this {{object|##.}} is currently in
{{enum|Idle|###.ExecutionUnit.{i}.Status}} the device will
attempt to Start the Execution Unit. If this {{object|##.}}
is in {{enum|Stopping|###.ExecutionUnit.{i}.Status}} the
request is rejected and a fault raised. Otherwise this
requested state is ignored.
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.
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.
{{datatype|expand}}
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
A textual name of the instance, which can be assigned by the user.
{{object}}.
This parameter provides the state of the {{object}} on the underlying
(proxied) connected network.
The date time of the last successful contact.
{{reference|a protocol object that uses the
{{param|ProxyProtocol}}}}.
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.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
{{numentries}}
Each Node instance represents distinct functional devices, which are
virtual and abstracted representation of functionality.
{{datatype|expand}}
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
This list of IoT capability objects.
{{datatype|expand}}
A textual name of the instance, which can be assigned by the user.
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.
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.
Describes the type of functionality that {{object}} is representing.
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
Value of {{true}} or {{false}} that reflects the functionality.
Toggle the {{param|Value}}.
LevelController is used to model a control with a range of continuous
states. These values are configurable via {{param|Value}} and measured
in {{param|Unit}} and are restricted between a Min and Max values.
Intensity profile - {{param|Value}} of intensity and ability to update
that level through {{param|StepUp}} and {{param|StepDown}} commands
with a configurable {{param|StepValue}}.
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
The desired run value that this {{object}} will be between
{{param|MinValue}} and {{param|MaxValue}}.
Units in which {{param|Value}}, {{param|Value}}, {{param|MinValue}},
{{param|MaxValue}} and {{param|StepValue}} are expressed.
{{datatype|expand}}.
Minimum allowed value for {{param|Value}}.
Maximum allowed value for {{param|Value}}.
Number of {{param|Unit}} changes of each {{param|StepUp}} and
{{param|StepDown}} command.
Step Up the {{param|Value}}.
Step Down the {{param|Value}}.
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.
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
Current value representing the {{object}}; MUST be an element of
{{param|ValidValues}}.
List of valid values from the control represented by the {{object}}.
Step up the {{param|Value}} to the next allowed value in the enum.
Step down the {{param|Value}} to the previous allowed value in the
enum.
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.
Describes the type of functionality that {{object}} is representing.
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
If the {{object}} has been recently activated, the value would be
true. For how long the state attribute remain true after being
activated depends on the underlying sensor reports.
The date and time in UTC when {{param|Value}} has been changed to the
current value.
A 0 to 100 value indicating how reactive to changes the {{object}}
should be, 0 being not sensible / disabled and 100 max sensitivity.
After activation has been detected and the sensing attribute set to
true, how soon, in {{units}} should the {{param|Value}} be reset to
{{false}}.
After activation has been detected and the {{param|Value}} set to
{{true}}, how soon, in {{units}} should affected again per subsequent
event.
LevelSensor is used to reflect the functionality of a sensor that
reports a {{param|Value}} in {{param|Unit}}.
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
The current value reading of this {{object}} in units defined in
{{param|Unit}}.
The date and time in UTC when {{param|Value}} has been changed to the
current value.
{{datatype|expand}} Unit in which {{param|Value}} is expressed.
Low level indicator. Is set to {{true}} if {{param|Value}} is equal
or less than the value defined in {{param|LowLevelThreshold}}.
The threshold value in for {{param|LowLevel}} expressed in the same
units like {{param|Value}}.
High level indicator. Is set to {{true}} if {{param|Value}} is equal
or higher than the value defined in {{param|HighLevelThreshold}}.
The threshold value in for {{param|HighLevel}} expressed in the same
units like {{param|Value}}.
MultiLevelSensor is used to reflect the functionality of a sensor that
reports multiple {{param|Values}} with the same {{param|Unit}}.
Describes the type of functionality that {{object}} is representing.
RGB color, encoded as integer value between 0 (usually
represented as 0x000000) and 16777215 (usually represented as
0xFFFFFF), e.g. Blue would be 255 (usually represented as
0x0000FF)
The sensor reports a location with the values of Longitude,
Latitude, Altitude as decimal values in km.
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
The current value reading of this {{object}} in units defined in
{{param|Unit}}.
The names of the values expressed in {{param|Values}}.
The date and time when {{param|Values}} has been changed to the
current values.
{{datatype|expand}} Unit in which {{param|Values}} are expressed.
EnumSensor is used to reflect the functionality of a sensor that
reports explicit non-continuous values.
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
The actual reading value; MUST be a member of the enumeration defined
in {{param|ValidValues}}.
The date and time when {{param|Value}} has been changed to the
current value.
List of valid values reported from the sensor represented by this
{{object}}.
Each Node instance represents distinct functional devices, which are
virtual and abstracted representation of functionality.
{{datatype|expand}}
{{datatype|expand}}
Human-readable description of the {{object}}. e.g. a more detailed
description of {{param|Type}}.
REQUIRED only for devices that support NAT.
This profile is IPv4 specific.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv4 capable devices.
REQUIRED only for IPv4 capable devices.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv6 capable devices.
Note: This profile is valid for G.992.1 modems.
Note: This profile is valid for G.992.3 and G.992.5 modems.
REQUIRED only for IPv4 capable devices.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv4 capable devices.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv4 capable devices.
REQUIRED only for IPv6 capable devices.
802.1x Authentication provisioning information used for MD5 shared
secret exchange. This object will not exist if EAP-MD5 is not a
supported authentication type.
802.1x Authentication provisioning information used for TLS
certificate authentication. This object will not exist if the EAP-TLS
is not a supported authentication type.
This table is REQUIRED to support sending of option 60 (Vendor Class
Identifier) and option 77 (User Class Identifier) values.
This table is REQUIRED to support requesting of option 60 (Vendor
Class Identifier), option 61 (Client Identifier) and option 77 (User
Class Identifier) values.
Provides MQTT client control
Provides basic MQTT client control and statistics
Adds client subscription control and access to received topics
Adds client authentication, will handling and extends statistics
Provides basic MQTT broker control and statistics
Adds parameters for MQTT network interconnection with Bridges
Adds client authentication and extends statistics
Note: This profile is valid for G.9701 modems.
Note: This profile is valid for G.992.1 modems.
Note: This profile is valid for G.992.3 and G.992.5 modems.
Note: This profile is valid for G.993.2 modems.
This profile adds USP agent extensions for MQTT transport.
This profile adds USP controller extensions for MQTT transport.