Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:2.4 Root Object definition
tr-181-2-4-0.xml (changes)

License

Copyright (c) 2010-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Summary

G.hn and Optical interfaces (including Ethernet RMON); additional WiFi parameters

Table of Contents

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
MACAddress string(17)

All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

[DSLite-options] RFC 6334, Dynamic Host Configuation Protocol for IPv6 (DHCPv6) Option for Dual-Stack Lite, IETF, 2011.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[RFC2819] RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-181i2] TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.

Device:2.4 Data Model (changes)

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 2.4, then it will indicate support for version 2.4. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
Device. object - The top-level object for a Device. - 2.0
RootDataModelVersion string­(32) -

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. Possible patterns:

- 2.4
Device.DeviceInfo. object - This object contains general device information. - 2.0
LocationNumberOfEntries unsignedInt - The number of entries in the Location table. - 2.4
Device.DeviceInfo.Location.{i}. object W

This object contains Location information.

At most one entry in this table can exist with the same values for Source and ExternalSource. On creation of a new table entry, the Agent MUST choose an initial value for ExternalSource such that the new entry does not conflict with any existing entries.

- 2.4
Source string -

Identifies the source of the location data. Enumeration of:

"External" 2.4
AcquiredTime dateTime - The time when the location was acquired. - 2.4
ExternalSource string -

URL, MAC address, or other identifier that identifies an "External" source of this location.

Meaningful only if Source has a value of External, otherwise it MUST be an empty string.

If ExternalProtocol has a value of CWMP, this is the URL or IP address of the ACS.

- 2.4
ExternalProtocol string -

Protocol used to acquire a location from an "External" source. Enumeration of:

Meaningful only if Source has a value of External, otherwise it MUST be an empty string.

"CWMP" 2.4
DataObject string­(1200) W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP.

If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491].

If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses).

If obtained by an external source this is the location information as received.

If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64.

CWMP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses).

Only zero or one Location object instance with value CWMP MUST exist at any given time.

- 2.4
Device.Optical. object - This object models optical interface technologies. It defines an 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 [G.988]. - 2.4
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.4
Device.Optical.Interface.{i}. object -

Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

- 2.4
Enable boolean W

Enables or disables the optical interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.4
Status string -

The current operational state of the optical interface (see [Section 4.2.2/TR-181i2]). Enumeration of:

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to 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 Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.4
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.4
Name string­(64) - The textual name of the optical interface as assigned by the CPE. - 2.4
LastChange unsignedInt - The accumulated time in seconds since the optical interface entered its current operational state. - 2.4
LowerLayers string­(1024) W

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.4
Upstream boolean -

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream 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, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.4
OpticalSignalLevel int -

Current measurement of total downstream optical signal level.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

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 [Section 9.2.1/G.988].

- 2.4
LowerOpticalThreshold int -

Optical level that is used to declare the downstream low received optical power alarm.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

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 [Section 9.2.1/G.988].

- 2.4
UpperOpticalThreshold int -

Optical level that is used to declare the downstream high received optical power alarm.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

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 [Section 9.2.1/G.988].

- 2.4
TransmitOpticalLevel int -

Current measurement of mean optical launch power.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

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 [Section 9.2.1/G.988].

- 2.4
LowerTransmitPowerThreshold int -

Minimum mean optical launch power that is used to declare the low transmit optical power alarm.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

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 [Section 9.2.1/G.988].

- 2.4
UpperTransmitPowerThreshold int -

Maximum mean optical launch power that is used to declare the high transmit optical power alarm.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

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 [Section 9.2.1/G.988].

- 2.4
Device.Optical.Interface.{i}.Stats. object -

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 Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.4
BytesSent unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.4
BytesReceived unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.4
PacketsSent unsignedLong - The total number of packets transmitted out of the interface. - 2.4
PacketsReceived unsignedLong - The total number of packets received on the interface. - 2.4
ErrorsSent unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.4
ErrorsReceived unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.4
DiscardPacketsSent unsignedInt - 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. - 2.4
DiscardPacketsReceived unsignedInt - 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. - 2.4
Device.Ethernet. object - Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. A VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
RMONStatsNumberOfEntries unsignedInt - The number of entries in the RMONStats table. - 2.4
Device.Ethernet.RMONStats.{i}. object W

Ethernet statistics based on the [RFC2819] RMON-MIB etherStatsTable, with some extensions inspired by [Section 9.3.32/G.988].

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 Queue parameter or by setting AllQueues to true then data is sampled on egress. In this case Bytes etc measure the data that has been sent on the interface, possibly filtered by Queue or VLANID.
  • Otherwise data is sampled on ingress. In this case Bytes etc measure the data that has been received on the interface, possibly filtered by 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 (Status = Disabled) or administratively enabled (Enable = true) is a local matter to the CPE. This is similar to the behavior of interface statistics, e.g. as specified for 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 Interface references an interface that is not capable of transporting Ethernet-encapsulated packets, or if Queue references a queue that is not instantiated on Interface, or if Queue is not a valid reference and AllQueues is false, the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The RMONStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated RMONStats row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending RMONStats row.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with all the same values for Interface, VLANID and Queue.

- 2.4
Enable boolean W Enables or disables this instance. false 2.4
Status string -

The status of this instance. Enumeration of:

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

"Disabled" 2.4
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.4
Name string­(64) - The textual name of the RMONStats entry as assigned by the CPE. - 2.4
Interface string W

The interface associated with this instance. The value MUST be the Path Name of an interface that is capable of transporting Ethernet-encapsulated packets. If the referenced object is deleted, the parameter value MUST be set to an empty string.

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.Link instance in the interface stack.

<Empty> 2.4
VLANID unsignedInt­[0:4094] W

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.

0 2.4
Queue string W

The value MUST be the Path Name of a row in the Device.QoS.Queue table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Filter criterion.

The egress queue with which this instance is associated.

Only packets that are sent to the referenced queue will be considered.

