{{docname|Device Data Model for TR-069}}
{{appdate|8 September 2014}}
{{trname|TR-181i2a8}}
* Added LLDP and HTIP home network topology discovery parameters, G.997.1-2012 DSL parameters, various WiFi parameters (associated device statistics, retry limits, reports, QoS), and other minor changes
* Updated G.hn data model to align with G.9962
* Updated Annex B on tunneling, and added GRE and MAP data models
* Added PCP data model
Enables or disables data gathering on the DSL line.
This parameter is DEPRECATED because its entries are out-of-date; {{param|XTSE}} points to a current list. Therefore its value MAY be {{empty}} if (and only if) {{param|XTSE}} is supported.
This configuration parameter defines the transmission system types to be allowed by the xTU on this {{object}} instance. Each bit is 0 if not allowed or 1 if allowed, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1.
Note: This parameter is defined as xDSL Transmission system enabling (XTSE) in ITU-T G.997.1. For a full definition, see Clause 7.3.1.1.1 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter is DEPRECATED because its entries are out-of-date; {{param|XTSE}} points to a current list. Therefore its value MAY be {{empty}} if (and only if) {{param|XTSUsed}} is supported.
This parameter indicates which DSL standard and recommendation are currently in use by the {{object}} instance. Only one bit is set, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1.
The success failure cause of the initialization. An enumeration of the following integer values:
* 0: Successful
* 1: Configuration error. This error occurs with inconsistencies in configuration parameters, e.g. when the line is initialized in an xDSL Transmission system where an xTU does not support the configured Maximum Delay or the configured Minimum or Maximum Data Rate for one or more bearer channels.
* 2: Configuration not feasible on the line. This error occurs if the Minimum Data Rate cannot be reached on the line with the Minimum Noise Margin, Maximum PSD level, Maximum Delay and Maximum Bit Error Ratio for one or more bearer channels.
* 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout.
* 4: No peer xTU detected. This error occurs if the peer xTU is not powered or not connected or if the line is too long to allow detection of a peer xTU.
* 5: Any other or unknown Initialization Failure cause.
* 6: ITU T G.998.4 retransmission mode was not selected while RTX_MODE = FORCED or with RTX_MODE = RTX_TESTMODE.
Note: In G.997.1, this parameter is called "Initialization success/failure cause". See Clause 7.5.1.6 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter contains the estimated electrical loop length estimated by the VTU-R expressed in {{units}} at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of {{units}}.
Note: This parameter is defined as UPBOKLE-R in Clause 7.5.1.23.2 of ITU-T Recommendation {{bibref|G.997.1}}.
VTU-O estimated upstream power back-off electrical length per band.
This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in {{units}} at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported upstream bands. The value of each list element ranges from 0 to 128 dB in steps of {{units}}, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).
Note: This parameter is defined as UPBOKLE-pb in Clause 7.5.1.23.3 of ITU-T Recommendation {{bibref|G.997.1}}.
VTU-R estimated upstream power back-off electrical length per band.
This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in {{units}} at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported downstream bands. The value of each list element ranges from 0 to 128 dB in steps of {{units}}, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).
The value of each list element is coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of {{units}}.
Note: This parameter is defined as UPBOKLE-R-pb in Clause 7.5.1.23.4 of ITU-T Recommendation {{bibref|G.997.1}}.
UPBO downstream receiver signal level threshold.
This parameter reports the downstream received signal level threshold value used in the alternative electrical length estimation method (ELE-M1). This parameter represents an offset from -100 dBm/Hz, and ranges from -64 dB to 0 dB in steps of {{units}}.
The value is coded as a 16 bit number in the range -64 (coded as -640) to 0 dB (coded as 0) in steps of {{units}}.
Note: See ITU-T Recommendation {{bibref|G.997.1}}.
This parameter indicates the actual active rate adaptation mode in the downstream direction.
* If {{param}} equals 1, the link is operating in RA-MODE 1 (MANUAL).
* If {{param}} equals 2, the link is operating in RA-MODE 2 (AT_INIT).
* If {{param}} equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
* If {{param}} equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).
Note: This parameter is defined as ACT-RA-MODEds in Clause 7.5.1.33.1 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter indicates the actual active rate adaptation mode in the upstream direction.
* If {{param}} equals 1, the link is operating in RA-MODE 1 (MANUAL).
* If {{param}} equals 2, the link is operating in RA-MODE 2 (AT_INIT).
* If {{param}} equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
* If {{param}} equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).
Note: This parameter is defined as ACT-RA-MODEus in Clause 7.5.1.33.2 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the downstream direction. The format and usage is identical to the channel status parameter {{param|#.Channel.{i}.ACTINP}}.
Note: This parameter is defined as ACTINP-ROC-ds in Clause 7.5.1.34.1 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the upstream direction. The format and usage is identical to the channel status parameter {{param|#.Channel.{i}.ACTINP}}.
Note: This parameter is defined as ACTINP-ROC-us in Clause 7.5.1.34.2 ITU-T Recommendation {{bibref|G.997.1}}.
This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the downstream direction (expressed in {{units}}). The format is identical to the format of the line status parameter SNRM margin {{param|DownstreamNoiseMargin}}.
Note: This parameter is defined as SNRM-ROC-ds in Clause 7.5.1.35.1 ITU-T Recommendation {{bibref|G.997.1}}.
This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the upstream direction (expressed in {{units}}). The format is identical to the format of the line status parameter SNRM margin ({{param|UpstreamNoiseMargin}}).
Note: This parameter is defined as SNRM-ROC-us in Clause 7.5.1.35.2 ITU-T Recommendation {{bibref|G.997.1}}.
This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2.
Note: see ITU-T Recommendation {{bibref|G.993.2}}.
This parameter is the maximum depth of the entire data gathering event buffer at the VTU-R, in number of {{units}}, where each of the {{units}} consists of 6 bytes indicating a data gathering event as defined in {{bibref|G.993.2}}.
Note: This parameter is defined as LOGGING_DEPTH_R in Clause 7.5.3.2 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter is actual logging depth that is used for reporting the VTU-R event trace buffer over the eoc channel, in number of {{units}}, where each of the {{units}} consists of 6 bytes indicating a data gathering event as defined in {{bibref|G.993.2}}.
Note: This parameter is defined as ACT_LOGGING_DEPTH_REPORTING_R in Clause 7.5.3.4 of ITU-T Recommendation {{bibref|G.997.1}}.
This parameter identifies the log file of the the data gathering event trace buffer containing the event records that originated at the VTU-R.
This indicates the table entry that represents a Vendor Log File that contains the data gathering buffer at the VTU-R in the {{object|###.DeviceInfo.VendorLogFile}} table.
This data gathering buffer MAY be retrieved wia an upload RPC of the identified Vendor Log File.
Note: This parameter is defined as EVENT_TRACE_BUFFER_R in Clause 7.5.3.6 of ITU-T Recommendation {{bibref|G.997.1}} and Clause 11.5 of ITU-T Recommendation {{bibref|G.993.2}}.
Actual net data rate expressed in {{units}}. Independent whether retransmission is used or not in a given transmit direction:
* In L0 state, this parameter reports the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) at which the bearer channel is operating.
* In L2 state, the parameter contains the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) in the previous L0 state.
Note: See ITU-T Recommendation {{bibref|G.997.1}}.
Actual impulse noise protection against REIN, expressed in {{units}}.
If retransmission is used in a given transmit direction, this parameter reports the actual impulse noise protection (INP) against REIN (under specific conditions detailed in [ITU T G.998.4]) on the bearer channel in the L0 state. In the L2 state, the parameter contains the INP in the previous L0 state.
The value is coded in fractions of DMT symbols with a granularity of 0.1 symbols.
The range is from 0 to 25.4. A special value of 25.5 indicates an ACTINP_REIN of 25.5 or higher.
Note: This parameter is defined as ACTINP_REIN in Clause 7.5.2.9 of ITU-T Recommendation {{bibref|G.997.1}}.
This object models cellular interfaces and access points.
Enables or disables roaming.
Current roaming status.
{{numentries}}
{{numentries}}
Cellular interface table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Each instance of this object models a cellular modem with a single radio and a single {{object|USIM}}.
Enables or disables the interface.
This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}}
When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a fault condition on the interface).
When {{param|Enable}} is changed to {{true}} then {{param}}
* SHOULD change to {{enum|Up}} if and only if the interface is able to transmit and receive network traffic.
* SHOULD change to {{enum|Dormant}} if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to {{enum|Up}} if still operable when the expected actions have completed)
* SHOULD remain in the {{enum|Error}} state if there is an error or other fault condition detected on the interface
* SHOULD remain in the {{enum|NotPresent}} state if the interface has missing (typically hardware) components; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason.
Because the interface includes layer 1 the {{enum|LowerLayerDown}} value SHOULD never be used.
This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}.
Corresponds to {{enum|GPRS|CurrentAccessTechnology}}, {{enum|UMTS|CurrentAccessTechnology}}, {{enum|LTE|CurrentAccessTechnology}} etc ''ATTACHED'' status
Corresponds to {{enum|GPRS|CurrentAccessTechnology}}, {{enum|UMTS|CurrentAccessTechnology}}, {{enum|LTE|CurrentAccessTechnology}} etc ''DETACHED'' status
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its current operational state.
{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used.
Indicates whether the interface points towards the Internet ({{true}}) or towards End Devices ({{false}}).
For example:
* For an Internet Gateway Device, {{param}} will be {{true}} for all WAN interfaces and {{false}} for all LAN interfaces.
* For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, {{param}} will be {{true}} for the Ethernet interface and {{false}} for the WiFi Radio interface.
* For an End Device, {{param}} will be {{true}} for all interfaces.
International Mobile Station Equipment Identity number, represented as a 15 digit string (digits 0-9).
Access technologies supported by the interface.
GSM with GPRS
GSM with EDGE
UMTS with High Speed Packet Access (HSPA {{bibref|3GPP-HSPA}})
Preferred access technology.
Access technology that is currently in use.
List of available networks.
Name of the network which will be used, or {{empty}} if the network is selected automatically.
The value is {{empty}} if no network is found, or if the network specified in {{param|NetworkRequested}} is not found.
The received signal strength in {{units}}. The allowed values depend on {{param|CurrentAccessTechnology}}:
* For {{enum|GPRS|SupportedAccessTechnologies}}, {{enum|EDGE|SupportedAccessTechnologies}} the range is -111 {{units}} to -49 {{units}}
* For {{enum|UMTS|SupportedAccessTechnologies}}, {{enum|UMTSHSPA|SupportedAccessTechnologies}} the range is -117 {{units}} to -54 {{units}}
* For {{enum|LTE|SupportedAccessTechnologies}} the range is -117 {{units}} to -25 {{units}}
Note: An undetectable signal is indicated by the appropriate lower limit, e.g. -117 {{units}} for LTE.
The current maximum attainable data rate upstream (expressed in {{units}}).
The current maximum attainable data rate downstream (expressed in {{units}}).
USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface.
The current status of the USIM card.
No card available
Card is available but not verified
Card can be used; either valid PIN was entered, or PIN check is deactivated
USIM is blocked because the maximum number of invalid PIN entries was exceeded
An error was detected with the card
International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN).
Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:
* Major industry identifier (MII), 2 fixed digits, 89 for telecommunication purposes.
* Country code, 1–3 digits, as defined by ITU-T recommendation {{bibref|ITU-E.164}}.
* identifier, 1–4 digits.
* Individual account identification number. Its length is variable, but every number under one IIN will have the same length.
* Single check digit calculated from the other digits using the Luhn algorithm.
For cards using an ICCID according to {{bibref|ITU-E.118}} the maximum length is 19 Digits, for GSM cards 20 digits.
Mobile Subscriber Integrated Service Digital Network Number, a number uniquely identifying a subscription in a GSM, UMTS, or LTE mobile network. {{bibref|ITU-E.164}}
Controls the PIN verification of the USIM card.
Check the PIN with each access to a new network
Check the PIN with first access after (re)boot
Disable the PIN check
Allows the ACS to change the USIM PIN used for SIM card activation.
Throughput statistics for this interface.
The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.
The total number of bytes transmitted out of the interface, including framing characters.
The total number of bytes received on the interface, including framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted because of errors.
The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.
The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent.
The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.
The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.
The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.
The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent.
The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.
The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent.
The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.
The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.
Cellular Access Point table. Each entry is identified by an {{param|APN}} (Access Point Name) that identifies a gateway between the mobile network and another computer network.
Enables or disables the Access Point.
{{datatype|expand}}
Access Point Name.
Username used to authenticate the CPE when making a connection to the Access Point.
Password used to authenticate the CPE when making a connection to the Access Point.
Proxy server IP address.
Proxy server port.
Reference to the interface with which the access point is associated.
Indicates whether this physical ethernet port supports Energy Efficient Ethernet as specified in {{bibref|802.3-2012_section6|Section 78}}.
Whether Energy Efficient Ethernet {{bibref|802.3-2012_section6|Section 78}} support is currently enabled. When enabled, this ethernet port will be capable of entering or exiting Low Power Idle (LPI) mode.
This parameter is DEPRECATED because it has been replaced by {{param|MediumType}}.
The maximum PHY data rate that the interface is capable of transmitting (expressed in {{units}}).
Indicates a request to force the role of the G.hn interface to Domain Master (DM) for the G.hn domain it is connected to. The selection of the Domain Master follows the procedures described in {{bibref|G.9961|Clause 8.6.6}}.
Indicates whether this G.hn interface is currently the Domain Master (DM) for the G.hn domain it is connected to, as described in {{bibref|G.9961|Clause 8.6}}.
Indicates a request to force the role of the G.hn interface to Security Controller (SC) for the G.hn domain it is connected to. The selection of the Security Controller follows the procedures described in {{bibref|G.9961|Clause 9.2}}.
Indicates whether this G.hn interface is currently the Security Controller (SC) for the G.hn domain it is connected to, as described in {{bibref|G.9961|Clause 9.2}}.
The standard versions that the interface supports. The list MUST have an even number of items. The first item of each pair represents an ITU-T G.hn Recommendation while the second element of each pair represents the amendment version of the indicated Recommendation that this interface supports (the value 0 corresponds to the base Recommendation).
For example, to indicate support for the G.9960 base document and G.9961 amendment 1, the corresponding list would be "G9960,0,G9961,1".
The largest bandplan that the interface can support, as defined in {{bibref|G.9961|Clause 8.8.5.5}}.
The medium type that the interface currently operates on. Refer to {{bibref|G.9962|Table 7-5}}.
The Acknowledgement InterFrame Gap, or TAIFG, as defined in {{bibref|G.9961|Clause 8.4}}. It is represented as multiples of {{units}}.
A bit map representing usage of international amateur bands (0 = masked, 1 = unmasked). The LSB represents the lowest band (1.8-2.0 MHz), the second LSB represents the second lowest band (3.5-4.0 MHz), and so on. The maximum value for this parameter is 0x03FF, i.e. it is a 10-bit quantity represented in 16 bits and the top 6 bits are always zero.
International Radio amateur bands are described in {{bibref|G.9964|Table D-1}} and conveyed by the Domain Master in the Amateur radio band descriptor (see {{bibref|G.9961|Table 8-77}}).
Comma-separated list of DeviceIDs of nodes that need to enable their PHY throughput diagnostics mode. All devices that are enabled will participate in the G.hn network PHY throughput diagnostics process.
Comma-separated list of DeviceIDs of nodes that need to enable their Performance Monitoring diagnostics mode on this node. All devices that are enabled will participate in the G.hn network Performance Monitoring diagnostics process.
{{numentries}}
This object specifies management parameters pertaining to the domain functionality (Domain Master function; see {{bibref|G.9961|Clause 8.6}}). The object exists only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter {{param|#.IsDM}} is {{true}}.
This is the domain name to which the interface is currently registered. {{empty}} indicates that the interface is currently not registered.
The Domain Name Identifier, a shortened version of {{param|DomainName}}, denoted as DNI in {{bibref|G.9961|Section 8.6.11.2.1}}.
The Domain Identifier of the domain to which the interface is registered, denoted as DOD in {{bibref|G.9961}}.
The MAC cycle duration, as specified in {{bibref|G.9961|Clause 8.4}}. It is represented as multiples of {{units}}. In the case of power line, writing to this parameter has no effect and it reads back as 0, which is a special value indicating that the MAC cycle is synchronized with 2 AC cycles as defined in {{bibref|G.9961|Clause 8.6.3.1}}.
The DEVICE_ID of the Security Controller selected by the Domain Master.
The REGID of the Security Controller selected by the Domain Master.
The time interval for periodic re-registration, as specified in {{bibref|G.9961|Clause 8.8.5.8}}. It is represented as multiples of {{units}}.
The time interval that a node sends out the periodic topology update using TM_NodeTopologyChange.ind message, as specified in {{bibref|G.9961|Clause 8.8.5.8.1}}. It is represented as multiples of {{units}}. The special value 0 represents an infinite interval (i.e., no periodic topology update).
Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain.
Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain.
This object specifies management parameters pertaining to the Security Controller functionality (Security Controller function; see {{bibref|G.9961|Clause 9.2}}). The object exists only on G.hn interfaces that are currently the Security Controller, i.e. for which parameter {{param|#.IsSC}} is {{true}}.
The security modes that the Security Controller can support. Refer to {{bibref|G.9961|Clause 9.2}}.
Node-to-Node
Network Membership Key
The security mode in which the Security Controller is operating.
The selected MIC size used in the domain.
Indicates whether the Security Controller is above the L1 reference point. It is set to {{true}} if the Security Controller is above the L1 reference point, and set to {{false}} otherwise.
Specifies the list of masked bands to be applied to the G.hn interface. This information is conveyed by the Domain Master in the SM descriptor as specified in {{bibref|G.9961|Table 8-77}}.
Instances of this object are expected to exist only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter {{param|#.IsDM}} is {{true}}.
Enables or disables the {{object}}.
The masked band number.
Index of the lowest frequency sub-carrier in the band to be masked as specified in {{bibref|G.9961|Table 8-79}}. This parameter is writable only on the interface which acts as the Domain Master.
Index of the highest frequency sub-carrier in the band to be masked as specified in Table 8-79 in {{bibref|G.9961}}. This parameter is writable only on the interface which acts as the Domain Master.
Throughput statistics for this interface at the different G.hn reference points described in {{bibref|G.9961|Clause 8.1}}.
The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.
More specifically, this is the total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in {{bibref|G.9960|Clause 5.2.1}}), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in {{bibref|G.9961|Clause 8.1}}). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets).
Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.
More specifically, this is the total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It can include blocks with errors.
Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.
More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.
More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.
More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).
More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.
More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.
More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.
More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).
More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.
More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.
More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.
More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.
More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.
More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.
The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead.
The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead.
The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in {{bibref|G.9961|Clause 8.1.3}}) that were transmitted by the node through a physical medium.
The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium.
The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs.
The total number of LPDUs that were received by the node through a physical medium, with or without errors.
The total number of LPDUs that were retransmitted.
The total number of received LPDUs that contained errors.
Note the following relationships hold:
* PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
* PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
* Retransmission rate = BlocksResent / BlocksSent.
* Block error rate = BlocksErrorReceived / BlocksReceived.
This is denoted as REGID in {{bibref|G.9961}}.
Device Id (as defined in G.hn) for the remote G.hn device, denoted as DEVICE_ID in {{bibref|G.9961}}.
Refer to Note 1 of {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down.
Refer to Note 1 of {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down.
If {{param}} is {{true}}, it indicates that the Status of the remote device is 0, 1, or 2 (see {{bibref|G.9961|Table 7-3}}).
The G.hn Diagnostics object.
G.hn PHY throughput diagnostics configuration and results.
When diagnostics are requested, all G.hn nodes for which the {{param|##.Interface.{i}.PHYThroughputDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
Indicates availability of diagnostic data for PHYThroughput measurements {{enum}}
If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above.
After the diagnostic is complete, the value of all result parameters (all read-only parameters in the Diagnostics object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}.
The interface over which the test is to be performed.
The MAC address of the originating G.hn interface of the link that is being diagnosed.
Note: This MAC address might belong to another node of the domain.
{{numentries}}
PHY throughput diagnostics results.
MAC address of the destination node of the link being measured.
Indicates the state of the link between the G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and the G.hn Interface with MAC address {{param|DestinationMACAddress}}.
There is a direct link between G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and G.hn Interface with MAC address {{param|DestinationMACAddress}}
There is no direct link between G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and G.hn Interface with MAC address {{param|DestinationMACAddress}}
PHY data rate in transmit direction in the link between the G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and the G.hn Interface with MAC address {{param|DestinationMACAddress}}. It is represented in {{units}} as defined in Note 1 to {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down.
PHY data rate in receive direction in the link between the G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and the G.hn Interface with MAC address {{param|DestinationMACAddress}}. It is represented in {{units}} as defined in Note 1 to {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down.
G.hn Performance Monitoring diagnostics configuration and results.
When diagnostics are requested, all G.hn nodes for which the {{param|##.Interface.{i}.PerformanceMonitoringDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
Indicates availability of diagnostic data for Performance Monitoring. {{enum}}
If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above.
After the diagnostic is complete, the value of all result parameters (all read-only parameters in the Diagnostics object) MUST be retained by the node until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}.
The interface over which the test is to be performed.
The MAC address of the originating G.hn interface of the link that is being diagnosed.
Note: This MAC address might belong to another node of the domain.
Time in {{units}} between automatic collection of performance monitoring data. A value of zero disables automatic collection of data.
The node MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error.
If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the device MAY choose to align sample intervals with time of day, but is not required to do so.
The number of sub-carriers in a group to be used for averaging SNR values when providing SNR information for a channel.
Per-node G.hn performance monitoring results.
When automatic collection is enabled, i.e. {{param|#.SampleInterval}} is non-zero, the "current" interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any.
When automatic collection is disabled, i.e. SampleInterval is zero, the "current" interval is defined by the three most recent manual samples.
Note: Packets in statistics counters are Ethernet packets.
Start time for the current interval.
When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample.
When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago.
End time for the current interval.
When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty.
When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample.
{{numentries}} This is the number of G.hn nodes for which performance monitoring results were collected during the current sample interval.
Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses {{param|##.DiagnoseMACAddress}}) and {{param|DestinationMACAddress}}).
Note: Packet counters indicate the number of packets received between {{param|#.CurrentStart}} and {{param|#.CurrentEnd}}.
MAC address of the destination node of the link being measured.
The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in {{bibref|G.9960|Clause 5.2.1}}), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in {{bibref|G.9961|Clause 8.1}}). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets).
Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.
The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors.
Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.
The total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.
The total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.
The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}). This parameter represents the total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in in {{bibref|G.9961|Clause 8.1.3}}) that were transmitted by the node through a physical medium) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).
The total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in {{bibref|G.9960|Clause 5.2.1}}). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.
The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.
The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.
The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).
The total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.
The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.
The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.
The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.
The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.
The total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.
The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead.
The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead.
The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in {{bibref|G.9961|Clause 8.1.3}}) that were transmitted by the node through a physical medium.
The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium.
The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs.
The total number of LPDUs that were received by the node through a physical medium, with or without errors.
The total number of LPDUs that were retransmitted.
The total number of received LPDUs that contained errors.
Note the following relationships hold:
* PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
* PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
* Retransmission rate = BlocksResent / BlocksSent.
* Block error rate = BlocksErrorReceived / BlocksReceived.
Per-channel G.hn performance monitoring results.
Note: channels are unidirectional.
Time at which channel data was last collected.
{{numentries}}
Per-channel G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected from the channel between a G.hn interface (as indicated by {{param|##.DiagnoseMACAddress}}) and a G.hn interface indicated by {{param|DestinationMACAddress}})
MAC address of the destination node of the link being measured.
The result of an SNR test performed over the channel. It is formatted as a comma-separated list of N/M unsigned integers that represents the result of Signal-to-Noise-Ratio measurement averaging in groups of M subcarriers. The number N depends on the bandplan used by the node and corresponds to the OFDM control parameter N of each medium as defined in {{bibref|G.9964}}. The number M corresponds to the parameter {{param|##.SNRGroupLength}}.
The maximum number of retransmissions of a short packet i.e. a packet that is no longer than the {{param|RTSThreshold}}. This corresponds to IEEE 802.11 parameter ''dot11ShortRetryLimit'' {{bibref|802.11-2012}}.
A request for the clear channel assessment (CCA) report in the format specified in {{bibref|802.11-2012|Clause 8.4.2.23.3}}.
The clear channel assessment (CCA) report in the format specified in {{bibref|802.11-2012|Clause 8.4.2.24.3}}.
When read, the value of this parameter MUST correspond to {{param|CCARequest}}. How this is achieved is a local matter to the CPE.
If this parameter is read before a CCARequest has been issued, then its value is {{empty}}.
A request for a received power indicator (RPI) histogram in the format specified in {{bibref|802.11-2012|Clause 8.4.2.23.4}}.
Received power indicator (RPI) histogram report in the format specified in {{bibref|802.11-2012|Clause 8.4.2.24.4}}.
This specifies the current maximum size, in {{units}}, of the MPDU that can be delivered to the PHY. This parameter is based on ''dot11FragmentationThreshold'' from {{bibref|802.11-2012}}.
This indicates the number of {{units}} in an MPDU, below which an RTS/CTS handshake is not performed. This parameter is based on ''dot11RTSThreshold'' from {{bibref|802.11-2012}}.
This indicates the maximum number of transmission attempts of a frame, the length of which is greater than {{param|RTSThreshold}}, that will be made before a failure condition is indicated. This parameter is based on ''dot11LongRetryLimit'' from {{bibref|802.11-2012}}.
Time interval between transmitting beacons (expressed in {{units}}). This parameter is based on ''dot11BeaconPeriod'' from {{bibref|802.11-2012}}.
This specifies the number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM Count field is 0. This parameter is based on ''dot11DTIMPeriod'' from {{bibref|802.11-2012}}.
This determines whether or not packet aggregation (commonly called "frame aggregation") is enabled. This applies only to 802.11n.
The type of preamble. Longer preambles (more overhead) are needed by 802.11g to coexist with legacy systems 802.11 and 802.11b.
{{list}} The set of data rates, in ''Mbps'', that have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed in {{param}}. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in {{param}}.
{{list}} Maximum access point data transmit rates in ''Mbps'' for unicast frames (a superset of {{param|BasicDataTransmitRates}}). Given the value of {{param|BasicDataTransmitRates}} from the example above, {{param}} might be "1,2,5.5,11", indicating that unicast frames can additionally be transmitted at 5.5 Mbps and 11 Mbps.
{{list}} Data transmit rates in ''Mbps'' for unicast frames at which the access point will permit a station to connect (a subset of {{param|OperationalDataTransmitRates}}). Given the values of {{param|BasicDataTransmitRates}} and {{param|OperationalDataTransmitRates}} from the examples above, {{param}} might be "1,2,5.5", indicating that the AP will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps, even though it could theoretically accept connections at 11 Mbps.
An indicator of average noise strength received at this radio, measured in {{units}}. This measurement of non-IEEE 802.11 noise power is made by sampling the channel when virtual carrier sense indicates idle and this radio is neither transmitting nor receiving a frame.
This parameter is DEPRECATED because it is really a {{object|#.Radio}} attribute. Use {{param|#.Radio.{i}.RetryLimit}}.
These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames.
The CPE MUST reset these {{object}} parameters (unless otherwise stated in individual object or parameter descriptions) either when the {{param|##.Status}} of the parent {{object|##}} object transitions from {{enum|Disabled|##.Status}} to {{enum|Enabled|##.Status}}, or when it transitions from {{enum|Enabled|##.Status}} to {{enum|Disabled|##.Status}}.
The total number of bytes transmitted to the Associated Device, including framing characters.
The total number of bytes received from the Associated Device, including framing characters.
The total number of packets transmitted to the Associated Device.
The total number of packets received from the Associated Device.
The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes.
The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two.
The number of packets that were not transmitted successfully due to the number of retransmission attempts exceeding an 802.11 retry limit. This parameter is based on ''dot11FailedCount'' from {{bibref|802.11-2012}}.
The number of packets that were successfully transmitted after one or more retransmissions. This parameter is based on ''dot11RetryCount'' from {{bibref|802.11-2012}}.
The number of packets that were successfully transmitted after more than one retransmission. This parameter is based on ''dot11MultipleRetryCount'' from {{bibref|802.11-2012}}.
This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the {{param|AccessCategory}} parameter as follows:
* BE (Best Effort)
* BK (Background)
* VI (Video)
* VO (Voice)
This identifies the access category.
{{datatype|expand}}
Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space.
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255, (expressed in {{units}}).
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255, (expressed in {{units}}).
Maximum transmit opportunity, in multiples of {{units}}. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU).
Ack Policy, where False="Do Not Acknowledge" and True="Acknowledge"
{{list}} Definition of the histogram intervals for counting the transmit queue length in packets. Each value indicates the maximum value of the interval. For example, "0,1,4,8," defines the five intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No value after the last comma means no upper bound.) If this parameter is set to {{empty}}, no {{param|Stats.OutQLenHistogram}} stats will be collected.
The time between recording samples of the current transmit queue in {{units}}.
This object contains statistics for different 802.11e access categories (priorities).
Packet counters here count 802.11 WiFi frames.
If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE).
The CPE MUST reset the Access Point's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point's Status parameter transitions to a Diasbled state) or when the Access Point becomes administratively up (i.e. the Access Point's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2].
The total number of {{units}} transmitted in this access category, including framing characters.
The total number of {{units}} received in this access category, including framing characters.
The total number of {{units}} transmitted in this access category.
The total number of {{units}} received in this access category.
The total number of outbound {{units}} in this access category that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes.
The total number of inbound {{units}} in this access category that contained errors preventing them from being delivered to a higher-layer protocol.
The total number of outbound {{units}} in this access category which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.
The total number of inbound {{units}} in this access category which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.
The total number of transmitted {{units}} in this access category which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two.
{{list}} Histogram of the total length of the transmit queue of this access category in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|#.OutQLenHistogramIntervals}}, with samples taken each {{param|#.OutQLenHistogramSampleInterval}}. Example: "12,5,1,0,2,0,0,1".
This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the {{param|AccessCategory}} parameter as follows:
* BE (Best Effort)
* BK (Background)
* VI (Video)
* VO (Voice)
This identifies the access category.
{{datatype|expand}}
Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space.
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255, (expressed in {{units}}).
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255, (expressed in {{units}}).
Maximum transmit opportunity, in multiples of {{units}}. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU).
Ack Policy, where False="Do Not Acknowledge" and True="Acknowledge"
{{list}} Definition of the histogram intervals for counting the transmit queue length in packets. Each value indicates the maximum value of the interval. For example, "0,1,4,8," defines the five intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no {{param|Stats.OutQLenHistogram}} stats will be collected.
The time between recording samples of the current transmit queue {{units}}.
This object contains statistics for different 802.11e access categories (priorities).
Packet counters here count 802.11 WiFi frames.
If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE).
The CPE MUST reset the EndPoint's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the EndPoint becomes operationally down due to a previous administrative down (i.e. the EndPoint's Status parameter transitions to a Diasbled state) or when the EndPoint becomes administratively up (i.e. the EndPoint's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2].
The total number of {{units}} transmitted in this access category, including framing characters.
The total number of {{units}} received in this access category, including framing characters.
The total number of {{units}} transmitted in this access category.
The total number of {{units}} received in this access category.
The total number of outbound {{units}} in this access category that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes.
The total number of inbound {{units}} in this access category that contained errors preventing them from being delivered to a higher-layer protocol.
The total number of outbound {{units}} in this access category which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.
The total number of inbound {{units}} in this access category which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.
The total number of transmitted {{units}} in this access category which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two.
{{list}} Histogram of the total length of the transmit queue of this access category in packets (1 packet, 2 packets, etc.) according to the intervals defined by {{param|#.OutQLenHistogramIntervals}}, with samples taken each {{param|#.OutQLenHistogramSampleInterval}}. Example: "12,5,1,0,2,0,0,1"
Note that {{enum|Tunnel|Type}} and {{enum|Tunneled|Type}} IP interfaces are part of a legacy mechanism that is only used for {{object|##.IPv6rd}}, {{object|##.DSLite}} and {{object|##.IPsec}} tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms {{enum|Normal|Type}} IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above {{object|##.GRE.Tunnel.{i}.Interface}} or {{object|##.MAP.Domain.{i}.Interface}} objects.
Only used with legacy ({{enum|Tunnel}},{{enum|Tunneled}}) IP interface pairs
Only used with legacy ({{enum|Tunnel}},{{enum|Tunneled}}) IP interface pairs
Assigned by MAP {{bibref|MAP}}, i.e. is this interface's ''MAP IPv6 address''
Indicates that Ping over IPv4 is supported.
Indicates that Ping over IPv6 is supported.
Indicates that TraceRoute over IPv4 is supported.
Indicates that TraceRoute over IPv6 is supported.
The CPE can not reach the requested Ping host address
{{reference}} The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1
If {{empty}} is specified, the CPE MUST use the interface as directed by its routing policy (''Forwarding'' table entries) to determine the appropriate interface.
Indicates the IP protocol to be used.
Use either IPv4 or IPv6 depending on the system preference
Use IPv4 for the Ping requests
Use IPv6 for the Ping requests
Indicates which IP address was used to send the Ping request. The parameter is only valid if the {{param|DiagnosticsState}} is {{enum|Complete|DiagnosticsState}}.
The CPE can not reach the requested TraceRoute host address
{{reference}} The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1
If {{empty}} is specified, the CPE MUST use the interface as directed by its routing policy (''Forwarding'' table entries) to determine the appropriate interface.
Indicates the IP protocol to be used.
Use either IPv4 or IPv6 depending on the system preference
Use IPv4 for the TraceRoute
Use IPv6 for the TraceRoute
Indicates which IP address was used for TraceRoute. The parameter is only valid if the {{param|DiagnosticsState}} is {{enum|Complete|DiagnosticsState}}.
This object contains Link Layer Discovery Protocol (LLDP) {{bibref|802.1AB-2009}} related objects and parameters.
This object is used for managing the discovery of LLDP devices.
The CPE MAY, but need not, retain some or all of the information in this object across reboot.
{{numentries}}
This table contains information about discovered LLDP devices.
{{reference|the interface via which the LLDP device was discovered}}
The chassis identifier subtype, which is included in the value of the ''LLDPDU's'' Chassis ID TLV (TLV Type = 1). The following subtype values are defined:
* ''0'' (Reserved)
* ''1'' (Chassis component)
* ''2'' (Interface alias)
* ''3'' (Port component)
* ''4'' (MAC address)
* ''5'' (Network address)
* ''6'' (Interface name)
* ''7'' (Locally assigned)
* ''8-255'' (Reserved)
Note: It is assumed that this integer might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the Chassis ID is set to the representative MAC address (chassis ID subtype = 4) for ''HTIP-Ethernet Bridge''.
The chassis identifier, which is included in the value of the ''LLDPDU's'' Chassis ID TLV (TLV Type = 1).
Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the Chassis ID is set to the representative MAC address. If ''LLDPDU''s are sent and received from two or more LLDP agents of the same ''HTIP-Ethernet Bridge'', this value is same in all ''LLDPDU''s.
{{list}}Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this device.
When the entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.
{{numentries}}
This table contains information about ports on discovered LLDP devices.
The port identifier subtype, which is included in the value of the ''LLDPDU's'' Port ID TLV (TLV Type = 2). The following subtype values are defined:
* ''0'' (Reserved)
* ''1'' (Interface alias)
* ''2'' (Port component)
* ''3'' (MAC address)
* ''4'' (Network address)
* ''5'' (Interface name)
* ''6'' (Agent circuit ID)
* ''7'' (Locally assigned)
* ''8-255'' (Reserved)
The port identifier, which is included in the value of the ''LLDPDU's'' Port ID TLV (TLV Type = 2).
The ''LLDPDU'' lifetime (in {{units}}), which is the value of the latest TimeToLive TLV (TLV Type = 3).
If this value is 0, it means that the LLDP agent or the MAC service function of the port is stopped.
The port description, which is the value of the latest Port Description TLV (TLV Type = 4), or {{empty}} if no Port Description TLV has been received.
Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the parameter value is likely to be one of the names defined in {{bibref|JJ-300.00|Appendix A (''List of Interface Standard Names'')}}.
The device's MAC addresses, which are included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no list of MAC addresses has been received.
The parameter is relevant when there is a LLDP device which has a MAC copy function and has two or more MAC addresses.
Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the {{bibref|OUI}} in the third octet is E0271A (''TTC-OUI'') and the organizationally defined subtype in the sixth octet is 3 (''MAC Address List'').
The date and time at which the last LLDPDU was received for this ({{object|#}},{{object}}).
The port's link information, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, the {{bibref|OUI}} in the third octet is E0271A (''TTC-OUI'') and the organizationally defined subtype in the sixth octet is 2 (''Link Information'').
The port's interface type, or 0 if no interface type has been received.
Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, it's an IANA interface type {{bibref|IANAifType}}.
For example, IANAifType defines the following interface types for wired line (UTP cable), wireless line, power line, and coaxial cable:
* ''6'' (Wired line)
* ''71'' (Wireless)
* ''174'' (PLC)
* ''236'' (Coaxial cable)
The port's MAC forwarding table, or the value is {{empty}} if no forwarding table was supplied.
The device information, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of ''LLDPDU'', in which the {{bibref|OUI}} in the third octet is E0271A (''TTC-OUI'') and the organizationally defined subtype in the sixth octet is 1 (''Device Information'').
Each list item indicates a device category (e.g."AV_TV" and "AV_Recorder"), or the value is {{empty}} if no device categories were provided.
Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. Standard HTIP device categories are defined in {{bibref|JJ-300.01}}. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.
The manufacturer OUI, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no manufacturer OUI was provided.
{{pattern}}
{{empty}}
The model name, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no model name was provided.
Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}.
The model number, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127), or {{empty}} if no model number was provided.
Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}.
{{numentries}}
The vendor-specific device information, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
{{keys}}
Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) {{bibref|JJ-300.00}} and {{bibref|G.9973}}. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of ''LLDPDU'', in which the {{bibref|OUI}} in the third octet is E0271A (''TTC-OUI''), the organizationally defined subtype in the sixth octet is 1 (''Device Information''), and the device information ID in the seventh octet is 255 (''Vendor-specific extension field'').
The vendor-specific organization code, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
The vendor-specific device information type, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
The vendor-specific device information, which is included in the value of the ''LLDPDU's'' Organizationally Specific TLV (TLV Type = 127).
This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ({{bibref|RFC2784}}) with Key and Sequence Number extensions ({{bibref|RFC2890}}). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of {{object|Filter}} objects to determine the treatment of the packet.
{{numentries}}
{{numentries}}
GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A {{object}} object has one or more {{object|Interface}} objects that further define the sessions or flows within the tunnel.
Enables or disables the tunnel.
The current operational state of the tunnel.
{{datatype|expand}}
The Fully Qualified Domain Name (FQDN) or IP address of the remote GRE tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence.
The mechanism used to keep the tunnel from timing out at the {{param|ConnectedRemoteEndpoint}}.
The tunnel keepalive timeout in {{units}}.
Number of KeepAlive messages unacknowledged by the {{param|ConnectedRemoteEndpoint}} before the {{object}} is perceived failed.
The protocol used for the delivery header.
If the specified entries in the {{object|#.Filter}} table do not match this {{object}} object or an instance of the {{object|Interface}} object for this {{object}} object, then the value of this parameter is applied to the delivery header of the packets in this {{object}}.
The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote GRE tunnel endpoint.
{{numentries}}
Statistics for this GRE tunnel, i.e. all traffic that has passed through the tunnel.
The device MUST reset the tunnel's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from {{false}} to {{true}}).
The total number of KeepAlive {{units}} sent out the tunnel.
The total number of KeepAlive {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} sent by the tunnel.
The total number of {{units}} received by the tunnel.
The total number of {{units}} discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers.
The total number of {{units}} received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol.
GRE Interface table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). The {{object}} object models the GRE Header as defined in {{bibref|RFC2784}} and extensions to the GRE Header as defined in {{bibref|RFC2890}}. The {{object}} object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the {{object}} object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of {{bibref|RFC2890}} is supported there is only one instance of this {{object}} object per tunnel.
Enables or disables the interface.
This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}}
When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a fault condition on the interface).
When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD change to {{enum|Up}} if and only if the interface is able to transmit and receive network traffic; it SHOULD change to {{enum|Dormant}} if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to {{enum|Up}} if still operable when the expected actions have completed); it SHOULD change to {{enum|LowerLayerDown}} if and only if the interface is prevented from entering the {{enum|Up}} state because one or more of the interfaces beneath it is down; it SHOULD remain in the {{enum|Error}} state if there is an error or other fault condition detected on the interface; it SHOULD remain in the {{enum|NotPresent}} state if the interface has missing (typically hardware) components; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason.
This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its current operational state.
{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
The Protocol ID assigned to this {{object}}. The Protocol Id is the EtherType value used to identify the encapsulated payload. When set to {{null}} the CPE determines the Protocol Id.
When {{true}}, includes the "Checksum" field in the GRE header as defined in {{bibref|RFC2784}}.
The method used to generate the Key Identifier extension as defined in.{{bibref|RFC2890}}.
The generation of the Key field is CPE specific implementation.
When the value of {{param|KeyIdentifierGenerationPolicy}} is {{enum|Provisioned|KeyIdentifierGenerationPolicy}} this {{param}} parameter is used to identify an individual traffic flow within a GRE tunnel, as defined in {{bibref|RFC2890}}.
When {{true}}, includes the "SequenceNumber" field in the GRE header as defined in {{bibref|RFC2890}}
Statistics for this GRE tunnel interface, i.e. all traffic that has passed through the interface.
The device MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e., the interface's Status parameter transitions to a down state after the interface has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from {{false}} to {{true}}).
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} sent by this interface.
The total number of {{units}} received by this interface.
The total number of {{units}} discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers.
The total number of {{units}} received by this interface that contained errors preventing them from being delivered to a higher-layer protocol.
The total number of {{units}} received by the tunnel interface that are discarded because of Checksum errors.
The total number of {{units}} received by the tunnel interface that are discarded because of Sequence Number errors.
GRE Filter table. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions:
* If the value of the {{param|AllInterfaces}} is {{true}}, then this entry will be applied to all {{object|#.Tunnel}} and {{object|#.Tunnel.{i}.Interface}} instances.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of {{param|Interface}} parameter is a reference to a row in the {{object|#.Tunnel}} table then this entry is applied to all {{object|#.Tunnel.{i}.Interface}} instances of the {{object|#.Tunnel}} reference.
* If the value of {{param|AllInterfaces}} is {{false}} and the value of {{param|Interface}} parameter is a reference to a row in the {{object|#.Tunnel.{i}.Interface}} table then this entry is applied to the {{object|#.Tunnel.{i}.Interface}} reference.
* If no entries are matched for the packet, then the default treatment (e.g., {{param|#.Tunnel.{i}.DefaultDSCPMark}}) is applied to the packet.
For enabled table entries, if {{param|Interface}} is not a valid reference and {{param|AllInterfaces}} is {{false}}, then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}.
Enables or disables this filter.
The status of this filter. {{enum}}
The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid.
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
Position of the {{object}} entry in the order of precedence. A value of ''1'' indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.
When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.
The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).
A non-volatile handle used to reference this instance. {{param}} provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.
Filter criterion. {{reference}}
Filter criterion. This specifies that all ingress GRE tunnel interfaces are associated with the entry. If {{true}}, the value of {{param|Interface}} is ignored since all ingress GRE tunnel interfaces are indicated.
Filter criterion.
Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering.
If {{false}}, the filter includes only those packets that match the {{param|VLANIDCheck}} entry, if specified.
If {{true}}, the filter includes all packets except those that match the {{param|VLANIDCheck}} entry, if specified.
DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion.
Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
* A value of -1 indicates copy from the upstream packet.
* A value of -2 indicates automatic marking of DSCP.
The Mapping of Address and Port (MAP) object {{bibref|MAP}} {{bibref|MAP-T}} {{bibref|MAP-DHCP}}. This object applies only to gateway devices that support IPv4 on the LAN side, include a {{object|#.NAT}}, and typically have only IPv6 connectivity on the WAN side.
See the MAP Theory of Operation {{bibref|TR-181i2a8|Appendix XV}} for a description of the working of this MAP data model.
Enables or disables MAP.
{{numentries}}
MAP domain settings {{bibref|MAP}}. Each instance models a MAP domain.
MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):
* MAP-E ({{param|TransportMode}} = {{enum|Encapsulation|TransportMode}}) uses an IPv4-in-IPv6 tunnel.
* MAP-T ({{param|TransportMode}} = {{enum|Translation|TransportMode}}) uses stateless NAT64.
Note: There is an n:1 relationship between a MAP domain and the associated {{param|WANInterface}}, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own ''End-user IPv6 prefix'' and ''MAP IPv6 address'').
Note: The {{object}} table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the offending {{object}} row.
Enables or disables the MAP domain.
The current operational state of the MAP domain.
The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid.
{{datatype|expand}}
The transport mode to use.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_CONT_MAPE'' and ''S46_CONT_MAPT'' container options.
MAP-E {{bibref|MAP}}
MAP-T {{bibref|MAP-T}}
The IP interface with which this MAP domain is associated. This will always be a NAT-ted upstream (WAN) interface.
The ''End-user IPv6 prefix'' {{param|IPv6Prefix}} is one of this IP interface's prefixes.
The ''MAP IPv6 address'' is derived from the ''End-user IPv6 prefix'' and is one of this IP interface's IP addresses, with an {{param|##.IP.Interface.{i}.IPv6Address.{i}.Origin}} of {{enum|MAP|##.IP.Interface.{i}.IPv6Address.{i}.Origin}}.
The MAP domain's ''End-user IPv6 prefix''. This MUST reference one of {{param|WANInterface}}'s prefixes.
If the ACS configures this prefix directly, the CPE MUST use the ACS-configured prefix. Otherwise, the CPE MUST select one of {{param|WANInterface}}'s prefixes; the selected prefix will typically have {{param|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} = {{enum|PrefixDelegation|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}.
The MAP Border Relay (BR) address or prefix.
* For MAP-E this is the BR address and therefore MUST be a /128 {{bibref|MAP}}.
* For MAP-T this is the BR prefix {{bibref|MAP-T}}.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_DMR'' (Default Mapping Rule) option.
Note: There will be a corresponding {{object|.Routing.Router.{i}.IPv4Forwarding}} default rule.
DSCP with which to mark the outer IP header for traffic that is associated with this MAP domain.
Downstream packets are never re-marked.
Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
* A value of -1 indicates copy from the incoming packet.
* A value of -2 indicates automatic marking of DSCP.
''Port-set ID'' (PSID) offset in {{units}}. The number of Port-sets is 2^{{param}}.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_PORTPARAMS'' (Port Parameters) option's ''offset'' field.
The length in {{units}} of the ''Port-set id'' (PSID) configured in the {{param|PSID}} parameter.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_PORTPARAMS'' (Port Parameters) option's ''PSID-len'' field.
''Port-set ID'' (PSID) to use in preference to the value extracted from the ''Embedded Address'' (EA) bits.
Only the high order {{param|PSIDLength}} bits of the {{param}} value are used, so the parameter is ignored when {{param|PSIDLength}} is zero.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_PORTPARAMS'' (Port Parameters) option's ''PSID'' field.
Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range [0:2^(16-{{param|PSIDOffset}})-1] are excluded, e.g. for the default {{param|PSIDOffset}} value of 4, ports [0:4095] are not included in the Port-sets.
As specified in {{bibref|MAP}}, this parameter is relevant only when {{param|PSIDOffset}} is 0.
{{numentries}}
The MAP domain's Mapping Rules {{bibref|MAP}}. The rule with the longest match between its {{param|IPv6Prefix}} and the end-user {{param|#.IPv6Prefix}} is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule.
Enable or disable this {{object}} instance.
The status of this {{object}} instance. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
The mechanism via which the {{object}} was created.
If the CPE supports MAP configuration via both DHCPv6 and CWMP, it is up to the implementation to determine how the two mechanisms will interact.
Created via a {{bibref|MAP-DHCP}} ''S46_RULE'' option.
Present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI)
The ''Rule IPv6 prefix''.
The Rule IPv6 prefix is a leading part of the end-user {{param|#.IPv6Prefix}}, i.e. its length MUST be less than or equal to the length of the end-user ''IPv6Prefix'', and it MUST match the end-user ''IPv6Prefix''.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_RULE'' option's ''ipv6-prefix'' field.
The ''Rule IPv4 prefix''.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_RULE'' option's ''ipv4-prefix'' field.
The length in {{units}} of the ''Embedded Address (EA) bits'' in the end-user {{param|#.IPv6Prefix}}.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_RULE'' option's ''ea-len'' field.
Indicates whether this rule is a ''Forwarding Mapping Rule'' (FMR), i.e. can be used for forwarding.
Corresponds to the {{bibref|MAP-DHCP}} ''S46_RULE'' option's ''flags'' field's ''F-Flag''.
MAP interface (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This models the LAN side MAP domain interface.
Enables or disables the interface.
This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}}
When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a fault condition on the interface).
When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD change to {{enum|Up}} if and only if the interface is able to transmit and receive network traffic; it SHOULD change to {{enum|Dormant}} if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to {{enum|Up}} if still operable when the expected actions have completed); it SHOULD change to {{enum|LowerLayerDown}} if and only if the interface is prevented from entering the {{enum|Up}} state because one or more of the interfaces beneath it is down; it SHOULD remain in the {{enum|Error}} state if there is an error or other fault condition detected on the interface; it SHOULD remain in the {{enum|NotPresent}} state if the interface has missing (typically hardware) components; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason.
This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}.
{{datatype|expand}}
The textual name of the interface as assigned by the CPE.
The accumulated time in {{units}} since the interface entered its current operational state.
{{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}.
Note: Since this interface object is a MAP domain interface, it is expected that {{param}} will not be used.
Throughput statistics for this MAP domain interface.
The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}.
The total number of bytes transmitted out of the interface, including framing characters.
The total number of bytes received on the interface, including framing characters.
The total number of packets transmitted out of the interface.
The total number of packets received on the interface.
The total number of outbound packets that could not be transmitted because of errors.
The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.
The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent.
The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.
The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.
The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.
The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent.
The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.
The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent.
Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.
The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.
Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.
The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.
Note that this parameter is permitted to reference ''Tunnel'' instances in order to classify upstream packets that have just been encapsulated (such packets are conceptually similar to locally-generated traffic). For example, this parameter might reference a {{object|.GRE.Tunnel}} or a {{object|.MAP.Domain}} instance.
NAT enabled but forced by a third party to be operationally disabled, e.g. because a {{object|##.MAP.Domain}} is enabled but there is no Basic Mapping Rule {{bibref|MAP}}.
The external port (or the first port of a range of external ports) that the NAT gateway would listen on for traffic to a corresponding {{param|InternalPort}}. Inbound packets to this external port on the WAN interface SHOULD be forwarded to the {{object|.IP.Interface}} associated with the {{param|InternalClient}} on the {{param|InternalPort}}.
A value of zero ({{null}}) represents a "wildcard", i.e. any port number. If this value is {{null}}, traffic on all external ports (that are not otherwise mapped) will be forwarded to {{param|InternalClient}}, and the value(s) of {{param|InternalPort}} on {{param|InternalClient}} are ignored.
When wildcard values are used for {{param|RemoteHost}} and/or {{param}}, the following precedence order applies (with the highest precedence listed first):
# Explicit {{param|RemoteHost}}, explicit {{param}}
# Explicit {{param|RemoteHost}}, zero {{param}}
# Empty {{param|RemoteHost}}, explicit {{param}}
# Empty {{param|RemoteHost}}, zero {{param}}
If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry.
The port on {{param|InternalClient}} that the gateway SHOULD forward traffic to.
Properties for Port Control Protocol (PCP) {{bibref|RFC6887}}.
See the PCP Theory of Operation {{bibref|TR-181i2a8|Appendix XIV}} for a description of the working of this PCP data model.
{{list}} Each list item denotes a PCP version supported by the PCP Client. Currently known versions are 0, 1 and 2.
This parameter is based on Version from {{bibref|RFC6887}}.
This is the version to be used in the first exchange with a new PCP Server.
The factory default MUST be the highest supported version, as described in {{bibref|RFC6887|Section 9}}.
{{list}} The list of the PCP Options supported by the PCP Client.
{{numentries}}
Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in {{bibref|RFC6887}} for internal device applications or LAN device applications via Interworking functions.
Enables or disables the PCP Client.
{{datatype|expand}}
{{reference|the interface stack instance representing the WAN interface this client operates on}} See {{object|.InterfaceStack.}}
The status of the PCP Client. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
Enables or disables the MAP OpCode.
Enables or disables the PEER OpCode.
Enables or disables the ANNOUNCE OpCode.
When {{false}} the PCP Client does not support unsolicited ANNOUNCE messages.
Enables or disables the THIRD_PARTY Option.
Indicates whether THIRD_PARTY Option is enabled or not. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
Enables or disables the FILTER option.
{{numentries}}
Properties for the Port Control Protocol (PCP) Proxy, as specified in {{bibref|PCPProxy}}.
Enables or disables the PCP Proxy for this PCP Client.
A string identifying the highest version of PCP that the proxy supports.
This parameter is based on Version from {{bibref|RFC6887}}.
The status of the PCP Proxy for this PCP Client. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
Properties for the interworking function between UPnP IGD (Internet Gateway Device) and PCP, as specified in {{bibref|RFC6970}}.
Enables or disables the UPnP IGD-PCP Interworking Function for this PCP Client.
The status of the UPnP IGD-PCP Interworking Function for this PCP Client. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per {{bibref|RFC7291}}.
Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a {{object}} instance. If an option returns multiple addresses then that {{object}} instance has multiple addresses.
Enables or disables this PCP Server.
The status of the PCP Server. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
{{datatype|expand}}
Method used to assign {{param|ServerNameOrAddress}} and create this table entry. {{enum}}
Note: In the {{enum|DHCPv4}} and {{enum|DHCPv6}} cases, if more than one IP address is received {{param|ServerNameOrAddress}} will be the first address and {{param|AdditionalServerAddresses}} will be the remaining addresses.
{{param|ServerNameOrAddress}} is an IPv4 address that was received via OPTION_V4_PCP_SERVER
{{param|ServerNameOrAddress}} is an IPv6 address that was received via OPTION_V6_PCP_SERVER
{{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6 address that was created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration
The FQDN or IP address of the PCP Server, assigned as described under {{param|Origin}}.
The IP address currently in use for the PCP Server, derived from the value of {{param|ServerNameOrAddress}}.
{{empty}} indicates that no PCP Server address is currently known.
PCP Server addresses in addition to {{param|ServerNameOrAddress}}. This can be non-empty only if {{param|Origin}} is {{enum|DHCPv4|Origin}} or {{enum|DHCPv6|Origin}} and if more than one PCP Server address was received.
The external IP address of the PCP-controlled device hosting this server.
This is the version of PCP resulting from client-server Version Negotiation.
This parameter is based on Version from {{bibref|RFC6887}}.
Indicates the maximum number of inbound filters allowed to be associated with a mapping entry on this server.
Indicates the maximum number of ports allocated to this PCP Client on this server.
A value of 0 means that there is no limitation.
Indicates the preferred lifetime (in {{units}}) to be used for mappings with this server when no preference is selected by an application/user.
Indicates the capabilities supported by the PCP Server. {{enum}}
{{numentries}}
{{numentries}}
Inbound Mapping table.
This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in {{bibref|RFC6887|Section 11}}.
These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping.
For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the ACS MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.
Enables or disables this {{object}} instance.
The status of this entry. {{enum}}
The {{enum|Error_PCPErrorCodeReceived}} value indicates that the PCP Client received an error code from the PCP Server.
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
Provides the PCP error code when {{param|Status}} is {{enum|Error_PCPErrorCodeReceived|Status}}. Error code values are defined in {{bibref|RFC6887|Section 7.4}}.
{{datatype|expand}}
Mechanism via which the mapping was requested. {{enum}}
Requested via internal device application
Requested via UPnP IGD interworking function
Requested via PCP proxy
Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration
Determines the time to live, in {{units}}, of this Inbound Mapping lease, i.e. the remaining time before this port mapping expires.
A value of 0 means that the port mapping is permanent (referred to as a static mapping in {{bibref|RFC6887}}).
When a dynamic Inbound Mapping lease expires, the CPE MUST automatically delete the corresponding {{object}} table entry.
The external IPv4 or IPv6 Address that the PCP-controlled device will listen on for incoming packets to be forwarded to the PCP Client.
This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP client does not know the external address, or does not have a preference, it MUST use {{empty}}.
The external port (or the first port of a range of external ports) that the PCP-controlled device will listen on for incoming packets. Those inbound packets will be forwarded to {{param|InternalPort}}. If the PCP client does not know the external port, or does not have a preference, it MUST use 0.
This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0.
Indicates the last port of the external port range that starts with {{param|SuggestedExternalPort}}.
If an external port range is specified, then the behavior described for {{param|SuggestedExternalPort}} applies to all ports within the range.
A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of {{param|SuggestedExternalPort}}.
If {{param|SuggestedExternalPort}} is zero (wildcard), the value of {{param}} MUST be ignored.
If specified, the value of this parameter MUST be zero or be greater than or equal to the value of {{param|SuggestedExternalPort}}.
The port on this PCP Client's {{param|##.WANInterface}} that the PCP-controlled device forwards incoming packets to.
The protocol number of the {{object}}. Values are taken from {{bibref|IANA-protocolnumbers}}.
The value -1 means ''all protocols''.
Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in {{bibref|RFC6887|Section 7.3}}. In that case, {{param}} is the IP address of the device for which the PCP operation is requested.
For non-third-party mappings, {{param}} SHOULD be {{empty}}.
User-readable description of this {{object}}.
The external IPAddress returned by the PCP Server. The IP address that the PCP-controlled device is listening on for incoming packets to a corresponding PCP Client.
The external port returned by the PCP Server. The external port (or the first port of a range of external ports) that the PCP-controlled device is listening on for incoming packets to a corresponding {{param|InternalPort}}. Inbound packets to this external port on the External interface of the PCP-controlled device is forwarded to the on the {{param|InternalPort}}.
Indicates the last port of the external port range that starts with {{param|AssignedExternalPort}}.
If an external port range is specified, then the behavior described for {{param|AssignedExternalPort}} applies to all ports within the range.
A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of {{param|AssignedExternalPort}}.
{{numentries}}
Filter table.
This table contains all Filters restricting this Inbound Mapping, as defined in {{bibref|RFC6887|}}.
{{datatype|expand}}
Permitted remote peer IP address for this filter.
Indicates how many bits of {{param|RemoteHostIPAddress}} are relevant for this filter.
Permitted remote peer port number for this filter.
The value 0 indicates ''all ports''.
Indicates the last port of the remote port range that starts with {{param|RemotePort}}.
If an external port range is specified, then the behavior described for {{param|RemotePort}} applies to all ports within the range.
A value of zero (0) indicates that no remote port range is specified, i.e. that the range consists only of {{param|RemotePort}}.
Outbound Mapping table.
This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in {{bibref|RFC6887|Section 12}}.
These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping.
For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the ACS MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.
Enables or disables this {{object}} instance.
The status of this entry. {{enum}}
The {{enum|Error_PCPErrorCodeReceived}} value indicates that the PCP Client received an error code from the PCP Server.
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
Provides the PCP Error code when {{param|Status}} is {{enum|Error_PCPErrorCodeReceived|Status}}. Error code values are defined in {{bibref|RFC6887|Section 7.4}}.
{{datatype|expand}}
Mechanism via which the mapping was requested. {{enum}}
Requested via internal device application
Requested via UPnP IGD interworking function
Requested via PCP proxy
Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration
Determines the time to live, in {{units}}, of this Outbound Mapping lease, i.e. the remaining time before this port mapping expires.
A value of 0 means that the port mapping is permanent (referred to as a static mapping in {{bibref|RFC6887}}).
When a dynamic Outbound Mapping lease expires, the CPE MUST automatically delete the corresponding {{object}} table entry.
The external IPv4 or IPv6 Address that the PCP-controlled device will use to send outgoing packets covered by this mapping.
This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external address, or does not have a preference, it MUST use {{empty}}.
The external port that the PCP-controlled device will use to send outgoing packets covered by this mapping.
This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0.
The remote peer's IP address, as seen from the PCP Client, for this Outbound Mapping.
The port on PCP Client WAN Interface that the PCP-controlled device SHOULD listen to for this mapping.
The remote peer's port, as seen from the PCP Client, for this Outbound Mapping.
The protocol number of the {{object}}. Values are taken from the {{bibref|IANA-protocolnumbers}}.
The value -1 means ''all protocols''.
Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in {{bibref|RFC6887|Section 7.3}}. In that case, {{param}} is the IP address of the device for which the PCP operation is requested.
For non-third-party mappings, {{param}} SHOULD be {{empty}}.
User-readable description of this {{object}}.
The external IP address returned by the PCP Server. The IP address that the PCP-controlled device uses to send outgoing packets corresponding to this mapping.
The external port returned by the PCP Server. The port that the PCP-controlled device uses to send outgoing packets corresponding to this mapping.