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 handle used to reference this instance. Alias provides a
mechanism for an ACS to label this instance for future reference.
If the CPE supports the Alias-based Addressing feature as defined in
{{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}},
the following mandatory constraints MUST be enforced:
* Its value MUST NOT be empty.
* Its value MUST start with a letter.
* If its value is not assigned by the ACS, it MUST start with a "cpe-"
prefix.
* The CPE MUST NOT change the parameter value.
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.
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.
Universally Unique Identifier. See {{bibref|RFC4122}}.
3GPP TS 23.003
Numbering, addressing and identification
3GPP CT WG4
https://www.3gpp.org/ftp/Specs/html-info/23003.htm
3GPP TS 23.107
Quality of Service (QoS) concept and architecture
3GPP SA WG2
https://www.3gpp.org/ftp/Specs/html-info/23107.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
3GPP TS 32.582
Telecommunications management; Home Node B (HNB) Operations,
Administration, Maintenance and Provisioning (OAM&P); Information
model for Type 1 interface HNB to HNB Management System (HMS)
3GPP SA WG5
https://www.3gpp.org/ftp/Specs/html-info/32582.htm
3GPP TS 32.584
Telecommunications management; Home Node B (HNB) Operations,
Administration, Maintenance and Provisioning (OAM&P); XML
definitions for Type 1 interface HNB to HNB Management Systems (HMS)
3GPP SA WG5
https://www.3gpp.org/ftp/Specs/html-info/32584.htm
3GPP TS 32.592
Telecommunications management; Home enhanced Node B (HeNB) Operations,
Administration, Maintenance and Provisioning (OAM&P); Information
model for Type 1 interface HeNB to HeNB Management System (HeMS)
3GPP SA WG5
https://www.3gpp.org/ftp/Specs/html-info/32592.htm
S.S0132-0 v1.0
Femtocell Security Framework
3GPP2
January 2010
https://www.3gpp2.org/Public_html/Specs/S.S0132-0_v1.0_Femtocell_Security_Framework.pdf
X.S0011-005-C
cdma2000 Wireless IP Network Standard: Accounting Services and 3GPP2
RADIUS VSAs
3GPP2
August 2003
https://www.3gpp2.org/Public_html/Specs/X.S0011-005-C_v1.0_110703.pdf
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.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
TS 102 824
Digital Video Broadcasting (DVB);Remote Management and Firmware Update
System for DVB IP Services
ETSI
July 2008
https://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769
http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769
ETSI TS 102 690 v1.1.6
Machine-to-Machine Communications (M2M Functional Architecture)
ETSI
June 2012
https://docbox.etsi.org/M2M/Open/Latest_Drafts/00002ed121v116.pdf
G.9973
Protocol for identifying home network topology
ITU-T
2011
https://www.itu.int/rec/T-REC-G.9973-201110-I/en
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
IANA Uniform Resource Identifier (URI) Schemes Registry
Uniform Resource Identifier (URI) Schemes
IANA
https://www.iana.org/assignments/uri-schemes
ISO/IEC 13818-6:1998
Information Technology - Generic coding of moving pictures and
associated audio information - Part 6: Extensions for DSM-CC
ISO
1998
https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039
http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039
RFC 793
Transmission Control Protocol
IETF
RFC
September 1981
https://www.rfc-editor.org/rfc/rfc793
http://www.ietf.org/rfc/rfc793.txt
RFC 862
Echo Protocol
IETF
RFC
1983
https://www.rfc-editor.org/rfc/rfc862
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
http://www.ietf.org/rfc/rfc1323.txt
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 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 2516
A Method for Transmitting PPP Over Ethernet (PPPoE)
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2516
RFC 2581
TCP Congestion Control
IETF
RFC
April 1999
https://www.rfc-editor.org/rfc/rfc2581
http://www.ietf.org/rfc/rfc2581.txt
RFC 2582
The NewReno Modification to TCP's Fast Recovery Algorithm
IETF
RFC
April 1999
https://www.rfc-editor.org/rfc/rfc2582
http://www.ietf.org/rfc/rfc2582.txt
RFC 2616
Hypertext Transfer Protocol - HTTP/1.1
IETF
RFC
1999
https://www.rfc-editor.org/rfc/rfc2616
RFC 2634
Enhanced Security Services for S/MIME
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2634
RFC 2662
Definitions of Managed Objects for the ADSL Lines
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2662
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 2818
HTTP Over TLS
IETF
RFC
May 2000
https://www.rfc-editor.org/rfc/rfc2818
http://www.ietf.org/rfc/rfc2818.txt
RFC 2863
The Interfaces Group MIB
IETF
2000
https://www.rfc-editor.org/rfc/rfc2863
RFC 2898
PKCS #5: Password-Based Cryptography Specification Version 2.0
IETF
RFC
https://www.rfc-editor.org/rfc/rfc2898
RFC 2974
Session Announcement Protocol
IETF
RFC
October 2000
https://www.rfc-editor.org/rfc/rfc2974
http://www.ietf.org/rfc/rfc2974.txt
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 3489
STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network
Address Translators (NATs)
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3489
RFC 3925
Vendor-Identifying Vendor Options for Dynamic Host Configuration
Protocol version 4 (DHCPv4)
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3925
RFC 3926
FLUTE - File Delivery over Unidirectional Transport
IETF
RFC
October 2004
https://www.rfc-editor.org/rfc/rfc3926
http://www.ietf.org/rfc/rfc3926.txt
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
http://www.ietf.org/rfc/rfc4122.txt
RFC 4291
IP Version 6 Addressing Architecture
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4291
RFC 4301
Security Architecture for the Internet Protocol
IETF
December 2005
https://www.rfc-editor.org/rfc/rfc4301
RFC 4307
Cryptographic Algorithms for Use in the Internet Key Exchange Version 2
(IKEv2)
IETF
December 2005
https://www.rfc-editor.org/rfc/rfc4307
RFC 4632
Classless Inter-domain Routing (CIDR): The Internet Address Assignment
and Aggregation Plan
IETF
2006
https://www.rfc-editor.org/rfc/rfc4632
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 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 6120
Extensible Messaging and Presence Protocol (XMPP) : Core
IETF
2011
https://www.rfc-editor.org/rfc/rfc6120
RFC 6763
DNS-Based Service Discovery
IETF
RFC
2013
https://www.rfc-editor.org/rfc/rfc6763
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 8141
Uniform Resource Names (URNs)
IETF
RFC
April 2017
https://www.rfc-editor.org/rfc/rfc8141
TR-069 Amendment 2
CPE WAN Management Protocol
Broadband Forum
TR
December 2007
TR-069 Amendment 3
CPE WAN Management Protocol
Broadband Forum
TR
November 2010
TR-069 Amendment 4
CPE WAN Management Protocol
Broadband Forum
TR
July 2011
TR-069 Amendment 5
CPE WAN Management Protocol
Broadband Forum
December 2013
TR-069 Amendment 6
CPE WAN Management Protocol
Broadband Forum
TR
April 2018
TR-098 Amendment 1
Internet Gateway Device Data Model for TR-069
Broadband Forum
TR
December 2006
TR-098 Amendment 2
Internet Gateway Device Data Model for TR-069
Broadband Forum
TR
September 2008
TR-098 Amendment 2 Corrigendum 1
Internet Gateway Device Data Model for TR-069
Broadband Forum
TR
December 2014
TR-106 Amendment 1
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
November 2006
TR-106 Amendment 2
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
November 2008
TR-106 Amendment 3
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
September 2009
TR-106 Amendment 4
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
February 2010
http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf
TR-106 Amendment 6
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
July 2011
TR-106 Amendment 7
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
September 2013
TR-143 Amendment 1 Corrigendum 1
Enabling Network Throughput Performance Tests and Statistical
Monitoring
Broadband Forum
TR
August 2015
TR-157 Amendment 3
Component Objects for CWMP
Broadband Forum
TR
November 2010
http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf
TR-157 Amendment 5
Component Objects for CWMP
Broadband Forum
TR
November 2011
TR-157 Amendment 10
Component Objects for CWMP
Broadband Forum
TR
November 2015
TR-181 Issue 1
Device Data Model for TR-069
Broadband Forum
TR
February 2010
TR-181 Issue 2 Amendment 15
Device Data Model
Broadband Forum
TR
January 2022
TR-196 Issue 2
Femto Access Point Service Data Model
Broadband Forum
TR
November 2011
TR-232
Bulk Data Collection
Broadband Forum
Technical Report
May 2012
TR-262
Femto Component Objects
Broadband Forum
TR
November 2011
Wi-Fi Protected Setup Specification Version 1.0h
Wi-Fi Alliance
2006
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)
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/
http://www.dlna.org/industry/certification/guidelines/
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
http://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
http://www.icsalabs.com/sites/default/files/residential.pdf
IPDR File Transfer Protocol
IPDR/File Transfer Protocol
TM Forum
https://www.tmforum.org/ipdr/
http://www.ipdr.org/public/
IPDR Streaming Protocol
IPDR Streaming Protocol (IPDR/SP) Specification
TM Forum
https://www.tmforum.org/ipdr/
http://www.ipdr.org/public/
IPDR XDR Encoding Format
IPDR/XDR Encoding Format
TM Forum
https://www.tmforum.org/ipdr/
http://www.ipdr.org/public/
IPDR XML File Encoding Format
IPDR/XML File Encoding Format
TM Forum
https://www.tmforum.org/ipdr/
http://www.ipdr.org/public/
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
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
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
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
USB 1.0
USB 1.0 Specification
USB-IF
January 1996
https://www.usb.org/documents
http://www.usb.org/developers/docs/
USB 2.0
USB 2.0 Specification
USB-IF
April 2000
https://www.usb.org/documents
http://www.usb.org/developers/docs/usb_20_122208.zip
USB 3.0
USB 3.0 Specification
USB-IF
November 2008
https://www.usb.org/documents
http://www.usb.org/developers/docs/usb_30_spec.zip
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
The top-level object for an Internet Gateway Device.
As defined in {{bibref|TR-106a1}}.
This parameter is DEPRECATED because
{{object|DeviceInfo.SupportedDataModel}} and associated Device Type
XML documents (DT Instances) provide a more granular and scalable way
of describing the device's data model. Therefore its value MAY be
{{empty}} if (and only if) {{object|DeviceInfo.SupportedDataModel}}
is supported.
Number of instances of {{object|LANDevice}}.
Number of instances of {{object|WANDevice}}.
{{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 device and would
therefore require a BOOTSTRAP Inform.
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. Any change would indicate that it's a new device and would
therefore require a BOOTSTRAP Inform.
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. Any
change would indicate that it's a new device and would therefore
require a BOOTSTRAP Inform.
A string identifying the particular CPE model and version.
A string identifying the software version currently installed in the
CPE. 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''.
A string identifying the version of the modem firmware currently
installed in the CPE. This is applicable only when the modem firmware
is separable from the overall CPE software.
This parameter is DEPRECATED because the "voucher mechanism", as
defined in {{bibref|TR-069a3|Annex C}} is deprecated in favor of the
"Software Module Management mechanism" as described in
{{bibref|TR-157a3|Appendix II}}. {{list}} The OptionName of each
Option that is currently enabled in the CPE. The OptionName of each
is identical to the OptionName element of the OptionStruct described
in {{bibref|TR-069a3}}. Only those options are listed whose State
indicates the option is enabled.
Any additional hardware version information the vendor might wish to
supply.
Any additional software version information the vendor might wish to
supply.
Represents the version of the specification implemented by the
device. Currently 1.0 is the only available version. The value of
this parameter MUST equal "1.0". This parameter is DEPRECATED because
its value is fixed and it therefore serves no purpose. However, it is
a Forced Inform parameter and therefore cannot be OBSOLETED.
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. If not
{{empty}}, this argument SHOULD be in the form of a hierarchical
descriptor with one or more nodes specified. Each node in the
hierarchy is represented as a 4-character sub-string, containing only
numerals or upper-case letters. If there is more than one node
indicated, each node is separated by a "." (dot). Examples: "TLCO" or
"TLCO.GRP2".
Time in seconds 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.
Vendor-specific log(s).
Number of instances of {{object|VendorConfigFile}}.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Every instance of this object is a Vendor Configuration File, and
contains parameters associated with the Vendor Configuration File.
This table of Vendor Configuration Files is for information only and
does not allow the ACS to operate on these files in any way. Whenever
the CPE successfully downloads a configuration file as a result of the
Download RPC with the FileType argument of ''3 Vendor Configuration
File'', the CPE MUST update this table. If the name of the file
(determined as described in the definition of the {{param|Name}}
parameter) differs from that of any existing instance, then the CPE
MUST create a new instance to represent this file. If instead, the name
of the file is identical to that of an existing instance, then the CPE
MUST update the content of the existing instance with the new version,
date, and (optionally) description of the file.{{nokeys}}
{{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).
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}} Since a Process can come and go very quickly, the CPE
SHOULD place a locally specified limit on the frequency at which it
will notify the ACS of value changes, as described in
{{bibref|TR-069a2|Section 3.2.1}}.
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.
When set to {{true}}, 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-106a2}}, 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-106a2}},
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-106a2}}, 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-106a2}}, 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-106a2}}, 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.
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-106a2}}, indicates
that an alarm has not been encountered since the last 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.
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
This table contains details of the device's Current Supported Data
Model. The table MUST describe the device's entire Supported Data
Model. Therefore, if a device's Supported Data Model changes at
run-time, entries will need to be added or removed as appropriate. Each
table entry MUST refer to only a single Root Object or Service Object.
The device MAY choose to use more than one table entry for a given Root
Object or Service Object. Considering that every device has some form
of a data model, this table MUST NOT be empty.
{{datatype|expand}}
URL ({{bibref|RFC3986}}) that describes some or all of the device's
Current Supported Data Model. The URL MUST reference an XML file
which describes the appropriate part of the Supported Data Model. The
referenced XML file MUST be compliant with the DT (Device Type)
Schema that is described in {{bibref|TR-106a3|Annex B}}, including
any additional normative requirements referenced within the Schema.
The XML file referenced by this URL MUST NOT change while the CPE is
running, and SHOULD NOT change across a CPE reboot. Note that
{{param|UUID}} is a unique key, so the XML file referenced by this
URL will never change. The XML file MAY be located within the CPE. In
this scenario the CPE MAY use the value of "localhost" as URL host
portion, When the "localhost" value is used, the ACS has the
responsibility to substitute the "localhost" value with the host
portion of the connection request URL. Behavior in the event of an
invalid URL, failure to access the referenced XML file, or an invalid
XML file, is implementation-dependent.
UUID ({{bibref|RFC4122}}) that is the value of the uuid attribute in
the DT Instance referenced by {{param|URL}}.
URN ({{bibref|RFC3986}}) that is the value of the spec attribute in
the DM (data model) Instance that defines the Root Object or Service
Object referenced by this table entry. For example, if this table
entry references a DT Instance that refers to the ''Device:1.3'' Root
Object, the value of this parameter would be
''urn:broadband-forum-org:tr-157-1-0-0'', because TR-157 defines
''Device:1.3''. If the DT Instance instead referred to a
vendor-specific Root Object, e.g. ''X_EXAMPLE_Device:1.0'' (derived
from ''Device:1.3''), the value of this parameter would be something
like ''urn:example-com:device-1-0-0''.
This parameter MUST list exactly the features that are defined using
the top-level ''feature'' element in the DT Instance referenced by
{{param|URL}}. For example, if the DT instance specified the
following:
:<feature name="DNSServer"/>
:<feature name="Router"/>
:<feature name="X_MyDeviceFeature"/> then the value of this
parameter might be ''DNSServer,Router,X_MyDeviceFeature''. The order
in which the features are listed is not significant.
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-106a4|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 ACS 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.
Represents the associated CPE Proxier for a Proxied Device that
utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069a4|Annex
J.1.1}}.
Organizationally unique identifier of the associated CPE Proxier.
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}}.
Identifier of the class of product of the associated CPE Proxier for
which the serial number applies. {{empty}} indicates either that the
CPE Proxier does not use a product class to differentiate its serial
number.
Serial number of the associated CPE Proxier.
The protocol being used to communicate between the CPE Proxier and
this Proxied Device. {{enum}} Vendors can extend the enumerated
values with vendor specific extensions, in which case the rules
outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
see {{bibref|ETSIM2MFA}}
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
ACS.
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}}. 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 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}} MUST exist at any given time.
This object contains general configuration parameters.
Arbitrary user data that MUST persist across CPE reboots.
A dump of the currently running configuration on the CPE. This
parameter enables the ability to backup and restore the last known
good state of the CPE. It returns a vendor-specific document that
defines the state of the CPE. The document MUST be capable of
restoring the CPE's state when written back to the CPE using
SetParameterValues.
An alternative to this parameter, e.g. when the configuration file is
larger than the parameter size limit, is to use the Upload and
Download RPCs with a FileType of ''1 Vendor Configuration File''.
This object contains parameters relating to the CPE's association with
an ACS.
Enables and disables the CPE's support for CWMP. {{false}} means that
CWMP support in the CPE is disabled, in which case the device MUST
NOT send any Inform messages to the ACS or accept any Connection
Request notifications from the ACS. {{true}} means that CWMP support
on the CPE is enabled. The factory default value MUST be {{true}}.
The subscriber can re-enable the CPE's CWMP support either by
performing a factory reset or by using a LAN-side protocol to change
the value of this parameter back to {{true}}.
URL, as defined in {{bibref|RFC3986}}, for the CPE to connect to the
ACS using the CPE WAN Management Protocol. This parameter MUST be in
the form of a valid HTTP or HTTPS URL {{bibref|RFC2616}}. The
''host'' portion of this URL is used by the CPE for validating the
ACS certificate when using SSL or TLS. Note that on a factory reset
of the CPE, the value of this parameter might be reset to its factory
value. If an ACS 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.
Username used to authenticate the CPE when making a connection to the
ACS using the CPE WAN Management Protocol. This username is used only
for HTTP-based authentication of the CPE.
Note that on a factory reset of the CPE, the value of this parameter
might be reset to its factory value. If an ACS modifies the value of
this parameter, it SHOULD be prepared to accommodate the situation
that the original value is restored as the result of a factory reset.
Password used to authenticate the CPE when making a connection to the
ACS using the CPE WAN Management Protocol. This password is used only
for HTTP-based authentication of the CPE.
Note that on a factory reset of the CPE, the value of this parameter
might be reset to its factory value. If an ACS 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.
Whether or not the CPE MUST periodically send CPE information to the
ACS using the Inform method call.
The duration in seconds of the interval for which the CPE MUST
attempt to connect with the ACS and call the Inform method if
{{param|PeriodicInformEnable}} is {{true}}.
An absolute time reference in UTC to determine when the CPE will
initiate the periodic Inform method calls. Each Inform call MUST
occur at this reference time plus or minus an integer multiple of the
{{param|PeriodicInformInterval}}. {{param}} is used only to set the
"phase" of the periodic Informs. The actual value of {{param}} can be
arbitrarily far into the past or future. For example, if
{{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} is
set to UTC midnight on some day (in the past, present, or future)
then periodic Informs 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-098a2|section 2.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
{{param|PeriodicInformInterval}}. If absolute time is not available
to the CPE, its periodic Inform behavior MUST be the same as if the
{{param}} parameter was set to the Unknown Time value.
{{param}} provides the ACS a reliable and extensible means to track
changes made by the ACS. The value of {{param}} MUST be equal to the
value of the ParameterKey argument from the most recent successful
SetParameterValues, AddObject, or DeleteObject method call from the
ACS. The CPE MUST set {{param}} to the value specified in the
corresponding method arguments if and only if the method completes
successfully and no fault response is generated. If a method call
does not complete successfully (implying that the changes requested
in the method did not take effect), the value of {{param}} MUST NOT
be modified. The CPE MUST only modify the value of {{param}} as a
result of SetParameterValues, AddObject, DeleteObject, or due to a
factory reset. On factory reset, the value of {{param}} MUST be set
to {{empty}}.
HTTP URL, as defined in {{bibref|RFC3986}}, for an ACS to make a
Connection Request notification to the CPE. In the form:
http://host:port/path The ''host'' portion of the URL MAY be the IP
address for the management interface of the CPE in lieu of a host
name.
Username used to authenticate an ACS making a Connection Request to
the CPE.
Password used to authenticate an ACS making a Connection Request to
the CPE.
Indicates whether or not the ACS will manage upgrades for the CPE. If
{{true}}, the CPE SHOULD NOT use other means other than the ACS to
seek out available upgrades. If {{false}}, the CPE MAY use other
means for this purpose. Note that an autonomous upgrade (reported via
an ''10 AUTONOMOUS TRANSFER COMPLETE'' Inform Event code) SHOULD be
regarded as a managed upgade if it is performed according to
ACS-specified policy.
Present only for a CPE that supports the Kicked RPC method.
LAN-accessible URL, as defined in {{bibref|RFC3986}}, from which the
CPE can be "kicked" to initiate the Kicked RPC method call. MUST be
an absolute URL including a host name or IP address as would be used
on the LAN side of the CPE.
Present only for a CPE that provides a LAN-side web page to show
progress during a file download. LAN-accessible URL, as defined in
{{bibref|RFC3986}}, to which a web-server associated with the ACS MAY
redirect a user's browser on initiation of a file download to
observer the status of the download.
This parameter is used to control throttling of active notifications
sent by the CPE to the ACS. It defines the minimum number of seconds
that the CPE MUST wait since the end of the last session with the ACS
before establishing a new session for the purpose of delivering an
active notification. In other words, if CPE needs to establish a new
session with the ACS for the sole purpose of delivering an active
notification, it MUST delay establishing such a session as needed to
ensure that the minimum time since the last session completion has
been met. The time is counted since the last successfully completed
session, regardless of whether or not it was used for active
notifications or other purposes. However, if connection to the ACS is
established for purposes other than just delivering active
notifications, including for the purpose of retrying a failed
session, such connection MUST NOT be delayed based on this parameter
value, and the pending active notifications MUST be communicated
during that connection. The time of the last session completion does
not need to be tracked across reboots.
Address and port to which an ACS MAY send a UDP Connection Request to
the CPE (see {{bibref|TR-069a2|Annex G}}). This parameter is
represented in the form of an Authority element as defined in
{{bibref|RFC3986}}. The value MUST be in one of the following two
forms:
: host:port
: host When {{param|STUNEnable}} is {{true}}, the ''host'' and
''port'' portions of this parameter MUST represent the public
address and port corresponding to the NAT binding through which the
ACS can send UDP Connection Request messages (once this information
is learned by the CPE through the use of STUN). When
{{param|STUNEnable}} is {{false}}, the ''host'' and ''port''
portions of the URL MUST represent the local IP address and port on
which the CPE is listening for UDP Connection Request messages. The
second form of this parameter MAY be used only if the port value is
equal to "80".
The minimum time, in seconds, between Active Notifications resulting
from changes to the {{param|UDPConnectionRequestAddress}} (if Active
Notification is enabled).
Enables or disables the use of STUN by the CPE. This applies only to
the use of STUN in association with the ACS to allow UDP Connection
Requests.
Host name or IP address of the STUN server for the CPE to send
Binding Requests if STUN is enabled via {{param|STUNEnable}}. If
{{empty}} and {{param|STUNEnable}} is {{true}}, the CPE MUST use the
address of the ACS extracted from the host portion of the ACS URL.
Port number of the STUN server for the CPE to send Binding Requests
if STUN is enabled via {{param|STUNEnable}}. By default, this SHOULD
be the equal to the default STUN port, 3478.
If not {{empty}}, the value of the STUN USERNAME attribute to be used
in Binding Requests (only if message integrity has been requested by
the STUN server). If {{empty}}, the CPE MUST NOT send STUN Binding
Requests with message integrity.
The value of the STUN Password to be used in computing the
MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if
message integrity has been requested by the STUN server).
If STUN Is enabled, the maximum period, in seconds, that STUN Binding
Requests MUST be sent by the CPE for the purpose of maintaining the
binding in the Gateway. This applies specifically to Binding Requests
sent from the UDP Connection Request address and port. A value of -1
indicates that no maximum period is specified.
If STUN Is enabled, the minimum period, in seconds, that STUN Binding
Requests can be sent by the CPE for the purpose of maintaining the
binding in the Gateway. This limit applies only to Binding Requests
sent from the UDP Connection Request address and port, and only those
that do not contain the BINDING-CHANGE attribute. This limit does not
apply to retransmissions following the procedures defined in
{{bibref|RFC3489}}.
When STUN is enabled, this parameter indicates whether or not the CPE
has detected address and/or port mapping in use. A {{true}} value
indicates that the received MAPPED-ADDRESS in the most recent Binding
Response differs from the CPE's source address and port. When
STUNEnable is {{false}}, this value MUST be {{false}}.
Indicates whether or not the Alias-Based Addressing Mechanism is
supported. A {{true}} value indicates that the CPE supports the
Alias-Based Addressing Mechanism, as defined in
{{bibref|TR-069a4|3.6.1}} and described in {{bibref|TR-069a4|Appendix
II}}.
Number of entries in the {{object|ManageableDevice}} table.
The minimum time, in seconds, between Active Notifications resulting
from changes to the {{param|ManageableDeviceNumberOfEntries}} (if
Active Notification is enabled).
{{numentries}}
{{numentries}}
Instance identification mode as defined in {{bibref|TR-069a4|3.6.1}}.
When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by
the ACS to control whether the CPE will use Instance Numbers or
Instance Aliases in returned Path Names. {{enum}} This parameter is
REQUIRED for any CPE supporting Alias-Based Addressing.
Enable or disable the Auto-Create Instance Mechanism. When
{{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates
whether or not the CPE will automatically create instances while
processing a SetParameterValues RPC (as defined in
{{bibref|TR-069a4|A.3.2.1}}).
*A {{true}} value indicates that the CPE will perform auto-creation
of instances when the Alias-Based Addressing Mechanism is used in
SetParameterValues RPC.
*A {{false}} value indicates that the CPE will not create new object
instances. Instead, it will reject the setting of parameters in
unrecognized instances and respond with a fault code. This parameter
is REQUIRED for any CPE supporting Alias-Based Addressing.
Configures the first session retry wait interval, in seconds, as
specified in {{bibref|TR-069a2|Section 3.2.1.1}}. A value of 5
corresponds to the default behavior that is described in
{{bibref|TR-069a2}}. The device MUST use a random value between
{{param}} and ({{param}} * {{param|CWMPRetryIntervalMultiplier}} /
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-069a2|Section 3.2.1.1}}. 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-069a2}}. The device MUST use a random value
between {{param|CWMPRetryMinimumWaitInterval}} and
({{param|CWMPRetryMinimumWaitInterval}} * {{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 connection request methods supported by this {{object}}. {{enum}}
The connection request method as specified in
{{bibref|TR-069|Section 3.2.2 ACS Connection Initiation}},
'''REQUIRED'''
The connection request method as specified in
{{bibref|TR-069|Annex G Connection Request via NAT Gateway}}
The connection request method as specified in
{{bibref|TR-069a5|Annex K XMPP Connection Request}}
{{reference|the {{object|.XMPP.Connection}} instance that is used for
connection requests to this {{object}}}}
When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza
will contian a "from" address that contains the Jabber ID of the
initiating entity. This parameter is a {{list}} Each entry represents
a Jabber ID, or address, that is allowed to initiate an XMPP
Connection Request. Each Jabber ID is allowed to be either a "Full
JID" (containing a local-part, domain-part, and resource-part in the
following format: "local-part@domain-part/resource-part") or a "Bare
JID" (containing a local-part and a domain-part in the following
format: "local-part@domain-part"). "Full JID" entries require an
exact match whereas "Bare JID" entries are a wildcard match and will
match any Jabber ID with the same local-part and domain-part
independent of the resource-part. For example, if {{param}} contained
"ACS1@tr069.example.com, ACS2@tr-069.example.com/resource1" then the
following incoming "from" addresses would be '''allowed''':
* "ACS1@tr069.example.com/resource1"
* "ACS1@tr069.example.com/resource2"
* "ACS2@tr069.example.com/resource1" And the following incoming
"from" addresses '''would not be allowed''':
* "ACS2@tr069.example.com/resource2"
* "ACS@tr069.example.com/resource" If this Parameter is {{empty}}
then all Jabber IDs are allowed and an XMPP Connection Request can
not be deemed invalid due to the "from" address.
The value MUST be the value of the
{{param|.XMPP.Connection.{i}.JabberID}} contained in the
{{object|.XMPP.Connection}} instance referenced by the
{{param|ConnReqXMPPConnection}} parameter. If the
{{param|ConnReqXMPPConnection}} parameter is empty or the
{{object|.XMPP.Connection}} instance being reference is disabled,
then this value will be empty. If the {{object|.XMPP.Connection}}
instance being referenced by the {{param|ConnReqXMPPConnection}}
parameter is lost ({{param|.XMPP.Connection.{i}.Status}} parameter
changes from Enabled to some other value), then the value of this
parameter MUST remain unchanged until the connection can be
reestablished and a new {{param|.XMPP.Connection.{i}.JabberID}} can
be established. If the new {{param|.XMPP.Connection.{i}.JabberID}} is
identical to the existing value, then the value of this parameter
MUST NOT be altered and a VALUE CHANGE event MUST NOT be generated.
Indicates the HTTP Compression mechanism(s) supported by this CPE.
Requirements for the use of HTTP Compression for CWMP can be found in
{{bibref|TR-069a5|Section 3.4.7}}. {{enum}} Vendors can extend the
enumerated values with vendor specific extensions, in which case the
rules outlined in {{bibref|TR-106a7|Section 3.3}} MUST be adhered to.
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 communicating with the ACS.
Indicates the Lightweight Notification Protocol(s) supported by this
CPE. {{enum}} Vendors can extend the enumerated values with vendor
specific extensions, in which case the rules outlined in
{{bibref|TR-106a7|Section 3.3}} MUST be adhered to.
As defined in {{bibref|TR-069a5|Annex M}}
The value of this parameter represents the protocol(s) that will be
used by the CPE when sending Lightweight Notifications. {{empty}}
means that Lightweight Notifications are disabled, despite any
SetParameterAttributes that have been configured on various
parameters.
Host name or address to be used when sending the UDP Lightweight
Notifications. {{param}} is only applicable when
{{param|LightweightNotificationProtocolsUsed}} contains the
{{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration. If
{{param}} is not implemented or is {{empty}}, and UDP Lightweight
Notifications are supported, the destination host MUST be the same as
the ACS (as contained in the host portion of the {{param|URL}}).
The port number to be used when sending UDP Lightweight
Notifications. {{param}} is only applicable when
{{param|LightweightNotificationProtocolsUsed}} contains the
{{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration. If
{{param}} is not implemented and UDP Lightweight Notifications are
supported, the destination port MUST be 7547.
{{numentries}}
Each entry in this table corresponds to a distinct LAN Device that
supports Device-Gateway Association according to
{{bibref|TR-069a2|Annex F}} as indicated by the presence of the DHCP
option specified in that Annex.
Organizationally unique identifier of the Device manufacturer as
provided to the Gateway by the Device. Represented as a six
hexadecimal-digit value using all upper-case letters and including
any leading zeros. The value MUST be a valid OUI as defined in
{{bibref|OUI}}.
Serial number of the Device as provided to the Gateway by the Device.
Identifier of the class of product for which the Device's serial
number applies as provided to the Gateway by the Device. If the
Device does not provide a Product Class, then this parameter MUST be
{{empty}}.
{{reference|a ''Host'' table row}} This list MUST include an item for
each ''Host'' table entry, whether active or inactive, that
corresponds to this physical LAN Device. As such entries are added to
or removed from the ''Host'' tables, the value of this parameter MUST
be updated accordingly. For example:
''InternetGatewayDevice.LANDevice.1.Hosts.Host.1,InternetGatewayDevice.LANDevice.1.Hosts.Host.5''
This object allows configuration of CPE policy for notification of
AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069a2}}.
The CPE policy determines the conditions under which the CPE notifies
the ACS of the completion of file transfers that were not specifically
requested by the ACS.
Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE
events to the ACS.
Indicates the transfer types that MUST be included when the CPE
notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer
types not indicated by this filter MUST NOT be included when the CPE
notifies the ACS. {{enum}} Note that this includes any backup or
restore operations that were not specifically requested by the ACS. A
backup is regarded as an Upload and a restore is regarded as a
Download.
Upload and Download
Indicates the transfer results that MUST be included when the CPE
notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer
results omitted from this list MUST NOT be included when the CPE
notifies the ACS. Note that this includes any backup or restore
operations that were not specifically requested by the ACS. A backup
is regarded as an Upload and a restore is regarded as a Download.
The autonomous file transfer completed successfully; i.e., the
FaultCode was zero
The autonomous file transfer did not complete successfully;
i.e., the FaultCode was non-zero
Success and Failure
{{list}} Indicates the file types that MUST be included when the CPE
notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types
omitted from this list MUST NOT be included when the CPE notifies the
ACS. {{pattern}} Additionally, the following format is defined to
allow the unique definition of vendor-specific file types:
* ''"X <OUI> <Vendor-specific identifier>"'' <OUI>
is replaced by a 6 hexadecimal-digit OUI (organizationally unique
identifier) as defined in {{bibref|OUI}}, with all upper-case
letters and any leading zeros included. The OUI used for a given
vendor-specific file type MUST be one that is assigned to the
organization that defined this file type (which is not necessarily
the same as the vendor of the CPE or ACS). Note that {{empty}}
indicates that all file types are excluded from this filter,
effectively disabling CPE notification of AUTONOMOUS TRANSFER
COMPLETE events to the ACS.
Download Only
Download Only
Download or Upload
Upload Only
For Vendor-Specific File Types, could be for either Download or
Upload
This object allows configuration of CPE policy for notification of "12
AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in
{{bibref|TR-069a3}}. The CPE policy determines the conditions under
which the CPE notifies the ACS of the completion of Deployment Unit
state changes that were not specifically requested via CWMP.
Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE
COMPLETE" events to the ACS.
Indicates the Deployment Unit operations that MUST be included when
the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE"
events. Operation types not indicated by this list MUST NOT be
included when the CPE notifies the ACS. {{empty}} is essentially the
same as setting {{param|Enable}} to {{false}}.
Indicates the Deployment Unit state change results that MUST be
included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE
CHANGE COMPLETE" events. State change results omitted from this
filter MUST NOT be included when the CPE notifies the ACS.
The autonomous state change completed successfully; i.e., the
FaultCode was zero
The autonomous state change did not complete successfully;
i.e., the FaultCode was non-zero
All result types independent of Success or Failure
Indicates the Deployment Unit state change fault codes that MUST be
included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE
CHANGE COMPLETE" events. State change fault codes omitted from this
filter MUST NOT be included when the CPE notifies the ACS. This
filter has no effect on the notification of a successful autonomous
state change. This filter only applies when
{{param|ResultTypeFilter}} is set to either
{{enum|Failure|ResultTypeFilter}} or {{enum|Both|ResultTypeFilter}}.
{{empty}} means that failed autonomous state changes will not be sent
to the ACS.
Each entry in this table represents a distinct Proxied Device that
utilizes the Embedded Object Mechanism {{bibref|TR-069a4|Annex J.1.2}}
for proxying devices.
Identifier of the controller that is responsible for a sub-network of
Proxied Devices within the LAN. {{empty}} indicates that this Proxied
Device either:
* Isn't part of a sub-network, within the LAN, with a controller
entity.
* Doesn't need a {{param}} to ensure its {{param|ProxiedDeviceID}} is
unique throughout the LAN.
Idenitfier of the Proxied Device. This is an opaque string that is
unique to the Proxied Device within a specific sub-network within the
LAN (identified by the {{param|ControllerID}}). If the
{{param|ControllerID}} is {{empty}} this {{param}} is unique across
the LAN.
{{noreference}}The value MUST be the path name of a table row. If the
referenced object is deleted, this {{object}} instance MUST also be
removed. Represents the instance of a multi-instanced object that is
directly controlled by, and has come into existence because of, this
Proxied Device that utilizes the Embedded Object Mechanism
{{bibref|TR-069a4|Annex J.1.2}}.
Represents the CWMP-DT schema instance(s) that this Proxied Device is
utilizing. The CWMP-DT schema instance is also the one being utilized
by the object referenced within {{param|Reference}}.
References the {{object|.LANDevice.{i}.Hosts.Host}} table entry(s),
whether active or inactive, that corresponds to this proxied LAN
device.
The protocol being used to communicate between the CPE Proxier and
this Proxied Device. {{enum}} Vendors can extend the enumerated
values with vendor specific extensions, in which case the rules
outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
see {{bibref|ETSIM2MFA}}
{{reference|a protocol object that uses the {{param|ProxyProtocol}}}}
{{list|that represents the discovery protocol(s) for this proxied
device}} {{enum}} Vendors can extend the enumerated values with
vendor specific extensions, in which case the rules outlined in
{{bibref|TR-106a3|Section 3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DAv1}}
see {{bibref|ETSIM2MFA}}
{{list}} {{reference|an object discovered using one or more protocols
listed in {{param|DiscoveryProtocol}}|ignore}} For objects discovered
by the UPnP discovery protocol, the {{param}} would contain items
that are references to instances of the following:
* {{object|.UPnP.Discovery.RootDevice}}
* {{object|.UPnP.Discovery.Device}}
* {{object|.UPnP.Discovery.Service}} For objects discovered by the
ETSI-M2M discovery protocol, the {{param}} would contain items that
are references to instances of
ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.
Whether or not the CPE Proxier has successfully communicated all
pending configuration commands down to the Proxied Device.
Detailed {{param|CommandProcessed}} error description (vendor
specific).
The last time that the CPE Proxier synchronized the state of the
Proxied Device. This parameter MUST be updated when a proxy command
is executed successfully on the Proxied Device. The Unknown Time
value, as defined in {{bibref|TR-106a6}}, indicates that the Proxied
Device's state has not been synchronized since the CPE Proxier was
last rebooted.
Each entry in this table represents a distinct Proxied Device that
utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069a4|Annex
J.1.1}} for proxying devices.
Organizationally unique identifier of the associated Proxied Device.
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}}.
Identifier of the class of product of the associated Proxied Device
for which the serial number applies.
Serial number of the associated Proxied Device.
{{list}} {{reference}} References all the
{{object|.LANDevice.{i}.Hosts.Host}} table entries, whether active or
inactive, that correspond to this proxied LAN device. There can be
multiple such entries if the Proxied Device has more than one network
interface.
The protocol being used to communicate between the CPE Proxier and
this Proxied Device. {{enum}} Vendors can extend the enumerated
values with vendor specific extensions, in which case the rules
outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
see {{bibref|ETSIM2MFA}}
{{reference|a protocol object that uses the {{param|ProxyProtocol}}}}
{{list|that represents the discovery protocol(s) for this proxied
device}} {{enum}} Vendors can extend the enumerated values with
vendor specific extensions, in which case the rules outlined in
{{bibref|TR-106a3|Section 3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DAv1}}
see {{bibref|ETSIM2MFA}}
{{list}} {{reference|an object discovered using one or more protocols
listed in {{param|DiscoveryProtocol}}|ignore}} For objects discovered
by the UPnP discovery protocol, the {{param}} would contain items
that are references to instances of the following:
* {{object|.UPnP.Discovery.RootDevice}}
* {{object|.UPnP.Discovery.Device}}
* {{object|.UPnP.Discovery.Service}} For objects discovered by the
ETSI-M2M discovery protocol, the {{param}} would contain items that
are references to instances of
ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.
Parameters related to CPE behavior when waking up from standby. If this
object is supported then the CPE MUST support the requirements of
{{bibref|TR-069a5|Annex L}}. NOTE: "CR", as used in the names and
descriptions of the parameters defined in this object, refers to the
Connection Request concept defined in TR-069.
When waking up from a non CR-Aware Standby that lasted more than this
parameter's value (in {{units}}), the CPE MUST issue a WAKEUP Event.
If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for
having been non CR-aware.
When waking up from a non fully Timer-Aware Standby that made it miss
more than this parameter's value Periodic Contacts, the CPE MUST
issue a WAKEUP Event. If the value is -1, the CPE MUST NOT ever issue
WAKEUP Events for exceeding that limit.
When waking up from a non fully Timer-Aware Standby that made it miss
at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if
this parameter is {{true}}.
Indicates that the CPE is capable of CR-Aware Standby.
Indicates that the CPE is capable of Timer-Aware Standby.
If {{param|NetworkAwarenessCapable}} and this parameter are both
{{true}}, the CPE MUST NOT go into a non CR-Aware Standby state.
If {{param|SelfTimerCapable}} and this parameter are both {{true}},
the CPE MUST NOT go into a standby state that prevents it from
honoring Periodic Contacts.
If this parameter is true, the CPE MUST NOT go into a standby state
that prevents it from honoring Scheduled Contacts. This means that,
whenever the ACS has requested a Scheduled Contact:
*if {{param|SelfTimerCapable}} is {{true}} and the CPE chooses to go
into Standby before the Scheduled Contact has been honored, it MUST
use a Timer-Aware Standby;
*if {{param|SelfTimerCapable}} is {{false}}, the CPE MUST NOT go into
Standby before the Scheduled Contact has been honored.
This table provides the ACS with the ability to control the Parameters
that are delivered by the Inform RPC. Any Parameter (identified by
{{param|ParameterName}}) contained in this table MUST be included
within the ParameterList argument of the Inform RPC whenever any Event
within the {{param|EventList}} is being delivered. This table does not
include Forced Inform Parameters, and Forced Inform Parameters are not
allowed to be inserted into this table. Any attempt by an ACS to
configure this table to contain a Forced Inform Parameter MUST result
in the failure of the SetParameterValues RPC with error code 9007.
Enables or disables this {{object}}.
{{datatype|expand}}
A pattern that describes the Parameter(s) to be included in the
Inform’s ParameterList argument. Specifically, patterns with
wildcards (an "*" character) in place of Instance Identifiers are
allowed; any attempt to set the value otherwise MUST be rejected by
the CPE. If the pattern does not match any existing Parameters at the
time that the CPE is creating the Inform RPC, then this
{{object|#.InformParameter}} instance is not included in the Inform’s
ParameterList argument.
Each entry in this list represents an Event for which this Parameter
MUST be included within the ParameterList argument of the Inform RPC.
All Inform Events (see {{bibref|TR-069|Section 3.7.1.5}}), except for
"4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE
CHANGE" is not allowed as that would violate requirements contained
in {{bibref|TR-069|Section A.3.3.1}}. {{empty}} means all events
except "4 VALUE CHANGE".
This object contains parameters relating an NTP or SNTP time client in
the CPE.
Enables or disables the NTP or SNTP time client.
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 offset from UTC, ignoring daylight savings time
adjustments, in the form:
: +hh:mm
: -hh:mm For example, this will always be "-08:00" for California,
"+00:00" or "-00:00" for the United Kingdom, and "+01:00" for
France. This parameter is OBSOLETED because the information that it
represents is fully covered by {{param|LocalTimeZoneName}}.
Name of the local time zone (human readable string).
The name SHOULD be encoded according to IEEE 1003.1 (POSIX). The
following is an example value: ''EST+5EDT,M4.1.0/2,M10.5.0/2''
Whether or not daylight savings time is in use in the CPE's local
time zone.
This parameter is OBSOLETED because the information that it
represents is fully covered by {{param|LocalTimeZoneName}}.
Current local date and time at which the switch to daylight savings
time occurs. If daylight savings time is not used, this value is
ignored. This parameter is OBSOLETED because the information that it
represents is fully covered by {{param|LocalTimeZoneName}}.
Current local date and time at which the switch from daylight savings
time will occur. If daylight savings time is not used, this value is
ignored. This parameter is OBSOLETED because the information that it
represents is fully covered by {{param|LocalTimeZoneName}}.
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.
This object contains parameters relating to the user interface of the
CPE.
Present only if the CPE provides a password-protected LAN-side user
interface. Indicates whether or not the CPE supports a user database
that provides per-user passwords that can be used for accessing the
local 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, or MUST be equal to the password
used by the LAN-side Auto-Configuration protocol.
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 URL of the ISP's home page.
The URL 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 URL of the ISP's mail server.
The URL of the ISP's news server.
The color of text on the GUI screens in RGB hexidecimal notation
(e.g., FF0088).
The color of the GUI screen backgrounds in RGB hexidecimal notation
(e.g., FF0088).
The color of buttons on the GUI screens in RGB hexidecimal notation
(e.g., FF0088).
The color of text on buttons on the GUI screens in RGB hexidecimal
notation (e.g., FF0088).
The server the CPE can check to see if an update is available for
direct download to it. This MUST NOT be used by the CPE if the
{{param|InternetGatewayDevice.ManagementServer.UpgradesManaged}}
parameter is {{true}}.
The server where a user can check via a web browser if an update is
available for download to a PC. This MUST NOT be used by the CPE if
the {{param|InternetGatewayDevice.ManagementServer.UpgradesManaged}}
parameter is {{true}}.
An example of a correct login, according to ISP-specific rules.
An example of a correct password, according to ISP-specific rules.
Available user-interface languages, where each language is specified
according to RFC 3066 {{bibref|RFC3066}}.
Present only if the CPE provides a password-protected LAN-side user
interface. Indicates whether or not a single shared password MUST
protect the local user interface, or whether per-user passwords can
be used. If either UserDatabaseSupported or PasswordUserSelectable is
{{false}}, the CPE MUST ignore the value of this parameter.
Current user-interface language, specified according to RFC 3066
{{bibref|RFC3066}}.
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}}.
This object allows the handling of the routing and forwarding
configuration of the device.
Specifies the default WAN interface. The content is the full
hierarchical parameter name of the default layer 3 connection object.
Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
Number of forwarding instances.
Layer 3 forwarding table. In addition to statically configured routes,
this table MUST include dynamic routes learned through layer 3 routing
protocols, including RIP, OSPF, DHCP, 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 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.
* For the remaining table entries, those for which the source
address/mask matches are sorted by longest prefix, i.e. with the most
specific networks first (an unspecified source address is a wild-card
and always matches, with a prefix length of zero).
* For the remaining table entries, those for which the destination
address/mask matches are sorted by longest prefix, i.e. with the most
specific networks first (an unspecified destination address is a
wild-card and always matches, with a prefix length of zero).
* The first of the remaining table entries is applied to the packet.
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.
{{datatype|expand}} This parameter can only be modified if
{{param|StaticRoute}} is {{true}}
If {{true}}, this route is a Static route.
Indicates the type of route.
{{enum}} This parameter is DEPRECATED because its value could
conflict with {{param|DestIPAddress}} and/or
{{param|DestSubnetMask}}.
Destination address. {{empty}} or a value of "0.0.0.0" indicates no
destination address is specified.
A Forwarding table entry for which {{param}} and
{{param|DestSubnetMask}} are both {{empty}} or "0.0.0.0" is a default
route.
Destination subnet mask. {{empty}} or a value of "0.0.0.0" 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}} or "0.0.0.0"
is a default route.
Source address. {{empty}} or a value of "0.0.0.0" indicates no source
address is specified.
Source subnet mask. {{empty}} or a value of "0.0.0.0" indicates no
source subnet mask is specified.
If a source subnet mask is specified, the {{param}} is ANDed with the
source address before comparing with the {{param|SourceIPAddress}}.
Otherwise, the full source address is used as is.
IP address of the gateway. Only one of GatewayIPAddress and Interface
SHOULD be configured for a route. If both are configured, {{param}}
and {{param|Interface}} MUST be consistent with each other.
Specifies the egress interface associated with this entry.
{{reference|the layer 3 connection object}} Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.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
route's egress interface.
Forwarding metric. A value of -1 indicates this metric is not used.
The maximum allowed size of an Ethernet frame for this route.
Identifier of a set of classes or flows that have the corresponding
{{param}} value as defined in the ''QueueManagement'' 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.
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|InternetGatewayDevice.UserInterface.PasswordUserSelectable}}
is {{true}}.
This object provides access to an IP-layer ping test.
Indicates availability of diagnostic data. {{enum}} If the ACS sets
the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the
communication session with the ACS before starting the diagnostic.
When the test is completed, the value of this parameter MUST be
either {{enum|Complete}} (if the test completed successfully), or one
of the ''Error'' values listed above. If the value of this parameter
is anything other than {{enum|Complete}}, the values of the results
parameters for this test are indeterminate. When the diagnostic
initiated by the ACS is completed (successfully or not), the CPE MUST
establish a new connection to the ACS to allow the ACS to view the
results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the
Inform message. After the diagnostic is complete, the value of all
result parameters (all read-only parameters in this object) MUST be
retained by the CPE until either this diagnostic is run again, or the
CPE reboots. After a reboot, if the CPE has not retained the result
parameters from the most recent test, it MUST set the value of this
parameter to {{enum|None}}. Modifying any of the writable parameters
in this object except for this one MUST result in the value of this
parameter being set to {{enum|None}}. While the test is in progress,
modifying any of the writable parameters in this object except for
this one MUST result in the test being terminated and the value of
this parameter being set to {{enum|None}}. While the test is in
progress, setting this parameter to {{enum|Requested}} (and possibly
modifying other writable parameters in this object) MUST result in
the test being terminated and then restarted using the current values
of the test parameters.
{{reference|the WAN or LAN IP-layer interface over which the test is
to be performed}} This identifies the source IP address to use when
performing the test. The following is a WAN interface example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
The following is a LAN interface example:
''InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1''
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 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 ping.
Number of repetitions of the ping test to perform before reporting
the results.
Timeout in milliseconds 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.
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 milliseconds
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 milliseconds
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 milliseconds
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 milliseconds
over all repetitions with successful responses of the most recent
ping test. If there were no successful responses, this value MUST be
zero.
Each instance models a LAN side layer 3 IP interface. Each instance has
children that correspond to the layer 2 interfaces that are connected
to the Gateway's IP router via the modeled IP interface. If a LANDevice
instance is deleted, the objects modeling those layer 2 interfaces that
are as a result no longer connected to the Gateway's IP router will
move to the InternetGatewayDevice.LANInterfaces object. If the
''Layer2Bridging'' object is implemented, the view that it provides of
the CPE's underlying bridging configuration MUST be consistent with the
view provided by any ''LANDevice'' and ''WAN**Connection'' objects. The
implications of this are explained in {{bibref|TR-098a2|Annex A.6}}.
{{datatype|expand}}
Number of instances of {{object|LANEthernetInterfaceConfig}} in this
''LANDevice''.
Number of instances of {{object|LANUSBInterfaceConfig}} in this
''LANDevice''.
Number of instances of {{object|WLANConfiguration}} in this
''LANDevice''.
This object enables reporting of LAN-related device information and
setting and configuring LAN IP addressing.
The DHCP parameters in this object define the behavior of the default
DHCP server, i.e. the behavior for DHCP requests that do not match any
of the DHCP conditional serving pool entries.
The MAC address associated with the IP interface modeled by this
LANDevice instance. This is the MAC address that is returned in
response to an ARP request for any of the IP interface's IP
addresses. It is also the source MAC address in all IP traffic sent
over the IP interface. If no single MAC address meets the above
criteria, the value of this parameter MUST be the all-zero MAC
address ''00:00:00:00:00:00''.
Enables the configuration of the DHCP server on the LAN interface. If
this variable is set to {{false}}, the CPE SHOULD restore its default
DHCP server settings.
Enables or disables the DHCP server on the LAN interface.
Indicates if the DHCP server performs the role of a server
({{false}}) or a relay ({{true}}) on the LAN interface. This
parameter is DEPRECATED because the functionality that it describes
is not well-defined. The CPE MAY set it to the value that it thinks
most appropriate, based on its configuration.
Specifies first address in the pool to be assigned by the DHCP server
on the LAN interface.
This parameter MUST have a valid value before the DHCP server can be
enabled.
Specifies last address in the pool to be assigned by the DHCP server
on the LAN interface.
This parameter MUST have a valid value before the DHCP server can be
enabled.
Addresses marked reserved from the address allocation pool.
Specifies the client's network subnet mask.
This parameter MUST have a valid value before the DHCP server can be
enabled.
DNS servers offered to DHCP clients. Support for more than three DNS
Servers is OPTIONAL.
Sets the domain name to provide to clients on the LAN interface.
IP addresses of routers on this subnet. Also known as default
gateway. Support for more than one Router address is OPTIONAL.
Specifies the lease time in seconds of client assigned addresses. A
value of -1 indicates an infinite lease.
Controls use of addresses from the associated WAN connection.
{{enum}} If {{enum|Normal}}, the address pool is directly configured
by the ACS. If {{enum|UseAllocatedSubnet}}, behavior is the same as
for {{enum|Passthrough}} with an empty
{{param|PassthroughMACAddress}}. For this reason,
{{enum|UseAllocatedSubnet}} is DEPRECATED. If {{enum|Passthrough}},
and {{param|PassthroughMACAddress}} is {{empty}}, the configured
values of the {{param|MinAddress}}, {{param|MaxAddress}},
{{param|SubnetMask}} and {{param|DNSServers}} parameters are ignored.
The corresponding address pool values are instead taken from the WAN
connection specified by {{param|AssociatedConnection}}. If
{{enum|Passthrough}}, and {{param|PassthroughMACAddress}} is not
{{empty}}, the LAN Host identified by {{param|PassthroughMACAddress}}
is given a WAN IP address from the WAN connection specified by
{{param|AssociatedConnection}}. Other LAN Hosts are treated as for
{{enum|Normal}}. Use of {{param|PassthroughMACAddress}} does not
cover the case where more than one LAN Host is to be given a WAN IP
address. This can be achieved by using a DHCP conditional serving
pool.
{{reference|the connection instance to be used for address allocation
if {{param|UseAllocatedWAN}} is set to
{{enum|UseAllocatedSubnet|UseAllocatedWAN}} or
{{enum|Passthrough|UseAllocatedWAN}}}} The content is the full
hierarchical parameter name of a WAN-side layer 3 connection object.
Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
If {{param|UseAllocatedWAN}} is
{{enum|UseAllocatedSubnet|UseAllocatedWAN}} or
{{enum|Passthrough|UseAllocatedWAN}}, this parameter MUST have a
valid value before the DHCP server can be enabled.
DHCP lease time in seconds given to the LAN Host that is used to
passthrough a WAN IP address if {{param|UseAllocatedWAN}} is
{{enum|Passthrough|UseAllocatedWAN}}. Note: A temporary private IP
address with short lease (for example, 1 min) might be given to the
passthrough LAN Host before the WAN IP address is acquired.
Hardware address of the LAN Host that is used to passthrough a WAN IP
address if {{param|UseAllocatedWAN}} is
{{enum|Passthrough|UseAllocatedWAN}}. Note: {{empty}} indicates that
no specific LAN Host is designated, and results in the same behavior
as the (DEPRECATED) {{enum|UseAllocatedSubnet|UseAllocatedWAN}}.
Hardware addresses that are allowed to connect to this connection if
''MACAddressControlEnabled'' is 1 for a given interface.
The number of entries in the {{object|IPInterface}} table.
The number of entries in the {{object|DHCPStaticAddress}} table.
The number of entries in the {{object|DHCPOption}} table.
The number of entries in the {{object|DHCPConditionalServingPool}}
table.
IP address table with each object representing an IP address on the
LANDevice IP interface. Support for more than one interface instance is
OPTIONAL.
Enables or disables this entry. On creation, an entry is disabled by
default.
{{datatype|expand}}
IP address of the LAN-side interface of the CPE.
Subnet mask of the LAN-side interface of the IGD.
Represents the addressing method used to assign the LAN-side IP
address of the CPE on this interface.
DHCP static address table. Entries in this table correspond to what RFC
2131 {{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 conditional serving pools, in which case it is possible that such
an address will be assigned to a different client.
Enables or disables the DHCPStaticAddress 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. This parameter MUST have a valid value before the table entry
can be enabled.
IP address to be assigned by the DHCP server to the DHCP client with
the specified hardware address (MAC address). This parameter MUST
have a valid value before the table entry can be enabled.
This object specifies the DHCP options that MUST, if enabled, be
returned to clients whose DHCP requests do not match any of the DHCP
conditional serving pool entries.
Enables or disables this DHCPOption table entry.
{{datatype|expand}}
Option tag as defined in RFC 2132 {{bibref|RFC2132}}.
Base64 encoded option value.
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. If a DHCP request does not match any of the
DHCP conditional serving pool entries, the handling of the request is
determined by the default DHCP server behavior that is defined by the
LANHostConfigManagement object. Overlapping pool ranges MUST be
supported.
Enables or disables the DHCPConditionalServingPool entry.
{{datatype|expand}}
Position of the pool entry in the order of precedence. A value of 1
indicates the first entry considered. For each DHCP request, the
highest ordered entry that matches the association criteria is
applied. All lower order entries are ignored. When this value is
modified, if the value matches that of an existing entry, the Order
value for the existing entry and all lower Order entries is
incremented (lowered in precedence) to ensure uniqueness of this
value. A deletion causes Order values to be compacted. When a value
is changed, incrementing occurs before compaction. The value on
creation of a DHCPConditionalServingPool table entry MUST be one
greater than the largest current value.
Pool association criterion. {{list}} {{reference|the layer 2 ingress
interfaces associated with this entry, i.e. the corresponding
''LAN**InterfaceConfig'' or ''WLANConfiguration'' objects}} For
example:
''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2,InternetGatewayDevice.LANDevice.1.WLANConfiguration.3''
{{empty}} indicates this entry is to apply to all layer 2 interface
objects under this ''LANDevice'' instance.
Pool association criterion. Used to identify one or more LAN devices,
value of the DHCP Vendor Class Identifier (Option 60) as defined in
RFC 2132 {{bibref|RFC2132}}, matched according to the criterion in
{{param|VendorClassIDMode}}. Case sensitive. {{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. Used to identify one or more LAN devices,
value of the DHCP Client Identifier (Option 61) as defined in RFC
2132 {{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. Used to identify one or more LAN devices,
value of the DHCP User Class Identifier (Option 77) as defined in RFC
3004 {{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.
If {{true}}, then the local DHCP server will assign an IP address
from the specific address pool specified in this object. If
{{false}}, the DHCP server will send the request to the
{{param|DHCPServerIPAddress}} configured for this pool.
Specifies first address in the pool to be assigned by the DHCP server
on the LAN interface. This parameter is configurable only if
{{param|UseAllocatedWAN}} is {{enum|Normal|UseAllocatedWAN}}. This
parameter MUST have a valid value before this pool can be enabled.
Specifies last address in the pool to be assigned by the DHCP server
on the LAN interface. This parameter is configurable only if
{{param|UseAllocatedWAN}} is {{enum|Normal|UseAllocatedWAN}}. This
parameter MUST have a valid value before this pool can be enabled.
IP addresses marked reserved from the address allocation pool.
Specifies the client's network subnet mask. This parameter is
configurable only if {{param|UseAllocatedWAN}} is
{{enum|Normal|UseAllocatedWAN}}. This parameter MUST have a valid
value before this pool can be enabled.
DNS servers offered to DHCP clients. Support for more than three DNS
Servers is OPTIONAL. This parameter is configurable only if
{{param|UseAllocatedWAN}} is {{enum|Normal|UseAllocatedWAN}}.
Sets the domain name to provide to clients on the LAN interface.
IP addresses of routers on this subnet. Also known as default
gateway. Support for more than one Router address is OPTIONAL.
Specifies the lease time in seconds of client assigned addresses. A
value of -1 indicates an infinite lease.
Controls whether the {{param|MinAddress}}, {{param|MaxAddress}},
{{param|SubnetMask}} and {{param|DNSServers}} parameters are
configurable or are taken from the associated WAN connection.
{{enum}} If {{enum|Normal}}, the above-mentioned pool parameters are
directly configured by the ACS. If {{enum|Passthrough}}, the
above-mentioned pool parameters cannot be configured by the ACS.
Their values are instead taken from the WAN connection specified by
{{param|AssociatedConnection}}.
{{reference|the connection instance to be used for address allocation
if {{param|UseAllocatedWAN}} is set to
{{enum|Passthrough|UseAllocatedWAN}}}} The content is the full
hierarchical parameter name of a WAN-side layer 3 connection object.
Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
If {{param|UseAllocatedWAN}} is {{enum|Passthrough|UseAllocatedWAN}},
this parameter MUST have a valid value before this pool can be
enabled.
IP address of the DHCP server, where the request has to be sent to
when there is a conditional match with this pool and
{{param|LocallyServed}} is {{false}}. If this parameter is not
configured, then the DHCP request is dropped.
The number of entries in the {{object|DHCPStaticAddress}} table.
The number of entries in the {{object|DHCPOption}} table.
DHCP static address table. Entries in this table correspond to what RFC
2131 {{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 the main pool
and/or 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 DHCPStaticAddress 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. This parameter MUST have a valid value before the table entry
can be enabled.
IP address to be assigned by the DHCP server to the DHCP client with
the specified hardware address (MAC address). This parameter MUST
have a valid value before the table entry can be enabled.
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 DHCPOption table entry.
{{datatype|expand}}
Option tag as defined in RFC 2132 {{bibref|RFC2132}}.
Base64 encoded option value.
This object models an Ethernet LAN connection on a CPE device. This
object MUST be implemented for CPE that contain an Ethernet interface
on the LAN side.
Enables or disables this interface.
Indicates the status of this interface.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
The name of this layer 2 interface, chosen by the vendor, e.g. "eth0"
or "eth0:1".
The physical address of the interface.
Indicates whether MAC Address Control is enabled or not on this
interface. MAC Address Control limits the clients that connect to
those that match a list of allowed MAC addresses specified in
{{param|InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses}}.
The maximum upstream and downstream bit rate available to this
connection.
The duplex mode available to this connection.
This object contains statistics for an Ethernet LAN interface on a CPE
device.
Note that these statistics refer to the link layer, not to the physical
layer.
The total number of bytes transmitted out of the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of bytes received on the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets transmitted out of the interface. The
value of this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets which were received on this interface.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The total number of outbound packets that could not be transmitted
because of errors. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of inbound packets that contained errors preventing
them from being deliverable. The value of this counter MAY be reset
to zero when the CPE is rebooted.
The total number of packets requested for transmission which were not
addressed to a multicast or broadcast address, including those that
were discarded or not sent. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of received packets which were not addressed to a
multicast or broadcast address. The value of this counter MAY be
reset to zero when the CPE is rebooted.
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 value of this counter MAY be
reset to zero when the CPE is rebooted.
The total number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable. One possible reason for discarding such a packet could
be to free up buffer space. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a multicast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
multicast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a broadcast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
broadcast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol. The value of
this counter MAY be reset to zero when the CPE is rebooted.
This object models a USB LAN connection on a CPE device. This object
MUST be implemented for CPE that contain a USB interface on the LAN
side.
Enables or disables this interface.
Indicates the status of this interface.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
The name of this layer 2 interface, chosen by the vendor, e.g.
"usb0".
The physical address of the interface.
Indicates whether MAC Address Control is enabled or not on this
interface. MAC Address Control limits the clients that connect to
those that match a list of allowed MAC addresses specified in
{{param|InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses}}.
USB version supported by the device.
Type of the USB interface.
Speed of the USB interface.
USB 2.0
Power configuration of the USB interface.
This object contains statistics for a USB LAN interface on a CPE
device.
Note that these statistics refer to the link layer, not to the physical
layer.
The total number of bytes transmitted out of the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of bytes received on the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets (cells) transmitted out of the interface.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The total number of packets (cells) which were received on this
interface. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of outbound packets that could not be transmitted
because of errors. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of inbound packets that contained errors preventing
them from being deliverable. The value of this counter MAY be reset
to zero when the CPE is rebooted.
The total number of packets requested for transmission which were not
addressed to a multicast or broadcast address, including those that
were discarded or not sent. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of received packets which were not addressed to a
multicast or broadcast address. The value of this counter MAY be
reset to zero when the CPE is rebooted.
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 value of this counter MAY be
reset to zero when the CPE is rebooted.
The total number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable. One possible reason for discarding such a packet could
be to free up buffer space. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a multicast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
multicast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a broadcast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
broadcast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol. The value of
this counter MAY be reset to zero when the CPE is rebooted.
This object models an 802.11 LAN connection on a CPE device. This
object MUST be implemented for CPE that contain an 802.11 interface on
the LAN side.
Enables or disables this interface.
When there are multiple ''WLANConfiguration'' instances, e.g. each
instance supports a different 802.11 standard or has a different
security configuration, this parameter can be used to control which
of the instances are currently enabled.
Indicates the status of this interface.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
The name of this layer 2 interface, chosen by the vendor, e.g.
"wlan0".
The MAC address of the interface.
The maximum upstream and downstream bit rate available to this
connection in Mbps. Either ''Auto'', or the largest of the
{{param|OperationalDataTransmitRates}} values.
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.
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 a "password" for joining a particular radio
network (BSS). Note: If an access point wishes to be known by more
than one SSID, it MUST provide a ''WLANConfiguration'' instance for
each SSID.
The capabilities that are currently enabled on the access point (and
that are announced via beacons if
{{param|BeaconAdvertisementEnabled}} is {{true}}). Write access to
this parameter enables and disables such capabilities. An attempt to
set this parameter to one of the REQUIRED (mandatory) values MAY be
rejected if (and only if) the requested capability is not available
on this WLANConfiguration instance but is available on another
WLANConfiguration instance within this Internet Gateway Device. For
example, only basic 802.11 might be supported by one virtual AP, and
only WPA might be supported by another virtual AP. A value of
{{enum|None}} means that no capabilities are currently enabled on the
access point and that no stations will be able to associate with it.
{{enum}} {{enum|11i}} SHOULD be taken to refer to both the 802.11i
specification and to the WPA2 specification (any WPA2-certified
device will implement all mandatory parts of the 802.11i standard).
The OBSOLETED values are those for Basic + WPA/WPA2 mixed modes,
which are not permitted by the WPA specifications.
Indicates whether MAC Address Control is enabled or not on this
interface. MAC Address Control limits the clients that connect to
those that match a list of allowed MAC addresses specified in
{{param|InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses}}.
Indicates which IEEE 802.11 standard this ''WLANConfiguration''
instance is configured for. {{enum}} Where each value indicates
support for only the indicated standard. If the device is configured
simultaneously for more than one standard, a separate
''WLANConfiguration'' instance MUST be used for each supported
standard.
b and g clients supported
only g clients supported
The index of the default WEP key.
A passphrase from which the WEP keys are to be generated. This
parameter is the same as the parameter
''InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.KeyPassphrase''
for the same instance of ''WLANConfiguration''. When either parameter
is changed, the value of the other is changed as well. If {{param}}
is written, all four WEP keys are immediately generated. The ACS
SHOULD NOT set the passphrase and also set the WEP keys directly (the
result of doing this is undefined). This MUST either be a valid key
length divided by 8, in which case each byte contributes 8 bits to
the key, or else MUST consist of Hex digits and be a valid key length
divided by 4, in which case each byte contributes 4 bits to the key.
Note: If a passphrase is used, all four WEP keys will be the same.
Supported key lengths. {{enum}} Any additional vendor-specific values
MUST start with the key length in bits. This parameter does not
enforce a given encryption level but only indicates capabilities. The
WEP encryption level for a given key is inferred from the key length.
Encryption modes that are available when basic 802.11 is enabled.
{{enum|WEPEncryption}} implies that all wireless clients can use WEP
for data encryption.
{{enum}} If this ''WLANConfiguration'' instance does not support
basic 802.11 then this parameter MUST NOT be present in this instance
of the ''WLANConfiguration'' object.
Authentication modes that are available when basic 802.11 is enabled.
{{enum}} If this ''WLANConfiguration'' instance does not support
basic 802.11 then this parameter MUST NOT be present in this instance
of the ''WLANConfiguration'' object.
Open authentication
Encryption modes that are available when WPA is enabled.
{{enum}} If this ''WLANConfiguration'' instance does not support WPA
then this parameter MUST NOT be present in this instance of the
''WLANConfiguration'' object. The DEPRECATED values are those that
combine WEP with TKIP and/or AES, which is not permitted by the WPA
specifications.
Authentication modes that are available when WPA is enabled.
{{enum}} If this ''WLANConfiguration'' instance does not support WPA
then this parameter MUST NOT be present in this instance of the
''WLANConfiguration'' object.
Encryption modes that are available when 802.11i is enabled.
{{enum}} If this ''WLANConfiguration'' instance does not support
802.11i then this parameter MUST NOT be present in this instance of
the ''WLANConfiguration'' object. ''IEEE11i'' SHOULD be taken to
refer to both the 802.11i specification and to the WPA2 specification
(any WPA2-certified device will implement all mandatory parts of the
802.11i standard). The DEPRECATED values are those that combine WEP
with TKIP and/or AES, which is not permitted by the WPA2
specifications.
Authentication modes that are available when 802.11i is enabled.
{{enum}} If this ''WLANConfiguration'' instance does not support
802.11i then this parameter MUST NOT be present in this instance of
the ''WLANConfiguration'' object. ''IEEE11i'' SHOULD be taken to
refer to both the 802.11i specification and to the WPA2 specification
(any WPA2-certified device will implement all mandatory parts of the
802.11i standard).
Possible radio channels for the wireless standard (a, b or g) and the
regulatory domain. Ranges in the form "n-m" are permitted. For
example, for 802.11b and North America, would be "1-11".
Maximum access point data transmit rates in Mbps for unicast,
multicast and broadcast frames. For example, a value of "1,2",
indicates that unicast, multicast and broadcast frames can be
transmitted at 1 Mbps and 2 Mbps.
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.
Data transmit rates 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.
Indicates whether insecure write access via mechanisms other than the
CPE WAN Management Protocol is permitted to the parameters in this
object.
Indicates whether or not the access point is sending out beacons.
Indicates whether or not beacons include the SSID name. This
parameter has an effect only if {{param|BeaconAdvertisementEnabled}}
is {{true}}.
Indicates whether or not the access point radio is enabled.
Supported transmit power levels as percentages of full power. For
example, "0,25,50,75,100".
Indicates whether the access point can automatically reduce the data
rate in the event of undue noise or contention.
An XML description of information used to identify the access point
by name and physical location. The CPE is not expected to parse this
string, but simply to treat it as an opaque string. {{empty}}
indicates no location has been set.
802.11d Regulatory Domain String. First two octets are ISO/IEC 3166-1
two-character country code. The third octet is either " " (all
environments), "O" (outside) or "I" (inside).
The number of times pre-shared key (PSK) authentication has failed
(relevant only to WPA and 802.11i).
The number of times the MICHAEL integrity check has failed (relevant
only to WPA and 802.11i)
Channels that the access point determines to be currently in use
(including any that it is using itself). Ranges in the form "n-m" are
permitted.
The current access-point operating mode. The OPTIONAL modes permit
the AP to be configured as a wireless bridge (to bridge two wired
networks), repeater (a bridge that also serves wireless clients), or
wireless station. Ad hoc stations are not supported.
The number of hops from the root access point to the wireless
repeater or bridge.
The MAC address of the peer in wireless repeater or bridge mode.
Indicates whether another service is involved in client
authentication ({{enum|LinkAuthentication}} for a co-located
authentication server; {{enum|RadiusClient}} for an external RADIUS
server).
Indicates whether this interface supports WiFi Multimedia (WMM)
Access Categories (AC).
The total number of bytes transmitted out of the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of bytes received on the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets transmitted out of the interface. The
value of this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets which were received on this interface.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The number of devices currently associated with the access point.
This corresponds to the number of entries in the AssociatedDevice
table.
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.
Indicates the current transmit power level as a percentage of full
power. The value MUST be one of the values reported by the
{{param|TransmitPowerSupported}} parameter.
Indicates whether this interface 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.
A table of the devices currently associated with the access point. The
size of this table is given by
{{param|InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.TotalAssociations}}.
This object MUST be implemented for CPE that contain an 802.11
interface on the LAN side.
The MAC address of an associated device.
The IP address or DNS name of an associated device.
Whether an associated device has authenticated ({{true}}) or not
({{false}}).
The unicast cipher that was most recently used for a station with a
specified MAC address (802.11i only).
The multicast cipher that was most recently used for a station with a
specified MAC address (802.11i only).
The pairwise master key (PMK) that was most recently used for a
station with a specified MAC address (802.11i only).
The data transmit rate that was most recently used for a station with
a specified MAC address.
This is a table of WEP keys. The size of this table is fixed with
exactly 4 entries (with instance numbers 1 through 4). This object MUST
be implemented for CPE that contain an 802.11 interface on the LAN
side.
{{datatype|expand}}
A WEP key expressed as a hexadecimal string. The WEP encryption level
for a given key is inferred from the key length, e.g. 10 characters
for 40-bit encryption, or 26 characters for 104-bit encryption (keys
do not all have to be of the same length, although they will be if
the CPE uses
{{param|InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.KeyPassphrase}}
to generate them). If
{{param|InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.KeyPassphrase}}
is written, all four WEP keys are immediately generated. The ACS
SHOULD NOT set the passphrase and also set the WEP keys directly (the
result of doing this is undefined).
This is a table of preshared keys. The size of this table is fixed with
exactly 10 entries (with instance numbers 1 through 10). This object
MUST be implemented for CPE that contain an 802.11 interface on the LAN
side.
{{datatype|expand}}
A literal WPA PSK expressed as a hexadecimal string. The first table
entry contains the default {{param}}
(''InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.PreSharedKey'').
If {{param|KeyPassphrase}} is written, the PSK is immediately
generated. The ACS SHOULD NOT set the passphrase and also set the PSK
directly (the result of doing this is undefined).
A passphrase from which the PSK is to be generated. The first table
entry is the same as the parameter
{{param|InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.KeyPassphrase}}
for the same instance of WLANConfiguration. When either parameter is
changed, the value of the other is changed as well. If {{param}} is
written, the PSK is immediately generated. The ACS SHOULD NOT set the
passphrase and also set the PSK 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 (RFC 2898 {{bibref|RFC2898}}).
The MAC address associated with a preshared key, or {{empty}} if no
MAC address is associated with the key.
This object contains statistics for an 802.11 LAN interface on a CPE
device. Note that these statistics refer to the link layer, not to the
physical layer. Note that this object does not include the total byte
and packet statistics, which are, for historical reasons, in the parent
object.
The total number of outbound packets that could not be transmitted
because of errors. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of inbound packets that contained errors preventing
them from being deliverable. The value of this counter MAY be reset
to zero when the CPE is rebooted.
The total number of packets requested for transmission which were not
addressed to a multicast or broadcast address, including those that
were discarded or not sent. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of received packets which were not addressed to a
multicast or broadcast address. The value of this counter MAY be
reset to zero when the CPE is rebooted.
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 value of this counter MAY be
reset to zero when the CPE is rebooted.
The total number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable. One possible reason for discarding such a packet could
be to free up buffer space. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a multicast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
multicast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a broadcast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
broadcast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol. The value of
this counter MAY be reset to zero when the CPE is rebooted.
This object contains parameters related to WPS (Wi-Fi Protected Setup)
{{bibref|WPSv1.0}} that apply to a CPE acting as an Access Point.
Enables or disables WPS functionality for this interface.
User-friendly description of the device. This parameter corresponds
directly to the "Device Name" attribute of the WPS specification
{{bibref|WPSv1.0}}.
Represents the DevicePassword used (commonly known as PIN). This
parameter corresponds directly to the "Device Password" attribute of
the WPS specification {{bibref|WPSv1.0}}.
UUID of the device. This is represented as specified in RFC 4122
{{bibref|RFC4122}} but omitting the leading "urn:uuid:", e.g.
"f81d4fae-7dec-11d0-a765-00a0c91e6bf6". This parameter corresponds
directly to the "UUID-E" (enrollee) and "UUID-R" (registrar)
attributes of the WPS specification {{bibref|WPSv1.0}}. Note that if
the Access Point can act both as an enrollee and as a registrar then
UUID-E and UUID-R will be the same as each other.
The Wi-Fi Protected Setup version supported by the device. This
parameter corresponds directly to the "Version" attribute of the WPS
specification {{bibref|WPSv1.0}}.
WPS configuration methods supported by the device. {{enum}} This
parameter corresponds directly to the "Config Methods" attribute of
the WPS specification {{bibref|WPSv1.0}}.
WPS configuration methods enabled on the device. This parameter
corresponds directly to the "Permitted Config Methods" attribute of
the WPS specification {{bibref|WPSv1.0}}.
Indicates if the AP Setup mode is enabled for configuration of the AP
through an external registrar. The AP Setup mode can be disabled by
the user, by the remote management or in case of a brute force attack
against the AP's PIN (Wrong PIN provided to AP multiple times).
{{enum}} This parameter corresponds directly to the "AP Setup Locked"
attribute of the WPS specification {{bibref|WPSv1.0}}. The factory
default setting is {{enum|Unlocked}}.
When set to {{true}}, the Access Point will refuse to accept new
external registrars; already established registrars will continue to
be able to add new enrollees (the {{param|SetupLockedState}} becomes
{{enum|LockedByRemoteManagement|SetupLockedState}}). When set to
{{false}}, the Access Point is enabled for configuration through an
external registrar (the {{param|SetupLockedState}} becomes
{{enum|Unlocked|SetupLockedState}}). The factory default setting is
{{false}}.
Description of the WPS status on the Wireless Access Point side.
{{enum}} This parameter corresponds directly to the "Wi-Fi Protected
Setup State" attribute of the WPS specification {{bibref|WPSv1.0}}.
WLAN interface is unconfigured: out-of-the box configuration
WLAN interface is configured
Shows the result of the last external registrar attempt to configure
the Access Point. {{enum}} If no external registrar has yet attempted
to configure the Access Point, this parameter MUST have the value
{{enum|NoError}}. The value of this parameter MUST persist across CPE
reboots. This parameter corresponds directly to the "Configuration
Error" attribute of the WPS specification {{bibref|WPSv1.0}}.
Number of entries in the Registrar table: number of Registrars that
currently have an association with the Access Point. This parameter
corresponds directly to the "Registrar Current" attribute of the WPS
specification {{bibref|WPSv1.0}}.
{{true}} if the Access Point has ever previously created an
association with a Registrar. This parameter corresponds directly to
the "Registrar Established" attribute of the WPS specification
{{bibref|WPSv1.0}}. The factory default setting is {{false}}.
This table lists the Registrars associated with the Access Point. This
table MUST persist across CPE reboots. The registrar UUID is the unique
key. This object corresponds directly to the "Registrar List" attribute
of the WPS specification {{bibref|WPSv1.0}}.
If {{true}}, the registrar can be used by the Access Point for WPS
procedures.
{{datatype|expand}}
UUID of the registrar. This is represented as specified in RFC 4122
{{bibref|RFC4122}} but omitting the leading "urn:uuid:", e.g.
''f81d4fae-7dec-11d0-a765-00a0c91e6bf6''. This parameter corresponds
directly to the "UUID-R" attribute of the WPS specification
{{bibref|WPSv1.0}}.
Device Name of the registrar. This parameter corresponds directly to
the "Device Name" attribute of the WPS specification
{{bibref|WPSv1.0}}.
This is a table of WMM parameters for traffic that originates at the
wireless access point, i.e. for outgoing traffic. The size of this
table is fixed, with 4 entries (with instance numbers 1 through 4).
Instance numbers MUST be assigned as follows:
# BE AC (Best Effort)
# BK AC (Background)
# VI AC (Video)
# VO AC (Voice)
{{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,
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,
Transmit Opportunity, in multiples of 32 microseconds.
Ack Policy, where {{false}}=''Do Not Acknowledge'' and
{{true}}=''Acknowledge''.
This is a table of WMM parameters for traffic that originates at the
wireless station, i.e. for incoming traffic. The size of this table is
fixed, with 4 entries (with instance numbers 1 through 4). Instance
numbers MUST be assigned as follows:
# BE AC (Best Effort)
# BK AC (Background)
# VI AC (Video)
# VO AC (Voice)
{{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,
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,
Transmit Opportunity, in multiples of 32 microseconds.
Ack Policy, where {{false}}=''Do Not Acknowledge'' and
{{true}}=''Acknowledge''.
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.
Number of entries in the {{object|Host}} table.
Host table.
Current IP Address of the host.
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.
DHCP lease time remaining in seconds. A value of -1 indicates an
infinite lease. The value MUST be 0 (zero) if the
{{param|AddressSource}} is not {{enum|DHCP|AddressSource}}.
MAC address of the host.
This parameter is the full hierarchical parameter name of a
particular ''LAN**InterfaceConfig'' object or a ''WLANConfiguration''
object. For example:
''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2''.
In the case of an embedded Ethernet switch, the {{param}} parameter
references the ''LANEthernetInterfaceConfig'' object that corresponds
to the switch port the device is connected to (a
''LANEthernetInterfaceConfig'' instance for each switch port). In the
case of an embedded WLAN access point, the {{param}} parameter
references the ''WLANConfiguration'' object that corresponds to the
SSID the device is connected to (if the access point supports
multiple SSIDs, then each SSID is a separate instance).
The device's host name or {{empty}} if unknown.
Type of physical interface through which this host is connected to
the CPE.
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, this variable 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.
Vendor Class Identifier DHCP option (Option 60) of the host. It MAY
be defined when ''AddressSource'' is ''DHCP''. {{empty}} indicates
this option is not used.
Client Identifier DHCP option (Option 61) for the specific IP
connection of the client. The option value is binary, so an exact
match is REQUIRED. It MAY be defined when ''AddressSource'' is
''DHCP''. {{empty}} indicates this option is not used.
User Class Identifier DHCP option (Option 77) of the host. It MAY be
defined when ''AddressSource'' is ''DHCP''. {{empty}} indicates this
option is not used.
Each instance contains all objects associated with a particular
physical WAN interface.
{{datatype|expand}}
Number of instances of {{object|WANConnectionDevice}} in this
''WANDevice''.
This object models WAN interface properties common across all
connection instances.
Used to enable or disable access to and from the Internet across all
connection instances.
Specifies the WAN access (modem) type.
Specifies the maximum upstream theoretical bit rate for the WAN
device in bits per second. This describes the maximum possible rate
given the type of interface assuming the best-case operating
environment, regardless of the current operating rate. For example,
if the physical interface is 100BaseT, this value would be 100000000,
regardless of the current operating rate.
Specifies the maximum downstream theoretical bit rate for the WAN
device in bits per second. This describes the maximum possible rate
given the type of interface assuming the best-case operating
environment, regardless of the current operating rate. For example,
if the physical interface is 100BaseT, this value would be 100000000,
regardless of the current operating rate.
Indicates the state of the physical connection (link) from WANDevice
to a connected entity.
Name of the Service Provider providing link connectivity on the WAN.
The cumulative counter for total number of bytes sent upstream across
all connection service instances on the WAN device.
The cumulative counter for total number of bytes received downstream
across all connection service instances on the WAN device.
The cumulative counter for total number of packets (IP or PPP) sent
upstream across all connection service instances on the WAN device.
The cumulative counter for total number of packets (IP or PPP)
received downstream across all connection service instances on the
WAN device.
Indicates the maximum number of active connections the CPE can
simultaneously support.
Number of WAN connection service instances currently active on this
WAN interface.
Active connection table.
{{datatype|expand}}
Specifies a WAN connection device object associated with this
connection instance. The content is the full hierarchical parameter
name of the WAN connection device. Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2''.
Specifies a WAN connection object associated with this connection
instance. The content is the full hierarchical parameter name of the
layer 3 connection object. Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
This object models physical layer properties specific to a single
physical connection of a DSL modem used for Internet access on a CPE.
This object is required for a CPE with a DSL modem WAN interface, and
is exclusive of any other ''WAN*InterfaceConfig'' object within a given
''WANDevice'' instance.
Enables or disables the link.
Status of the DSL physical link.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
Indicates which link encapsulation standards and recommendations are
supported by the B-NT.
Auto
Indicates the type of modulation used on the connection.
{{enum}} This parameter, which was inherited from WANDSLLinkConfig,
is DEPRECATED because it is in general not clear which standards
correspond to which of the the above enumerated values. It is
RECOMMENDED that the {{param|StandardUsed}} parameter be used to
indicate which standard is in use.
The line encoding method used in establishing the Layer 1 DSL
connection between the CPE and the DSLAM. Note: Generally speaking,
this variable does not change after provisioning.
Indicates which VDSL2 profiles are allowed on the line. {{enum}}
Note: In G.997.1, this parameter is called PROFILES. See ITU-T
Recommendation 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 whether the data path is fast (lower latency) or
interleaved (lower error rate).
{{enum}} Note1: This parameter is only applicable to G.992.1. Note2:
For an ADSL1-capable multimode device operating in a mode other than
ADSL1, the value of this parameter SHOULD be set to {{enum|None}}.
ADSL1 Interleaved depth. This variable is only applicable to ADSL1
and only if {{param|DataPath}} = {{enum|Interleaved|DataPath}}.
Otherwise, the value of this parameter MUST be zero.
Signifies the line pair that the modem is using to connection.
{{param}} = 1 is the innermost pair.
The current physical layer aggregate data rate (expressed in Kbps) of
the upstream DSL connection.
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 4294967295 (the maximum for its
data type).
The current physical layer aggregate data rate (expressed in Kbps) of
the downstream DSL connection.
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 4294967295 (the maximum for its
data type).
The current attainable rate (expressed in Kbps) of the upstream DSL
channel.
Note: This parameter is related to the G.997.1 parameter ATTNDRus,
which is measured in bits/s. See ITU-T Recommendation G.997.1.
The current attainable rate (expressed in Kbps) of the downstream DSL
channel.
Note: This parameter is related to the G.997.1 parameter ATTNDRds,
which is measured in bits/s. See ITU-T Recommendation G.997.1.
The current signal-to-noise ratio margin (expressed in 0.1 dB) in the
upstream direction. Note: In G.997.1, this parameter is called
SNRMus. See ITU-T Recommendation G.997.1.
The current signal-to-noise ratio margin (expressed in 0.1 dB) in the
downstream direction. Note: In G.997.1, this parameter is called
SNRMds. See ITU-T Recommendation G.997.1.
The current upstream signal loss (expressed in 0.1 dB).
The current downstream signal loss (expressed in 0.1 dB).
The current output power at the CPE's DSL interface (expressed in 0.1
dBmV).
The current received power at the CPE's DSL interface (expressed in
0.1 dBmV).
ATU-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".
T.35 country code of the ATU-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".
ATU-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.
ATU-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.
ATU-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 ATU-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".
ATU-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.
ATU-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.
Number of seconds since the beginning of the period used for
collection of ''Total'' statistics. Statistics SHOULD continue to be
accumulated across CPE reboots, though this might not always be
possible.
Number of seconds since the most recent DSL Showtime - the beginning
of the period used for collection of ''Showtime'' statistics.
Showtime is defined as successful completion of the DSL link
establishment process. The ''Showtime'' statistics are those
collected since the most recent establishment of the DSL link.
Number of seconds since the second most recent DSL Showtime-the
beginning of the period used for collection of ''LastShowtime''
statistics. If the CPE has not retained information about the second
most recent Showtime (e.g., on reboot), the start of ''LastShowtime''
statistics MAY temporarily coincide with the start of ''Showtime''
statistics.
Number of seconds since the beginning of the period used for
collection of ''CurrentDay'' statistics. The CPE MAY align the
beginning of each CurrentDay interval with days in the UTC time zone,
but does not have to do so. Statistics SHOULD continue to be
accumulated across CPE reboots, though this might not always be
possible.
Number of seconds since the beginning of the period used for
collection of ''QuarterHour'' statistics. The CPE MAY align the
beginning of each QuarterHour interval with real-time quarter-hour
intervals, but does not have to do so. Statistics SHOULD continue to
be accumulated across CPE reboots, though this might not always be
possible.
Indicates the link encapsulation standard requested by the B-NT.
Indicates the link encapsulation standard that the B-NT is using for
the connection. {{enum}} When the standard identifies ATM
encapsulation then the
{{object|InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig}}
object MUST be used. When the standard identifies PTM encapsulation
then the
{{object|InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig}}
object MUST be used.
Indicates which DSL standards and recommendations are supported by
the B-NT.
Indicates the standard that the B-NT is using for the connection.
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.
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.
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.
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.
This parameter contains the estimated electrical loop length
expressed in dB at 1MHz, kle (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.
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).
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).
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.
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.
Reports the index of the latency path supporting the bearer channel.
For single-latency connections, LPATH = 0. Note: See ITU-T
Recommendation G.997.1.
Reports the interleaver depth D for the latency path indicated in
LPATH. Note: See ITU-T Recommendation G.997.1. For a multimode device
operating in a mode in which this parameter does not apply, the value
of this parameter SHOULD be set to -1.
Reports the interleaver block length in use on the latency path
indicated in LPATH. Note: See ITU-T Recommendation G.997.1. For a
multimode device operating in a mode in which this parameter does not
apply, the value of this parameter SHOULD be set to -1.
Reports the actual delay, in milliseconds, of the latency path due to
interleaving. Note: In G.997.1, this parameter is called "Actual
Interleaving Delay." See ITU-T Recommendation G.997.1.
Reports the actual impulse noise protection (INP) provided by the
latency path indicated in LPATH. The value is the actual INP in the
L0 (i.e., Showtime) state. Note: See ITU-T Recommendation G.997.1.
For a multimode device operating in a mode in which this parameter
does not apply, the value of this parameter SHOULD be set to -1.
Reports whether the value reported in ACTINP was computed assuming
the receiver does not use erasure decoding. Valid values are 0
(computed per the formula assuming no erasure decoding) and 1
(computed by taking into account erasure decoding capabilities of
receiver). Note: See ITU-T Recommendation G.997.1. For a multimode
device operating in a mode in which this parameter does not apply,
the value of this parameter SHOULD be set to {{false}}.
Reports the size, in octets, of the Reed-Solomon codeword in use on
the latency path indicated in LPATH. Note: See ITU-T Recommendation
G.997.1. For a multimode device operating in a mode in which this
parameter does not apply, the value of this parameter SHOULD be set
to -1.
Reports the number of redundancy bytes per Reed-Solomon codeword on
the latency path indicated in LPATH. Note: See ITU-T Recommendation
G.997.1. For a multimode device operating in a mode in which this
parameter does not apply, the value of this parameter SHOULD be set
to -1.
Reports the number of bits per symbol assigned to the latency path
indicated in LPATH. This value does not include overhead due to
trellis coding. Note: See ITU-T Recommendation G.997.1. For a
multimode device operating in a mode in which this parameter does not
apply, the value of this parameter SHOULD be set to -1.
Reports whether trellis coding is enabled in the downstream
direction. A value of 1 indicates that trellis coding is in use, and
a value of 0 indicates that the trellis is disabled. Note: See ITU-T
Recommendation G.997.1. For a multimode device operating in a mode in
which this parameter does not apply, the value of this parameter
SHOULD be set to -1.
Reports whether trellis coding is enabled in the upstream direction.
A value of 1 indicates that trellis coding is in use, and a value of
0 indicates that the trellis is disabled. Note: See ITU-T
Recommendation G.997.1. For a multimode device operating in a mode in
which this parameter does not apply, the value of this parameter
SHOULD be set to -1.
Reports whether the OPTIONAL virtual noise mechanism is in use in the
downstream direction. A value of 1 indicates the virtual noise
mechanism is not in use, and a value of 2 indicates the virtual noise
mechanism is in use. Note: See ITU-T Recommendation G.997.1. For a
multimode device operating in a mode in which this parameter does not
apply, the value of this parameter SHOULD be set to 0.
Reports whether the OPTIONAL virtual noise mechanism is in use in the
upstream direction. A value of 1 indicates the virtual noise
mechanism is not in use, and a value of 2 indicates the virtual noise
mechanism is in use. Note: See ITU-T Recommendation G.997.1. For a
multimode device operating in a mode in which this parameter does not
apply, the value of this parameter SHOULD be set to 0.
Reports the virtual noise PSD for the downstream direction. Base64
encoded of the binary representation defined in G.997.1 by the
parameter called TXREFVNds (maximum length is 97 octets, which
requires 132 bytes for Base64 encoding). See ITU-T Recommendation
G.997.1. For a multimode device operating in a mode in which this
parameter does not apply, the value of this parameter SHOULD be set
to {{empty}}.
Reports the virtual noise PSD for the upstream direction. Base64
encoded of the binary representation defined in G.997.1by the
parameter called TXREFVNus (maximum length is 49 octets, which
requires 68 bytes for Base64 encoding). See ITU-T Recommendation
G.997.1. For a multimode device operating in a mode in which this
parameter does not apply, the value of this parameter SHOULD be set
to {{empty}}.
Reports the actual cyclic extension, as the value of m, in use for
the connection. Note: See ITU-T Recommendation G.997.1. For a
multimode device operating in a mode in which this parameter does not
apply, the value of this parameter SHOULD be set to 99.
The current signal-to-noise ratio margin of each upstream band.
Interpretation of the values is as defined in ITU-T Rec. G.997.1.
Note: See ITU-T Recommendation G.997.1.
The current signal-to-noise ratio margin of each band. Interpretation
of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T
Recommendation G.997.1.
The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset,
measured in DMT symbols, that the xTU receiver uses to determine in
which bin of the IAT histogram the IAT is reported. Note: In G.997.1,
this parameter is called INMIATO. See ITU-T Recommendation G.997.1.
The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that
the xTU receiver uses to determine in which bin of the IAT histogram
the IAT is reported. Note: In G.997.1, this parameter is called
INMIATS. See ITU-T Recommendation G.997.1.
The Impulse Noise Monitoring (INM) Cluster Continuation value,
measured in DMT symbols, that the xTU receiver uses in the cluster
indication process. Note: In G.997.1, this parameter is called INMCC.
See ITU-T Recommendation G.997.1.
The Impulse Noise Monitoring (INM) Equivalent Impulse Noise
Protection (INP) Mode that the xTU receiver uses in the computation
of the Equivalent INP. Note: In G.997.1, this parameter is called
INM_INPEQ_MODE. See ITU-T Recommendation G.997.1.
This object contains statistics for a WAN DSL physical interface.
This object contains DSL total statistics.
Total number of successfully received blocks, where a block is as
defined in RFC 2662 {{bibref|RFC2662}}. This parameter is DEPRECATED
because it is not available at either the G or the S/T interface.
Total number of successfully transmitted blocks, where a block is as
defined in RFC 2662 {{bibref|RFC2662}}. This parameter is DEPRECATED
because it is not available at either the G or the S/T interface.
Total number of cell-delineation errors (total seconds with NCD or
LCD failures as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Total number of link-retrain errors (Full Initialization Count as
defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Total number of initialization errors (LINIT failures as defined in
ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not defined in G.997.1.
Total number of initialization timeout errors.
Total number of loss-of-framing errors (LOF failures as defined in
ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not defined in G.997.1.
Total number of errored seconds (ES-L as defined in ITU-T Rec.
G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of severely errored seconds (SES-L as defined in ITU-T
Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of FEC errors detected (FEC-C as defined in ITU-T Rec.
G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of FEC errors detected by the ATU-C (FEC-CFE as defined
in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of HEC errors detected (HEC-P as defined in ITU-T Rec.
G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of HEC errors detected by the ATU-C (HEC-PFE as defined
in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of CRC errors detected (CV-C as defined in ITU-T Rec.
G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Total number of CRC errors detected by the ATU-C (CV-CFE as defined
in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
LInit is a flag to signal that a failure occurred as defined in
G.997.1.
This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1.
LOF is a flag to signal that a failure occurred.
Total number of errored seconds detected by the ATU-C (ES-L as
defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at
the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Total number of severely errored seconds detected by the ATU-C (SES-L
as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL
at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter
is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
This object contains DSL statistics accumulated since the most recent
DSL Showtime.
Number of successfully received blocks since the most recent DSL
Showtime, where a block is as defined in RFC 2662 {{bibref|RFC2662}}.
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of successfully transmitted blocks since the most recent DSL
Showtime, where a block is as defined in RFC 2662 {{bibref|RFC2662}}.
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of cell-delineation errors since the most recent DSL Showtime
(total seconds with NCD or LCD failures as defined in ITU-T Rec.
G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of link-retrain errors since the most recent DSL Showtime
(Full Initialization Count as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of initialization errors since the most recent DSL Showtime
(LINIT failures as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not defined in G.997.1.
Number of initialization timeout errors since the most recent DSL
Showtime.
Number of loss-of-framing errors since the most recent DSL Showtime
(LOF failures as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not defined in G.997.1.
Number of errored seconds since the most recent DSL Showtime (ES-L as
defined in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of severely errored seconds since the most recent DSL Showtime
(SES-L as defined in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of FEC errors detected since the most recent DSL Showtime
(FEC-C as defined in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of FEC errors detected by the ATU-C since the most recent DSL
Showtime (FEC-CFE as defined in ITU-T Rec. G.997.1).
Note: 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 HEC errors detected since the most recent DSL Showtime
(HEC-P as defined in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of HEC errors detected by the ATU-C since the most recent DSL
Showtime (HEC-PFE as defined in ITU-T Rec. G.997.1).
Note: 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 CRC errors detected since the most recent DSL Showtime
(CV-C as defined in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of CRC errors detected by the ATU-C since the most recent DSL
Showtime (CV-CFE as defined in ITU-T Rec. G.997.1).
Note: 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).
LInit is a flag to signal that a failure occurred as defined in
G.997.1.
This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1.
LOF is a flag to signal that a failure occurred.
Number of errored seconds since the most recent DSL Showtime detected
by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of severely errored seconds since the most recent DSL Showtime
detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note:
This parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
This object contains DSL statistics accumulated since the second most
recent DSL Showtime.
Number of successfully received blocks since the second most recent
DSL Showtime, where a block is as defined in RFC 2662
{{bibref|RFC2662}}. This parameter is DEPRECATED because it is not
available at either the G or the S/T interface.
Number of successfully transmitted blocks since the second most
recent DSL Showtime, where a block is as defined in RFC 2662
{{bibref|RFC2662}}. This parameter is DEPRECATED because it is not
available at either the G or the S/T interface.
Number of cell-delineation errors since the second most recent DSL
Showtime (total seconds with NCD or LCD failures as defined in ITU-T
Rec. G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of link-retrain errors since the second most recent DSL
Showtime (Full Initialization Count as defined in ITU-T Rec.
G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of initialization errors since the second most recent DSL
Showtime (LINIT failures as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not defined in G.997.1.
Number of initialization timeout errors since the second most recent
DSL Showtime.
Number of loss-of-framing errors since the second most recent DSL
Showtime (LOF failures as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not defined in G.997.1.
Number of errored seconds since the second most recent DSL Showtime
(ES-L as defined in ITU-T Rec. G.997.1).
Note: This parameter is OPTIONAL at the G and S/T interfaces in
G.997.1 Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of severely errored seconds since the second most recent DSL
Showtime (SES-L as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of FEC errors detected since the second most recent DSL
Showtime (FEC-C as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of FEC errors detected by the ATU-C since the second most
recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. G.997.1). Note:
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 HEC errors detected since the second most recent DSL
Showtime (HEC-P as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of HEC errors detected by the ATU-C since the second most
recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. G.997.1). Note:
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 CRC errors detected since the second most recent DSL
Showtime (CV-C as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of CRC errors detected by the ATU-C since the second most
recent DSL Showtime (CV-CFE as defined in ITU-T Rec. G.997.1). Note:
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).
LInit is a flag to signal that a failure occurred as defined in
G.997.1.
This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1.
LOF is a flag to signal that a failure occurred.
Number of errored seconds since the second most recent DSL Showtime
detected by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note:
This parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of severely errored seconds since the second most recent DSL
Showtime detected by the ATU-C (SES-L as defined in ITU-T Rec.
G.997.1). Note: This parameter is OPTIONAL at the G and S/T
interfaces in G.997.1 Amendment 1. If the parameter is implemented
but no value is available, its value MUST be 4294967295 (the maximum
for its data type).
This object contains DSL statistics accumulated during the current day.
Number of successfully received blocks during the current day, where
a block is as defined in RFC 2662 {{bibref|RFC2662}}. This parameter
is DEPRECATED because it is not available at either the G or the S/T
interface.
Number of successfully transmitted blocks during the current day,
where a block is as defined in RFC 2662 {{bibref|RFC2662}}. This
parameter is DEPRECATED because it is not available at either the G
or the S/T interface.
Number of cell-delineation errors during the current day (total
seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1).
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of link-retrain errors during the current day (Full
Initialization Count as defined in ITU-T Rec. G.997.1). This
parameter is DEPRECATED because it is not available at either the G
or the S/T interface.
Number of initialization errors during the current day (LINIT
failures as defined in ITU-T Rec. G.997.1). This parameter is
DEPRECATED because it is not defined in G.997.1.
Number of initialization timeout errors during the current day.
Number of loss-of-framing errors during the current day (LOF failures
as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED
because it is not defined in G.997.1.
Number of errored seconds during the current day (ES-L as defined in
ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and
S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Number of severely errored seconds during the current day (SES-L as
defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at
the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Number of FEC errors detected during the current day (FEC-C as
defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at
the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Number of FEC errors detected by the ATU-C during the current day
(FEC-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is
OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the
parameter is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
Number of HEC errors detected during the current day (HEC-P as
defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at
the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Number of HEC errors detected by the ATU-C during the current day
(HEC-PFE as defined in ITU-T Rec. G.997.1). Note: This parameter is
OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the
parameter is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
Number of CRC errors detected during the current day (CV-C as defined
in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and
S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Number of CRC errors detected by the ATU-C during the current day
(CV-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is
OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the
parameter is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
LInit is a flag to signal that a failure occurred as defined in
G.997.1.
This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1.
LOF is a flag to signal that a failure occurred.
Number of errored seconds during the current day detected by the
ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter
is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If
the parameter is implemented but no value is available, its value
MUST be 4294967295 (the maximum for its data type).
Number of severely errored seconds during the current day detected by
the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
This object contains DSL statistics accumulated during the current
quarter hour.
Number of successfully received blocks during the current quarter
hour, where a block is as defined in RFC 2662 {{bibref|RFC2662}}.
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of successfully transmitted blocks during the current quarter
hour, where a block is as defined in RFC 2662 {{bibref|RFC2662}}.
This parameter is DEPRECATED because it is not available at either
the G or the S/T interface.
Number of cell-delineation errors during the current quarter hour
(total seconds with NCD or LCD failures as defined in ITU-T Rec.
G.997.1). This parameter is DEPRECATED because it is not available at
either the G or the S/T interface.
Number of link-retrain errors during the current quarter hour (Full
Initialization Count as defined in ITU-T Rec. G.997.1). This
parameter is DEPRECATED because it is not available at either the G
or the S/T interface.
Number of initialization errors during the current quarter hour
(LINIT failures as defined in ITU-T Rec. G.997.1). This parameter is
DEPRECATED because it is not defined in G.997.1.
Number of initialization timeout errors during the current quarter
hour.
Number of loss-of-framing errors during the current quarter hour (LOF
failures as defined in ITU-T Rec. G.997.1). This parameter is
DEPRECATED because it is not defined in G.997.1.
Number of errored seconds during the current quarter hour (ES-L as
defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at
the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is
implemented but no value is available, its value MUST be 4294967295
(the maximum for its data type).
Number of severely errored seconds during the current quarter hour
(SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is
OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the
parameter is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
Number of FEC errors detected during the current quarter hour (FEC-C
as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL
at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter
is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
Number of FEC errors detected by the ATU-C during the current quarter
hour (FEC-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter
is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If
the parameter is implemented but no value is available, its value
MUST be 4294967295 (the maximum for its data type).
Number of HEC errors detected during the current quarter hour (HEC-P
as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL
at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter
is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
Number of HEC errors detected by the ATU-C during the current quarter
hour (HEC-PFE as defined in ITU-T Rec. G.997.1). Note: This parameter
is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If
the parameter is implemented but no value is available, its value
MUST be 4294967295 (the maximum for its data type).
Number of CRC errors detected during the current quarter hour (CV-C
as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL
at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter
is implemented but no value is available, its value MUST be
4294967295 (the maximum for its data type).
Number of CRC errors detected by the ATU-C during the current quarter
hour (CV-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter
is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If
the parameter is implemented but no value is available, its value
MUST be 4294967295 (the maximum for its data type).
LInit is a flag to signal that a failure occurred as defined in
G.997.1.
This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1.
LOF is a flag to signal that a failure occurred.
Number of errored seconds during the current quarter hour detected by
the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This
parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
Number of severely errored seconds during the current quarter hour
detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note:
This parameter is OPTIONAL at the G and S/T interfaces in G.997.1
Amendment 1. If the parameter is implemented but no value is
available, its value MUST be 4294967295 (the maximum for its data
type).
This object contains the DSL 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, and 8.
Note: See ITU-T Recommendation G.997.1. For a multimode device
operating in a mode in which this parameter does not apply, the value
of this parameter SHOULD be set to 1.
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 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.
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 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.
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 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 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 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, and 8.
Note: See ITU-T Recommendation G.997.1. For a multimode device
operating in a mode in which this parameter does not apply, the value
of this parameter SHOULD be set to 1.
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 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.
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 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.
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 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 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 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 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 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.
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 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.
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 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 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 G.997.1. For a multimode
device operating in a mode in which this parameter does not apply,
the value of this parameter SHOULD be set to 0.
Downstream 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 G.997.1.
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 G.997.1.
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 G.997.1.
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 G.997.1.
This object models physical layer properties specific to a single
Ethernet physical connection used for Internet access on a CPE. This
object is required for a CPE with an Ethernet WAN interface, and is
exclusive of any other ''WAN*InterfaceConfig'' object within a given
''WANDevice'' instance. Note that this object is not related to the
Ethernet protocol layer sometimes used in associated with a DSL
connection.
Enables or disables this interface.
Indicates the status of this interface.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
The physical address of the interface.
The maximum upstream and downstream bit rate available to this
connection.
The duplex mode available to this connection.
Rate to shape this 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 statistics for an Ethernet WAN interface on a CPE
device.
Total number of bytes sent over the interface since the CPE was last
reset.
Total number of bytes received over the interface since the CPE was
last reset.
Total number of packets sent over the interface since the CPE was
last reset.
Total number of packets received over the interface since the CPE was
last reset.
This object is intended for a CPE with a DSL modem WAN interface. Note
- This object was originally created to allow ''WANConnection'' devices
and services to be added dynamically in the IGD object model in TR-064
because UPnP Device Architecture 1.0 did not contain this capability
natively. Because in TR-069 objects can be created and removed using
the AddObject and DeleteObject RPCs, ''WANConnection'' interfaces can
be managed using these TR-069 mechanisms directly. Therefore, unlike
the TR-064 equivalent, the {{object|ConnectionService}} table within
this object is Read-Only in the TR-069 ''InternetGatewayDevice'' data
model context. This object is OBSOLETED because it serves no purpose.
Number of table entries in the ConnectionService table.
This parameter is OBSOLETED because it is within an OBSOLETED object.
The CPE MAY return a value of 0 for this parameter, regardless of the
number of connection services, in which case no
{{object|ConnectionService}} instances will exist.
This table contains an entry for each connection service.
This object is OBSOLETED because it is within an OBSOLETED object.
Specifies a WAN connection device object associated with this
connection instance. The content is the full hierarchical parameter
name of the WAN connection device. Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2''.
This parameter is OBSOLETED because it is within an OBSOLETED object.
Specifies a WAN connection object associated with this connection
instance. The content is the full hierarchical parameter name of the
layer 3 connection object. Example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
This parameter is OBSOLETED because it is within an OBSOLETED object.
Destination address of the WANConnectionDevice entry. One of:
* ''PVC: VPI/VCI''
* ''SVC: ATM connection name''
* ''SVC: ATM address''
The "PVC:" or "SVC:" prefix is part of the parameter value and MUST
be followed by 0 or 1 space characters. For example, possible values
for this parameter are "PVC:8/23" or "PVC: 0/35". This parameter is
OBSOLETED because it is within an OBSOLETED object.
Link Type of the ''WANConnectionDevice'' entry. One of Link Types as
described in ''WANDSLLinkConfig''. This parameter is OBSOLETED
because it is within an OBSOLETED object.
Connection Type of the ''WANPPPConnection'' or ''WANIPConnection''
entry. One of ''PossibleConnectionTypes'' as described in
''WAN**Connection'' service.
This parameter is OBSOLETED because it is within an OBSOLETED object.
User-readable name of the connection.
This parameter is OBSOLETED because it is within an OBSOLETED object.
This object is to provide diagnostic information for a CPE with an
ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL.
Indicates availability of diagnostic data. {{enum}} If the ACS sets
the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test, which brings down the DSL
connection while the test is operating. When writing, the only
allowed value is {{enum|Requested}}. When requested, the CPE SHOULD
wait until after completion of the communication session with the ACS
before starting the diagnostic. When the test is completed, the value
of this parameter MUST be either {{enum|Complete}} (if the test
completed successfully), or one of the ''Error'' values listed above.
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the results parameters for this test
are indeterminate. When the diagnostic initiated by the ACS is
completed, the CPE MUST establish a new connection to the ACS to
allow the ACS to view the results, indicating the corresponding
reason in the Inform message. After the diagnostic is complete, the
value of all result parameters (all read-only parameters in this
object instance) MUST be retained by the CPE until either this
diagnostic is run again, or the CPE reboots. After a reboot, if the
CPE has not retained the result parameters from the most recent test,
it MUST set the value of this parameter to {{enum|None}}.
Downstream actual power spectral density. Interpretation of the value
is as defined in ITU-T Rec. G.997.1.
Note: See ITU-T Recommendation G.997.1.
Upstream actual power spectral density. Interpretation of the value
is as defined in ITU-T Rec. G.997.1.
Note: See ITU-T Recommendation G.997.1.
Downstream actual aggregate transmitter power. Interpretation of the
value is as defined in ITU-T Rec. G.997.1.
Note: See ITU-T Recommendation G.997.1.
Upstream actual aggregate transmitter power. Interpretation of the
value is as defined in ITU-T Rec. G.997.1.
Note: See ITU-T Recommendation G.997.1.
Downstream linear representation scale. Interpretation of the value
is as defined in ITU-T Rec. G.997.1.
Note: See ITU-T Recommendation G.997.1. For a multimode device
operating in a mode in which this parameter does not apply, the value
of this parameter SHOULD be set to 0.
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 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''.
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 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''.
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 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''.
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. G.997.1.
Downstream gain 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. G.997.1. This parameter is
DEPRECATED.
Scaling used to represent the upstream linear channel
characteristics. Interpretation of the value is as defined in ITU-T
Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode
device operating in a mode in which this parameter does not apply,
the value of this parameter SHOULD be set to 0.
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 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 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 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 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.
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 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.
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 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 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 G.997.1. For a multimode
device operating in a mode in which this parameter does not apply,
the value of this parameter SHOULD be set to 0.
Downstream 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 G.997.1.
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 G.997.1.
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 G.997.1.
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 G.997.1.
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 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 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 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.
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 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 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 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 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 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.
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 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 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 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.
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. G.997.1.
Each instance contains objects associated with a given WAN link. In the
case of DSL, each instance corresponds to either a single ATM VC or a
PTM Ethernet link. On creation of a ''WANConnectionDevice'' instance,
there are initially no connection objects contained within. In the case
of Ethernet (interface or link), only one ''WANConnectionDevice''
instance is supported.
{{datatype|expand}}
Number of instances of {{object|WANIPConnection}} in this
''WANConnectionDevice''.
Number of instances of {{object|WANPPPConnection}} in this
''WANConnectionDevice''.
This object models the ATM layer properties specific to a single
physical connection of a DSL modem used for Internet access on a CPE.
This object is intended for a CPE with a DSL modem WAN interface, and
is exclusive of any other ''WAN*LinkConfig'' object within a given
''WANConnectionDevice'' instance.
Enables or disables the link. On creation of a
''WANConnectionDevice'', this object is disabled by default.
Status of the link.
Indicates the type of DSL connection and refers to the complete stack
of protocol used for this connection. {{enum}} The value
{{enum|PPPoE}} has always been DEPRECATED and {{enum|EoA}} SHOULD be
used instead (see {{bibref|TR-098a2|Annex B}}). The ACS MUST NOT set
this parameter to {{enum|PPPoE}} and the CPE MUST reject attempts to
do so.
RFC 2684 {{bibref|RFC2684}} bridged Ethernet over ATM
RFC 2684 {{bibref|RFC2684}} routed IP over ATM
RFC 2364 {{bibref|RFC2634}} PPP over ATM
RFC 2516 {{bibref|RFC2516}} PPP over Ethernet on RFC 2684
{{bibref|RFC2684}} bridged Ethernet over ATM
RFC 2225 {{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.
Indicates the type of DSL modulation used on the interface associated
with this connection (duplication from ''WANDSLInterfaceConfig'').
Destination address of this link. One of:
* ''PVC: VPI/VCI''
* ''SVC: ATM connection name''
* ''SVC: ATM address''
The "PVC:" or "SVC:" prefix is part of the parameter value and MUST
be followed by 0 or 1 space characters. For example, possible values
for this parameter are "PVC:8/23" or "PVC: 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 RFC 2684 {{bibref|RFC2684}}. It is only
applicable in the upstream direction.
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, ...'' Example:
: ''0/35, 8/35, 1/35''
Describes the ATM Adaptation Layer (AAL) currently in use on the PVC.
The current count of successfully transmitted cells.
The current count of successfully received cells.
Describes the ATM Quality Of Service (QoS) being used on the VC.
Specifies the upstream peak cell rate in cells per second.
Specifies the upstream maximum burst size in cells.
Specifies the upstream sustainable cell rate, in cells per second,
used for traffic shaping.
Count of the AAL5 layer cyclic redundancy check errors.
This parameter is DEPRECATED because it overlaps with the
{{param|ATMCRCErrors}} parameter. If present, it MUST have the same
value as the {{param|ATMCRCErrors}} parameter if AAL5 is in use, or 0
if AAL5 is not in use.
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|ATMAAL}} 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.
This object is provides access to an ATM-layer F5 OAM loopback test.
Indicates availability of diagnostic data. {{enum}} If the ACS sets
the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the
communication session with the ACS before starting the diagnostic.
When the test is completed, the value of this parameter MUST be
either {{enum|Complete}} (if the test completed successfully), or one
of the ''Error'' values listed above. If the value of this parameter
is anything other than {{enum|Complete}}, the values of the results
parameters for this test are indeterminate. When the diagnostic
initiated by the ACS is completed (successfully or not), the CPE MUST
establish a new connection to the ACS to allow the ACS to view the
results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the
Inform message. After the diagnostic is complete, the value of all
result parameters (all read-only parameters in this object instance)
MUST be retained by the CPE until either this diagnostic is run
again, or the CPE reboots. After a reboot, if the CPE has not
retained the result parameters from the most recent test, it MUST set
the value of this parameter to {{enum|None}}. Modifying any of the
writable parameters in this object except for this one MUST result in
the value of this parameter being set to {{enum|None}}. While the
test is in progress, modifying any of the writable parameters in this
object except for this one MUST result in the test being terminated
and the value of this parameter being set to {{enum|None}}. While the
test is in progress, setting this parameter to {{enum|Requested}}
(and possibly modifying other writable parameters in this object)
MUST result in the test being terminated and then restarted using the
current values of the test parameters.
Number of repetitions of the ping test to perform before reporting
the results.
Timeout in milliseconds for the ping test.
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 milliseconds
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 milliseconds
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 milliseconds
over all repetitions with successful responses of the most recent
ping test. If there were no successful responses, this value MUST be
zero.
This object models the PTM layer properties specific to a layer 2
interface of a DSL modem used for Internet access on a CPE. This object
is intended for a CPE with a DSL modem WAN interface, and is exclusive
of any other ''WAN*LinkConfig'' object within a given
''WANConnectionDevice'' instance. The PTM Link Layer object exists when
the ''WANDSLInterfaceConfig'' ''LinkEncapsulationSupported'' parameter
includes any of:
* ''G.992.3_Annex_K_PTM''
* ''G.993.2_Annex_K_PTM''
* ''G.994.1''
Enables or disables the link. On creation of a
''WANConnectionDevice'', this object is disabled by default.
Status of the link.
The physical address of the interface.
This object represents the statistics collected and returned over a PTM
link.
The total number of bytes transmitted out of the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of bytes received on the interface, including
framing characters. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets (frames) transmitted out of the
interface. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of packets (frames) which were received on this
interface. The value of this counter MAY be reset to zero when the
CPE is rebooted.
Indication that the CPE has detected the link is Out of
Synchronization since the CPE rebooted or the interface was last
enabled.
Indication that the remote device has detected the link is Out of
Synchronization since the CPE rebooted or the interface was last
enabled.
The total number of outbound packets that could not be transmitted
because of errors. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of inbound packets that contained errors preventing
them from being deliverable. The value of this counter MAY be reset
to zero when the CPE is rebooted.
The total number of packets requested for transmission which were not
addressed to a multicast or broadcast address, including those that
were discarded or not sent. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of received packets which were not addressed to a
multicast or broadcast address. The value of this counter MAY be
reset to zero when the CPE is rebooted.
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 value of this counter MAY be
reset to zero when the CPE is rebooted.
The total number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable. One possible reason for discarding such a packet could
be to free up buffer space. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a multicast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
multicast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets requested for transmission which were
addressed to a broadcast address, including those that were discarded
or not sent. The value of this counter MAY be reset to zero when the
CPE is rebooted.
The total number of received packets which were addressed to a
broadcast address. The value of this counter MAY be reset to zero
when the CPE is rebooted.
The total number of packets received via the interface which were
discarded because of an unknown or unsupported protocol. The value of
this counter MAY be reset to zero when the CPE is rebooted.
This object models the Ethernet link layer properties specific to a
single physical connection used for Internet access on a CPE. This
object is intended for a CPE with an Ethernet WAN interface, and is
exclusive of any other ''WAN*LinkConfig'' object within a given
''WANConnectionDevice'' instance. Note that this object is not related
to the Ethernet protocol layer sometimes used in associated with a DSL
connection.
Status of the Ethernet link.
This object models the POTS link layer properties specific to a single
physical connection used for Internet access on a CPE. This object is
intended for a CPE with a POTS WAN interface, and is exclusive of any
other ''WAN*LinkConfig'' object within a given ''WANConnectionDevice''
instance.
Enables or disables the link. On creation of a
''WANConnectionDevice'', this object is disabled by default.
Status of the link.
Specifies a list of strings separated by semicolon (;), each string
representing a phone number to connect to a particular ISP. The
digits of the phone number follow the semantics of the ITU-T E.164
specification. Delimiters such as brackets or hyphens between the
digits of a phone number are to be ignored by the CPE.
Information identifying the Internet Service Provider. The format of
the string is vendor specific.
This variable indicates the type of POTS link used for the dialup
connection.
The number of times the CPE SHOULD attempt an Internet connection
setup before returning error.
The number of seconds the CPE SHOULD wait between attempts to setup
an Internet connection.
Specifies capabilities of the POTS modem - i.e., if it handles data
({{enum|0}}), fax ({{enum|1}},{{enum|2}},{{enum|2.0}}), voice
({{enum|8}}), DSVD ({{enum|80}}).
The modulation standard currently being used for data.
The protocol standard currently being used for data transfers.
The compression technology implemented on the modem.
Capability for full duplex operation with data and voice.
This object enables configuration of IP connections on the WAN
interface of a CPE.
If the ''Layer2Bridging'' object is implemented, the view that it
provides of the CPE's underlying bridging configuration MUST be
consistent with the view provided by any ''LANDevice'' and
''WAN**Connection'' objects. The implications of this are explained in
{{bibref|TR-098a2|Annex A.6}}.
Enables or disables the connection instance. On creation of a
''WANIPConnection'' instance, it is initially disabled.
{{datatype|expand}}
When set to {{true}}, the device MUST tear down the existing IP
connection represented by this object and establish a new one. The
device MUST initiate the reset after completion of the current CWMP
session. The device MAY delay resetting the connection in order to
avoid interruption of a user service such as an ongoing voice call.
When read, this parameter always returns {{false}}.
Current status of the connection.
{{enum}} The value {{enum|Disconneting}} is DEPRECATED because it is
a typo. The ACS MUST treat {{enum|Disconneting}} and
{{enum|Disconnecting}} the same.
Types of connections possible for this connection instance.
Specifies the connection type of the connection instance.
User-readable name of this connection.
The time in seconds that this connection has been up.
The cause of failure for the last connection setup attempt.
The time in seconds 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 seconds 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 seconds the Status remains in the pending disconnect state
before transitioning to disconnecting state to drop the connection.
Indicates if Realm-specific IP (RSIP) is available as a feature on
the CPE.
Indicates if Network Address Translation (NAT) is enabled for this
connection.
The method used to assign an address to the WAN side interface of the
CPE for this connection.
This is the external IP address used by NAT for this connection. This
parameter is configurable only if the {{param|AddressingType}} is
{{enum|Static|AddressingType}}.
If Active Notification is enabled, the CPE MUST initiate an Inform
whenever either the value of this parameter changes or the default
WAN connection changes to a different connection.
Subnet mask of the WAN interface. This parameter is configurable only
if the {{param|AddressingType}} is {{enum|Static|AddressingType}}.
The IP address of the default gateway for this connection. This
parameter is configurable only if the {{param|AddressingType}} is
{{enum|Static|AddressingType}}.
Whether or not the device SHOULD attempt to query a DNS server across
this connection.
Whether or not a manually set, non-empty DNS address can be
overridden by a DNS entry received from the WAN.
DNS server IP addresses for this connection. Support for more than
three DNS Servers is OPTIONAL.
The maximum allowed size of an Ethernet frame from LAN-side devices.
The physical address of the ''WANIPConnection'' if applicable.
Configurable only if {{param|MACAddressOverride}} is present and
{{true}}.
Whether the value of {{param|MACAddress}} parameter can be
overridden. If {{false}}, the CPE's default value is used (or
restored if it had previously been overridden).
Trigger used to establish the IP connection.
{{enum}} The above values are defined as follows:
* {{enum|OnDemand}}: If this IP 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.
* {{enum|AlwaysOn}}: If this IP 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).
* {{enum|Manual}}: If this IP 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. Note
that the reason for an IP connection becoming disconnected to begin
with might be either external to the CPE, such as non-renewal of a
DHCP lease 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. Note also that the means by which a CPE
would keep an IP connection disconnected (while waiting for the
designated trigger) if it is otherwise physically connected and has
an IP address is a local matter specific to the implementation of
the CPE.
Defines the Rx protocol to be used.
Total number of port mapping entries.
Rate to shape this 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 DHCP client configuration parameters.
The number of entries in the {{object|SentDHCPOption}} table.
The number of entries in the {{object|ReqDHCPOption}} table.
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 SentDHCPOption table entry.
{{datatype|expand}}
Option tag as defined in RFC 2132 {{bibref|RFC2132}}.
Base64 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 ReqDHCPOption table entry.
{{datatype|expand}}
Position of the option in the DHCP client request. A value of 1
indicates the first entry. When this value is modified, if the value
matches that of an existing entry, the Order value for the existing
entry and all lower Order entries is incremented to ensure uniqueness
of this value. A deletion causes Order values to be compacted. When a
value is changed, incrementing occurs before compaction. The value on
creation of a ReqDHCPOption table entry MUST be one greater than the
largest current value.
Option tag as defined in RFC 2132 {{bibref|RFC2132}}.
Base64 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.
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. At most one entry in an
instance of this table can exist with all of the same values for
{{param|RemoteHost}}, {{param|ExternalPort}}, and
{{param|PortMappingProtocol}}. If the ACS attempts to set the
parameters of an existing entry such that this requirement would be
violated, the CPE MUST reject the request. In this case, the
SetParameterValues response MUST include a SetParameterValuesFault
element for each parameter in the corresponding request whose
modification would have resulted in such a violation. On creation of a
new table entry, the CPE MUST choose default values for
{{param|ExternalPort}} and {{param|PortMappingProtocol}} such that the
new entry does not conflict with any existing entry.
Enables or disables the port mapping instance. On creation, an entry
is disabled by default.
{{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.
Determines the time to live, in seconds, of a port-mapping lease,
where "time to live" means the number of seconds before the port
mapping expires. A value of 0 means the port mapping is static.
Support for dynamic (non-static) port mappings is OPTIONAL. That is,
the only value for {{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 ''PortMapping'' table entry.
This parameter is the IP address of the source of inbound packets.
{{empty}} indicates a "wildcard" (this will be a wildcard in most
cases). CPE are REQUIRED only to support wildcards. When {{param}} is
a wildcard, all traffic sent to the {{param|ExternalPort}} on the WAN
interface of the gateway is forwarded to 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-wildcard values for {{param}},
it MAY additionally support the ability to have more than one port
mapping with the same {{param|ExternalPort}} and
{{param|PortMappingProtocol}}, 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}}, wildcard {{param|ExternalPort}}
# Wildcard {{param}}, explicit {{param|ExternalPort}}
# Wildcard {{param}}, wildcard {{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. At most one entry in this table can exist
with all of the same values for {{param}}, {{param|ExternalPort}},
and {{param|PortMappingProtocol}}.
The external port (or the first port of a range of external ports)
that the NAT gateway would listen on for connection requests to a
corresponding {{param|InternalPort}}. Inbound packets to this
external port on the WAN interface SHOULD be forwarded to
{{param|InternalClient}} on the {{param|InternalPort}}. A value of
zero (0) represents a "wildcard". If this value is a wildcard,
connection requests on all external ports (that are not otherwise
mapped) will be forwarded to {{param|InternalClient}}. In the
wildcard case, 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}}, wildcard {{param}}
# Wildcard {{param|RemoteHost}}, explicit {{param}}
# Wildcard {{param|RemoteHost}}, wildcard {{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. At most one entry in this table can exist
with all of the same values for {{param|RemoteHost}}, {{param}},
and {{param|PortMappingProtocol}}.
The port on {{param|InternalClient}} that the gateway SHOULD forward
connection requests to. A value of zero (0) is not allowed.
The protocol of the port mapping.
{{enum}} At most one entry in this table can exist with all of the
same values for {{param|RemoteHost}}, {{param|ExternalPort}}, and
{{param}}.
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 ACS
can learn the host name associated with a given LAN device via the
''Hosts'' table
({{object|InternetGatewayDevice.LANDevice.{i}.Hosts}}). Read access
to this parameter MUST always return the exact value that was last
set by the ACS. 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. {{empty}} indicates an unconfigured {{param}}. If this
parameter is unconfigured, this port mapping MUST NOT be operational.
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.
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}}.
This object contains statistics for all connections within the same
''WANConnectionDevice'' that share a common MAC address. The contents
of this object SHOULD be identical for each such connection. This
object is intended only for ''WANConnectionDevice''s that can support
an Ethernet-layer on this interface (e.g., ''PPPoE'', ''IPoE'').
The total number of bytes transmitted, including framing characters,
over all connections within the same ''WANConnectionDevice'' that
share a common MAC address. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of bytes received, including framing characters,
over all connections within the same ''WANConnectionDevice'' that
share a common MAC address. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of packets transmitted over all connections within
the same ''WANConnectionDevice'' that share a common MAC address. The
value of this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets which were received over all connections
within the same ''WANConnectionDevice'' that share a common MAC
address. The value of this counter MAY be reset to zero when the CPE
is rebooted.
The total number of outbound packets that could not be transmitted
because of errors, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of inbound packets that contained errors preventing
them from being deliverable, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets requested for transmission which were not
addressed to a multicast or broadcast address, including those that
were discarded or not sent, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of received packets which were not addressed to a
multicast or broadcast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of outbound packets which were chosen to be
discarded even though no errors had been detected to prevent their
being transmitted, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. One possible
reason for discarding such a packet could be to free up buffer space.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The total number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. One possible
reason for discarding such a packet could be to free up buffer space.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The total number of packets requested for transmission, including
those that were discarded or not sent, which were addressed to a
multicast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of received packets which were addressed to a
multicast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets requested for transmission, including
those that were discarded or not sent, which were addressed to a
broadcast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of received packets which were addressed to a
broadcast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets which were discarded because of an
unknown or unsupported protocol, received over all connections within
the same ''WANConnectionDevice'' that share a common MAC address. The
value of this counter MAY be reset to zero when the CPE is rebooted.
This object enables configuration of PPP connections on the WAN
interface of a CPE.
If the ''Layer2Bridging'' object is implemented, the view that it
provides of the CPE's underlying bridging configuration MUST be
consistent with the view provided by any ''LANDevice'' and
''WAN**Connection'' objects. The implications of this are explained in
{{bibref|TR-098a2|Annex A.6}}.
Enables or disables the connection instance. On creation of a
''WANPPPConnection'' instance, it is initially disabled.
{{datatype|expand}}
When set to {{true}}, the device MUST tear down the existing PPP
connection represented by this object and establish a new one. The
device MUST initiate the reset after completion of the current CWMP
session. The device MAY delay resetting the connection in order to
avoid interruption of a user service such as an ongoing voice call.
When read, this parameter always returns {{false}}.
Current status of the connection.
Types of connections possible for this connection instance.
Specifies the connection type of the connection instance.
Represents the PPPoE Session ID.
User-readable name of this connection.
The time in seconds that this connection has been up.
The cause of failure for the last connection setup attempt.
The time in seconds 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 seconds 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 seconds the Status remains in the pending disconnect state
before transitioning to disconnecting state to drop the connection.
Indicates if Realm-specific IP (RSIP) is available as a feature on
the CPE.
Indicates if Network Address Translation (NAT) is enabled for this
connection.
Username to be used for authentication.
Password to be usef for authentication.
Describes the PPP encryption protocol used between the WAN device and
the ISP POP.
Describes the PPP compression protocol used between the WAN device
and the ISP POP.
Describes the PPP authentication protocol used between the WAN device
and the ISP POP.
This is the external IP address used by NAT for this connection.
If Active Notification is enabled, the CPE MUST initiate an Inform
whenever either the value of this parameter changes or the default
WAN connection changes to a different connection.
The remote IP address for this connection.
The maximum allowed size of frames sent from the remote peer.
The current MRU in use over this connection.
Whether or not the device SHOULD attempt to query a DNS server across
this connection.
Whether or not a manually set, non-empty DNS address can be
overridden by a DNS entry received from the WAN.
DNS server IP addresses for this connection. Support for more than
three DNS Servers is OPTIONAL.
The physical address of the ''WANPPPConnection'' if applicable.
Configurable only if {{param|MACAddressOverride}} is present and
{{true}}.
If {{param|TransportType}} is {{enum|PPPoA|TransportType}}, the value
of this parameter is irrelevant and MUST be {{empty}}.
Whether the value of {{param|MACAddress}} parameter can be
overridden. If {{false}}, the CPE's default value is used (or
restored if it had previously been overridden).
If {{param|TransportType}} is {{enum|PPPoA|TransportType}}, the value
of this parameter is irrelevant and MUST be {{false}}.
PPP transport type of the connection.
for future use
for future use
PPPoE Access Concentrator.
PPPoE Service Name.
Trigger used to establish the PPP connection. {{enum}} The above
values are defined as follows:
* {{enum|OnDemand}}: 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.
* {{enum|AlwaysOn}}: 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).
* {{enum|Manual}}: 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. 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.
Defines the Rx protocol to be used.
PPP LCP Echo period in seconds.
Number of PPP LCP Echo retries within an echo period.
Total number of port mapping entries.
Rate to shape this 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.
Represents the IP Address of the remote end Default Gateway
established through PPPoE.
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. At most one entry in an
instance of this table can exist with all of the same values for
{{param|RemoteHost}}, {{param|ExternalPort}}, and
{{param|PortMappingProtocol}}. If the ACS attempts to set the
parameters of an existing entry such that this requirement would be
violated, the CPE MUST reject the request. In this case, the
SetParameterValues response MUST include a SetParameterValuesFault
element for each parameter in the corresponding request whose
modification would have resulted in such a violation. On creation of a
new table entry, the CPE MUST choose default values for
{{param|ExternalPort}} and {{param|PortMappingProtocol}} such that the
new entry does not conflict with any existing entry.
Enables or disables the port mapping instance. On creation, an entry
is disabled by default.
{{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.
Determines the time to live, in seconds, of a port-mapping lease,
where "time to live" means the number of seconds before the port
mapping expires. A value of 0 means the port mapping is static.
Support for dynamic (non-static) port mappings is OPTIONAL. That is,
the only value for {{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 ''PortMapping'' table entry.
This parameter is the IP address of the source of inbound packets.
{{empty}} indicates a "wildcard" (this will be a wildcard in most
cases). CPE are REQUIRED only to support wildcards. When {{param}} is
a wildcard, all traffic sent to the {{param|ExternalPort}} on the WAN
interface of the gateway is forwarded to 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-wildcard values for {{param}},
it MAY additionally support the ability to have more than one port
mapping with the same {{param|ExternalPort}} and
{{param|PortMappingProtocol}}, 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}}, wildcard {{param|ExternalPort}}
# Wildcard {{param}}, explicit {{param|ExternalPort}}
# Wildcard {{param}}, wildcard {{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. At most one entry in this table can exist
with all of the same values for {{param}}, {{param|ExternalPort}},
and {{param|PortMappingProtocol}}.
The external port (or the first port of a range of external ports)
that the NAT gateway would listen on for connection requests to a
corresponding {{param|InternalPort}}. Inbound packets to this
external port on the WAN interface SHOULD be forwarded to
{{param|InternalClient}} on the {{param|InternalPort}}. A value of
zero (0) represents a "wildcard". If this value is a wildcard,
connection request on all external ports (that are not otherwise
mapped) will be forwarded to {{param|InternalClient}}. In the
wildcard case, 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}}, wildcard {{param}}
# Wildcard {{param|RemoteHost}}, explicit {{param}}
# Wildcard {{param|RemoteHost}}, wildcard {{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. At most one entry in this table can exist
with all of the same values for {{param|RemoteHost}}, {{param}},
and {{param|PortMappingProtocol}}.
The port on {{param|InternalClient}} that the gateway SHOULD forward
connection requests to. A value of zero (0) is not allowed.
The protocol of the port mapping.
{{enum}} At most one entry in this table can exist with all of the
same values for {{param|RemoteHost}}, {{param|ExternalPort}}, and
{{param}}.
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 ACS
can learn the host name associated with a given LAN device via the
''Hosts'' table
({{object|InternetGatewayDevice.LANDevice.{i}.Hosts}}). Read access
to this parameter MUST always return the exact value that was last
set by the ACS. 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. {{empty}} indicates an unconfigured {{param}}. If this
parameter is unconfigured, this port mapping MUST NOT be operational.
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.
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}}.
This object contains statistics for all connections within the same
''WANConnectionDevice'' that share a common MAC address. The contents
of this object SHOULD be identical for each such connection. This
object is intended only for ''WANConnectionDevice''s that can support
an Ethernet-layer on this interface (e.g., ''PPPoE'', ''IPoE'').
The total number of bytes transmitted, including framing characters,
over all connections within the same ''WANConnectionDevice'' that
share a common MAC address. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of bytes received, including framing characters,
over all connections within the same ''WANConnectionDevice'' that
share a common MAC address. The value of this counter MAY be reset to
zero when the CPE is rebooted.
The total number of packets transmitted over all connections within
the same ''WANConnectionDevice'' that share a common MAC address. The
value of this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets which were received over all connections
within the same ''WANConnectionDevice'' that share a common MAC
address. The value of this counter MAY be reset to zero when the CPE
is rebooted.
The total number of outbound packets that could not be transmitted
because of errors, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of inbound packets that contained errors preventing
them from being deliverable, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets requested for transmission which were not
addressed to a multicast or broadcast address, including those that
were discarded or not sent, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of received packets which were not addressed to a
multicast or broadcast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of outbound packets which were chosen to be
discarded even though no errors had been detected to prevent their
being transmitted, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. One possible
reason for discarding such a packet could be to free up buffer space.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The total number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. One possible
reason for discarding such a packet could be to free up buffer space.
The value of this counter MAY be reset to zero when the CPE is
rebooted.
The total number of packets requested for transmission, including
those that were discarded or not sent, which were addressed to a
multicast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of received packets which were addressed to a
multicast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets requested for transmission, including
those that were discarded or not sent, which were addressed to a
broadcast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of received packets which were addressed to a
broadcast address, over all connections within the same
''WANConnectionDevice'' that share a common MAC address. The value of
this counter MAY be reset to zero when the CPE is rebooted.
The total number of packets which were discarded because of an
unknown or unsupported protocol, received over all connections within
the same ''WANConnectionDevice'' that share a common MAC address. The
value of this counter MAY be reset to zero when the CPE is rebooted.
Layer 2 bridging configuration. Specifies bridges between layer 2 LAN
and/or WAN 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-2005}} 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. If the Layer2Bridging object is implemented, the
view that it provides of the CPE's underlying bridging configuration
MUST be consistent with the view provided by any LANDevice and
WAN**Connection objects. The implications of this are explained in
Annex A.6.
The maximum number of entries available in the {{object|Bridge}}
table.
The maximum number of 802.1D {{bibref|802.1D-2004}} entries available
in the {{object|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 entries available in the {{object|Filter}}
table.
The maximum number of entries available in the {{object|Marking}}
table.
Number of entries in the {{object|Bridge}} table.
Number of entries in the {{object|Filter}} table.
Number of entries in the {{object|Marking}} table.
Number of entries in the {{object|AvailableInterface}} table.
The maximum number of 802.1Q {{bibref|802.1Q-2005}} entries available
in the {{object|Bridge}} table. A positive 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-2005}} VLANs supported
per {{object|Bridge}} table entry.
Bridge table. Each entry in this table represents a single physical
802.1D {{bibref|802.1D-2004}} or 802.1Q {{bibref|802.1Q-2005}} bridge.
If the Bridge Port table is supported, it explicitly defines the
Bridge's interfaces. Otherwise, they are implicitly defined via the
union of the FilterInterface / MarkingInterface parameters for all the
Filter and Marking table entries that are associated with the Bridge.
{{datatype|expand}}
Unique key for each Bridge table entry.
Selects the standard supported by this Bridge table entry.
{{bibref|802.1D-2004}}
{{bibref|802.1Q-2005}}
Enables or disables this Bridge table entry.
The status of this Bridge table entry.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
Human-readable name for this Bridge table entry.
For an 802.1D {{bibref|802.1D-2004}} Bridge, which has no concept of
VLANs, the value of this parameter MUST be 0. For an 802.1Q
{{bibref|802.1Q-2005}} Bridge, this is the Bridge's default VLAN ID,
i.e. the VLAN ID that applies to Filter table entries with
''VLANIDFilter''=-1. For an 802.1Q Bridge, the value of this
parameter MUST NOT be 0.
Number of entries in the Bridge {{object|Port}} table.
Number of entries in the Bridge {{object|VLAN}} table.
Bridge Port table. If this table is supported, it MUST contain an entry
for each Bridge Port.
Enables or disables this Bridge Port table entry.
{{datatype|expand}}
The interface associated with this Bridge Port table entry.
Represents a bridge port as defined in 802.1D {{bibref|802.1D-2004}}
and 802.1Q {{bibref|802.1Q-2005}}. To associate this Bridge Port with
an interface listed in the ''AvailableInterface'' table, the
{{param}} value is set to the value of the corresponding
''AvailableInterfaceKey''.
Bridge Port state as defined in 802.1D {{bibref|802.1D-2004}} and
802.1Q {{bibref|802.1Q-2005}}.
Default Port VLAN ID as defined in 802.1Q {{bibref|802.1Q-2005}}. For
an 802.1D {{bibref|802.1D-2004}} Bridge, this parameter MUST be
ignored.
Bridge Port acceptable frame types as defined in 802.1Q
{{bibref|802.1Q-2005}}. {{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-2005}}. For an 802.1D {{bibref|802.1D-2004}} Bridge,
the value of this parameter MUST be {{false}}.
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-2005}} Bridge.
Enables or disables this VLAN table entry.
{{datatype|expand}}
Human-readable name for this VLAN table entry.
VLAN ID of the entry,
Filter table containing filter entries each of which is associated with
one Bridge as specified by a ''Bridge'' table entry.
For both 802.1D {{bibref|802.1D-2004}} and 802.1Q
{{bibref|802.1Q-2005}} Bridges, this table is used for the following:
# If the Bridge Port table is not supported, it implicitly specifies
the Bridge interfaces (in collaboration with the Marking table).
# It specifies destination MAC address classification rules. For an
802.1Q Bridge, this table is also used for the following:
# For each VLAN ID, it specifies the interfaces that are in the VLAN's
Member Set.
# If the Bridge Port table is not supported, it specifies the Port VLAN
ID (PVID) for each interface. This table also supports several
concepts that are not covered by either 802.1D or 802.1Q:
# It allows a given packet to be admitted to multiple Bridges.
# It supports Ethertype and source MAC address classification rules.
{{datatype|expand}}
Unique key for each Filter table entry.
Enables or disables this Filter table entry.
The status of this Filter table entry.
{{enum}} 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|FilterInterface}}, 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}}.
The ''BridgeKey'' value of the ''Bridge'' table entry associated with
this Filter. A value of -1 indicates the Filter table entry is not
associated with a Bridge (and has no effect).
Whether or not the Filter definition is exclusive of all others. And
if the entry is exclusive, order of precedence. A value of 1 or
greater indicates an Exclusive Filter, where the value 1 indicates
the first entry to be considered (highest precedence). A value of 0
indicates a Non-Exclusive Filter (OPTIONAL). For each packet, if the
packet matches any Exclusive Filters, the packet is assigned to the
Bridge associated with the highest precedence Exclusive Filter to
which it matches (lowest {{param}} value). If and only if the packet
does not match any Exclusive Filters, the packet is assigned to all
Bridges associated with each Non-Exclusive Filter for which it
matches the defining criteria. If a packet matches no Filter, it is
discarded. When the {{param}} is set to match that of an existing
Exclusive Filter (1 or greater), the value for the existing entry and
all higher numbered entries is incremented (lowered in precedence) to
ensure uniqueness of this value. A deletion or change in {{param}} of
an Exclusive Filter causes {{param}} values of other Exclusive
Filters (values 1 or greater) to be compacted. Note that the use of
Exclusive Filters to associate a layer 3 router interface with LAN
and/or WAN interfaces via a Bridge entry overrides and updates the
association between layer 3 and layer 2 objects implied by the
''InternetGatewayDevice'' object hierarchy. Support for Non-Exclusive
Filter entries, i.e. entries with an {{param}} value of 0, is
OPTIONAL because 802.1D {{bibref|802.1D-2004}} and 802.1Q
{{bibref|802.1Q-2005}} do not consider the case of a packet
potentially being admitted to more than one bridge.
The interface or interfaces associated with this Filter table entry.
The bridge corresponding to this Filter table entry is defined to
admit packets on ingress to the bridge from the specified interfaces
that meet all of the criteria specified in the Filter table entry.
The following values are defined.
* To associate this Filter with a single interface listed in the
''AvailableInterface'' table, the {{param}} value is set to the
value of the corresponding ''AvailableInterfaceKey''.
* ''AllInterfaces'' indicates that this Filter is associated with all
LAN and WAN interfaces listed in the ''AvailableInterface'' table
(all entries of ''InterfaceType'' ''LANInterface'' or
''WANInterface''). This value is DEPRECATED because of the
configuration complexity it requires.
* ''LANInterfaces'' indicates that this Filter is associated with all
LAN interfaces listed in the ''AvailableInterface'' table (all
entries of ''InterfaceType'' ''LANInterface''). This value is
DEPRECATED because of the configuration complexity it requires.
* ''WANInterfaces'' indicates that this Filter is associated with all
WAN interfaces listed in the ''AvailableInterface'' table (all
entries of ''InterfaceType'' ''WANInterface''). This value is
DEPRECATED because of the configuration complexity it requires.
{{empty}} indicates the Filter table entry is not associated with
any interface (and has no effect)
The 802.1Q {{bibref|802.1Q-2005}} VLAN ID associated with this Filter
table entry. A value of -1 indicates that the default VLAN ID for the
Bridge MUST be used instead (as specified by
{{param|InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID}} for
the Bridge table entry associated with this Filter table entry). For
an 802.1Q bridge, the value of this parameter MUST NOT be 0, and it
is interpreted as follows (more than one condition can apply, e.g. a
single Filter table entry might both add an interface to a VLAN's
Member Set, and define a classification rule).
# If the Bridge Port table is not supported, it is a candidate to be
the 802.1Q Port VLAN ID (PVID) for the interface associated with
this Filter. Where there is more than one such candidate for a
given interface, the PVID MUST be selected according to the
{{param|ExclusivityOrder}} precedence rules.
# The interface associated with this Filter is added to the VLAN's
802.1Q Member Set.
# If a classification parameter, e.g.
{{param|DestMACAddressFilterList}}, is specified, a classification
rule for this VLAN ID is added. For an 802.1D
{{bibref|802.1D-2004}} Bridge, which has no concept of VLANs, the
VLAN ID MUST be 0. This is most easily achieved by allowing this
parameter to retain its default value of -1 and relying on the fact
that the default VLAN ID for an 802.1D bridge will always be 0.
802.1Q {{bibref|802.1Q-2005}} Acceptable Frame Types criterion. This
parameter is DEPRECATED, because it only partly models 802.1Q
Acceptable Frame Types (and Ingress Filtering). The Bridge Port table
SHOULD be used instead and, if supported, MUST take precedence over
this parameter. If {{true}}, the Bridge admits only packets tagged
with VLAN IDs that include the ingress interface in their 802.1Q
Member Sets. If {{false}}, the Bridge admits both packets tagged with
VLAN IDs that include the ingress interface in their 802.1Q Member
Sets, and any Untagged or PriorityOnly packets. All Untagged or
PriorityOnly packets are associated on ingress with the interface's
Port VLAN ID (PVID). See the description of {{param|VLANIDFilter}}
for an explanation of how the Member Set and PVID are determined. If
more than one Filter table entry is associated with a given
interface, the value of {{param}} MUST be the same for all such
entries. For an 802.1D {{bibref|802.1D-2004}} Bridge, which has no
concept of VLANs, the value of this parameter MUST be {{false}}.
Classification criterion. {{list|each representing an Ethertype
value}} Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q
{{bibref|802.1Q-2005}} 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-2005}} 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-2005}} 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-2005}} support classification based on source MAC
address.
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''
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 DHCP Vendor Class
Identifier (Option 60 as defined in RFC 2132 {{bibref|RFC2132}}) in
the most recent DHCP lease acquisition or renewal matches the
specified value according to the match criterion in
SourceMACFromVendorClassIDMode. Case sensitive. Note that neither
802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}}
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 that of a LAN device previously identified as described in
{{param|SourceMACFromVendorClassIDFilter}}. If
{{param|SourceMACFromVendorClassIDFilter}} 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}}. If the
{{param|SourceMACFromVendorClassIDFilter}} is {{empty}}, packets are
admitted regardless of MAC address.
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q
{{bibref|802.1Q-2005}} 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 DHCP Vendor Class
Identifier (Option 60 as defined in RFC 2132 {{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.
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}}. If
{{param|DestMACFromVendorClassIDFilter}} 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}}.
If the {{param|DestMACFromVendorClassIDFilter}} 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 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 DHCP Client Identifier
(Option 61 as defined in RFC 2132 {{bibref|RFC2132}}) in the most
recent DHCP lease acquisition or renewal 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-2005}} 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 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-2005}} 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 DHCP Client Identifier
(Option 61 as defined in RFC 2132 {{bibref|RFC2132}}) in the most
recent DHCP lease acquisition or renewal was equal to the specified
value. The option value is binary, so an exact match is REQUIRED.
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 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 DHCP User Class
Identifier (Option 77 as defined in RFC 3004 {{bibref|RFC3004}}) in
the most recent DHCP lease acquisition or renewal was equal to the
specified value. Note that neither 802.1D {{bibref|802.1D-2004}} nor
802.1Q {{bibref|802.1Q-2005}} 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 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-2005}} 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 DHCP User Class
Identifier (Option 77 as defined in RFC 3004 {{bibref|RFC3004}}) in
the most recent DHCP lease acquisition or renewal was equal to the
specified value.
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.
{{param|SourceMACFromVendorClassIDFilter}} pattern match criterion.
{{enum}} For example, if {{param|SourceMACFromVendorClassIDFilter}}
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}}. Note that neither 802.1D
{{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support
classification based on source MAC address.
Marking table identifying non-default layer 2 marking behavior for
packets on egress from the specified interfaces. This table is not
relevant to 802.1D {{bibref|802.1D-2004}} Bridges, which are not
VLAN-aware. For 802.1Q {{bibref|802.1Q-2005}} Bridges, this table is
used for the following:
# It specifies whether VLAN tags are to be removed on egress. This
table also supports several concepts that are not covered by 802.1Q:
# It allows the VLAN ID to be changed on egress.
# It allows the Ethernet Priority to be changed on egress.
{{datatype|expand}}
Unique key for each Marking table entry.
Enables or disables this Marking table entry.
The status of this Marking table entry.
{{enum}} 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|MarkingInterface}}, or if such an entry exists
but is disabled, {{param}} MUST NOT indicate {{enum|Enabled}}.
The ''BridgeKey'' value of the Bridge table entry associated with
this Marking table entry. A value of -1 indicates the Marking table
entry is not associated with a Bridge (and has no effect). The effect
of a Marking table entry applies only to packets that have been
admitted to the specified bridge (regardless of the ingress
interface).
The interface or interfaces associated with this Marking table entry
for which the specified marking behavior is to apply on egress from
the associated bridge. The following values are defined.
* To associate this Marking table entry with a single interface
listed in the ''AvailableInterface'' table, the {{param}} value is
set to the value of the corresponding ''AvailableInterfaceKey''.
* ''AllInterfaces'' indicates that this Marking table entry is
associated with all LAN and WAN interfaces listed in the
''AvailableInterface'' table (all entries of ''InterfaceType''
''LANInterface'' or ''WANInterface''). This value is DEPRECATED
because of the configuration complexity it requires.
* ''LANInterfaces'' indicates that this Marking table entry is
associated with all LAN interfaces listed in the
''AvailableInterface'' table (all entries of ''InterfaceType''
''LANInterface''). This value is DEPRECATED because of the
configuration complexity it requires.
* ''WANInterfaces'' indicates that this Marking table entry is
associated with all WAN interfaces listed in the
''AvailableInterface'' table (all entries of ''InterfaceType''
''WANInterface''). This value is DEPRECATED because of the
configuration complexity it requires.
* {{empty}} indicates the Marking table entry table entry is not
associated with any interface (and has no effect) If there is more
than one enabled Marking table entry that specifies one or more of
the same interfaces for the same bridge (identical values of
{{param|MarkingBridgeReference}}), then for packets on egress from
the specified bridge to those interfaces, the applied marking MUST
be that specified in the Marking table entry among those in
conflict with the lowest {{param|MarkingKey}} value. If an
interface in a given bridge does not have a corresponding Marking
table entry, the marking is left unchanged on egress.
If {{true}}, on egress to the interfaces associated with this Marking
table entry, all packets are sent Untagged. If {{false}}, on egress
to the interfaces associated with this Marking table entry, all
packets are sent Tagged with the VLAN ID of the VLAN in which the
packet is being bridged.
The 802.1Q {{bibref|802.1Q-2005}} VLAN ID to be used on egress to the
interfaces associated with this Marking table entry. A value of -1
indicates that the VLAN ID of the VLAN in which the packet is being
bridged is to be used, i.e. no change. The value of this parameter
MUST NOT be 0. If {{param|VLANIDUntag}} is {{true}}, then no VLAN
marking is done since the tag containing the VLAN ID is removed. Note
that 802.1Q does not support re-marking on egress.
Ethernet priority code (as defined in 802.1D {{bibref|802.1D-2004}})
to mark traffic with that falls into this Bridge on egress to the
interfaces associated with this Marking table entry. A value of -1
indicates no change from the incoming packet or the mark assigned by
the classifier. Note that 802.1Q {{bibref|802.1Q-2005}} does not
support re-marking on egress.
If {{false}}, on egress to the interfaces associated with this
Marking table entry, the {{param|EthernetPriorityMark}}, if
specified, is applied only to packets of priority 0. If {{true}}, on
egress to the interfaces associated with this Marking table entry,
the {{param|EthernetPriorityMark}}, if specified, is to be applied to
all packets on this Bridge. Note that 802.1Q {{bibref|802.1Q-2005}}
does not support re-marking on egress.
If {{false}}, on egress to the interfaces associated with this
Marking table entry, the {{param|VLANIDMark}}, if specified, is
applied only to PriorityOnly packets. If {{true}}, on egress to the
interfaces associated with this Marking table entry, the
{{param|VLANIDMark}}, if specified, is to be applied to all packets
on this Bridge. If {{param|VLANIDUntag}} is {{true}}, then no VLAN
marking is done since the tag containing the VLAN ID is removed. Note
that 802.1Q {{bibref|802.1Q-2005}} does not support re-marking on
egress.
Table containing all LAN and WAN interfaces that are available to be
referenced by the Bridge table. Only interfaces that can carry layer 2
bridged traffic are included.
{{datatype|expand}}
Unique key for each Interface entry.
Whether the interface is a LAN-side or WAN-side interface, or a
LAN-side or WAN-side connection to the Gateway's IP router.
{{reference|an available LAN or WAN interface}} This table SHOULD
contain a single entry for each available LAN and WAN interface. When
such an interface is modeled in more than one place within the data
model, the value of this parameter MUST include the full hierarchical
parameter names of all of the corresponding objects. For example, if
a given Ethernet interface is present within two ''LANDevice''
instances, the value of this parameter might be:
''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.1,
InternetGatewayDevice.LANDevice.2.LANEthernetInterfaceConfig.1'' Note
that the remainder of the parameter description does not refer to the
possibility that the parameter value is a comma-separated list.
Nevertheless, the above requirement does apply.
* For a WAN interface, this parameter is the full hierarchical
parameter name of a particular ''WANConnectionDevice''. A
''WANConnectionDevice'' is considered available (included in this
table) only if it supports layer 2 bridged traffic. That is, this
table MUST include only ''WANConnectionDevice''s that contain
either a ''WANEthernetLinkConfig'' object, or that contain a
''WANDSLLinkConfig'' object for which the ''LinkType'' is ''EoA''.
For example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2''
* For a LAN interface, this parameter is the full hierarchical
parameter name of a particular ''LAN**InterfaceConfig'' object, or
a ''WLANConfiguration'' object. This table SHOULD include one entry
for each such object. For example:
''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2''
* For a WAN-side connection to the Gateway's IP router, this
parameter is the full hierarchical parameter name of a particular
''WAN**Connection'' service. This table SHOULD include an entry for
each layer 3 WAN connection. For example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
* For a LAN-side connection to the Gateway's IP router, this
parameter is the full hierarchical parameter name of a particular
''LANDevice''. This table SHOULD include an entry for each
''LANDevice'', each of which is associated with a LAN-side layer 3
connection to the Gateway's IP router. For example:
''InternetGatewayDevice.LANDevice.2''
Queue management configuration object.
Enables or disables all queuing operation.
The maximum number of queues supported by the CPE. Calculated as the
sum of the number of different queues pointed to by Classification
table. For each entry in the Classification table, the count includes
a queue for each egress interface to which the corresponding
classified traffic could reach.
The maximum number of entries available in the Classification table.
The number of entries in the {{object|Classification}} table.
The maximum number of entries available in the {{object|App}} table.
The number of entries in the {{object|App}} table.
The maximum number of entries available in the {{object|Flow}} table.
The number of entries in the {{object|Flow}} table.
The maximum number of entries available in the {{object|Policer}}
table.
The number of entries in the {{object|Policer}} table.
The maximum number of entries available in the {{object|Queue}}
table.
The number of entries in the {{object|Queue}} table.
The number of entries in the {{object|QueueStats}} table.
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. A value of -1 indicates a
null traffic class.
Instance number of the Policer table entry for traffic not associated
with any specified classifier. A value of -1 indicates a null
policer.
Instance number of the {{object|Queue}} table entry for traffic not
associated with any specified classifier.
A value of 0xffffffff (-1) indicates a null queue (permitted in data
model versions 1.4 and later).
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-098a1|Annex A}}.
Ethernet priority code (as defined in 802.1D) 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-098a1|Annex A}}.
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-098a1|Annex A}} as well as other URNs
defined elsewhere.
Classification table.
Unique key for each classification entry.
This parameter is OBSOLETED because it serves no purpose (no other
parameter references it).
Enables or disables this classifier.
The status of this classifier.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
Position of the classification entry in the order of precedence. A
value of 1 indicates the first entry considered. For each packet, the
highest ordered entry that matches the classification criteria is
applied. All lower order entries are ignored. When this value is
modified, if the value matches that of an existing entry, the Order
value for the existing entry and all lower Order entries is
incremented (lowered in precedence) to ensure uniqueness of this
value. A deletion causes Order values to be compacted. When a value
is changed, incrementing occurs before compaction.
The value on creation of a Classification table entry MUST be one
greater than the largest current value.
Classification criterion. Specifies the LAN or WAN ingress interface
associated with this entry. The content is the full hierarchical
parameter name of the particular ''WANDevice'',
''WANConnectionDevice'', ''WAN**Connection'', ''LANDevice'',
''LAN**InterfaceConfig'', or ''WLANConfiguration'' object. The
following are WAN interface examples:
* ''InternetGatewayDevice.WANDevice.2''
*
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
The following are LAN interface examples:
* ''InternetGatewayDevice.LANDevice.3''
* ''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2''
* ''InternetGatewayDevice.LANDevice.1.WLANConfiguration.3'' The
string ''WAN'' indicates this entry is to apply to traffic entering
from any WAN interface. The string ''LAN'' indicates this entry is
to apply to traffic entering from any LAN interface. The string
''Local'' indicates this entry is to apply to IP-layer traffic
entering from a local source within the Internet Gateway Device.
{{empty}} indicates this classification entry is to apply to all
sources.
Classification criterion. Destination IP address. {{empty}} indicates
this criterion is not used for classification.
Destination IP address mask. If not {{empty}}, only the indicated
network portion of the DestIP address is to be used for
classification. {{empty}} indicates that the full DestIP address is
to be used for classification.
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. If not {{empty}}, only the indicated network
portion of the SourceIP address is to be used for classification.
{{empty}} indicates that the full SourceIP address is to be used for
classification.
If {{false}}, the class includes only those packets that match the
(masked) SourceIP entry, if specified. If {{true}}, the class
includes all packets except those that match the (masked) 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
Protocol entry, if specified. If {{true}}, the class includes all
packets except those that match the 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 DestPort through
DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be
greater than or equal to DestPort. A value of -1 indicates that no
port range is specified.
If {{false}}, the class includes only those packets that match the
DestPort entry (or port range), if specified. If {{true}}, the class
includes all packets except those that match the 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 SourcePort through
SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST
be greater than or equal to SourcePort. A value of -1 indicates that
no port range is specified.
If {{false}}, the class includes only those packets that match the
SourcePort entry (or port range), if specified. If {{true}}, the
class includes all packets except those that match the SourcePort
entry (or port range), if specified.
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 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 SourceMACAdress are to be used
for classification.
If {{false}}, the class includes only those packets that match the
(masked) SourceMACAddress entry, if specified. If {{true}}, the class
includes all packets except those that match the (masked)
SourceMACAddress entry, if specified.
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 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 DestMACAdress are to be used for
classification.
If {{false}}, the class includes only those packets that match the
(masked) DestMACAddress entry, if specified. If {{true}}, the class
includes all packets except those that match the (masked)
DestMACAddress entry, if specified.
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
Ethertype entry, if specified. If {{true}}, the class includes all
packets except those that match the 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
SSAP entry, if specified. If {{true}}, the class includes all packets
except those that match the 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
DSAP entry, if specified. If {{true}}, the class includes all packets
except those that match the 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
LLCControl entry, if specified. If {{true}}, the class includes all
packets except those that match the 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
SNAPOUI entry, if specified. If {{true}}, the class includes all
packets except those that match the SNAPOUI entry, if specified.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCP Vendor Class Identifier (Option 60) as defined in
RFC 2132 {{bibref|RFC2132}}, matched according to the criterion in
{{param|SourceVendorClassIDMode}}. Case sensitive. {{empty}}
indicates this criterion is not used for classification.
If {{false}}, the class includes only those packets sourced from LAN
devices that match the SourceVendorClassID entry, if specified. If
{{true}}, the class includes all packets except those sourced from
LAN devices that match the SourceVendorClassID entry, 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 DHCP Vendor Class Identifier (Option 60) as defined in
RFC 2132 {{bibref|RFC2132}}, matched according to the criterion in
{{param|DestVendorClassIDMode}}. Case sensitive. {{empty}} indicates
this criterion is not used for classification.
If {{false}}, the class includes only those packets destined for LAN
devices that match the DestVendorClassID entry, if specified. If
{{true}}, the class includes all packets except those destined for
LAN devices that match the DestVendorClassID entry, if specified.
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. Used to identify one or more LAN devices,
value of the DHCP Client Identifier (Option 61) as defined in RFC
2132 {{bibref|RFC2132}}. The option value is binary, so an exact
match is REQUIRED. {{empty}} indicates this criterion is not used for
classification.
If {{false}}, the class includes only those packets sourced from LAN
devices that match the SourceClientID entry, if specified. If
{{true}}, the class includes all packets except those sourced from
LAN devices that match the SourceClientID entry, if specified.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCP Client Identifier (Option 61) as defined in RFC
2132 {{bibref|RFC2132}}. The option value is binary, so an exact
match is REQUIRED. {{empty}} indicates this criterion is not used for
classification.
If {{false}}, the class includes only those packets destined for LAN
devices that match the DestClientID entry, if specified. If {{true}},
the class includes all packets except those destined for LAN devices
that match the DestClientID entry, if specified.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCP User Class Identifier (Option 77) as defined in RFC
3004 {{bibref|RFC3004}}. {{empty}} indicates this criterion is not
used for classification.
If {{false}}, the class includes only those packets sourced from LAN
devices that match the SourceUserClassID entry, if specified. If
{{true}}, the class includes all packets except those sourced from
LAN devices that match the SourceUserClassID entry, if specified.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCP User Class Identifier (Option 77) as defined in RFC
3004 {{bibref|RFC3004}}. {{empty}} indicates this criterion is not
used for classification.
If {{false}}, the class includes only those packets destined for LAN
devices that match the DestUserClassID entry, if specified. If
{{true}}, the class includes all packets except those destined for
LAN devices that match the DestUserClassID entry, if specified.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCP Vendor-specific Information (Option 125) as defined
in RFC 3925 {{bibref|RFC3925}}, matched according to the criteria in
{{param|SourceVendorSpecificInfoEnterprise}},
{{param|SourceVendorSpecificInfoSubOption}} and
{{param|SourceVendorSpecificInfoMode}}. Case sensitive. {{empty}}
indicates this criterion is not used for classification.
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
TCPACK entry, if specified. If {{true}}, the class includes all
packets except those that match the 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 IPLengthMin
through IPLengthMax. A value of zero for both IPLengthMin and
IPLengthMax allows any length packet. An equal non-zero value of
IPLengthMin and IPLengthMax allows only a packet with the exact
length specified. If {{true}}, the class includes all packets except
those whose length (including header) falls within the inclusive
range IPLengthMin through IPLengthMax.
Classification criterion. DiffServ codepoint (defined in RFC 2474
{{bibref|RFC2474}}). If set to a Class Selector Codepoint (defined in
RFC 2474), 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
DSCPCheck entry, if specified. If {{true}}, the class includes all
packets except those that match the 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-098a1|Annex A}}.
Classification criterion. Current Ethernet priority as defined in
802.1D. A value of -1 indicates this criterion is not used for
classification.
If {{false}}, the class includes only those packets that match the
EthernetPriorityCheck entry, if specified. If {{true}}, the class
includes all packets except those that match the
EthernetPriorityCheck entry, if specified.
Classification result. Ethernet priority code (as defined in 802.1D)
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 EthernetPriority based upon the
DSCP value of the incoming packet as defined in
{{bibref|TR-098a1|Annex A}}.
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
VLANIDCheck entry, if specified. If {{true}}, the class includes all
packets except those that match the 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 Queue table entry MUST include this traffic class in its
''TrafficClass'' parameter (which is a comma-separated list). A value
of -1 indicates a null traffic class. {{param}}, {{param|ClassQueue}}
and {{param|ClassApp}} are mutually exclusive and one of the three
MUST be specified. If {{param}} and {{param|ClassQueue}} are null,
{{param|ClassApp}} MUST be specified, and vice versa.
Classification result. Instance number of the Policer table entry for
traffic that falls in this classification. A value of -1 indicates a
null policer.
Classification result. Instance number of the Queue table entry for
traffic that falls in this classification. A value of -1 indicates a
null queue. {{param|TrafficClass}}, {{param}} and {{param|ClassApp}}
are mutually exclusive and one of the three MUST be specified. If
{{param|TrafficClass}} and {{param}} are null, {{param|ClassApp}}
MUST be specified, and vice versa.
Classification result. Instance number of the App table entry for
traffic that falls in this classification. A value of -1 indicates a
null App table entry. {{param|TrafficClass}}, {{param|ClassQueue}}
and {{param}} are mutually exclusive and one of the three MUST be
specified. If {{param|TrafficClass}} and {{param|ClassQueue}} are
null, {{param}} MUST be specified, and vice versa.
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
RFC 3925 {{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 RFC
3925 {{bibref|RFC3925}}.
{{param|SourceVendorSpecificInfo}} pattern match criterion.
Classification criterion. Used to identify one or more LAN devices,
value of the DHCP Vendor-specific Information (Option 125) as defined
in RFC 3925 {{bibref|RFC3925}}, matched according to the criteria in
{{param|DestVendorSpecificInfoEnterprise}},
{{param|DestVendorSpecificInfoSubOption}} and
{{param|DestVendorSpecificInfoMode}}. {{empty}} indicates this
criterion is not used for classification.
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 RFC
3925 {{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 RFC
3925 {{bibref|RFC3925}}.
{{param|DestVendorSpecificInfo}} pattern match criterion.
Application table.
Unique key for each App table entry.
This parameter is OBSOLETED because it serves no purpose (no other
parameter references it).
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-098a1|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. A value of -1 indicates a null traffic class. {{param}} and
{{param|AppDefaultQueue}} MUST NOT both be specified.
Instance number of the Policer table entry for traffic associated
with this App table entry, but not associated with any specified
flow. A value of -1 indicates a null policer.
Instance number of the Queue table entry for traffic associated with
this App table entry, but not associated with any specified flow. A
value of -1 indicates a null queue.
{{param|AppDefaultTrafficClass}} and {{param}} MUST NOT both be
specified.
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-098a1|Annex A}}.
Ethernet priority code (as defined in 802.1D) 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-098a1|Annex A}}.
Flow table.
Unique key for each Flow table entry.
This parameter is OBSOLETED because it serves no purpose (no other
parameter references it).
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
queue and policer. A set of defined URNs is given in
{{bibref|TR-098a1|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.
Instance number of the App table entry associated with this flow. A
value of -1 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. A value of
-1 indicates a null traffic class. {{param}} and {{param|FlowQueue}}
MUST NOT both be specified.
Instance number of the Policer table entry for traffic that falls in
this flow. A value of -1 indicates a null policer.
Instance number of the Queue table entry for traffic that falls in
this flow. A value of -1 indicates a null queue.
{{param|FlowTrafficClass}} and {{param}} MUST NOT both be specified.
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-098a1|Annex A}}.
Ethernet priority code (as defined in 802.1D) 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-098a1|Annex A}}.
Policer table.
Unique key for each policer entry.
This parameter is OBSOLETED because it serves no purpose (no other
parameter references it).
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 bits-per-second.
Committed Burstsize in bytes.
Excess Burstsize in bytes. Applied for a
{{enum|SingleRateThreeColor|MeterType}} meter.
Peak rate allowed for this Meter in bits-per-second. 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}} {{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 RFC 2697 {{bibref|RFC2697}}. {{enum|TwoRateThreeColor}}
makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}},
{{param|PeakRate}}, and {{param|PeakBurstSize}} as defined in RFC
2698 {{bibref|RFC2698}}.
Supported meter types.
Instructions for how to handle traffic that is conforming.
{{pattern}} {{pattern|Null}} corresponds with no action. A
{{pattern|Count}} action (and only the {{pattern|Count}} action)
increases the meter instance count statistics in the
{{param|CountedPackets}} and {{param|CountedBytes}} parameters.
{{pattern|Count}} actions are DEPRECATED because they can not be
combined with other actions, e.g. marking actions. ''<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. A {{pattern|Count}} action (and only the {{pattern|Count}}
action) increases the meter instance count statistics in the
{{param|CountedPackets}} and {{param|CountedBytes}} parameters.
{{pattern|Count}} actions are DEPRECATED because they can not be
combined with other actions, e.g. marking actions. ''<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. A
{{pattern|Count}} action (and only the {{pattern|Count}} action)
increases the meter instance count statistics in the
{{param|CountedPackets}} and {{param|CountedBytes}} parameters.
{{pattern|Count}} actions are DEPRECATED because they can not be
combined with other actions, e.g. marking actions. ''<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>
Number of Packets counted as result of a ''Count'' meter action. This
parameter is DEPRECATED because the ''Count'' meter action is
DEPRECATED.
Number of Bytes counted as result of a ''Count'' meter action. This
parameter is DEPRECATED because the ''Count'' meter action is
DEPRECATED.
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.
This table can contain hardware queues. The CPE MAY refuse to allow
hardware queues to be deleted.
Unique key for each queue entry.
This parameter is OBSOLETED because it serves no purpose (no other
parameter references it).
Enables or disables this queue.
The status of this queue.
{{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate
a locally defined error condition.
{{datatype|expand}}
Identifies the set of traffic classes associated with this queue. If
this list is empty then traffic can be sent to this queue only as a
result of a direct reference from a Classification, App or Flow table
entry, e.g. via the Classification table's ''ClassQueue'' parameter.
If this list is non-empty then traffic can additionally be sent to
this queue if a Classification, App or Flow table entry specifies a
traffic class, e.g. via the Classification table's ''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.
Egress interfaces for which the specified queue MUST exist. This
parameter MUST be in one of the following forms: The full
hierarchical parameter name of the particular ''WANDevice'',
''WANConnectionDevice'', ''WAN**Connection'', ''LANDevice'',
''LAN**InterfaceConfig'', or ''WLANConfiguration'' object. The string
''WAN'', which indicates this entry applies to all WAN interfaces.
The string ''LAN'', which indicates this entry applies to all LAN
interfaces. {{empty}}, which indicates this classification entry is
to apply to all interfaces. Packets classified into this queue that
exit through any other interface MUST instead use the default queuing
behavior specified in the Queue table entry referenced by
{{param|InternetGatewayDevice.QueueManagement.DefaultQueue}}. For the
default queue itself (the Queue table entry referenced by
{{param|InternetGatewayDevice.QueueManagement.DefaultQueue}}), the
value of the {{param}} parameter MUST be ignored. That is, the
default queue MUST exist on all egress interfaces.
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 ACS, which will
create entries only for those {Queue, Interface} combinations for which
statistics are to be collected.
Enables or disables this object.
The status of this object.
Enabled and {Queue,Interface} is valid
Enabled but {Queue,Interface} is invalid
{{datatype|expand}}
Instance number of the Queue table entry with which this object is
associated.
Egress interface for which this object contains statistics. This
parameter MUST be the full hierarchical parameter name of the
particular ''WANDevice'', ''WANConnectionDevice'',
''WAN**Connection'', ''LANDevice'', ''LAN**InterfaceConfig'', or
''WLANConfiguration'' object.
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 as a percentage, i.e. 100 * queue occupancy in bytes
/ queue size in bytes (gives a measure of queue usage).
The capabilities of the device. This is a constant read-only object,
meaning that only a firmware upgrade will cause these values to be
altered.
The capabilities of the Performance Diagnostics
(''DownloadDiagnostics'' and ''UploadDiagnostics'') for the device.
Supported ''DownloadDiagnostics'' transport protocols for a CPE
device.
Supported ''UploadDiagnostics'' transport protocols for a CPE device.
This object 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.
Indicate the availability of diagnostic data. {{enum}} If the ACS
sets the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the
communication session with the ACS before starting the diagnostic.
When the test is completed, the value of this parameter MUST be
either {{enum|Completed}} (if the test completed successfully), or
one of the ''Error'' values listed above. If the value of this
parameter is anything other than {{enum|Completed}}, the values of
the results parameters for this test are indeterminate. When the
diagnostic initiated by the ACS is completed (successfully or not),
the CPE MUST establish a new connection to the ACS to allow the ACS
to view the results, indicating the Event code ''8 DIAGNOSTICS
COMPLETE'' in the Inform message. After the diagnostic is complete,
the value of all result parameters (all read-only parameters in this
object) MUST be retained by the CPE until either this diagnostic is
run again, or the CPE reboots. After a reboot, if the CPE has not
retained the result parameters from the most recent test, it MUST set
the value of this parameter to {{enum|None}}. Modifying any of the
writable parameters in this object except for this one MUST result in
the value of this parameter being set to {{enum|None}}. While the
test is in progress, modifying any of the writable parameters in this
object except for this one MUST result in the test being terminated
and the value of this parameter being set to {{enum|None}}. While the
test is in progress, setting this parameter to {{enum|Requested}}
(and possibly modifying other writable parameters in this object)
MUST result in the test being terminated and then restarted using the
current values of the test parameters.
{{reference|the IP-layer interface over which the test is to be
performed}} 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 use the default routing
interface.
The URL, as defined in {{bibref|RFC3986}}, for the CPE to perform the
download on. This parameter MUST be in the form of a valid HTTP
{{bibref|RFC2616}} or FTP {{bibref|RFC862}} 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.
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.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* 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.123456
* 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.123456
* 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 test traffic received in bytes during the FTP/HTTP transaction
including FTP/HTTP headers, between {{param|BOMTime}} and
{{param|EOMTime}},
The total number of bytes received on the Interface between
{{param|BOMTime}} and {{param|EOMTime}}.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* 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.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* 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.
This object 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.
Indicate the availability of diagnostic data. {{enum}} If the ACS
sets the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the
communication session with the ACS before starting the diagnostic.
When the test is completed, the value of this parameter MUST be
either {{enum|Completed}} (if the test completed successfully), or
one of the ''Error'' values listed above. If the value of this
parameter is anything other than {{enum|Completed}}, the values of
the results parameters for this test are indeterminate. When the
diagnostic initiated by the ACS is completed (successfully or not),
the CPE MUST establish a new connection to the ACS to allow the ACS
to view the results, indicating the Event code ''8 DIAGNOSTICS
COMPLETE'' in the Inform message. After the diagnostic is complete,
the value of all result parameters (all read-only parameters in this
object) MUST be retained by the CPE until either this diagnostic is
run again, or the CPE reboots. After a reboot, if the CPE has not
retained the result parameters from the most recent test, it MUST set
the value of this parameter to {{enum|None}}. Modifying any of the
writable parameters in this object except for this one MUST result in
the value of this parameter being set to {{enum|None}}. While the
test is in progress, modifying any of the writable parameters in this
object except for this one MUST result in the test being terminated
and the value of this parameter being set to {{enum|None}}. While the
test is in progress, setting this parameter to {{enum|Requested}}
(and possibly modifying other writable parameters in this object)
MUST result in the test being terminated and then restarted using the
current values of the test parameters.
{{reference|the IP-layer interface over which the test is to be
performed}} The value of this parameter MUST be either a valid
interface or an empty string. An attempt to set this parameter to a
different value MUST be rejected as an invalid parameter value. If
{{empty}} is specified, the CPE MUST use the default routing
interface.
The URL, as defined in {{bibref|RFC3986}}, for the CPE to Upload to.
This parameter MUST be in the form of a valid HTTP {{bibref|RFC2616}}
or FTP {{bibref|RFC862}} 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.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the client sends the PUT command
* For FTP this is the time at which the STOR command is sent.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the first data packet is sent.
* For FTP this is the time at which the client receives the ready for
transfer notification.
End of transmission in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time when the HTTP successful response code is
received.
* For FTP this is the time when the client receives a transfer
complete.
The total number of bytes sent on the Interface between
{{param|BOMTime}} and {{param|EOMTime}}.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* 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.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* 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.
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 parameters relating to the captive portal
configuration on the CPE. The captive portal configuration defines the
CPE's WAN-destined HTTP (port 80) traffic redirect behavior. When the
captive portal is disabled, WAN-destined HTTP (port 80) traffic MUST be
permitted to all destinations. When the captive portal is enabled,
WAN-destined 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|CaptivePortalURL}}.
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|CaptivePortalURL}} is {{empty}}
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 subnet
specified using variable length subnet mask (VLSM) syntax. An IP
subnet is specified as an IP address followed (with no intervening
white space) by "/n", where n is an integer in the range 0-32; this
is equivalent to a subnet mask consisting of n 1s followed by 32
minus n 0s. For example, 1.2.3.4 specifies a single IP address, and
1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0.
The maximum length of a single entry (plus comma) is 19 characters so
10000 bytes is sufficient for more than 500 IP addresses and/or IP
subnets.
Captive portal URL to which WAN-destined 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}}).
This object is defines access to an IP-layer trace-route test for the
specified IP interface.
Indicates availability of diagnostic data. {{enum}} If the ACS sets
the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the
communication session with the ACS before starting the diagnostic.
When the diagnostic initiated by the ACS is completed (successfully
or not), the CPE MUST establish a new connection to the ACS to allow
the ACS to view the results, indicating the Event code ''8
DIAGNOSTICS COMPLETE'' in the Inform message.
{{reference|the WAN or LAN IP-layer interface over which the test is
to be performed}} This identifies the source IP address to use when
performing the test. The following is a WAN interface example:
''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
The following is a LAN interface example:
''InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1''
Host name or address of the host to find a route to
Number of tries per hop. Set prior to running Diagnostic. By default,
the CPE SHOULD set this value to 3.
Timeout in milliseconds for 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.
Result parameter indicating the response time in milliseconds the
most recent trace route test. If a route could not be determined,
this value MUST be zero.
Number of entries in the {{object|RouteHops}} table.
Contains the array of 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|HopHost}}
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.
Contains one or more round trip times in milliseconds (one for each
repetition) for this hop.
This object contains LAN-side layer 1/2 interfaces that are not
currently connected to the Gateway's IP router and which therefore do
not currently reside within a ''LANDevice'' instance.
Number of instances of {{object|LANEthernetInterfaceConfig}} in this
object.
Number of instances of {{object|LANUSBInterfaceConfig}} in this
object.
Number of instances of {{object|WLANConfiguration}} in this object
object.
This object models an Ethernet LAN connection on a CPE device. The
object definition is identical to that for
{{object|InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}}}.
{{datatype|expand}}
This object models a USB LAN connection on a CPE device. The object
definition is identical to that for
{{object|InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}}}.
{{datatype|expand}}
This object models an 802.11 LAN connection on a CPE device. The object
definition is identical to that for
{{object|InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}}}.
{{datatype|expand}}
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.
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 URL 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 URL 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 URL 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 URL from which the device description was retrieved (e.g.
the LOCATION from the SSDP message) is utilized as the URLBase. Note:
the URLBase element is not recommended by {{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 URL. 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 URL. 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 URL. 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}}.
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.
When set to {{true}}, resets 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-106a2|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-106a2|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 diagnostics test is vendor-specific and MAY include testing
hardware, software, and/or firmware.
Indicates availability of diagnostic data. {{enum}} If the ACS sets
the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the DiagnosticsState to Requested.
When requested, the CPE SHOULD wait until after completion of the
communication session with the ACS before starting the diagnostic.
When the test is completed, the value of this parameter MUST be
either {{enum|Complete}} (if the test completed successfully), or one
of the Error values listed above. If the value of this parameter is
anything other than {{enum|Complete}}, the values of the results
parameters for this test are indeterminate. When the diagnostic
initiated by the ACS is completed (successfully or not), the CPE MUST
establish a new connection to the ACS to allow the ACS to view the
results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the
Inform message. After the diagnostic is complete, the value of all
result parameters (all read-only parameters in this object) MUST be
retained by the CPE until either this diagnostic is run again, or the
CPE reboots. After a reboot, if the CPE has not retained the result
parameters from the most recent test, it MUST set the value of this
parameter to {{enum|None}}. Modifying any of the writable parameters
in this object except for this one MUST result in the value of this
parameter being set to {{enum|None}}. While the test is in progress,
modifying any of the writable parameters in this object except for
this one MUST result in the test being terminated and the value of
this parameter being set to {{enum|None}}. While the test is in
progress, setting this parameter to {{enum|Requested}} (and possibly
modifying other writable parameters in this object) MUST result in
the test being terminated and then restarted using the current values
of the test parameters.
Results of self-test (vendor specific).
This object 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.
Indicates availability of diagnostic data. {{enum}} If the ACS sets
the value of this parameter to {{enum|Requested}}, the CPE MUST
initiate the corresponding diagnostic test. When writing, the only
allowed value is {{enum|Requested}}. To ensure the use of the proper
test parameters (the writable parameters in this object), the test
parameters MUST be set either prior to or at the same time as (in the
same SetParameterValues) setting the DiagnosticsState to
{{enum|Requested}}. When requested, the CPE SHOULD wait until after
completion of the communication session with the ACS before starting
the diagnostic. When the test is completed, the value of this
parameter MUST be either {{enum|Complete}} (if the test completed
successfully), or one of the Error values listed above. If the value
of this parameter is anything other than {{enum|Complete}}, the
values of the results parameters for this test are indeterminate.
When the diagnostic initiated by the ACS is completed (successfully
or not), the CPE MUST establish a new connection to the ACS to allow
the ACS to view the results, indicating the Event code "8 DIAGNOSTICS
COMPLETE" in the Inform message. After the diagnostic is complete,
the value of all result parameters (all read-only parameters in this
object) MUST be retained by the CPE until either this diagnostic is
run again, or the CPE reboots. After a reboot, if the CPE has not
retained the result parameters from the most recent test, it MUST set
the value of this parameter to {{enum|None}}. Modifying any of the
writable parameters in this object except for this one MUST result in
the value of this parameter being set to {{enum|None}}. While the
test is in progress, modifying any of the writable parameters in this
object except for this one MUST result in the test being terminated
and the value of this parameter being set to {{enum|None}}. While the
test is in progress, setting this parameter to {{enum|Requested}}
(and possibly modifying other writable parameters in this object)
MUST result in the test being terminated and then restarted using the
current values of the test parameters.
Unable to resolve DNSServer Name
{{reference}} This parameter specifies the IP-layer interface over
which the test is to be performed (i.e. the source IP address to use
when performing the test). If {{empty}} is specified, the CPE MUST
use its routing policy (Forwarding table entries), if necessary, 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.
Number of successfully executed repetitions.
{{numentries}} Total number of Result entries from the most recent
invocation of the test.
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. Errors for individual Result instances do not get bubbled up to
{{param|#.DiagnosticsState}}. A failure on a specific attempt does
not mean that the overall test failed, but a failure on all attempts
means that {{param|#.DiagnosticsState}} SHOULD be
{{enum|Error_Other|#.DiagnosticsState}}.
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.
Firewall configuration object.
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-106a2|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.
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.
This object models the CPE's USB Host controllers. See
{{bibref|TR-157|Appendix I}} 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
When set to {{true}}, 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. The value is not saved in the
device's state and setting it to {{false}} has no effect.
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.
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).
This object configures collection of periodic statistics for the
device. Periodic statistics are measured over a sample interval (which
can be aligned with absolute time) and are made available to the ACS as
a comma-separated list of the most recent <n> samples. This
object provides a single set of global settings that affect the entire
device unless overridden locally.
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 ACS 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 ACS 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-106a2}} 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 ACS
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}}.
When set to {{true}}, forces statistics for the current sample to be
calculated and updated in the data model. Setting it to {{false}} has
no effect. {{hidden}} If this is the first time that {{param}} has
been set to {{true}} 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 {{param}} has been set to {{true}}
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 {{param}} was set to {{true}}
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 {{param}}
was set to {{true}} 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 ACS of such changes, as described in {{bibref|TR-069a2|Section
3.2.1}}. 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 multicast announcement and query parameters used
for the purpose of downloading files.
This object contains multicast announcement parameters used to download
files.
Enable/disable CPE ability to receive and use multicast announcements
from a server for the purpose of downloading files.
The status of the announcement service.
MAY be used by the CPE to indicate a locally defined error
condition.
{{numentries}}
Multicast groups to which the CPE SHOULD listen for announcements.
{{datatype|expand}}
Enable/disable listening to this multicast group.
The status of this group table entry.
MAY be used by the CPE to indicate a locally defined error
condition, e.g. unable to parse received announcements.
URL {{bibref|RFC3986}} encoding the group address, source and port on
which to listen, and other protocol information, e.g. expected
announcement format. Depending on the application, the messages
identified by this URL MAY directly contain the data to be
downloaded, or alternatively MAY contain information informing the
CPE how to obtain the data to be downloaded via a separate mechanism,
which itself could involve a unicast or a multicast download
protocol. Refer to {{bibref|DVB-TS.102.824}} for an example of a URL
format that identifies a SAP {{bibref|RFC2974}} stream that indicates
how to use either FLUTE {{bibref|RFC3926}} or DSM-CC
{{bibref|ISO-13818-6:1998}} to perform the download.
This object contains multicast query parameters used to download files.
Enable/disable CPE ability to autonomously query a server for the
purpose of downloading files.
The status of the query service.
MAY be used by the CPE to indicate a locally defined error
condition, e.g. unable to contact query response server.
URL {{bibref|RFC3986}} of the query response server. Depending on the
application, the protocol described by this URL MAY be a SOAP
interface, or MAY be any other RPC mechanism. Refer to
{{bibref|DVB-TS.102.824}} for an example of a URL format that
identifies a SOAP interface running over HTTP or HTTPS.
Top level object for dynamically managed software applications.
{{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 a ChangeDUState is
attempted on a {{object|#.DeploymentUnit}} that is to be applied
against a disabled {{object}}, that ChangeDUState operation fails and
the associated DUStateChangeComplete RPC will contain a FaultStruct
for that operation. If a SetParameterValues is attempted against the
{{param|#.ExecutionUnit.{i}.RequestedState}} for an
{{object|#.ExecutionUnit}} that is associated with a disabled
{{object}} a CWMP Fault will be issued in response. 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 the ACS disabled it, the CWMP management agent might
be terminated leaving the device unmanageable.
Indicates the status of this {{object}}.
Setting this parameter to {{true}} causes this {{object}} to revert
back to the state it was in when the device last issued a "0
BOOTSTRAP" Inform event. The following requirements dictate what MUST
happen for the reset to be complete:
# All Deployment Units that were installed after the last "0
BOOTSTRAP" Inform 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
"0 BOOTSTRAP" Inform event was issued
# Any Deployment Unit that was present when the last "0 BOOTSTRAP"
Inform event was issued, but was subsequently uninstalled and is
now not present, MUST be installed with the version that was
present when the last "0 BOOTSTRAP" Inform event was issued
# The Execution Environment MUST be restored to the version and
configuration present when the last "0 BOOTSTRAP" Inform event was
issued
# The Execution Environment MUST be restarted after all other
restoration requirements have been met
{{datatype|expand}}
A Name provided by the CPE 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 CPE 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}}.
Provides a mechanism to remotely manipulate the run level of this
{{object}}, meaning that altering this parameter's value 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}}. Setting this
value when {{param|CurrentRunLevel}} is -1 has no impact to the Run
Level of this {{object}}.
The run level that this {{object}} is currently operating in. This
value is altered by changing the {{param|RequestedRunLevel}}
parameter. Upon startup (whether that is caused by a CPE 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 {{param|RequestedRunLevel}} 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.
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 ACS, or
generated by the CPE, at the time of Deployment Unit Installation.
The format of this value is defined by {{bibref|RFC4122}} Version 3
(Name-Based) and {{bibref|TR-069a3|Annex H}}. 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-069a3|Annex H}}.
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 URL used by the most recent ChangeDUState RPC 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-069a3|Annex H}}.
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 CPE. 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 CPE. 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.
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.
Indicates the state transition that the ACS is requesting for this
{{object}}. {{enum}} If this {{object}} is associated with an
Execution Environment that is disabled and an attempt is made to
alter this value, then a CWMP Fault MUST be generated.
If this {{object}} is currently in {{enum|Starting|Status}} or
{{enum|Active|Status}} the CPE will attempt to Stop the
Execution Unit; otherwise this requested state is ignored.
If this {{object}} is currently in {{enum|Idle|Status}} the CPE
will attempt to Start the Execution Unit. If this {{object}} is
in {{enum|Stopping|Status}} the request is rejected and a fault
raised. Otherwise this requested state is ignored.
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-106a4|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 {{empty}} and ignored by the ACS.
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 ACS 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}}. See {{bibref|TR-157a3|Appendix II.3.2}} for more
description and some examples. 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
{{object|.DeviceInfo.SupportedDataModel.{i}.}} table.
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 CPE. 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
CPE. 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 CWMP-DT schema instances that have been introduced to
this device because of the existence of this {{object}}.
Represents the {{object|#.ExecEnv}} that this {{object}} is
associated with.
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 {{param|#.SupportedDataModelList}} will be
used to determine their locations. See {{bibref|TR-157a3|Appendix
II.3.2}} for more description and some examples.
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 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 ACS (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-106a4}}. 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 ACS (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-106a4}}.
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-106a4}}. 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 ACS (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-106a4}}.
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 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-106a4|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-106a4|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.
Setting this to {{true}} will cause a reset on the GPS Hardware.
Setting this to {{false}} has no effect.
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-106a4|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 Tunneling.
{{numentries}}
{{numentries}}
{{numentries}}
The maximum number of virtual interfaces.
{{numentries}}
If the SecGW parameters are configured then this parameter determines
whether the CWMP traffic will be sent across the IPsec tunnel(s) or
outside of the IPsec tunnel(s). If {{false}} then the CWMP traffic
will be sent outside of the IPsec tunnel(s). If {{true}} then the
CWMP traffic will be sent across the IPsec tunnel(s).
Indicates the maximum number of child SAs per IKE session that the
device is capable of supporting.
Indicates the maximum number of IKE sessions the device is capable of
supporting at any given time.
This object contains parameters relating to IKEv2 and IPsec crypto
profiles, which are essentially a subset of the typical IPsec SPD.
{{bibref|RFC4301}}. For Cdma2000 devices, see also
{{bibref|3GPP2-S.S0132}}.
Enables and disables this entry.
{{datatype|expand}}
Specifies the Security mechanism and set of credentials used by the
device to authenticate itself (either an instance of the
''.Security.Certificate.'' object defined in {{bibref|TR-157a5}} or
an instance of the
''.Services.FAPService.{i}.Transport.Security.Secret.'' object
defined in {{bibref|TR-196i2}}). {{reference}} If the value is an
{{empty}}, the device chooses the authentication method based on
local policy. In order to configure the device for both device and
hosting-party authentication, the object is populated with an enabled
instance of the ''.Security.Certificate.''. object.
Controls the maximum number of child SAs that can be negotiated by a
single IKE session.
IKEv2 encryption algorithm. {{bibref|RFC4307}} For CDMA2000 devices,
see also {{bibref|3GPP2-S.S0132}}.
IKEv2 pseudo-random function. {{bibref|RFC4307}} For CDMA2000
devices, see also {{bibref|3GPP2-S.S0132}}.
IKEv2 integrity function. {{bibref|RFC4307}} For CDMA2000 devices,
see also {{bibref|3GPP2-S.S0132}}.
IKEv2 pseudo-random function. {{bibref|RFC4307}} For CDMA2000
devices, see also {{bibref|3GPP2-S.S0132}}.
IPsec encryption algorithm. {{bibref|RFC4835|Section 3.1.1}} For
CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
IPsec integrity function. {{bibref|RFC4835|Section 3.1.1}} For
CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
The size of the Anti-Replay Window. If 0 Sequence Number Verification
is disabled. For UMTS devices, see {{bibref|3GPP-TS.32.582}} and
{{bibref|3GPP-TS.32.584}}. For LTE devices, see
{{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
IKEv2 SA rekey timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
IPsec SA rekey timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
IPsec SA rekey timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
DPD timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
NAT-T keepalive timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
Maximum fragment size, in {{units}}, from device before Encryption.
For CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
Indicates if the 'Do Not Fragment' bit needs to be turned on/off. For
CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
IKE IPsec Security Association Table. This Table is a member of the
IPsec Security Association Database (SAD). {{bibref|RFC4301}}.
The status of this IKE SA entry.
This value MAY be used by the CPE to indicate a locally defined
error condition.
The IP address of the peer SecGW.
The time that the current IKE SA was set up.
The current IP address assigned to this interface by IKEv2.
The current subnet mask assigned to this interface by IKEv2.
{{list}} Each item is an IP Address of a DNS server for this
interface assigned to this interface by IKEv2.
{{list}} Each item is an IP address of a DHCP server for this
interface. A non empty list instructs the CPE to send any internal
DHCP request to the address contained within this parameter.
The number of inbound packets discarded by the IKE SA due to
Integrity checking errors.
The number of inbound packets discarded by the IKE SA due to other
errors, such as anti-replay errors.
The number of inbound packets discarded by the IKE SA due to
authentication errors.
Child IPsec Security Association Table. This Table is a member of the
IPsec Security Association Database (SAD). {{bibref|RFC4301}}.
{{reference}}
SPI value of the Child SA.
Traffic Direction. If {{true}} this Child SA refers to outbound
traffic. If {{false}} this Child SA refers to inbound traffic.
The time that the current Child SA was set up.
The measured traffic in {{units}} transferred by the Child SA.
The number of inbound {{units}} discarded by the Child SA due to
integrity checking errors.
The number of inbound {{units}} discarded by the Child SA due to
anti-replay errors.
Virtual Interfaces used for associating the tunnel (ephemeral) childSA
pairs with QoS Classification and Queue tables as defined in
{{bibref|TR-098a2}}
(InternetGatewayDevice.QueueManagement.Classification.{i}. and
InternetGatewayDevice.QueueManagement.Queue.{i}.) or
{{bibref|TR-181i2}} (Device.QoS.Classification.{i}. and
Device.QoS.Queue.{i}.).
Enables and disables this entry.
{{datatype|expand}}
{{reference}} If multiple instances of VirtualInterface point to the
same CryptoProfile instance, the associated
{{param|#.CryptoProfile.{i}.MaxChildSA}} determines whether a new IKE
session will be created (dynamically) to negotiate the child SA(s)
for each of the virtual interfaces; otherwise, they are negotiated
through the same IKE session.
DSCP to mark the outer IP header for traffic that is associated with
this virtual interface. A value of -1 indicates copy from the
incoming packet. A value of -2 indicates automatic marking of DSCP as
defined for the UMTS QoS class {{bibref|3GPP-TS.23.107}} or CDMA2000
Subscriber QoS profile {{bibref|3GPP2-X.S0011}}. De-tunneled packets
are never re-marked.
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}}
URL specifying the destination file location. HTTP and HTTPS
transports MUST be supported. Other transports MAY be supported. This
argument specifies only the destination file location, and does not
indicate in any way the name or location of the local file to be
uploaded.
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-106a4|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. If InternetGatewayDevice:1
{{bibref|TR-098}} or Device:1 {{bibref|TR-181i1}}) is used as root
data model the {{param}} MUST point to a row in the
''.FAP.Tunnel.IKESA.{i}.'' table. If the root data model used is
Device:2 {{bibref|TR-181i2}} than the {{param}} MUST point to an
tunnel instance defined in this 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}}.
Bulk Data collection utilizes the IPDR solution to collect data from
devices based on a service specification described in
{{bibref|TR-232}}. 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. This object provides bulk data
collection capabilities and global collection settings that affect the
entire device.
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 Protocols that this device is capable of
supporting.
IPDR Streaming Protocol {{bibref|IPDR-SP}}
IPDR File Transfer Protocol {{bibref|IPDR-FTP}}
Represents the IPDR Encoding Types that this device is capable of
supporting.
{{bibref|IPDR-XML}}
{{bibref|IPDR-XDR}}
The maximum number of profiles that can exist at any given time.
Specifically, the maximum number of {{object|Profile.{i}.}} instances
that the ACS 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 ACS 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 IPDR Protocol being used for this collection profile.
The IPDR 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-106a2}} 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 IANA default port for {{bibref|IPDR-SP}}
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}}). An ACS 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'.
ASCII values of '0' - '9'
ASCII values of 'A' - 'Z'
This is the URL within the CPE that is used by an IPDR Collector to
retrieve the IPDRDocs when this collection profile is configured for
the IPDR File Transfer Protocol {{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 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.
Represents the parameter(s) that are part of this Bulk Data
collection profile. In the case where a partial parameter path is
specified all sub-objects 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 '.'.
Properties for Domain Name Service (DNS). It contains the Service
Discovery (DNS-SD) objects.
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}}
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.
The {{object}} represents the XMPP capabilities of the device as
described in {{bibref|TR-069a5|Appendix III}}.
{{numentries}}
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 an ACS 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. {{enum}}
Use the connection algorithm as specified in
{{bibref|RFC6120|Section 3.2}} where the value of the
{{param|Domain}} parameter is used to look up the server
address and port to use.
Use the instances of the {{object|Server}} table based on the
values of the {{param|Server.{i}.Priority}} and
{{param|Server.{i}.Weight}} parameters as the basis for
reconnect. Instances must be reachable and reachable instances
with the lowest value MUST be preferred.
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}}, as
specified in {{bibref|TR-069a5|Annex K XMPP Connection Request}}. 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 as specified in
{{bibref|TR-069a5|Annex K XMPP Connection Request}}. 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 an ACS 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".
Note that support for this profile implies support for the requirements
of {{bibref|TR-069a5|Annex L}}.