Broadband Forum

Femto Component Objects

tr-262-1-0-0.xml

DATA MODEL DEFINITION

License

Copyright (c) 2011-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.

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

Data Type Base Type Description
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 [SOAP1.1].
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.

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.

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-069] and described in [Appendix II/TR-069], 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.
IPAddress string(:45)

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

References

[3GPP-TS.23.107] 3GPP TS 23.107, Quality of Service (QoS) concept and architecture, 3GPP SA WG2.
[3GPP-TS.25.171] 3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4.
[3GPP-TS.32.582] 3GPP TS 32.582, Telecommunications management; Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Information model for Type 1 interface HNB to HNB Management System (HMS), 3GPP SA WG5.
[3GPP-TS.32.584] 3GPP TS 32.584, Telecommunications management; Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); XML definitions for Type 1 interface HNB to HNB Management Systems (HMS), 3GPP SA WG5.
[3GPP-TS.32.592] 3GPP TS 32.592, Telecommunications management; Home enhanced Node B (HeNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Information model for Type 1 interface HeNB to HeNB Management System (HeMS), 3GPP SA WG5.
[3GPP2-S.S0132] S.S0132-0 v1.0, Femtocell Security Framework, 3GPP2, January 2010.
[3GPP2-X.S0011] X.S0011-005-C, cdma2000 Wireless IP Network Standard: Accounting Services and 3GPP2 RADIUS VSAs, 3GPP2, August 2003.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4307] RFC 4307, Cryptographic Algorithms for Use in the Internet Key Exchange Version 2 (IKEv2), IETF, December 2005.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4835] RFC 4835, Cryptographic Algorithm Implementation Requirements for Encapsulating Security Payload (ESP) and Authentication Header (AH), IETF, 2007.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-098] TR-098 Amendment 2 Corrigendum 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2014.
[TR-098a2] TR-098 Amendment 2, Internet Gateway Device Data Model for TR-069, Broadband Forum, September 2008.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, February 2010.
[TR-157a5] TR-157 Amendment 5, Component Objects for CWMP, Broadband Forum, November 2011.
[TR-181i1] TR-181 Issue 1, Device Data Model for TR-069, Broadband Forum, February 2010.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[TR-196i2] TR-196 Issue 2, Femto Access Point Service Data Model, Broadband Forum, November 2011.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Parameter definition.

TR-262:1.0 Data Model

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 1.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
FAP. object R 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. - 1.0
FAP.GPS. object R This object contains the parameters relating to the GPS scan. - 1.0
ScanOnBoot boolean W

Enables or disables GPS scans during the device start up.

The factory default value MUST be true.

 - 1.0
ScanPeriodically boolean W

Enables or disables periodic GPS scans.

The factory default value MUST be false.

 - 1.0
PeriodicInterval unsignedInt W When ScanPeriodically is true, this value indicates the interval in seconds which GPS scan is performed. - 1.0
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. - 1.0
ContinuousGPS boolean W Whether or not the device SHOULD maintain a continuous GPS lock (e.g. as a frequency stability source). - 1.0
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” - 1.0
ScanStatus string R

Indicates the current status of this scan.

Enumeration of:

  • Indeterminate (The scan has not been executed and there are no valid scan results available)
  • InProgress
  • Success
  • Error
  • Error_TIMEOUT
 - 1.0
ErrorDetails string(:256) R Provides more detail when the ScanStatus is either Error or Error_TIMEOUT. - 1.0
LastScanTime dateTime R

The date and time when the last GPS scan completed.

Active Notification MUST by default be enabled for this parameter.

 - 1.0
LastSuccessfulScanTime dateTime R

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

Active Notification requests for this parameter MAY be denied.

 - 1.0
