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.
3GPP TS 23.003
Numbering, addressing and identification
3GPP CT WG4
https://www.3gpp.org/ftp/Specs/html-info/23003.htm
Organizationally Unique Identifiers (OUIs)
https://standards.ieee.org/faqs/regauth
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
IEEE
March 1997
https://standards.ieee.org/regauth/oui/tutorials/EUI64.html
IANA Uniform Resource Identifier (URI) Schemes Registry
Uniform Resource Identifier (URI) Schemes
IANA
https://www.iana.org/assignments/uri-schemes
RFC 2616
Hypertext Transfer Protocol - HTTP/1.1
IETF
RFC
1999
https://www.rfc-editor.org/rfc/rfc2616
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 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
RFC 4291
IP Version 6 Addressing Architecture
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4291
RFC 4632
Classless Inter-domain Routing (CIDR): The Internet Address Assignment
and Aggregation Plan
IETF
2006
https://www.rfc-editor.org/rfc/rfc4632
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 8089
The "file" URI Scheme
IETF
RFC
February 2017
https://www.rfc-editor.org/rfc/rfc8089
RFC 8141
Uniform Resource Names (URNs)
IETF
RFC
April 2017
https://www.rfc-editor.org/rfc/rfc8141
TR-069 Amendment 1
CPE WAN Management Protocol
Broadband Forum
TR
December 2006
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-106 Amendment 8
Data Model Template for CWMP Endpoints and USP Agents
Broadband Forum
TR
May 2018
Blue
A New Class of Active Queue Management Algorithms
https://en.wikipedia.org/wiki/Blue_(queue_management_algorithm)
HTML 4.01 Specification
W3C
https://www.w3.org/TR/html4
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
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-106}}.
Number of instances of {{object|LANDevice}}.
Number of instances of {{object|WANDevice}}.
This object contains general services information.
This object contains general device information.
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. The value MUST be a valid OUI as defined in {{bibref|OUI}}.
Model name of the CPE (human readable string).
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.
Serial number of the CPE.
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.
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-069a1}}. 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}}.
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}}
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).
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.
This object contains parameters relating to the CPE's association with an ACS.
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-098a1|section 2.2}} 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 {{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.
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.
Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see {{bibref|TR-069a1|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}}.
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).
Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to {{bibref|TR-069a1|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}}.
This object contains parameters relating an NTP or SNTP time client in the CPE.
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 offset from UTC in the form:
: +hh:mm
: -hh:mm
Name of the local time zone (human readable string).
Whether or not daylight savings time is in use in the CPE's local time zone.
Date and time daylight savings time begins if used in local standard time. If daylight savings time is not used, this value is ignored.
Date and time daylight savings time ends if used in local daylight time. If daylight savings time is not used, this value is ignored.
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 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.
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.
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 {{param}} and {{param|Interface}} SHOULD be configured for a route.
If both are configured, {{param}} and {{param|Interface}} MUST be self-consistent.
Specifies the egress interface associated with this entry. The content is the full hierarchical parameter name of 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 self-consistent.
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 optional 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.
Specifies the WAN or LAN IP-layer interface over which the test is to be performed. The content is the full hierarchical parameter name of the interface.
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 contains all LAN-related objects for a given bridged subnet.
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.
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 (0) or a relay (1) 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.
Specifies last address in the pool to be assigned by the DHCP server on the LAN interface.
Comma separated list of addresses marked reserved from the address allocation pool.
Specifies the client's network subnet mask.
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.
{{enum}}
If {{enum|Normal}}, then DHCP addresses are to be allocated out of a private address pool.
If {{enum|UseAllocatedSubnet}}, instructs the CPE to allocate DHCP addresses from the WAN subnet block for the WAN connection identified in {{param|AssociatedConnection}}.
If {{enum|Passthrough}}, then the specified LAN Host identified by the Passthrough MAC address is given the WAN IP address.
Specifies the connection instance for the connection 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 the default layer-3 connection object. Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
DHCP lease time in seconds given to the specified LAN Host when the WAN IP address is passed-through.
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 the WAN IP address if {{param|UseAllocatedWAN}} is {{enum|Passthrough|UseAllocatedWAN}}.
Hardware addresses that are allowed to connect to this connection if ''MACAddressControlEnabled'' is 1 for a given interface.
Number of IP interface at LAN side of the CPE. 1 is a typical value for CPE not supporting Multihomed interfaces. Support for more than one interface instance is OPTIONAL.
IP interface table.
Enables or disables this entry. On creation, an entry is disabled by default.
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.
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.
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.
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 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.
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.
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 cells sent over the interface since the CPE was last reset.
Total number of cells received over the interface since the CPE was last reset.
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.
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. Note: There is currently no way of requesting automatic selection of a channel.
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.
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 the access point radio is enabled.
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).
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.
The number of devices currently associated with the access point. This corresponds to the number of entries in the {{object|AssociatedDeivce}} table.
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).
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.
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.
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 (RFC2898).
The MAC address associated with a preshared key, or {{empty}} if no MAC address is associated with the key.
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.
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 zero for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE.
Each instance contains all objects associated with a particular physical WAN interface.
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.
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 the type of modulation used on the connection.
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 whether the data path is fast (lower latency) or interleaved (lower error rate).
ADSL Interleaved depth. This variable is only applicable 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.
The current physical layer aggregate data rate (expressed in Kbps) of the downstream DSL connection.
The current attainable rate (expressed in Kbps) of the upstream DSL channel.
The current attainable rate (expressed in Kbps) of the downstream DSL channel.
The current signal-to-noise ratio (expressed in 0.1 db) of the upstream DSL connection.
The current signal-to-noise ratio (expressed in 0.1 db) of the downstream DSL connection.
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.
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.
ATU-R T1.413 Revision Number as defined in T1.413 Issue 2.
ATU-R Vendor Revision Number as defined in T1.413 Issue 2.
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.
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.
ATU-C T1.413 Revision Number as defined in T1.413 Issue 2.
ATU-C Vendor Revision Number as defined in T1.413 Issue 2.
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.
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 is not required 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 is not required to do so.
Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.
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.
Total number of successfully transmitted blocks, where a block is as defined in RFC 2662.
Total number of cell-delineation errors (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1).
Total number of link-retrain errors (Full Initialization Count as defined in ITU-T Rec. G.997.1).
Total number of initialization errors (LINIT failures as defined in ITU-T Rec. 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).
Total number of errored seconds (ES-L as defined in ITU-T Rec. G.997.1).
Total number of severely errored seconds (SES-L as defined in ITU-T Rec. G.997.1).
Total number of FEC errors detected (FEC-C as defined in ITU-T Rec. G.997.1).
Total number of FEC errors detected by the ATU-C (FEC-CFE as defined in ITU-T Rec. G.997.1).
Total number of HEC errors detected (HEC-P as defined in ITU-T Rec. G.997.1).
Total number of HEC errors detected by the ATU-C (HEC-PFE as defined in ITU-T Rec. G.997.1).
Total number of CRC errors detected (CV-C as defined in ITU-T Rec. G.997.1).
Total number of CRC errors detected by the ATU-C (CV-CFE as defined in ITU-T Rec. G.997.1).
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.
Number of successfully transmitted blocks since the most recent DSL Showtime, where a block is as defined in RFC 2662.
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).
Number of link-retrain errors since the most recent DSL Showtime (Full Initialization Count as defined in ITU-T Rec. G.997.1).
Number of initialization errors since the most recent DSL Showtime (LINIT failures as defined in ITU-T Rec. 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).
Number of errored seconds since the most recent DSL Showtime (ES-L as defined in ITU-T Rec. G.997.1).
Number of severely errored seconds since the most recent DSL Showtime (SES-L as defined in ITU-T Rec. G.997.1).
Number of FEC errors detected since the most recent DSL Showtime (FEC-C as defined in ITU-T Rec. G.997.1).
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).
Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. G.997.1).
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).
Number of CRC errors detected since the most recent DSL Showtime (CV-C as defined in ITU-T Rec. G.997.1).
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).
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.
Number of successfully transmitted blocks since the second most recent DSL Showtime, where a block is as defined in RFC 2662.
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).
Number of link-retrain errors since the second most recent DSL Showtime (Full Initialization Count as defined in ITU-T Rec. G.997.1).
Number of initialization errors since the second most recent DSL Showtime (LINIT failures as defined in ITU-T Rec. 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).
Number of errored seconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. G.997.1).
Number of severely errored seconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. G.997.1).
Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. G.997.1).
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).
Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. G.997.1).
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).
Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. G.997.1).
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).
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.
Number of successfully transmitted blocks during the current day, where a block is as defined in RFC 2662.
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).
Number of link-retrain errors during the current day (Full Initialization Count as defined in ITU-T Rec. G.997.1).
Number of initialization errors during the current day (LINIT failures as defined in ITU-T Rec. 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).
Number of errored seconds during the current day (ES-L as defined in ITU-T Rec. G.997.1).
Number of severely errored seconds during the current day (SES-L as defined in ITU-T Rec. G.997.1).
Number of FEC errors detected during the current day (FEC-C as defined in ITU-T Rec. G.997.1).
Number of FEC errors detected by the ATU-C during the current day (FEC-CFE as defined in ITU-T Rec. G.997.1).
Number of HEC errors detected during the current day (HEC-P as defined in ITU-T Rec. G.997.1).
Number of HEC errors detected by the ATU-C during the current day (HEC-PFE as defined in ITU-T Rec. G.997.1).
Number of CRC errors detected during the current day (CV-C as defined in ITU-T Rec. G.997.1).
Number of CRC errors detected by the ATU-C during the current day (CV-CFE as defined in ITU-T Rec. G.997.1).
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.
Number of successfully transmitted blocks during the current quarter hour, where a block is as defined in RFC 2662.
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).
Number of link-retrain errors during the current quarter hour (Full Initialization Count as defined in ITU-T Rec. G.997.1).
Number of initialization errors during the current quarter hour (LINIT failures as defined in ITU-T Rec. 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).
Number of errored seconds during the current quarter hour (ES-L as defined in ITU-T Rec. G.997.1).
Number of severely errored seconds during the current quarter hour (SES-L as defined in ITU-T Rec. G.997.1).
Number of FEC errors detected during the current quarter hour (FEC-C as defined in ITU-T Rec. G.997.1).
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).
Number of HEC errors detected during the current quarter hour (HEC-P as defined in ITU-T Rec. G.997.1).
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).
Number of CRC errors detected during the current quarter hour (CV-C as defined in ITU-T Rec. G.997.1).
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).
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.
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.
Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream linear channel characteristics per subcarrier. Each successive pair of integers represents the real and imaginary parts of each complex value. Maximum number of complex pairs is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream quiet line noise per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream SNR per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream bit allocation per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. Interpretation of the value is as defined in ITU-T Rec. G.997.1.
Downstream gain allocation per subcarrier. Maximum number of elements is 256 for ADSL and ADSL2, 512 for ADSL2+. 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 this case of DSL, each instance corresponds to a single ATM VC. On creation of a ''WANConnectionDevice'' instance, there are initially no connection objects contained within.
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 ''PPPoE'' has always been DEPRECATED and ''EoA'' should be used instead (see {{bibref|TR-098a1|Annex B}}). The ACS MUST NOT set this parameter to ''PPPoE'' and the CPE MUST reject attempts to do so.
RFC2684 bridged Ethernet over ATM
RFC2684 routed IP over ATM
RFC2364 PPP over ATM
RFC2516 PPP over Ethernet on RFC2684 bridged Ethernet over ATM
RFC1577 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 1483. It is only applicable in the upstream direction.
Comma separated 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 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.
Enables or disables the connection instance. On creation of a ''WANIPConnection'' instance, it is initially disabled.
Current status of the connection.
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}}.
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.
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.
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.
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 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.
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'').
Total number of bytes sent over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Total number of bytes received over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Total number of Ethernet packets sent over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Total number of Ethernet packets received over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
This object enables configuration of PPP connections on the WAN interface of a CPE.
Enables or disables the connection instance. On creation of a ''WANPPPConnection'' instance, it is initially disabled.
Current status of the connection.
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.
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.
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.
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.
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.
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 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.
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'').
Total number of bytes sent over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Total number of bytes received over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Total number of Ethernet packets sent over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Total number of Ethernet packets received over all connections within the same ''WANConnectionDevice'' that share a common MAC address since the CPE was last reset.
Layer-2 bridging table. 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.
The maximum number of entries available in the {{object|Bridge}} table.
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.
Bridge table.
Unique key for each Bridge table entry.
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.
The 802.1Q VLAN ID associated with this Bridge.
A value of 0 indicates either Untagged or PriorityOnly tagging, which are treated identically.
Filter table containing filter entries each of which is associated with one Bridge as specified by a ''Bridge'' table entry.
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.
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.
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 the default association between layer-3 and layer-2 objects implied by the ''InternetGatewayDevice'' object hierarchy.
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 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'').
* ''LANInterfaces'' indicates that this Filter is associated with all LAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface'').
* ''WANInterfaces'' indicates that this Filter is associated with all WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''WANInterface'').
* {{empty}} indicates the Filter table entry is not associated with any interface (and has no effect)
The 802.1Q VLAN ID of packets to admit to the specified Bridge through the interfaces specified for this Filter.
A value of -1 indicates that the default VLAN ID for the Bridge SHOULD be used instead (as specified by {{param|InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID}} for the Bridge table entry associated with this Filter table entry). On creation of a Filter entry, the default value for this parameter MUST be -1.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits only packets tagged with a VLAN ID that matches the {{param|VLANIDFilter}} parameter (or instead, the VLAN ID for the Bridge if {{param|VLANIDFilter}} is unspecified).
If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits both packets tagged with a VLAN ID that matches the {{param|VLANIDFilter}} parameter (or instead, the VLAN ID for the Bridge if {{param|VLANIDFilter}} is unspecified), and any Untagged or PriorityOnly packets. All Untagged or PriorityOnly packets are tagged on ingress with the value of the {{param|VLANID}} parameter.
If the {{param|VLANIDFilter}} parameter (or instead, the VLAN ID for the Bridge if {{param|VLANIDFilter}} is unspecified) is equal to 0, then this parameter is ignored, and only packets that are Untagged or PriorityOnly packets are admitted.
Comma-separated list of unsigned integers, each representing an Ethertype value.
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.
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 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.
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.
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 it its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132) 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 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.
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 it its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132) 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|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.
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 it its DHCP Client Identifier (Option 61 as defined in RFC 2132) 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 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.
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 it its DHCP Client Identifier (Option 61 as defined in RFC 2132) 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|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.
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 it its DHCP User Class Identifier (Option 77 as defined in RFC 3004) 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 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.
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 it its DHCP User Class Identifier (Option 77 as defined in RFC 3004) 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.
Marking table identifying non-default layer-2 marking behavior for packets on egress from the specified interfaces.
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.
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 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'').
* ''LANInterfaces'' indicates that this Marking table entry is associated with all LAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface'').
* ''WANInterfaces'' indicates that this Marking table entry is associated with all WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''WANInterface'').
* {{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 Untagged. That is, the VLAN tag is stripped from the packet.
If {{false}}, on egress to the interfaces associated with this Marking table entry, all VLAN tags are left intact (including those added on ingress).
The 802.1Q VLAN ID to be used on egress to the interfaces associated with this Marking table entry (if {{param|VLANIDUntag}} is {{false}}).
A value of -1 indicates that the default VLAN ID for the Bridge SHOULD be used instead (as specified by {{param|InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID}} for the Bridge table entry associated with this Marking table entry).
Ethernet priority code (as defined in 802.1D) 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.
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.
If {{param|VLANIDUntag}} is {{true}}, then no priority marking is done since the tag containing the Ethernet priority is removed.
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.
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.
This table SHOULD contain a single entry for each available LAN and WAN interface.
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.LANLANEthernetInterfaceConfig.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.
Identifier of the forwarding policy associated with traffic not associated with any specified classifier.
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.
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.
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.
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.
{{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.
Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132.
{{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.
Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132.
{{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.
{{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.
{{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.
{{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.
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).
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 result.
Identifier of the forwarding policy associated with traffic that falls in this classification.
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}} and {{param|ClassApp}} are mutually exclusive and one of the two MUST be specified. If {{param}} is 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|ClassQueue}} and {{param}} are mutually exclusive and one of the two MUST be specified. If {{param|ClassQueue}} is null, {{param}} MUST be specified, and vice versa.
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.
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.
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.
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.
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.
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.
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.
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.
{{enum|TwoRateThreeColor}} makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}}, {{param|PeakRate}}, and {{param|PeakBurstSize}} as defined in RFC 2698.
Supported meter types.
Instructions for how to handle traffic that is conforming. {{pattern}}
{{pattern|Null}} corresponds with no action.
A {{pattern|Count}} action increases the meter instance count statistics.
''<DSCP Value>'' is an unsigned integer that corresponds with a mark action overwriting the traffic's DSCP with the configured DSCP.
<DSCP Value>
Instructions for how to handle traffic that is partially conforming (colored yellow). {{pattern}}
{{pattern|Null}} corresponds with no action.
A {{pattern|Count}} action increases the meter instance count statistics.
''<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.
<DSCP Value>
Instructions for how to handle traffic that is non-conforming. {{pattern}}
{{pattern|Null}} corresponds with no action.
A {{pattern|Count}} action increases the meter instance count statistics.
''<DSCP Value>'' is an unsigned integer that corresponds with a mark action overwriting the traffic's DSCP with the configured DSCP.
<DSCP Value>
Number of Packets counted as result of a count meter action.
Number of Bytes counted as result of a count 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.
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.
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.