G.hn and Optical interfaces (including Ethernet RMON); additional WiFi parameters Root data model version, e.g. ''2.4''. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based. This object models optical interface technologies. It defines an {{object|Interface}} object that models a layer 1 optical interface that is capable of transporting Ethernet packets. The data model definition is based on parts of {{bibref|G.988}}. {{numentries}} Optical interface table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This table models physical optical interfaces. Enables or disables the optical interface. This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}. The current operational state of the optical interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a fault condition on the interface). When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD change to {{enum|Up}} if and only if the interface is able to transmit and receive network traffic; it SHOULD change to {{enum|Dormant}} if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to {{enum|Up}} if still operable when the expected actions have completed); it SHOULD change to {{enum|LowerLayerDown}} if and only if the interface is prevented from entering the {{enum|Up}} state because one or more of the interfaces beneath it is down; it SHOULD remain in the {{enum|Error}} state if there is an error or other fault condition detected on the interface; it SHOULD remain in the {{enum|NotPresent}} state if the interface has missing (typically hardware) components; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason. This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}. {{datatype|expand}} The textual name of the optical interface as assigned by the CPE. The accumulated time in {{units}} since the optical interface entered its current operational state. {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used. Indicates whether the interface points towards the Internet ({{true}}) or towards End Devices ({{false}}). For example: * For an Internet Gateway Device, {{param}} will be {{true}} for all WAN interfaces and {{false}} for all LAN interfaces. * For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, {{param}} will be {{true}} for the Ethernet interface and {{false}} for the WiFi Radio interface. * For an End Device, {{param}} will be {{true}} for all interfaces. Current measurement of total downstream optical signal level. {{datatype|expand}} Valid values are -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments. This parameter is based on ''Optical signal level'' from {{bibref|G.988|Section 9.2.1}}. Optical level that is used to declare the downstream low received optical power alarm. {{datatype|expand}} Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy. This parameter is based on ''Lower optical threshold'' from {{bibref|G.988|section 9.2.1}}. Optical level that is used to declare the downstream high received optical power alarm. {{datatype|expand}} Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy. This parameter is based on ''Upper optical threshold'' from {{bibref|G.988|section 9.2.1}}. Current measurement of mean optical launch power. {{datatype|expand}} Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy. This parameter is based on ''Transmit optical level'' from {{bibref|G.988|section 9.2.1}}. Minimum mean optical launch power that is used to declare the low transmit optical power alarm. {{datatype|expand}} Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy. This parameter is based on ''Lower transmit power threshold'' from {{bibref|G.988|section 9.2.1}}. Maximum mean optical launch power that is used to declare the high transmit optical power alarm. {{datatype|expand}} Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy. This parameter is based on ''Upper transmit power threshold'' from {{bibref|G.988|section 9.2.1}}. Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}. The total number of bytes transmitted out of the interface, including framing characters. The total number of bytes received on the interface, including framing characters. The total number of packets transmitted out of the interface. The total number of packets received on the interface. The total number of outbound packets that could not be transmitted because of errors. The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. {{numentries}} Ethernet statistics based on the {{bibref|RFC2819}} ''RMON-MIB'' ''etherStatsTable'', with some extensions inspired by {{bibref|G.988|Section 9.3.32}}. Each instance is associated with an interface capable of transporting Ethernet-encapsulated packets, and contains a set of unidirectional Ethernet statistics. The statistics are sampled either on ingress or on egress. This is determined as follows: * If the instance is associated with an egress queue (or queues) via the {{param|Queue}} parameter or by setting {{param|AllQueues}} to {{true}} then data is sampled on egress. In this case {{param|Bytes}} etc measure the data that has been sent on the interface, possibly filtered by {{param|Queue}} or {{param|VLANID}}. * Otherwise data is sampled on ingress. In this case {{param|Bytes}} etc measure the data that has been received on the interface, possibly filtered by {{param|VLANID}}. When sampling on egress, the term ''received'' means ''received by the queuing sub-system''. Multiple instances can be associated with a single interface: individual instances can be configured to collect data associated with the entire interface, or with a particular VLAN and/or queue. The CPE MUST reset each instances's Stats parameters whenever the instance is disabled and re-enabled. Whether this reset occurs when the instance becomes operationally disabled ({{param|Status}} = {{enum|Disabled|Status}}) or administratively enabled ({{param|Enable}} = {{true}}) is a local matter to the CPE. This is similar to the behavior of interface statistics, e.g. as specified for {{object|Device.Ethernet.Interface.{i}.Stats}}. Furthermore, this instance's Stats parameters MUST be reset whenever the referenced interface's Stats parameters are reset, or when the referenced queue or VLAN is disabled and re-enabled. For enabled table entries, if {{param|Interface}} references an interface that is not capable of transporting Ethernet-encapsulated packets, or if {{param|Queue}} references a queue that is not instantiated on {{param|Interface}}, or if {{param|Queue}} is not a valid reference and {{param|AllQueues}} is {{false}}, the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Note: The {{object}} table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the offending {{object}} row. Enables or disables this instance. The status of this instance. {{enum}} The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. {{datatype|expand}} The textual name of the {{object}} entry as assigned by the CPE. The interface associated with this instance. {{reference|an interface that is capable of transporting Ethernet-encapsulated packets}} The term "capable of transporting Ethernet-encapsulated packets" means "has an Ethernet header" and therefore refers to any interface that is at or below an ''Ethernet''.{{object|#.Link}} instance in the interface stack. Filter criterion. The VLAN ID for which statistics are to be collected. A zero value indicates that all packets, whether or not they have a VLAN header, will be considered. A non-zero value indicates that only packets that have the the specified VLAN ID will be considered. Filter criterion. The egress queue with which this instance is associated. Only packets that are sent to the referenced queue will be considered. Indicates whether this instance applies to all queues. If {{true}}, the value of {{param|Queue}} is ignored since all egress queues are indicated. The total number of events in which packets were dropped due to lack of resources. Note that this number is not necessarily the number of packets dropped; it is just the number of times this condition has been detected. This parameter is based on ''etherStatsDropEvents'' from {{bibref|RFC2819}}. The total number of {{units}} (including those in bad packets) received (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsOctets'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets, broadcast packets, and multicast packets) received. This parameter is based on ''etherStatsPkts'' from {{bibref|RFC2819}}. The total number of good {{units}} received that were directed to the broadcast address. Note that this does not include multicast packets. This parameter is based on ''etherStatsBroadcastPkts'' from {{bibref|RFC2819}}. The total number of good {{units}} received that were directed to a multicast address. Note that this number does not include packets directed to the broadcast address. This parameter is based on ''etherStatsMulticastPkts'' from {{bibref|RFC2819}}. The total number of {{units}} received that had a length (excluding framing bits, but including FCS bytes) of between 64 and 1518 bytes, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of bytes (FCS Error) or a bad FCS with a non-integral number of bytes (Alignment Error). This parameter is based on ''etherStatsCRCAlignErrors'' from {{bibref|RFC2819}}. The total number of {{units}} received that were less than 64 bytes long (excluding framing bits, but including FCS bytes) and were otherwise well formed. This parameter is based on ''etherStatsUndersizePkts'' from {{bibref|RFC2819}}. The total number of {{units}} received that were longer than 1518 bytes (excluding framing bits, but including FCS bytes) and were otherwise well formed. This parameter is based on ''etherStatsOversizePkts'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsPkts64Octets'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets) received that were between 65 and 127 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsPkts65to127Octets'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets) received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsPkts6128to255Octets'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets) received that were between 256 and 511 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsPkts256to511Octets'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets) received that were between 512 and 1023 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsPkts512to1023Octets'' from {{bibref|RFC2819}}. The total number of {{units}} (including bad packets) received that were between 1024 and 1518 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on ''etherStatsPkts1024to1518Octets'' from {{bibref|RFC2819}}. G.hn object that contains an {{object|Interface}} table for G.hn supported CPE. The ITU-T G.hn specifications {{bibref|G.9960}} and {{bibref|G.9961}} define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. {{numentries}} G.hn interface table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Each table entry models the PHY {{bibref|G.9960}} and MAC {{bibref|G.9961}} layers of a G.hn interface. Enables or disables the interface. This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}. The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a fault condition on the interface). When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD change to {{enum|Up}} if and only if the interface is able to transmit and receive network traffic; it SHOULD change to {{enum|Dormant}} if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to {{enum|Up}} if still operable when the expected actions have completed); it SHOULD change to {{enum|LowerLayerDown}} if and only if the interface is prevented from entering the {{enum|Up}} state because one or more of the interfaces beneath it is down; it SHOULD remain in the {{enum|Error}} state if there is an error or other fault condition detected on the interface; it SHOULD remain in the {{enum|NotPresent}} state if the interface has missing (typically hardware) components; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason. This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}. {{datatype|expand}} The textual name of the interface as assigned by the CPE. The accumulated time in {{units}} since the interface entered its current operational state. {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. Note: Since {{object}} is a layer 1 interface, it is expected that {{param}} will not be used. Indicates whether the interface points towards the Internet ({{true}}) or towards End Devices ({{false}}). For example: * For an Internet Gateway Device, {{param}} will be {{true}} for all WAN interfaces and {{false}} for all LAN interfaces. * For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, {{param}} will be {{true}} for the Ethernet interface and {{false}} for the WiFi Radio interface. * For an End Device, {{param}} will be {{true}} for all interfaces. The MAC Address of the interface, denoted as node MAC address or REGID in {{bibref|G.9961}}. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|.Ethernet.Link.{i}.MACAddress}} parameter. The firmware version of the interface. Connection type for which the G.hn protocol is active. {{list}} Identifies the target domains configured by the user, as described in {{bibref|G.9961|Section 8.6.1}}. When registering or re-registering, the G.hn interface SHOULD try to register to one of these domains in the given order. This is the domain name to which the interface is currently registered. {{empty}} indicates that the interface is currently not registered. The Domain Name Identifier, a shortened version of {{param|DomainName}}, denoted as DNI in {{bibref|G.9961|Section 8.6.11.2.1}}. The Domain Identifier of the domain to which the interface is registered, denoted as DOD in {{bibref|G.9961}}. The Device Identifier assigned by the Domain Master, denoted as DEVICE_ID in {{bibref|G.9961}}. The value 0 indicates that the device is not currently registered. The maximum PHY bit rate supported by this interface (expressed in {{units}}). Indicates whether this interface has the capability to act as Domain Master in the G.hn domain. Indicates whether this interface has the capability to act as Security Controller in the G.hn domain. Requests the interface to become the Domain Master in the G.hn domain. This parameter is valid only if {{param|NodeTypeDMCapable}} is {{true}}. Note that, if more than one node is configured to act as Domain Master, G.hn specifies a protocol to ensure only one device actually becomes DM. Indicates whether the interface is acting as Domain Master ({{true}}) or not ({{false}}). See Note in {{param|NodeTypeDMConfig}} regarding the possibility of more than one node being configured with {{param|NodeTypeDMConfig}} = {{true}}. Indicates whether the interface is acting as Security Controller ({{true}}) or not ({{false}}). {{numentries}} Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's {{param|#.Status}} parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}). Administrative and operational interface status is discussed in {{bibref|TR-181i2|section 4.2.2}}. The total number of bytes transmitted out of the interface, including framing characters. The total number of bytes received on the interface, including framing characters. The total number of packets transmitted out of the interface. The total number of packets received on the interface. The total number of outbound packets that could not be transmitted because of errors. The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. This table contains information about other G.hn devices connected to this G.hn interface. MAC address of remote G.hn device. Device Id (as defined in G.hn) for the remote G.hn device, denoted as DEVICE_ID in {{bibref|G.9961}}. Unregistered devices (with Device Id 0) SHOULD not be present in this table. The PHY transmit Rate (expressed in {{units}}) to this remote device, denoted as PHY data rate in {{bibref|G.9961}}. The PHY receive Rate (expressed in {{units}}) from this remote device, denoted as PHY data rate in {{bibref|G.9961}}. Whether or not this device is currently present in the G.hn domain. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. Enables or disables device isolation. A value of {{true}} means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot). When set to {{true}}, this {{object|#}} instance's WiFi security settings are reset to their factory default values. The affected settings include {{param|ModeEnabled}}, {{param|WEPKey}}, {{param|PreSharedKey}} and {{param|KeyPassphrase}}. If the parameter cannot be set, the CPE MUST reject the request as an invalid parameter value. Possible failure reasons include a lack of default values or if {{param|ModeEnabled}} is an Enterprise type, i.e. {{enum|WPA-Enterprise|ModesSupported}}, {{enum|WPA2-Enterprise|ModesSupported}} or {{enum|WPA-WPA2-Enterprise|ModesSupported}}. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as ''DUID''. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as ''DUID''. The Fully Qualified Domain Name (FQDN) of the tunnel concentrator (remote endpoint). This parameter is based on ''OPTION_DS_LITE_NAME'' from {{bibref|DSLite-options|Section 4}} and can be assigned statically (e.g. present in the factory default configuration or set by the ACS) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then {{param|EndpointAssignmentPrecedence}} indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to {{param}}. The address of the tunnel concentrator (remote endpoint). This parameter can be assigned statically (e.g. present in the factory default configuration or set by the ACS) or can be updated dynamically (via a DNS lookup) when {{param|EndpointName}} is set. If both statically and dynamically assigned, then {{param|EndpointAssignmentPrecedence}} indicates whether it is the static configuration or the DHCPv6-derived configuration that is actually applied to {{param}}. Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if {{param|InternalClient}} is {{empty}}, or if {{param|Interface}} is not a valid reference and {{param|AllInterfaces}} is {{false}}, then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Note: DHCPv6 Option 1 (DUID) is sometimes referred to as ''Client Identifier''. Firewall Rule table. Each entry defines a Firewall packet selection rule. The {{param|Target}} parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another {{object|#}}. This table MUST NOT contain dynamic Firewall rules associated with {{enum|Stateful|##.Type}} Firewall sessions. All entries are created by the creator of the parent {{object|#}}, as indicated by its {{param|#.Creator}} parameter. {{object}} entries in a {{object|#}} with a {{param|#.Creator}} of {{enum|Defaults|#.Creator}}, {{enum|ACS|#.Creator}}, {{enum|UserInterface|#.Creator}} or (maybe) {{enum|Other|#.Creator}} are referred to as ''Static'' {{object}}s. Whether or not a {{object}} in a {{object|#}} with {{param|#.Creator}} {{enum|Other|#.Creator}} is regarded as ''Static'' is a local matter to the CPE. Some of this object's parameter descriptions refer to whether a {{object}} is ''Static'' when specifying whether or not the parameter value can be modified. For enabled table entries, if {{param|SourceInterface}} is not a valid reference and {{param|SourceAllInterfaces}} is {{false}}, or if {{param|DestInterface}} is not a valid reference and {{param|DestAllInterfaces}} is {{false}}, then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}.