LockedLatitude int(-90000000:90000000) R

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 (131,000,000)+((19.431,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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
LockedLongitude int(-180000000:180000000) R

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 (131,000,000)+((19.431,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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
NumberOfSatellites unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
GPSReset boolean W Setting this to true will cause a reset on the GPS Hardware. Setting this to false has no effect. - 1.0
FAP.GPS.ContinuousGPSStatus. object R 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. - 1.0
CurrentFix boolean R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
GotFix boolean R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
TimingGood boolean R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Latitude int(-90000000:90000000) R

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 (131,000,000)+((19.431,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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Longitude int(-180000000:180000000) R

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 (131,000,000)+((19.431,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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Elevation int(-5000000:25000000) R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
LastFixTime dateTime R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
LastFixDuration unsignedInt R

Number of seconds of continuous GPS fix time. After a reboot this value is reset to 0.

Active Notification requests for this parameter MAY be denied.

 - 1.0
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. - 1.0
SatellitesTracked unsignedInt R

The number of satellites the receiver is tracking.

Active Notification requests for this parameter MAY be denied.

 - 1.0
SatelliteTrackingInterval unsignedInt(60:3600) W The interval in seconds at which the GPS tracking information gets reported. - 1.0
ReceiverStatus string(:256) R

The output of the GPS receiver’s status.

Active Notification requests for this parameter MAY be denied.

 - 1.0
LocationType string R

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:

  • Real
  • Reference

Active Notification requests for this parameter MAY be denied.

 - 1.0
LockTimeOutDuration unsignedInt(120:86400) W The timer duration, in seconds, for which the device waits for GPS to acquire lock. - 1.0
FAP.GPS.AGPSServerConfig. object R 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] - 1.0
Enable boolean W Enables or disables the AGPSServerConfig entry. - 1.0
ServerURL string(:256) W A-GPS server host name or IP address. - 1.0
ServerPort unsignedInt(:65535) W The port to use when communicating to the A-GPS Server. - 1.0
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. - 1.0
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.

 - 1.0
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 (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00’ S would be represented as value -50,000,000. - 1.0
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 (131,000,000)+((19.431,000,000)/60). A longitude of 50d00’00* W would be represented as value -50,000,000. - 1.0
ServerInUse boolean R 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. - 1.0
FAP.Tunnel. object R This object contains parameters relating to Tunneling. - 1.0
CryptoProfileNumberOfEntries unsignedInt R The number of entries in the CryptoProfile table. - 1.0
IKESANumberOfEntries unsignedInt R The number of entries in the IKESA table. - 1.0
ChildSANumberOfEntries unsignedInt R The number of entries in the ChildSA table. - 1.0
MaxVirtualInterfaces unsignedInt R The maximum number of virtual interfaces. - 1.0
VirtualInterfaceNumberOfEntries unsignedInt R The number of entries in the VirtualInterface table. - 1.0
UseForCWMP boolean W If the SecGW parameters are configured then this parameter determines whether the CWMP traffic will be sent across the IPsec tunnel(s) or outside of the IPsec tunnel(s). If false then the CWMP traffic will be sent outside of the IPsec tunnel(s). If true then the CWMP traffic will be sent across the IPsec tunnel(s). - 1.0
MaxChildSAPerIKE unsignedInt R Indicates the maximum number of child SAs per IKE session that the device is capable of supporting. - 1.0
MaxIKESessions unsignedInt R Indicates the maximum number of IKE sessions the device is capable of supporting at any given time. - 1.0
FAP.Tunnel.CryptoProfile.{i}. object(0:) W

This object contains parameters relating to IKEv2 and IPsec crypto profiles, which are essentially a subset of the typical IPsec SPD. [RFC4301]. For Cdma2000 devices, see also [3GPP2-S.S0132].

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 the same values for all of AuthMethod, IKEEncrypt, IKEPRF, IKEIntegrity, IKEDH, ESPEncrypt and ESPIntegrity.

 - 1.0
Enable boolean W Enables and disables this entry. false 1.0
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 1.0
AuthMethod string(:256) W Specifies the Security mechanism and set of credentials used by the device to authenticate itself (either an instance of the .Security.Certificate. object defined in [TR-157a5] or an instance of the .Services.FAPService.{i}.Transport.Security.Secret. object defined in [TR-196i2]). The value MUST be the Path Name of a table row. If the value is an an empty string, the device chooses the authentication method based on local policy. In order to configure the device for both device and hosting-party authentication, the object is populated with an enabled instance of the .Security.Certificate.. object. <Empty> 1.0
MaxChildSA unsignedInt(2,4,6,8,10) W Controls the maximum number of child SAs that can be negotiated by a single IKE session. 2 1.0
IKEEncrypt string[] W

Comma-separated list of strings. IKEv2 encryption algorithm. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132].

Each list item is an enumeration of:

  • 3DES-CBC
  • AES-CBC
 AES-CBC 1.0
IKEPRF string[] W

Comma-separated list of strings. IKEv2 pseudo-random function. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132].

Each list item is an enumeration of:

  • HMAC-SHA1
  • AES-XCBC-PRF-128
 HMAC-SHA1 1.0
IKEIntegrity string[] W

Comma-separated list of strings. IKEv2 integrity function. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132].

Each list item is an enumeration of:

  • HMAC-SHA1-96
  • AES-XCBC-MAC-96
 HMAC-SHA1-96 1.0
IKEDH string[] W

Comma-separated list of strings. IKEv2 pseudo-random function. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132].

Each list item is an enumeration of:

  • 1024
  • 2048
 2048 1.0
ESPEncrypt string[] W

Comma-separated list of strings. IPsec encryption algorithm. [Section 3.1.1/RFC4835] For CDMA2000 devices, see also [3GPP2-S.S0132].

Each list item is an enumeration of:

  • 3DES-CBC
  • AES-CBC
  • Null
 AES-CBC 1.0
ESPIntegrity string[] W

Comma-separated list of strings. IPsec integrity function. [Section 3.1.1/RFC4835] For CDMA2000 devices, see also [3GPP2-S.S0132].

Each list item is an enumeration of:

  • HMAC-SHA1-96
  • AES-XCBC-MAC-96
 HMAC-SHA1-96 1.0
IPsecWindowSize unsignedInt W The size of the Anti-Replay Window. If 0 Sequence Number Verification is disabled. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. 0 1.0
IKERekeyLifetime unsignedInt W IKEv2 SA rekey timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. - 1.0
IPsecRekeyLifetimeByte unsignedInt W IPsec SA rekey timeout in Kilobytes. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. - 1.0
IPsecRekeyLifetimeTime unsignedInt W IPsec SA rekey timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. - 1.0
DPDTimer unsignedInt W DPD timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. 300 1.0
NATTKeepaliveTimer unsignedInt W NAT-T keepalive timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. 180 1.0
SecMaxFragSize unsignedInt(256:1400) W Maximum fragment size, in bytes, from device before Encryption. For CDMA2000 devices, see also [3GPP2-S.S0132]. 1200 1.0
SecDFBit string W

Indicates if the ‘Do Not Fragment’ bit needs to be turned on/off. For CDMA2000 devices, see also [3GPP2-S.S0132].

Enumeration of:

  • On
  • Off
 Off 1.0
FAP.Tunnel.IKESA.{i}. object(0:) R

IKE IPsec Security Association Table. This Table is a member of the IPsec Security Association Database (SAD). [RFC4301].

At most one entry in this table can exist with the same values for both IPAddress and SubnetMask.

 - 1.0
Status string R

The status of this IKE SA entry.

Enumeration of:

  • Disabled
  • Active
  • Completed
  • Progressing
  • Error (This value MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)
 - 1.0
PeerAddress string(:45) R [IPAddress] The IP address of the peer SecGW. - 1.0
CreationTime dateTime R The time that the current IKE SA was set up. - 1.0
IPAddress string(:45) R

[IPAddress] The current IP address assigned to this interface by IKEv2.

Active Notification MUST by default be enabled for this parameter.

 - 1.0
SubnetMask string R The current subnet mask assigned to this interface by IKEv2. - 1.0
DNSServers string(:45)[](:256) R [IPAddress] Comma-separated list (maximum number of characters 256) of IP Addresses. Each item is an IP Address of a DNS server for this interface assigned to this interface by IKEv2. - 1.0
DHCPServers string(:45)[](:256) R [IPAddress] Comma-separated list (maximum number of characters 256) of IP Addresses. Each item is an IP address of a DHCP server for this interface. A non empty list instructs the CPE to send any internal DHCP request to the address contained within this parameter. - 1.0
IntegrityErrors unsignedInt R

The number of inbound packets discarded by the IKE SA due to Integrity checking errors.

Active Notification requests for this parameter MAY be denied.

 - 1.0
OtherErrors unsignedInt R

The number of inbound packets discarded by the IKE SA due to other errors, such as anti-replay errors.

Active Notification requests for this parameter MAY be denied.

 - 1.0
AuthErrors unsignedInt R

The number of inbound packets discarded by the IKE SA due to authentication errors.

Active Notification requests for this parameter MAY be denied.

 - 1.0
FAP.Tunnel.ChildSA.{i}. object(0:) R

Child IPsec Security Association Table. This Table is a member of the IPsec Security Association Database (SAD). [RFC4301].

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

 - 1.0
ParentID string(:256) R The value MUST be the Path Name of a row in the IKESA. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.0
SPI unsignedInt R SPI value of the Child SA. - 1.0
DirectionOutbound boolean R Traffic Direction. If true this Child SA refers to outbound traffic. If false this Child SA refers to inbound traffic. - 1.0
CreationTime dateTime R The time that the current Child SA was set up. - 1.0
Traffic unsignedInt R The measured traffic in bytes transferred by the Child SA. - 1.0
IntegrityErrors unsignedInt R

The number of inbound packets discarded by the Child SA due to integrity checking errors.

Active Notification requests for this parameter MAY be denied.

 - 1.0
ReplayErrors unsignedInt R

The number of inbound packets discarded by the Child SA due to anti-replay errors.

Active Notification requests for this parameter MAY be denied.

 - 1.0
FAP.Tunnel.VirtualInterface.{i}. object(0:) W

Virtual Interfaces used for associating the tunnel (ephemeral) childSA pairs with QoS Classification and Queue tables as defined in [TR-098a2] (InternetGatewayDevice.QueueManagement.Classification.{i}. and InternetGatewayDevice.QueueManagement.Queue.{i}.) or [TR-181i2] (Device.QoS.Classification.{i}. and Device.QoS.Queue.{i}.).

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 the same values for both CryptoProfile and DSCPMarkPolicy.

 - 1.0
Enable boolean W Enables and disables this entry. false 1.0
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 1.0
CryptoProfile string(:256) W The value MUST be the Path Name of a row in the CryptoProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If multiple instances of VirtualInterface point to the same CryptoProfile instance, the associated CryptoProfile.{i}.MaxChildSA determines whether a new IKE session will be created (dynamically) to negotiate the child SA(s) for each of the virtual interfaces; otherwise, they are negotiated through the same IKE session. <Empty> 1.0
DSCPMarkPolicy int(-2:) W DSCP to mark the outer IP header for traffic that is associated with this virtual interface. A value of -1 indicates copy from the incoming packet. A value of -2 indicates automatic marking of DSCP as defined for the UMTS QoS class [3GPP-TS.23.107] or CDMA2000 Subscriber QoS profile [3GPP2-X.S0011]. De-tunneled packets are never re-marked. -1 1.0
FAP.PerfMgmt. object R This object contains parameters relating to Performance Management in a Femto-related environment. - 1.0
ConfigNumberOfEntries unsignedInt R The number of entries in the Config table. - 1.0
FAP.PerfMgmt.Config.{i}. object(0:) 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 the same values for all of URL, PeriodicUploadInterval and PeriodicUploadTime.

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

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

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

 - 1.0
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. - 1.0
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. - 1.0
FAP.ApplicationPlatform. object R 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.
 - 1.0
Version string(:64) R Version of Femto Application Platform running on this device - 1.0
Enable boolean W Enable or disable the Femto ApplicationPlatform - 1.0
Status string R

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)
 - 1.0
MaxNumberOfApplications unsignedInt R Determines how many Femtozone Applications can be supported by the Femto Application Platform simultaneously. - 1.0
CurrentNumberofApplications unsignedInt R Specifies how many Femtozone Applications are currently communicating with the Femto Application Platform. - 1.0
FAP.ApplicationPlatform.Capabilities. object R This object contains parameters related to the capabilities of the Femtozone Application Platform and the Femtozone APIs. - 1.0
PresenceApplicationSupport boolean R Specifies whether the Femto Application Platform supports Presence-Based Femtozone Applications - 1.0
FemtoAwarenessAPISupport boolean R Specifies whether the Femto Awareness API is supported on this device. - 1.0
SMSAPISupport boolean R Specifies whether the SMS API is supported on this device. - 1.0
SubscribeToNotificationsOfSMSSentToApplicationSupport boolean R Specifies whether the SubscribeToNotificationsOfSMSSentToApplication functionality is supported by the FAP SMS API. - 1.0
QuerySMSDeliveryStatusSupport boolean R Specifies whether the QuerySMSDeliveryStatus functionality is supported by the FAP SMS API. - 1.0
MMSAPISupport boolean R Specifies whether the MMS API is supported on this device. - 1.0
QueryMMSDeliveryStatusSupport boolean R Specifies whether the QueryMMSDeliveryStatus functionality is supported by the FAP MMS API. - 1.0
SubscribeToNotificationsOfMMSSentToApplicationSupport boolean R Specifies whether the SubscribeToNotificationsOfMMSSentToApplication functionality is supported by the FAP MMS API. - 1.0
TerminalLocationAPISupport boolean R Specifies whether the Terminal Location API is supported on this device. - 1.0
AuthenticationMethodsSupported string[] R

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:

  • Basic
  • Digest
  • DigitalSignature
 - 1.0
AccessLevelsSupported string[] R

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:

  • Guest
  • Standard
  • Restricted
  • Administrator
  • Debug
 - 1.0
SendSMSTargetAddressType string[] R

Comma-separated list of strings. Specifies the supported types of addresses SMSs can be sent to.

Each list item is an enumeration of:

  • TelUri
  • AnonymousReference
  • All
 - 1.0
SendMMSTargetAddressType string[] R

Comma-separated list of strings. Specifies the supported types of addresses MMSs can be sent to.

Each list item is an enumeration of:

  • TelUri
  • AnonymousReference
  • All
 - 1.0
FAP.ApplicationPlatform.Control. object R This object contains parameters related to the operation of the Femtozone APIs. - 1.0
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. - 1.0
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. - 1.0
FAP.ApplicationPlatform.Control.FemtoAwareness. object R This object contains parameters related to the Femto Awareness API. - 1.0
APIEnable boolean W Enable or disable FemtoAwareness API exposure on FAP - 1.0
QueueEnable boolean W Enable or disable Request queueing for the API - 1.0
Queueing string W

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

Enumeration of:

  • FiFo
  • Priority
 - 1.0
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to Femto Awareness API. - 1.0
FemtozoneID string(:256) W Specifies Identifier of the Femtozone. - 1.0
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. - 1.0
SubscribeToNotificationsResponseCallbackData boolean W Specifies whether the OPTIONAL Argument “Callback Data” has to be used in Responses to Requests to “Subscribe To Femto Awareness Notifications”. - 1.0
QueryFemtocellResponseTimezone boolean W Specifies whether the OPTIONAL Argument “Timezone” has to be used in Responses to Requests to “Query Femtocell Status”. - 1.0
FAP.ApplicationPlatform.Control.SMS. object R This object contains parameters related to the SMS API. - 1.0
APIEnable boolean W Enable or disable SMS API exposure on FAP - 1.0
QueueEnable boolean W Enable or disable Request queueing for the API - 1.0
Queueing string W

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

Enumeration of:

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

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

Enumeration of:

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

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

Enumeration of:

  • FiFo
  • Priority
 - 1.0
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to TerminalLocation API. - 1.0
QueryMobileLocationResponseAddress string W

Specifies Terminal Address Format to be used in QueryMobileLocation Responses.

Enumeration of:

  • TelUri
  • AnonymousReference
 - 1.0
QueryMobileLocationResponseLongitudeLatitude boolean W Include or exclude FAP Longitude and Latitude arguments in Responses to QueryMobileLocation Requests. - 1.0
QueryMobileLocationResponseAltitude boolean W Include or exclude FAP Altitude argument in Responses to QueryMobileLocation Requests . - 1.0
QueryMobileLocationResponseTimestamp unsignedInt(0:86399) W Specifies Response Timestamp in seconds. - 1.0
FAP.ApplicationPlatform.Monitoring. object R This object contains parameters related to the monitoring of the Femtozone Application Platform and the Femtozone APIs. - 1.0
Enable boolean W Enables and disables this entry. - 1.0
MonitoringInterval unsignedInt W Specifies the interval in seconds used to collect the monitoring measurements. - 1.0
AuthenticationRequestsReceived unsignedInt R 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. - 1.0
AuthenticationRequestsRejected unsignedInt R 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. - 1.0
FAP.ApplicationPlatform.Monitoring.FemtoAwareness. object R This object contains parameters related to the Monitoring of the FemtoAwareness API. - 1.0
APIAvailable boolean R Specifies whether the FemtoAwareness API is currently available on this device (the API could be disabled or could have exhausted its resources) - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the Femto Awareness API. - 1.0
QueueState string R

Specifies the state of the Femto Awareness API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the Femto Awareness API Queue. - 1.0
QueueReceived unsignedInt R 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. - 1.0
QueueDiscarded unsignedInt R 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. - 1.0
FAP.ApplicationPlatform.Monitoring.SMS. object R This object contains parameters related to the Monitoring of the SMS API. - 1.0
APIAvailable boolean R Specifies whether the SMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the SMS API. - 1.0
QueueState string R

Specifies the state of the SMS API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the SMS API Queue. - 1.0
QueueReceived unsignedInt R 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. - 1.0
QueueDiscarded unsignedInt R 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. - 1.0
FAP.ApplicationPlatform.Monitoring.MMS. object R This object contains parameters related to the Monitoring of the MMS API. - 1.0
APIAvailable boolean R Specifies whether the MMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the MMS API. - 1.0
QueueState string R

Specifies the state of the MMS API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the MMS API Queue. - 1.0
QueueReceived unsignedInt R 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. - 1.0
QueueDiscarded unsignedInt R 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. - 1.0
FAP.ApplicationPlatform.Monitoring.TerminalLocation. object R This object contains parameters related to the Monitoring of the TerminalLocation API. - 1.0
APIAvailable boolean R Specifies whether the TerminalLocation API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the Terminal Location API. - 1.0
QueueState string R

Specifies the state of the Terminal Location API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the Terminal Location API Queue. - 1.0
QueueReceived unsignedInt R 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. - 1.0
QueueDiscarded unsignedInt R 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. - 1.0

Inform and Notification Requirements

Default Active Notification Parameters

Parameter
FAP.GPS.LastScanTime
FAP.Tunnel.IKESA.{i}.IPAddress

Parameters for which Active Notification MAY be Denied

Parameter
FAP.GPS.
LastSuccessfulScanTime
LockedLatitude
LockedLongitude
NumberOfSatellites
FAP.GPS.ContinuousGPSStatus.
CurrentFix
GotFix
TimingGood
Latitude
Longitude
Elevation
LastFixTime
LastFixDuration
SatellitesTracked
ReceiverStatus
LocationType
FAP.Tunnel.IKESA.{i}.
IntegrityErrors
OtherErrors
AuthErrors
FAP.Tunnel.ChildSA.{i}.
IntegrityErrors
ReplayErrors

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.

FAP_GPS:1 Profile

This table defines the FAP_GPS:1 profile for the TR-262:1 data model. The minimum REQUIRED version for this profile is TR-262:1.0.

Name Requirement
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_Tunnel:1 Profile

This table defines the FAP_Tunnel:1 profile for the TR-262:1 data model. The minimum REQUIRED version for this profile is TR-262:1.0.

Name Requirement
FAP.Tunnel. P
IKESANumberOfEntries R
ChildSANumberOfEntries R
MaxVirtualInterfaces R
VirtualInterfaceNumberOfEntries R
UseForCWMP W
MaxChildSAPerIKE R
MaxIKESessions R
FAP.Tunnel.IKESA.{i}. P
Status R
PeerAddress R
CreationTime R
IPAddress R
SubnetMask R
FAP.Tunnel.ChildSA.{i}. P
ParentID R
SPI R
DirectionOutbound R
CreationTime R
FAP.Tunnel.VirtualInterface.{i}. P
Enable W
CryptoProfile W
DSCPMarkPolicy W
FAP.Tunnel.CryptoProfile.{i}. C
Enable W
AuthMethod W
MaxChildSA W
IKEEncrypt W
IKEPRF W
IKEIntegrity W
IKEDH W
ESPEncrypt W
ESPIntegrity W

FAP_PerfMgmt:1 Profile

This table defines the FAP_PerfMgmt:1 profile for the TR-262:1 data model. The minimum REQUIRED version for this profile is TR-262:1.0.

Name Requirement
FAP.PerfMgmt. P
ConfigNumberOfEntries R
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 TR-262:1 data model. The minimum REQUIRED version for this profile is TR-262:1.0.

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

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:46:47 UTC.
report.py –filter model=None –output –transform automodel –format markdown tr-262-1-0-0.xml

Table of Contents