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 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 6
CPE WAN Management Protocol
Broadband Forum
TR
April 2018
TR-098 Amendment 2 Corrigendum 1
Internet Gateway Device Data Model for TR-069
Broadband Forum
TR
December 2014
TR-106 Amendment 8
Data Model Template for CWMP Endpoints and USP Agents
Broadband Forum
TR
May 2018
HTML 4.01 Specification
W3C
https://www.w3.org/TR/html4
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.
Comma-separated list of 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-069}}. Only those options are listed whose State
indicates the option is enabled.
Represents any additional hardware version information the vendor may
wish to supply.
Represents any additional software version information the vendor may
wish to supply.
This parameter is deprecated Represents the version of the
specification implemented by the device. Currently 1.0 is the only
available version.
Identifier of the primary service provider and other provisioning
information, which MAY be used by the Server 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.
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.
Name of the vendor configuration file.
A string identifying the configuration file version currently used in
the CPE.
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 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 server-side certificate authentication when using SSL or
TLS.
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.
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.
Whether or not the CPE must periodically send CPE information to
Server 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 should
initiate the Inform method calls. Each Inform call must occur at this
reference time plus or minus an integer multiple of the
{{param|PeriodicInformInterval}}. A zero dateTime value
(0000-00-00T00:00:00) indicates that no particular time reference is
specified. That is, the CPE may locally choose the time reference,
required only to adhere to the specified
{{param|PeriodicInformInterval}}.
{{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 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 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 to which a
web-server associated with the ACS may redirect a user's browser on
initiation of a file download to observer the status of the download.
This object contains parameters relating an NTP or SNTP time client in
the CPE. Support for this object is Optional.
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. Support for this object is Optional.
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.
This table MUST NOT include routes learned through dynamic layer-3
routing protocols, such as RIP or OSPF.
Enables or disables the forwarding entry. On creation, an entry is
disabled by default.
Indicates the status of the forwarding entry.
Indicates the type of route.
Destination address. {{empty}} or a value of "0.0.0.0" indicates no
destination address is specified.
Destination subnet mask. {{empty}} or a value of "0.0.0.0" indicates
no destination subnet mask is specified.
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.
IP address of the gateway.
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''.
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.
This object is provides access to an IP-layer ping test.
Indicates availability of diagnostic data. {{enum}} Value may be set
to {{enum|Requested}} to initiate the diagnostic test. When writing,
the only allowed value is {{enum|Requested}}. To ensure the use of
the proper test parameters (the writable parameters in this object),
the test parameters MUST be set either prior to or at the same time
as (in the same SetParameterValues) setting the {{param}} to
{{enum|Requested}}. When requested, the CPE SHOULD wait until after
completion of the communication session with the ACS before starting
the diagnostic. When the diagnostic initiated by the ACS is completed
(successfully or not), the CPE MUST establish a new connection to the
ACS to allow the ACS to view the results, indicating the Event code
''8 DIAGNOSTICS COMPLETE'' in the Inform message.
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''
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.
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.
Comma separated list of 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.
Comma separated list of 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) may 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.
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.
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.
Indicates the status of this interface.
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 breacon types to be use with this connection.
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 mode the device is currently operating
in.
The index of the default WEP key.
A passphrase from which the WEP keys were generated. This parameter
for information only-the CPE is not responsible for generating the
key based on the passphrase. This parameter is the same as the
parameter
{{param|InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.KeyPassprhase}}
for the same instance of ''WLANConfiguration''. When either parameter
is changed, the value of the other is changed as well. 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.
Encryption modes that are available when basic 802.11 is enabled.
{{enum|WEPEncryption}} implies that all wireless clients can use WEP
for data encryption.
Authentication modes that are available when basic 802.11 is enabled.
Encryption modes that are available when WPA is enabled.
Authentication modes that are available when WPA is enabled.
Encryption modes that are available when 802.11i is enabled.
Authentication modes that are available when 802.11i is enabled.
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
is inferred from the key length, e.g. 10 characters for 40-bit
encryption, or 26 characters for 104-bit encryption.
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 ''PreSharedKey''
(''InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.PreSharedKey'').
A passphrase from which WEP or PSK keys were generated. This
parameter for information only-the CPE is not responsible for
generating the key based on the passphrase. For WEP keys it 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. For WPA PSK, the key is generated as
specified by WPA, which uses PBKDF2 from PKCS #5: Password-based
Cryptography Specification Version 2.0 (RFC2898).. Note: The 802.11i
standard specifies rules for generation of WEP keys from a
passphrase.
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.
Specifies the maximum downstream theoretical bit rate for the WAN
device in bits per second.
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.
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}}.
Signifies the line pair that the modem is using to connection.
{{param}} = 1 is the innermost pair.
The current payload bandwidth (expressed in Kbps) of the upstream DSL
channel.
The current payload bandwidth (expressed in Kbps) of the downstream
DSL channel.
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.
T.35 country code of the ATU-R vendor as defined in G.994.1.
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.
T.35 country code of the ATU-C vendor as defined in G.994.1.
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 may not always be
possible.
Number of seconds since the most recent DSL Showtime-the beginning of
the period used for collection of Showtime{{bibref|RFC2616}}
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 may 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 may
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.
Total number of successfully transmitted blocks.
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.
Number of successfully transmitted blocks since the most recent DSL
Showtime.
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.
Number of successfully transmitted blocks since the second most
recent DSL Showtime.
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.
Number of successfully transmitted blocks during the current day.
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.
Number of successfully transmitted blocks during the current quarter
hour.
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.
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 required for a CPE with a DSL modem WAN interface
Number of table entries in the ConnectionService table.
This table contains an entry for each connection service.
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''.
Destination address of the WANConnectionDevice entry. One of:
* ''PVC: VPI/VCI''
* ''SVC: ATM connection name''
* ''SVC: ATM address''
Link Type of the WANConnectionDevice entry. One of Link Types as
described in ''WANDSLLinkConfig''
Connection Type of the ''WANPPPConnection'' or ''WANIPConnection''
entry. One of ''PossibleConnectionTypes'' as described in
''WAN**Connection'' service.
User-readable name of the connection.
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}} Value may be set
to {{enum|Requested}} to initiate the 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 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.
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.
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''
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 {{enum|LLC|ATMEncapsulation}} or
{{enum|VCMUX|ATMEncapsulation}} 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 blocks.
The current count of successfully received blocks.
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.
Count of the ATM layer cyclic redundancy check errors.
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}} Value may be set
to {{enum|Requested}} to initiate the diagnostic test. When writing,
the only allowed value is {{enum|Requested}}. To ensure the use of
the proper test parameters (the writable parameters in this object),
the test parameters MUST be set either prior to or at the same time
as (in the same SetParameterValues) setting the {{param}} to
{{enum|Requested}}. When requested, the CPE SHOULD wait until after
completion of the communication session with the ACS before starting
the diagnostic. When the diagnostic initiated by the ACS is completed
(successfully or not), the CPE MUST establish a new connection to the
ACS to allow the ACS to view the results, indicating the Event code
''8 DIAGNOSTICS COMPLETE'' in the Inform message.
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. This object is intended only for all
''WANConnectionDevice''s not employing PPP addressing, and must not be
active for ''WANConnectionDevice''s that do employ PPP addressing.
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.
Comma separated list of 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.
Defines the Rx protocol to be used.
Total number of port mapping entries.
Rate to shape this connection's egress traffic to. If <= 100, in
percent of the rate of the highest rate-constrained layer over which
the packet will travel on egress. The rate is limited over the window
period specified by {{param|ShapeWindow}}. If > 100, in bits per
second. A value of -1 indicates no shaping.
Burst Size in bytes.
Port mapping table.
This table MUST NOT contain dynamic NAT binding entries.
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. A
value of 0 means the port mapping is static. Static port mappings do
not necessarily mean persistence of these mappings across device
resets or reboots.
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.
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.
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.
The IP address or DNS host name of an internal client (on the LAN).
Support for an IP address is mandatory, while support for DNS host
names is optional. This value cannot be {{empty}}. 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. This object is intended only for all
''WANConnectionDevice''s that employ PPP addressing, and must not be
active for ''WANConnectionDevice''s that do not employ PPP addressing.
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.
Comma separated list of 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}}.
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).
PPP transport type of the connection.
for future use
for future use
PPPoE Access Concentrator.
PPPoE Service Name.
Trigger used to establish the IP connection.
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. If <= 100, in
percent of the rate of the highest rate-constrained layer over which
the packet will travel on egress. The rate is limited over the window
period specified by {{param|ShapeWindow}}. If > 100, in bits per
second. A value of -1 indicates no shaping.
Burst Size in bytes.
Port mapping table.
This table MUST NOT contain dynamic NAT binding entries.
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. A
value of 0 means the port mapping is static. Static port mappings do
not necessarily mean persistence of these mappings across device
resets or reboots.
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|RemoteHost}} 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.
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.
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.
The IP address or DNS host name of an internal client (on the LAN).
Support for an IP address is mandatory, while support for DNS host
names is optional. This value cannot be {{empty}}. 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|AvailableInterfaces}} table.
Bridge table.
Unique key for each Bridge table entry.
Enables or disables this Bridge table entry.
The status of this Bridge table entry.
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.
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
should 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.
Comma-separated list of MAC Addresses. 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 may 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.
Comma-separated list of MAC Addresses. 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 may 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.
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 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 as defined in {{bibref|TR-098|Appendix 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 as defined in
{{bibref|TR-098|Appendix A}}.
Comma-separated list of 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-098|Appendix A}} as
well as other URNs defined elsewhere.
Classification table.
Unique key for each classification entry.
Enables or disables this classifier.
The status of this classifier.
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'', or
''LAN**InterfaceConfig'' 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.LANLANEthernetInterfaceConfig.2''
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 as defined in
{{bibref|TR-098|Appendix 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 as defined in {{bibref|TR-098|Appendix 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. ClassQueue and ClassApp are mutually exclusive and one of
the two must be specified. If ClassQueue is null, 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. ClassQueue and ClassApp are mutually exclusive
and one of the two must be specified. If ClassQueue is null, ClassApp
must be specified, and vice versa.
Application table.
Unique key for each App table entry.
Enables or disables this App table entry.
The status of this App table entry.
URN identifying the protocol associated with the given application. A
set of defined URNs is given in {{bibref|TR-098|Appendix 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 as defined in
{{bibref|TR-098|Appendix 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 as defined in {{bibref|TR-098|Appendix A}}.
Flow table.
Unique key for each Flow table entry.
Enables or disables this Flow table entry.
The status of this Flow table entry.
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-098|Appendix 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 as
defined in {{bibref|TR-098|Appendix 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 as defined in
{{bibref|TR-098|Appendix A}}.
Policer table.
Unique key for each policer entry.
Enables or disables this policer.
The status of this policer.
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.
Unique key for each queue entry.
Enables or disables this queue.
The status of this queue.
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'', or ''LAN**InterfaceConfig'' 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.
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 Discard threshold; in case the {{param|DropAlgorithm}}
is {{enum|RED|DropAlgorithm}}, this is the threshold to use.
Random Early Discard percentage; in case the {{param|DropAlgorithm}}
is {{enum|RED|DropAlgorithm}}, this is the percentage to use.
Dropping algorithm used for this queue if congested.
Scheduling Algorithm used by scheduler.
strict priority
Rate to shape this queue's traffic. If <= 100, in percent of the
rate of the highest rate-constrained layer over which the packet will
travel on egress. The rate is limited over the window period
specified by {{param|ShapeWindow}}. If > 100, in bits per second.
A value of -1 indicates no shaping.
Burst Size in bytes.