<Empty> 2.4
AllQueues boolean W Indicates whether this instance applies to all queues. If true, the value of Queue is ignored since all egress queues are indicated. false 2.4
DropEvents unsignedInt -

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 [RFC2819].

0 2.4
Bytes unsignedLong -

The total number of bytes (including those in bad packets) received (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsOctets from [RFC2819].

0 2.4
Packets unsignedLong -

The total number of packets (including bad packets, broadcast packets, and multicast packets) received.

This parameter is based on etherStatsPkts from [RFC2819].

0 2.4
BroadcastPackets unsignedLong -

The total number of good packets received that were directed to the broadcast address. Note that this does not include multicast packets.

This parameter is based on etherStatsBroadcastPkts from [RFC2819].

0 2.4
MulticastPackets unsignedLong -

The total number of good packets 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 [RFC2819].

0 2.4
CRCErroredPackets unsignedInt -

The total number of packets 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 [RFC2819].

0 2.4
UndersizePackets unsignedInt -

The total number of packets 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 [RFC2819].

0 2.4
OversizePackets unsignedInt -

The total number of packets 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 [RFC2819].

0 2.4
Packets64Bytes unsignedLong -

The total number of packets (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts64Octets from [RFC2819].

0 2.4
Packets65to127Bytes unsignedLong -

The total number of packets (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 [RFC2819].

0 2.4
Packets128to255Bytes unsignedLong -

The total number of packets (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 [RFC2819].

0 2.4
Packets256to511Bytes unsignedLong -

The total number of packets (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 [RFC2819].

0 2.4
Packets512to1023Bytes unsignedLong -

The total number of packets (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 [RFC2819].

0 2.4
Packets1024to1518Bytes unsignedLong -

The total number of packets (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 [RFC2819].

0 2.4
Device.Ghn. object - G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [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. - 2.4
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.4
Device.Ghn.Interface.{i}. object -

G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

- 2.4
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.4
Status string -

The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to 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 Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.4
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.4
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.4
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.4
LowerLayers string­(1024) W

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.4
Upstream boolean -

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream 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, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.4
MACAddress string­(17) -

[MACAddress] The MAC Address of the interface, denoted as node MAC address or REGID in [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 Ethernet.Link.{i}.MACAddress parameter.

- 2.4
FirmwareVersion string­(64) - The firmware version of the interface. - 2.4
ConnectionType string -

Connection type for which the G.hn protocol is active. Enumeration of:

- 2.4
TargetDomainNames string­(1024) W Comma-separated list (maximum list length 1024) of strings (maximum item length 32). Identifies the target domains configured by the user, as described in [Section 8.6.1/G.9961]. When registering or re-registering, the G.hn interface SHOULD try to register to one of these domains in the given order. - 2.4
DomainName string­(32) -

This is the domain name to which the interface is currently registered.

An empty string indicates that the interface is currently not registered.

- 2.4
DomainNameIdentifier unsignedInt - The Domain Name Identifier, a shortened version of DomainName, denoted as DNI in [Section 8.6.11.2.1/G.9961]. - 2.4
DomainId unsignedInt - The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.4
DeviceId unsignedInt -

The Device Identifier assigned by the Domain Master, denoted as DEVICE_ID in [G.9961].

The value 0 indicates that the device is not currently registered.

- 2.4
MaxBitRate unsignedInt - The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.4
NodeTypeDMCapable boolean - Indicates whether this interface has the capability to act as Domain Master in the G.hn domain. - 2.4
NodeTypeSCCapable boolean - Indicates whether this interface has the capability to act as Security Controller in the G.hn domain. - 2.4
NodeTypeDMConfig boolean W

Requests the interface to become the Domain Master in the G.hn domain.

This parameter is valid only if 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.

- 2.4
NodeTypeDMStatus boolean -

Indicates whether the interface is acting as Domain Master (true) or not (false).

See Note in NodeTypeDMConfig regarding the possibility of more than one node being configured with NodeTypeDMConfig = true.

- 2.4
NodeTypeSCStatus boolean - Indicates whether the interface is acting as Security Controller (true) or not (false). - 2.4
AssociatedDeviceNumberOfEntries unsignedInt - The number of entries in the AssociatedDevice table. - 2.4
Device.Ghn.Interface.{i}.Stats. object -

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 Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.4
BytesSent unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.4
BytesReceived unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.4
PacketsSent unsignedLong - The total number of packets transmitted out of the interface. - 2.4
PacketsReceived unsignedLong - The total number of packets received on the interface. - 2.4
ErrorsSent unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.4
ErrorsReceived unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.4
UnicastPacketsSent unsignedLong - 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. - 2.4
UnicastPacketsReceived unsignedLong - 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. - 2.4
DiscardPacketsSent unsignedInt - 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. - 2.4
DiscardPacketsReceived unsignedInt - 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. - 2.4
MulticastPacketsSent unsignedLong - 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. - 2.4
MulticastPacketsReceived unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.4
BroadcastPacketsSent unsignedLong - 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. - 2.4
BroadcastPacketsReceived unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.4
UnknownProtoPacketsReceived unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.4
Device.Ghn.Interface.{i}.AssociatedDevice.{i}. object -

This table contains information about other G.hn devices connected to this G.hn interface.

At most one entry in this table can exist with a given value for MACAddress.

- 2.4
MACAddress string­(17) - [MACAddress] MAC address of remote G.hn device. - 2.4
DeviceId unsignedInt - Device Id (as defined in G.hn) for the remote G.hn device, denoted as DEVICE_ID in [G.9961]. Unregistered devices (with Device Id 0) SHOULD not be present in this table. - 2.4
TxPhyRate unsignedInt - The PHY transmit Rate (expressed in Mbps) to this remote device, denoted as PHY data rate in [G.9961]. - 2.4
RxPhyRate unsignedInt - The PHY receive Rate (expressed in Mbps) from this remote device, denoted as PHY data rate in [G.9961]. - 2.4
Active boolean -

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, Active 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.

- 2.4
Device.WiFi. object - The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
Device.WiFi.AccessPoint.{i}. object W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with a given value for SSIDReference.

- 2.0
MaxAssociatedDevices unsignedInt W

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.

0 2.4
IsolationEnable boolean W

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).

- 2.4
Device.WiFi.AccessPoint.{i}.Security. object - This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. - 2.0
Reset boolean W

When set to true, this AccessPoint instance's WiFi security settings are reset to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey and 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 ModeEnabled is an Enterprise type, i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise.

The value of this parameter is not part of the device configuration and is always false when read.

- 2.4
Device.SoftwareModules. object - Top level object for dynamically managed software applications. - 2.1
Device.SoftwareModules.ExecEnv.{i}. object -

The Execution Environments that are available on the device, along with their properties and configurable settings.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

- 2.1
InitialExecutionUnitRunLevel int­[-1:65535] W

Indicates the initial value on creation for ExecutionUnit.{i}.RunLevel for all Execution Unit instances associated with this ExecEnv.

If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit.

- 2.4
Device.FaultMgmt. object - This object contains parameters relating to Fault/Alarm Management. - 2.4
SupportedAlarmNumberOfEntries unsignedInt - The number of entries in the SupportedAlarm table. - 2.4
MaxCurrentAlarmEntries unsignedInt - The maximum number of entries allowed in the FaultMgmt.CurrentAlarm.{i}. table. - 2.4
CurrentAlarmNumberOfEntries unsignedInt - The number of entries in the CurrentAlarm table. - 2.4
HistoryEventNumberOfEntries unsignedInt - The number of entries in the HistoryEvent table. - 2.4
ExpeditedEventNumberOfEntries unsignedInt - The number of entries in the ExpeditedEvent table. - 2.4
QueuedEventNumberOfEntries unsignedInt - The number of entries in the QueuedEvent table. - 2.4
Device.FaultMgmt.SupportedAlarm.{i}. object -

Supported Alarm Entries which can be raised by the device.

The instance numbers for this table SHOULD be maintained across firmware upgrades of the device.

At most one entry in this table can exist with all the same values for EventType, ProbableCause, SpecificProblem and PerceivedSeverity.

- 2.4
EventType string­(64) - Indicates the type of event. - 2.4
ProbableCause string­(64) - Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string­(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support unique indexing of the table using SpecificProblem.

The string can be set to "*" to indicate the default case if only a subset of SpecificProblem are to be contained within the table.

- 2.4
PerceivedSeverity string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

This will be an empty string if the device doesn't support unique indexing of the table using PerceivedSeverity.

The string can be set to "*" to indicate the default case if only a subset of PerceivedSeverity are to be contained within the table.

- 2.4
ReportingMechanism string W

Indicates the reporting mechanism setting of the alarm. Enumeration of:

- 2.4
Device.FaultMgmt.CurrentAlarm.{i}. object -

Contains all currently active alarms (whose FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity is not Cleared).

Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table.

If maximum entries as indicated by FaultMgmt.MaxCurrentAlarmEntries is reached, the next event overrides the object with the oldest AlarmChangedTime.

When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier, or with all the same values for EventType, ProbableCause and SpecificProblem.

- 2.4
AlarmIdentifier string­(64) - Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 2.4
AlarmRaisedTime dateTime - Indicates the date and time when the alarm was first raised by the device. - 2.4
AlarmChangedTime dateTime - Indicates the date and time when the alarm was last changed by the device. - 2.4
ManagedObjectInstance string­(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this CurrentAlarm. - 2.4
EventType string­(64) - Indicates the type of event. - 2.4
ProbableCause string­(64) - Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string­(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 2.4
PerceivedSeverity string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 2.4
AdditionalText string­(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 2.4
AdditionalInformation string­(256) - This contains additional information about the alarm and is vendor defined. - 2.4
Device.FaultMgmt.HistoryEvent.{i}. object -

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table. This table also contains alarm clearing events.

Active alarms at the time of a power failure or reboot might not get an alarm clearing event.

This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.HistoryEventNumberOfEntries.

If maximum instance number FaultMgmt.HistoryEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records.

At most one entry in this table can exist with the same values for EventTime and AlarmIdentifier.

- 2.4
EventTime dateTime - Indicates the date and time when the alarm event occurs. - 2.4
AlarmIdentifier string­(64) - Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 2.4
NotificationType string -

Indicates the reason for the specific alarm notification event. Enumeration of:

- 2.4
ManagedObjectInstance string­(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this HistoryEvent. - 2.4
EventType string­(64) - Indicates the type of event. - 2.4
ProbableCause string­(64) - Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string­(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 2.4
PerceivedSeverity string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 2.4
AdditionalText string­(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 2.4
AdditionalInformation string­(256) - This contains additional information about the alarm and is vendor defined. - 2.4
Device.FaultMgmt.ExpeditedEvent.{i}. object -

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 0 Expedited. This table also contains alarm clearing events.

This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.ExpeditedEventNumberOfEntries.

Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4].

If maximum instance number FaultMgmt.ExpeditedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records.

When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier.

- 2.4
EventTime dateTime -

Indicates the date and time when the alarm event occurs.

For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4].

- 2.4
AlarmIdentifier string­(64) -

Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm.

For an unpopulated entry, the value is an empty string.

- 2.4
NotificationType string -

Indicates the reason for the specific alarm notification event. Enumeration of:

- 2.4
ManagedObjectInstance string­(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this ExpeditedEvent. - 2.4
EventType string­(64) - Indicates the type of event. - 2.4
ProbableCause string­(64) - Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string­(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 2.4
PerceivedSeverity string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 2.4
AdditionalText string­(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 2.4
AdditionalInformation string­(256) - This contains additional information about the alarm and is vendor defined. - 2.4
Device.FaultMgmt.QueuedEvent.{i}. object -

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 1 Queued. This table also contains alarm clearing events.

This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.QueuedEventNumberOfEntries.

Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4].

If maximum instance number FaultMgmt.QueuedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records.

When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier.

- 2.4
EventTime dateTime -

Indicates the date and time when the alarm event occurs.

For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4].

- 2.4
AlarmIdentifier string­(64) -

Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm.

For an unpopulated entry, the value is an empty string.

- 2.4
NotificationType string -

Indicates the reason for the specific alarm notification event. Enumeration of:

- 2.4
ManagedObjectInstance string­(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this QueuedEvent. - 2.4
EventType string­(64) - Indicates the type of event. - 2.4
ProbableCause string­(64) - Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string­(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 2.4
PerceivedSeverity string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 2.4
AdditionalText string­(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 2.4
AdditionalInformation string­(256) - This contains additional information about the alarm and is vendor defined. - 2.4
Device.Security. object - This object contains general information related to managing security features on the device. - 2.4
CertificateNumberOfEntries unsignedInt - The number of entries in the Certificate table. - 2.4
Device.Security.Certificate.{i}. object -

This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280].

At most one entry in this table can exist with the same values for SerialNumber and Issuer.

- 2.4
Enable boolean W Enables or disables this certificate. - 2.4
LastModif dateTime - The last modification time of this certificate. - 2.4
SerialNumber string­(64) - The Serial Number field in an X.509 certificate, see [RFC5280]. - 2.4
Issuer string­(256) - The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 2.4
NotBefore dateTime - The beginning of the certificate validity period; i.e. the Not Before field in an X.509 certificate, see [RFC5280]. - 2.4
NotAfter dateTime - The end of the certificate validity period; i.e., the Not After field in an X.509 certificate, see [RFC5280]. - 2.4
Subject string­(256) - The Distinguished Name (DN) of the entity associated with the Public Key; i.e., the Subject field in an X.509 certificate, see [RFC5280]. - 2.4
SubjectAlt string­(256) -

Comma-separated list (maximum list length 256) of strings. Each item is a DNS Name.

The Subject Alternative Names extension field in an X.509 certificate, see [RFC5280].

- 2.4
SignatureAlgorithm string­(256) - The algorithm used in signing the certificate; i.e. the Signature Algorithm field in an X.509 certificate, see [RFC5280]. - 2.4
Device.FAP. object - This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 2.4
Device.FAP.GPS. object - This object contains the parameters relating to the GPS scan. - 2.4
ScanOnBoot boolean W

Enables or disables GPS scans during the device start up.

The factory default value MUST be true.

- 2.4
ScanPeriodically boolean W

Enables or disables periodic GPS scans.

The factory default value MUST be false.

- 2.4
PeriodicInterval unsignedInt W When ScanPeriodically is true, this value indicates the interval in seconds which GPS scan is performed. - 2.4
PeriodicTime dateTime W

An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the PeriodicInterval.

PeriodicTime is used only to set the "phase" of the GPS scan. The actual value of PeriodicTime can be arbitrarily far into the past or future.

For example, if PeriodicInterval is 86400 (a day) and if PeriodicTime is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106a4] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval.

If absolute time is not available to the CPE, its periodic GPS scan behavior MUST be the same as if PeriodicTime parameter was set to the Unknown Time value.

- 2.4
ContinuousGPS boolean W Whether or not the device SHOULD maintain a continuous GPS lock (e.g. as a frequency stability source). - 2.4
ScanTimeout unsignedInt W Specifies the time-out value in seconds since the scan started after which the scan will time out. A timed out scan is to be reported as Error_TIMEOUT with ErrorDetails indicating "Timed out" - 2.4
ScanStatus string -

Indicates the current status of this scan. Enumeration of:

- 2.4
ErrorDetails string­(256) - Provides more detail when the ScanStatus is either Error or Error_TIMEOUT. - 2.4
LastScanTime dateTime - The date and time when the last GPS scan completed. - 2.4
LastSuccessfulScanTime dateTime -

Specifies the date and time, when the GPS scan last completed successfully.

This value is retained across reboot and is only reset after another scan completes successfully or GPSReset is set to true.

The values for LockedLatitude, LockedLongitude and NumberOfSatellites correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in [Section 3.2/TR-106a4].

- 2.4
LockedLatitude int­[-90000000:90000000] -

This parameter specifies the latitude of the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator.

Range is from: 90d00.00' South (-90,000,000) to 90d00.00' North (90,000,000).

Example: A latitude of 13d19.43' N would be represented as 13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60). Latitude of 50d00.00' S would be represented as value -50,000,000.

This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported.

- 2.4
LockedLongitude int­[-180000000:180000000] -

This parameter specifies the longitude of the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian.

Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East (180,000,000).

Example: A longitude of 13d19.43' E would be represented as 13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00.00' W would be represented as value -50,000,000.

This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported.

- 2.4
NumberOfSatellites unsignedInt -

The number of satellites that were locked during the test execution. The greater the number of satellites the better the precision of the results.

This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported.

- 2.4
GPSReset boolean W

Setting this to true will cause a reset on the GPS Hardware. Setting this to false has no effect.

The value of this parameter is not part of the device configuration and is always false when read.

- 2.4
Device.FAP.GPS.ContinuousGPSStatus. object -

When ContinuousGPS is true, the parameters in this object contain the GPS status as it is continuously monitored.

When ContinuousGPS is false, the parameters in this object are not being updated and their values are not accurate.

- 2.4
CurrentFix boolean - The value is true if the location fix is currently valid (i.e. GPS receiver is currently tracking satellite signals), otherwise it is false. After a reboot the value is false until the GPS receivers has a valid current position. - 2.4
GotFix boolean -

The value is true if CurrentFix has transitioned to true at least once since ContinuousGPS was enabled, otherwise it is false. After a reboot the value is false until CurrentFix has transitioned to true again.

The GPS coordinates (Latitude, Longitude, and Elevation) are not valid until GotFix has a value of true.

- 2.4
TimingGood boolean - The value is true if the timing synchronization is good, otherwise it is false. After a reboot the value is false until the timing is synchronized again. - 2.4
Latitude int­[-90000000:90000000] -

This parameter represents the most recent latitude reading for the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator.

Range is from: 90 deg 00.00' South (-90,000,000) to 90 deg 00.00' North (90,000,000).

Example: A latitude of 13 deg 19.43' N would be represented as 13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60). Latitude of 50 deg 00.00' S would be represented as value -50,000,000.

Latitude is not valid until GotFix is true.

If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot.

- 2.4
Longitude int­[-180000000:180000000] -

This parameter represents the most recent longitude reading for the device's position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian.

Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East (180,000,000).

Example: A longitude of 13d19.43' E would be represented as 13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00.00' W would be represented as value -50,000,000.

Longitude is not valid until GotFix is true.

If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot.

- 2.4
Elevation int­[-5000000:25000000] -

This parameter represents the most recent elevation reading for the device's position in millimeters, relative to the WGS84 ellipsoid. The positive value signifies the direction, above sea level. The negative value signifies the direction, below sea level.

Range is from: 5,000.000 meters below sea level (-5,000,000) to 25,000.000 meters above sea level (25,000,000).

Elevation is not valid until GotFix is true.

If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot.

- 2.4
LastFixTime dateTime -

Represents the date and time when the last GPS Fix was acquired.

The Unknown Time value defined in [Section 3.2/TR-106a4] is used when GotFix is false. This applies too after a reboot of the device until a valid location is determined and GotFix transsitions to true.

- 2.4
LastFixDuration unsignedInt - Number of seconds of continuous GPS fix time. After a reboot this value is reset to 0. - 2.4
FirstFixTimeout int­[-1:] W

Number of seconds to wait for first GPS fix before declaring a GPS fault.

A value of -1 means that there is no timeout and no fault logging.

- 2.4
SatellitesTracked unsignedInt - The number of satellites the receiver is tracking. - 2.4
SatelliteTrackingInterval unsignedInt­[60:3600] W The interval in seconds at which the GPS tracking information gets reported. - 2.4
ReceiverStatus string­(256) - The output of the GPS receiver's status. - 2.4
LocationType string -

Indicates whether the Latitude, Longitude, and Elevation values are determined via a GPS Fix (where the value of this parameter would be Real) or via some other means (where the value of this parameter would be Reference). Enumeration of:

- 2.4
LockTimeOutDuration unsignedInt­[120:86400] W The timer duration, in seconds, for which the device waits for GPS to acquire lock. - 2.4
Device.FAP.GPS.AGPSServerConfig. object - This object contains parameters for the configuration of the Assisted Global Positioning System (A-GPS) server. See also [Section 3.2/3GPP-TS.25.171] - 2.4
Enable boolean W Enables or disables the AGPSServerConfig entry. - 2.4
ServerURL string­(256) W A-GPS server host name or IP address. - 2.4
ServerPort unsignedInt­[:65535] W The port to use when communicating to the A-GPS Server. - 2.4
Username string­(64) W Username to be used by the device to authenticate with the A-GPS server. This string is set to an empty string if no authentication is used. - 2.4
Password string­(64) W

Password to be used by the device to authenticate with the A-GPS server. This string is set to an empty string if no authentication is used.

When read, this parameter returns an empty string, regardless of the actual value.

- 2.4
ReferenceLatitude int­[-90000000:90000000] W

This parameter specifies the reference latitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator.

Range is from: 90d00.00' South (-90,000,000) to 90d00.00' North (90,000,000).

Example: A latitude of 13d19.43' N would be represented as 13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60). Latitude of 50d00.00' S would be represented as value -50,000,000.

- 2.4
ReferenceLongitude int­[-180000000:180000000] W

This parameter specifies the reference longitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian.

Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East (180,000,000).

Example: A longitude of 13d19.43' E would be represented as 13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00'00'' W would be represented as value -50,000,000.

- 2.4
ServerInUse boolean -

The value is true if the device has successfully contacted and received A-GPS info from the A-GPS server, otherwise the value is false.

After a reboot the value is false until the server could be contacted again.

- 2.4
Device.FAP.PerfMgmt. object - This object contains parameters relating to Performance Management in a Femto-related environment. - 2.4
ConfigNumberOfEntries unsignedInt - The number of entries in the Config table. - 2.4
Device.FAP.PerfMgmt.Config.{i}. object W

This object contains parameters relating to File Management configuration for uploading of Performance Files to a designated File Server. Each table entry can be referenced by zero or more radio-specific objects contained in the FAPService instances. The periodic upload will upload data for all of the radio-specific objects that reference it.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with all the same values for URL, PeriodicUploadInterval and PeriodicUploadTime.

- 2.4
Enable boolean W Enables or disables this entry. If this entry is disabled then its periodic uploads are not performed. - 2.4
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.4
URL string­(256) W

URL specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported.

This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.

- 2.4
Username string­(256) W Username to be used by the device to authenticate with the file server. This string is set to an empty string if no authentication is used. - 2.4
Password string­(256) W

Password to be used by the device to authenticate with the file server. This string is set to an empty string if no authentication is used.

When read, this parameter returns an empty string, regardless of the actual value.

- 2.4
PeriodicUploadInterval unsignedInt­[1:] W The duration in seconds of the interval for which the device MUST create a Performance File and attempt to upload the file to URL if Enable is true. - 2.4
PeriodicUploadTime dateTime W

An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the PeriodicUploadInterval.

PeriodicUploadTime is used only to set the "phase" of the periodic uploads. The actual value of PeriodicUploadTime can be arbitrarily far into the past or future.

For example, if PeriodicUploadInterval is 86400 (a day) and if PeriodicUploadTime is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicUploadTime refers to a day in the future.

The Unknown Time value as defined in [Section 3.2/TR-106a4] indicates that no particular time reference is specified. That is, the device MAY locally choose the time reference, and is REQUIRED only to adhere to the specified PeriodicUploadInterval.

If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the PeriodicUploadTime parameter was set to the Unknown Time value.

- 2.4
Device.FAP.ApplicationPlatform. object -

This object defines the data model for the following Femtozone APIs.

  • Femto Awareness
  • SMS
  • MMS
  • Terminal Location

Femto Awareness, SMS, MMS, and Terminal Location APIs are defined in the Release 1 API Specifications of the Service SIG in the Femto Forum (non public document).

[Appendix I/TR-262] provides the "Theory of Operation" for the usage of this object.

- 2.4
Version string­(64) - Version of Femto Application Platform running on this device - 2.4
Enable boolean W Enable or disable the Femto ApplicationPlatform - 2.4
Status string -

Current state of the Femto Application Platform. Enumeration of:

  • Disabled (The Femto Application Platform is not available)
  • Enabled (The Femto Application Platform is available)
  • Reset (The FemtoApplicationPlatform is in the process of being reset and will transition to the Disabled state when the reset operation is completed)
  • Initializing (The FemtoApplicationPlatform is being initialized and will transition to the Enabled state once the initialization is completed)
- 2.4
MaxNumberOfApplications unsignedInt - Determines how many Femtozone Applications can be supported by the Femto Application Platform simultaneously. - 2.4
CurrentNumberofApplications unsignedInt - Specifies how many Femtozone Applications are currently communicating with the Femto Application Platform. - 2.4
Device.FAP.ApplicationPlatform.Capabilities. object - This object contains parameters related to the capabilities of the Femtozone Application Platform and the Femtozone APIs. - 2.4
PresenceApplicationSupport boolean - Specifies whether the Femto Application Platform supports Presence-Based Femtozone Applications - 2.4
FemtoAwarenessAPISupport boolean - Specifies whether the Femto Awareness API is supported on this device. - 2.4
SMSAPISupport boolean - Specifies whether the SMS API is supported on this device. - 2.4
SubscribeToNotificationsOfSMSSentToApplicationSupport boolean - Specifies whether the SubscribeToNotificationsOfSMSSentToApplication functionality is supported by the FAP SMS API. - 2.4
QuerySMSDeliveryStatusSupport boolean - Specifies whether the QuerySMSDeliveryStatus functionality is supported by the FAP SMS API. - 2.4
MMSAPISupport boolean - Specifies whether the MMS API is supported on this device. - 2.4
QueryMMSDeliveryStatusSupport boolean - Specifies whether the QueryMMSDeliveryStatus functionality is supported by the FAP MMS API. - 2.4
SubscribeToNotificationsOfMMSSentToApplicationSupport boolean - Specifies whether the SubscribeToNotificationsOfMMSSentToApplication functionality is supported by the FAP MMS API. - 2.4
TerminalLocationAPISupport boolean - Specifies whether the Terminal Location API is supported on this device. - 2.4
AuthenticationMethodsSupported string -

Comma-separated list of strings. Specifies the supported methods that 3rd Party Applications can use to authenticate with the Femto Application Platform at initialization. Comma separated list of strings. Each list item is an enumeration of:

- 2.4
AccessLevelsSupported string -

Comma-separated list of strings. Specifies the supported access levels that 3rd Party Applications can request when authenticating with the Femto Application Platform at initialization. This access level is with respect to resources within the Femto Application Platform only (not to be confused with Access Mode parameter in .FAPService.{i}.AccessMgmt). Each list item is an enumeration of:

- 2.4
SendSMSTargetAddressType string -

Comma-separated list of strings. Specifies the supported types of addresses SMSs can be sent to. Each list item is an enumeration of:

- 2.4
SendMMSTargetAddressType string -

Comma-separated list of strings. Specifies the supported types of addresses MMSs can be sent to. Each list item is an enumeration of:

- 2.4
Device.FAP.ApplicationPlatform.Control. object - This object contains parameters related to the operation of the Femtozone APIs. - 2.4
AuthenticationMethod string­(256) W

Specifies how 3rd Party Applications have to authenticate against Femto APIs in order to use it. The value MUST be a member of the list reported by the Capabilities.AuthenticationMethodsSupported parameter.

Note: The credentials are not part of the data model and have to be supplied externally.

- 2.4
TunnelInst string­(256) W

This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic.

If InternetGatewayDevice:1 [TR-098] or Device:1 [TR-181i1]) is used as root data model the TunnelInst MUST point to a row in the .FAP.Tunnel.IKESA.{i}. table.

If the root data model used is Device:2 [TR-181i2] than the TunnelInst MUST point to an tunnel instance defined in this data model.

If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.4
Device.FAP.ApplicationPlatform.Control.FemtoAwareness. object - This object contains parameters related to the Femto Awareness API. - 2.4
APIEnable boolean W Enable or disable FemtoAwareness API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to Femto Awareness API. Enumeration of:

- 2.4
MaxAPIUsersNumber unsignedInt­[0:255] W Determines the Max Number of different Applications that can send Requests to Femto Awareness API. - 2.4
FemtozoneID string­(256) W Specifies Identifier of the Femtozone. - 2.4
NotificationsUserIdentifierMSISDN boolean W Specifies whether the Mobile Station International Subscriber Directory Number (MSISDN) has to be used as UserIdentifier in Femto Awareness Notifications. A value of true means that the MSISDN is send as user identifier, a value of false means that an anonymous reference is used. - 2.4
SubscribeToNotificationsResponseCallbackData boolean W Specifies whether the OPTIONAL Argument "Callback Data" has to be used in Responses to Requests to "Subscribe To Femto Awareness Notifications". - 2.4
QueryFemtocellResponseTimezone boolean W Specifies whether the OPTIONAL Argument "Timezone" has to be used in Responses to Requests to "Query Femtocell Status". - 2.4
Device.FAP.ApplicationPlatform.Control.SMS. object - This object contains parameters related to the SMS API. - 2.4
APIEnable boolean W Enable or disable SMS API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to SMS API. Enumeration of:

- 2.4
MaxAPIUsersNumber unsignedInt­[0:255] W Determines the Max Number of different Applications that can send Requests to SMS API. - 2.4
MinSendSMSTimeInterval unsignedInt­[0:3599] W Determines the Minimum Time Interval in seconds between two consecutive Send SMS Requests by the same Application. - 2.4
EnableQuerySMSDeliveryStatus boolean W Enable or disable "QuerySMSDeliveryStatus" Operation on SMS API. When disabled, QuerySMSDeliveryStatus Requests to SMS API are ignored. - 2.4
EnableSubscribeToNotificationsOfMessageSentToApplication boolean W Enable or disable "SubscribeToNotificationsOfMessageSentToApplication" Operation on SMS API. When disabled, SubscribeTo NotificationsOfMessageSentToApplication Requests to SMS API are ignored. - 2.4
Device.FAP.ApplicationPlatform.Control.MMS. object - This object contains parameters related to the MMS API. - 2.4
APIEnable boolean W Enable or disable MMS API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to MMS API. Enumeration of:

- 2.4
MaxAPIUsersNumber unsignedInt­[0:255] W Determines the Max Number of different Applications that can send Requests to MMS API. - 2.4
MinSendMMSTimeInterval unsignedInt­[0:3599] W Determines the Minimum Time Interval in seconds between two consecutive Send MMS Requests by the same Application. - 2.4
EnableQueryMMSDeliveryStatus boolean W Enable or disable "QuerySMSDeliveryStatus" Operation on MMS API. When disabled, QuerySMSDeliveryStatus Requests to MMS API are ignored. - 2.4
EnableSubscribeToNotificationsOfMessageSentToApplication boolean W Enable or disable "SubscribeTo NotificationsOfMessageSentToApplication" Operation on MMS API. When disabled, SubscribeTo NotificationsOfMessageSentToApplication Requests to MMS API are ignored. - 2.4
Device.FAP.ApplicationPlatform.Control.TerminalLocation. object - This object contains parameters related to the TerminalLocation API. - 2.4
APIEnable boolean W Enable or disable TerminalLocation API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to TerminalLocation API. Enumeration of:

- 2.4
MaxAPIUsersNumber unsignedInt­[0:255] W Determines the Max Number of different Applications that can send Requests to TerminalLocation API. - 2.4
QueryMobileLocationResponseAddress string W

Specifies Terminal Address Format to be used in QueryMobileLocation Responses. Enumeration of:

- 2.4
QueryMobileLocationResponseLongitudeLatitude boolean W Include or exclude FAP Longitude and Latitude arguments in Responses to QueryMobileLocation Requests. - 2.4
QueryMobileLocationResponseAltitude boolean W Include or exclude FAP Altitude argument in Responses to QueryMobileLocation Requests . - 2.4
QueryMobileLocationResponseTimestamp unsignedInt­[0:86399] W Specifies Response Timestamp in seconds. - 2.4
Device.FAP.ApplicationPlatform.Monitoring. object - This object contains parameters related to the monitoring of the Femtozone Application Platform and the Femtozone APIs. - 2.4
Enable boolean W Enables and disables this entry. - 2.4
MonitoringInterval unsignedInt W Specifies the interval in seconds used to collect the monitoring measurements. - 2.4
AuthenticationRequestsReceived unsignedInt - Specifies the total number of authentication requests received by the Femto Application Platform. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
AuthenticationRequestsRejected unsignedInt - Specifies the number of authentication requests received by the Femto Application Platform that were rejected. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.FemtoAwareness. object - This object contains parameters related to the Monitoring of the FemtoAwareness API. - 2.4
APIAvailable boolean - Specifies whether the FemtoAwareness API is currently available on this device (the API could be disabled or could have exhausted its resources) - 2.4
APIUsers unsignedInt­[0:255] - Specifies the current number of Applications using the Femto Awareness API. - 2.4
QueueState string -

Specifies the state of the Femto Awareness API Queue. Enumeration of:

- 2.4
QueueNum unsignedInt­[0:255] - Specifies the current number of requests waiting in the Femto Awareness API Queue. - 2.4
QueueReceived unsignedInt - Specifies the number of requests in the Femto Awareness API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt - Specifies the number of requests in the Femto Awareness API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.SMS. object - This object contains parameters related to the Monitoring of the SMS API. - 2.4
APIAvailable boolean - Specifies whether the SMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 2.4
APIUsers unsignedInt­[0:255] - Specifies the current number of Applications using the SMS API. - 2.4
QueueState string -

Specifies the state of the SMS API Queue. Enumeration of:

- 2.4
QueueNum unsignedInt­[0:255] - Specifies the current number of requests waiting in the SMS API Queue. - 2.4
QueueReceived unsignedInt - Specifies the number of requests in the SMS API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt - Specifies the number of requests in the SMS API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.MMS. object - This object contains parameters related to the Monitoring of the MMS API. - 2.4
APIAvailable boolean - Specifies whether the MMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 2.4
APIUsers unsignedInt­[0:255] - Specifies the current number of Applications using the MMS API. - 2.4
QueueState string -

Specifies the state of the MMS API Queue. Enumeration of:

- 2.4
QueueNum unsignedInt­[0:255] - Specifies the current number of requests waiting in the MMS API Queue. - 2.4
QueueReceived unsignedInt - Specifies the number of requests in the MMS API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt - Specifies the number of requests in the MMS API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.TerminalLocation. object - This object contains parameters related to the Monitoring of the TerminalLocation API. - 2.4
APIAvailable boolean - Specifies whether the TerminalLocation API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 2.4
APIUsers unsignedInt­[0:255] - Specifies the current number of Applications using the Terminal Location API. - 2.4
QueueState string -

Specifies the state of the Terminal Location API Queue. Enumeration of:

- 2.4
QueueNum unsignedInt­[0:255] - Specifies the current number of requests waiting in the Terminal Location API Queue. - 2.4
QueueReceived unsignedInt - Specifies the number of requests in the Terminal Location API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt - Specifies the number of requests in the Terminal Location API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4

Inform and Notification Requirements

Forced Inform Parameters

Parameter
Device.RootDataModelVersion

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter
Device.FAP.GPS.LastScanTime

Parameters for which Active Notification MAY be Denied

Parameter
Device.Optical.Interface.{i}.
LastChange
Device.Optical.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
DiscardPacketsSent
DiscardPacketsReceived
Device.Ethernet.RMONStats.{i}.
DropEvents
Bytes
Packets
BroadcastPackets
MulticastPackets
CRCErroredPackets
UndersizePackets
OversizePackets
Packets64Bytes
Packets65to127Bytes
Packets128to255Bytes
Packets256to511Bytes
Packets512to1023Bytes
Packets1024to1518Bytes
Device.Ghn.Interface.{i}.
LastChange
Device.Ghn.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Ghn.Interface.{i}.AssociatedDevice.{i}.
TxPhyRate
RxPhyRate
Device.FAP.GPS.
LastSuccessfulScanTime
LockedLatitude
LockedLongitude
NumberOfSatellites
Device.FAP.GPS.ContinuousGPSStatus.
CurrentFix
GotFix
TimingGood
Latitude
Longitude
Elevation
LastFixTime
LastFixDuration
SatellitesTracked
ReceiverStatus
LocationType

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

Location:1 Profile

This table defines the Location:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­DeviceInfo. P
LocationNumberOfEntries R
Device.­DeviceInfo.­Location.­{i}. C
Source R
AcquiredTime R
ExternalSource R
ExternalProtocol R
DataObject W

FaultMgmtSupportedAlarms:1 Profile

This table defines the FaultMgmtSupportedAlarms:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FaultMgmt. P
SupportedAlarmNumberOfEntries R
Device.­FaultMgmt.­SupportedAlarm.­{i}. P
EventType R
ProbableCause R
SpecificProblem R
PerceivedSeverity R
ReportingMechanism W

FaultMgmtActive:1 Profile

This table defines the FaultMgmtActive:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FaultMgmt. P
CurrentAlarmNumberOfEntries R
Device.­FaultMgmt.­CurrentAlarm.­{i}. P
AlarmIdentifier R
AlarmRaisedTime R
AlarmChangedTime R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtHistory:1 Profile

This table defines the FaultMgmtHistory:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FaultMgmt. P
HistoryEventNumberOfEntries R
Device.­FaultMgmt.­HistoryEvent.­{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtExpedited:1 Profile

This table defines the FaultMgmtExpedited:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FaultMgmt. P
ExpeditedEventNumberOfEntries R
Device.­FaultMgmt.­ExpeditedEvent.­{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtQueued:1 Profile

This table defines the FaultMgmtQueued:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FaultMgmt. P
QueuedEventNumberOfEntries R
Device.­FaultMgmt.­QueuedEvent.­{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FAP_GPS:1 Profile

This table defines the FAP_GPS:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FAP.­GPS. P
ScanOnBoot W
ScanPeriodically W
PeriodicInterval W
PeriodicTime W
ContinuousGPS W
ScanTimeout W
ScanStatus R
ErrorDetails R
LastScanTime R
LastSuccessfulScanTime R
LockedLatitude R
LockedLongitude R
NumberOfSatellites R

FAP_PerfMgmt:1 Profile

This table defines the FAP_PerfMgmt:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FAP.­PerfMgmt. P
ConfigNumberOfEntries R
Device.­FAP.­PerfMgmt.­Config.­{i}. P
Enable W
URL W
Username W
Password W
PeriodicUploadInterval W
PeriodicUploadTime W

FAP_ApplicationPlatform:1 Profile

This table defines the FAP_ApplicationPlatform:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­FAP.­ApplicationPlatform. P
Version R
Enable W
MaxNumberOfApplications R
Device.­FAP.­ApplicationPlatform.­Control. P
AuthenticationMethod W
Device.­FAP.­ApplicationPlatform.­Control.­FemtoAwareness. P
APIEnable W
MaxAPIUsersNumber W
FemtozoneID W
Device.­FAP.­ApplicationPlatform.­Control.­SMS. P
APIEnable W
MaxAPIUsersNumber W
MinSendSMSTimeInterval W
Device.­FAP.­ApplicationPlatform.­Control.­MMS. P
APIEnable W
MaxAPIUsersNumber W
MinSendMMSTimeInterval W
Device.­FAP.­ApplicationPlatform.­Control.­TerminalLocation. P
APIEnable W
MaxAPIUsersNumber W
QueryMobileLocationResponseAddress W
QueryMobileLocationResponseLongitudeLatitude W

Baseline:3 Profile

The Baseline:3 profile for the Device:2 data model is defined as the union of the Baseline:2 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device. P
RootDataModelVersion R

Optical:1 Profile

This table defines the Optical:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­Optical. P
InterfaceNumberOfEntries R
Device.­Optical.­Interface.­{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
OpticalSignalLevel R
TransmitOpticalLevel R
Device.­Optical.­Interface.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

EthernetRMONStats:1 Profile

This table defines the EthernetRMONStats:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­Ethernet. P
RMONStatsNumberOfEntries R
Device.­Ethernet.­RMONStats.­{i}. P
Enable W
Status R
Interface R
Bytes R
Packets R
CRCErroredPackets R

Ghn:1 Profile

This table defines the Ghn:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.­Ghn. P
InterfaceNumberOfEntries R
Device.­Ghn.­Interface.­{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
FirmwareVersion R
TargetDomainNames W
DomainName R
DomainNameIdentifier R
DomainId R
DeviceId R
MaxBitRate R
NodeTypeDMCapable R
NodeTypeSCCapable R
NodeTypeDMConfig R
NodeTypeDMStatus R
NodeTypeSCStatus R
AssociatedDeviceNumberOfEntries R
Device.­Ghn.­Interface.­{i}.­Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
Device.­Ghn.­Interface.­{i}.­AssociatedDevice.­{i}. P
MACAddress R
DeviceId R
TxPhyRate R
RxPhyRate R
Active R


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:22:54.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-4-0-diffs.html tr-181-2-4-0.xml