DATA MODEL DEFINITION

Networked Functional API (nFAPI) NFAPIService:1.0 Service Object definition
nFAPI-1-0-0.xml

Notice

Copyright Notification: The Small Cell Forum authorize you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services, nor does it encompass the granting of any patent rights. The Small Cell Forum assume no responsibility for errors or omissions in this document. © 2017, Small Cell Forum. All rights reserved.

Notice of Disclaimer & Limitation of Liability: The information provided in this document is directed solely to professionals who have the appropriate degree of experience to understand and interpret its contents in accordance with generally accepted engineering or other professional standards and applicable regulations. No recommendation as to products or vendors is made or should be implied. NO REPRESENTATION OR WARRANTY IS MADE THAT THE INFORMATION IS TECHNICALLY ACCURATE OR SUFFICIENT OR CONFORMS TO ANY STATUTE, GOVERNMENTAL RULE OR REGULATION, AND FURTHER, NO REPRESENTATION OR WARRANTY IS MADE OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR AGAINST INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. THE SMALL CELL FORUM SHALL NOT BE LIABLE WITH RESPECT TO ANY CLAIM, AND IN NO EVENT SHALL THE SMALL CELL FORUM BE LIABLE FOR LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES. THE SMALL CELL FORUM EXPRESSLY ADVISES ANY AND ALL USE OF OR RELIANCE UPON THIS INFORMATION PROVIDED IN THIS DOCUMENT IS AT THE RISK OF THE USER.

Summary

Networked Functional API (nFAPI) NFAPIService:1.0

Publication History:

  28-February-2017:  Original

Table of Contents

• Data Types
• References
• NFAPIService:1.0 Data Model
• Data Model Definition
• X_SCF_org_NFAPIService.{i}.
• X_SCF_org_NFAPIService.{i}.Capabilities.
• X_SCF_org_NFAPIService.{i}.Capabilities.LTE.
• X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.
• X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.PHY.{i}.
• X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.RF.{i}.
• X_SCF_org_NFAPIService.{i}.Control.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.LTE.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.LTE.SecurityGateway.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.LTE.VNF.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.Tunnel.{i}.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.RF.{i}.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.PHY.{i}.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Stats.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Assoc.{i}.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Assoc.{i}.Stats.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.UDP.
• X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.UDP.Stats.
• Inform and Notification Requirements
• Forced Inform Parameters
• Forced Active Notification Parameters
• Default Active Notification Parameters
• Parameters for which Active Notification MAY be Denied
• Profile Definitions
• Notation

Data Types

The parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. The complete set of data types, along with the notation used to represent these types, is listed in [Appendix I.4/TR-106a7]. The following named data types are used by this specification.

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.
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.32.300]	3GPP TS 32.300, Telecommunication management; Configuration Management (CM); Name convention for Managed Objects, 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.
[3GPP-TS.36.101]	3GPP TS 36.101, Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) radio transmission and reception, 3GPP RAN WG4.
[3GPP-TS.36.104]	3GPP TS 36.104, Evolved Universal Terrestrial Radio Access (E-UTRA); Base Station (BS) radio transmission and reception, 3GPP RAN WG4.
[3GPP-TS.36.331]	3GPP TS 36.331, Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification, 3GPP RAN WG2.
[RFC3873]	RFC 3873, Stream Control Transmission Protocol (SCTP) Management Information Base (MIB), IETF, September 2004.
[RFC4122]	RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291]	RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632]	RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4960]	RFC 4960, Stream Control Transmission Protocol, IETF, September 2007.
[SOAP1.1]	Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069a4]	TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-106a7]	TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.
[TR-181i2]	TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.
[TR-262]	TR-262, Femto Component Objects, Broadband Forum, 2011.

NFAPIService:1.0 Data Model

Name	Type	Write	Description	Object Default	Version
X_SCF_org_NFAPIServiceNumberOfEntries	unsignedInt	-	The number of entries in the X_SCF_org_NFAPIService table.	-	1.0
X_SCF_org_NFAPIService.{i}.	object	-	The top-level object for device with nFAPI capabilities. At most one entry in this table can exist with a given value for Alias.	-	1.0
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.	-	1.0
DNPrefix	string­(256)	W	The Distinguished Name prefix (DNPrefix) is an operator-configurable prefix string that is pre-pended to object distinguished names in the ManagedObjectInstance parameters of the [TR-181i2] FaultMgmt objects. See [3GPP-TS.32.300] for the formal definition and examples of DNPrefix as applied to 3GPP alarm objects	-	1.0
NFAPIInterfaceNumberOfEntries	unsignedInt	-	The number of entries in the NFAPIInterface table.	-	1.0
X_SCF_org_NFAPIService.{i}.Capabilities.	object	-	This object contains parameters relating to the hardware capabilities of the service.	-	1.0
SyncMode	string	-	Comma-separated list of strings. Each entry is a type of time synchronization mode that the service supports for its PHY interfaces. Each list item is an enumeration of: Unaligned (There is no time alignment of any of the PHY interfaces to any internal or external reference) Internal (All the PHYs within this service are time synchronised to each other, but not to any external reference) Absolute (All the PHYs within this service are time synchronised to a global external reference. For example GNSS)	-	1.0
SyncSource	string	-	Comma-separated list of strings. Indicates external synchronization sources supported by the service. An empty list indicates a lack of capability. Each list item is an enumeration of: GPS GLONASS BeiDuo IEEE1588 SyncE NMM NTP	-	1.0
SupportedSystems	string	-	Comma-separated list of strings. Each entry is a type of system that the service supports. Each list item is an enumeration of: LTE	-	1.0
X_SCF_org_NFAPIService.{i}.Capabilities.LTE.	object	-	This object contains parameters relating to the system and RF aspect of the service that supports the LTE system.	-	1.0
MaxNFAPIInterfaces	unsignedInt	-	Maximum number of NFAPI interfaces (VNF associations) supported by the service.	-	1.0
X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.	object	-	This object contains parameters relating to RAN aspects of the service.	-	1.0
NumberPHY	unsignedInt	-	The maximum number of operational PHYs supported by the service.	-	1.0
MaxTotalBW	unsignedInt	-	The total maximum bandwidth, in MHz, supported by the service.	-	1.0
TotalDLLayers	unsignedInt	-	The total number of DL layers supported by the service	-	1.0
TotalULLayers	unsignedInt	-	The total number of UL layers supported by the service	-	1.0
SharedBands	boolean	-	Indication of how the service shares RF bands. When true, the instances of the RF table are available across all PHY.{i} object instances. However, each RF.{i} object instance may only be used with a single PHY.{i} object instance. When false, the RF.{i} object instances are not shared and only the RF.{i} object instances defined by the PHY.{i}.RFConfig parameter are available to be used.	-	1.0
SharedPA	boolean	-	Indication that the service shares the PA across all available PHY.{i} object instances. When true, the PA is shared across available RF.{i} object instances, so that the value of the MaxTotalPower parameter must be shared between all PHY and RF instances. When false, each PHY.{i} object instance and RF.{i} object instance does not share the PA.	-	1.0
MaxTotalPower	int	-	The maximum transmit power, in dBm, across all available PHYs. Value is in 0.1dB steps with 0 = 0dBm. Valid only if the value of the SharedPA is true.	-	1.0
PHYNumberOfEntries	unsignedInt	-	The number of entries in the PHY table.	-	1.0
RFNumberOfEntries	unsignedInt	-	The number of entries in the RF table.	-	1.0
X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.PHY.{i}.	object	-	This object contains parameters relating to LTE PHY aspects of the service. At most one entry in this table can exist with a given value for Alias.	-	1.0
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.	-	1.0
DLBandwidth	string	-	Comma-separated list (at least 1 items) of unsigned integers, (value 6, 15, 25, 50, 75, or 100). Each item is a downlink transmission bandwidth, specified in number of Resource Blocks. Each item in the list indicates that the PHY can be configured to support this bandwidth. In case there is more than one item in the list, the first item contains the most preferred value. Corresponds to parameter dl_Bandwidth in MIB (Master Information Block) in [Section 6.2.2/3GPP-TS.36.331] and to parameter NRB in [Table 5.6-1/3GPP-TS.36.101].	-	1.0
ULBandwidth	string	-	Comma-separated list (at least 1 items) of unsigned integers, value 6, 15, 25, 50, 75, or 100). Each item is an uplink transmission bandwidth, specified in number of Resource Blocks. Each item in the list indicates that the PHY can be configured to support this bandwidth. In case there is more than one item in the list, the first item contains the most preferred value. Corresponds to parameter ul_Bandwidth in SIB2 in [Section 6.3.1/3GPP-TS.36.331]and to parameter NRB in [Table 5.6-1/3GPP-TS.36.101].	-	1.0
DLLayers	unsignedInt­[1, 2, 4, 8]	-	Maximum number of DL layers supported by the PHY.	-	1.0
ULLayers	unsignedInt­[1, 2, 4]	-	Maximum number of UL layers supported by the PHY.	-	1.0
NMMMode	string	-	Comma-separated list of strings. Each entry is a type of Network Monitoring Mode that the PHY supports. An empty list indicates that this PHY has no NMM support. Each list item is an enumeration of: NMM-Only (This PHY only supports NMM) NMM-Configured (This PHY only supports NMM in the Configured state) NMM-Running (This PHY only supports NMM in the Running state) NMM-Configured-and-Running (This PHY supports NMM in the Configured and Running states)	-	1.0
RFConfig	string	-	Comma-separated list (at least 1 items) of unsigned integers. Each item is a reference to the value of the RAN.RF.{i}.RFIndex of the RAN.RF.{i} object. It specifies which RF objects are able to be used with this PHY instance.	-	1.0
X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.RF.{i}.	object	-	This object contains parameters relating to LTE RF aspects of the service. At most one entry in this table can exist with a given value for Alias, or with a given value for RFIndex.	-	1.0
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.	-	1.0
RFIndex	unsignedInt	-	The unique index number for the PHY to associate with this instance of RF configuration.	-	1.0
BandsSupported	string	-	Comma-separated list (at least 1 items) of unsigned integers. Indicates the LTE bands that the service supports as defined in [Section 5.5/3GPP-TS.36.101]. At least one band MUST be supported and multiple bands MAY be supported. Each individual band is identified by arabic number (1, 2,...). The order of the band indicators in the string has no significance. The followings are examples of valid values: "1" (specifies only band-1 is supported) "1,2,11" (specifies 3 bands are supported) "2,11,1" (specifies 3 bands are supported)	-	1.0
MaxTransmitPower	int	-	The maximum transmit power, in 0.1 dBm steps, for the RF chain operating at the maximum supported bandwidth as defined in [3GPP-TS.36.104]. A value of 0 = 0dBm	-	1.0
NumberofAntennas	unsignedInt­[1, 2, 4, 8]	-	The maximum number of physical antenna ports supported.	-	1.0
MinDLFrequency	unsignedInt	-	Minimum supported DL frequency in 100KHz.	-	1.0
MaxDLFrequency	unsignedInt	-	Maximum supported DL frequency in 100KHz.	-	1.0
MinULFrequency	unsignedInt	-	Minimum supported UL frequency in 100KHz.	-	1.0
MaxULFrequency	unsignedInt	-	Maximum supported UL frequency in 100KHz.	-	1.0
X_SCF_org_NFAPIService.{i}.Control.	object	-	This object contains parameters relating to state management and provisioning aspects of the service	-	1.0
EnclosureTamperingDetected	boolean	-	This parameter indicates whether or not physical tampering of the device enclosure occurred, such as illegal opening of the box. If true device tampering is detected. If false no sign of device tampering is detected. Tampering state MUST be persisted across reboots and the device MUST never reset it back from true to false even after a factory reset.	-	1.0
OpState	boolean	-	Current operational state of the LTE nFAPI service as defined in [ITU-X.731]. If true the LTE nFAPI service is currently enabled. If false the LTE nFAPI service is currently disabled.	-	1.0
AdminState	boolean	W	Lock or unlock the LTE nFAPI service. This controls the administrative state of the LTE nFAPI service as defined in [ITU-X.731]. If true the AdminState is Unlocked, giving permission to serve traffic (and enable RF transmitter(s)). If false the AdminState is Locked. This transitions the LTE nFAPI service to a state where it is NOT permitted to serve traffic and the RF transmitter is disabled. Given that this command controls the LTE nFAPI service's RF transmitter(s), the underlying expectation is that the unlock is done when all necessary conditions are met to allow the transmitter(s) to be powered on and provide service, including aspects such as: location verification (including meeting the governing regulatory requirements) verifying the LTE nFAPI service configuration If physical tampering is supported and no physical tampering is detected. The default value after power-on is false.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.	object	W	The NFAPI Service Interface between the device and the nFAPI Virtual Network Function (VNF). The set of configuration parameters across all NFAPIInterface instances must not define a configuration that exceeds the capabilities defined in the Capabilities object. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.	-	1.0
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.	-	1.0
Enable	boolean	W	Enables or disables this entry.	false	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.	object	-	This object contains parameters relating to state management and provisioning aspects of the nFAPI Interface.	-	1.0
ActiveSyncSource	string	W	The active external synchronization source. The value MUST be a member of the list reported by the Capabilities.SyncSource parameter, or else be an empty string.	-	1.0
SyncStatus	string	W	The status of active external synchronization source. Enumeration of: TimeLocked FrequencyLocked Unlocked	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.LTE.	object	-	This object contains parameters relating to the LTE system specific information.	-	1.0
PMConfig	string­(256)	W	The value MUST be the path name of a row in optional the .FAP.PerfMgmt.Config. table (see [TR-262]). This is the performance management related configuration for the LTE nFAPI interface service. In case of a multiple-radio-technology FAP product, each radio technology can have its own PM configuration or share a common PM configuration. In the former case, PMConfig can contain a unique instance number. In the latter case, PMConfig under all radio technologies can have the same instance number. If the referenced object is deleted, the parameter value MUST be set to an empty string.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.LTE.SecurityGateway.	object	-	This object contains parameters relating to the Security Gateways to which the LTE nFAPI interface service is to connect.	-	1.0
SecGWServers	string­(256)	W	Comma-separated list (maximum list length 256) (up to 3 items) of strings. The list is an ordered list where each item is either the hostname or IPAddress of a SecGW to which the LTE nFAPI interface service connects. The order of the list indicates the preference for the entry in connecting to the SecGW.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Control.LTE.VNF.	object	-	This object contains parameters relating to the remote nFAPI VNF to which the LTE nFAPI interface service is to connect.	-	1.0
VNFLinkServers	string­(256)	W	Comma-separated list (maximum list length 256) (1 to 4 items) of strings. Each item is a VNF connection end point to which the LTE nFAPI interface service attempts to establish a connection. It is in the form of either hostname or IPaddress and optional port. The hostname or IPaddress and the optional port field within the list item are separated by a colon, if present. Use of the IANA-defined value (7701) is recommended. The LTE nFAPI interface service's behavior in terms of the number of VNF connections to establish is determined by value of the VNFConnectionMode parameter. If VNFConnectionMode parameter has the value of One, then the LTE nFAPI interface service attempts to establish VNF connection with only one address following the preference ordering of the list. If VNFConnectionMode parameter has the value of All, then the LTE nFAPI interface service attempts to establish connection with all addresses in the list. This is intended for multi-homed SCTP associations to a single VNF.	-	1.0
VNFConnectionMode	string	W	Indicates how many of the configured VNF connection endpoint address(es),as defined in the VNFLinkServers, the LTE nFAPI interface service SHOULD attempt to establish connection with simultaneously. Enumeration of: One All	"One"	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.	object	-	This object contains parameters relating to configuring the nFAPI service.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.	object	-	This object contains parameters relating to configuring the LTE nFAPI interface service.	-	1.0
TunnelNumberOfEntries	unsignedInt	-	The number of entries in the Tunnel table.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.Tunnel.{i}.	object	W	This object contains a table of all tunnel instances configured for the LTE nFAPI interface service. 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 CPE 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 TunnelRef. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.	-	1.0
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.	-	1.0
Enable	boolean	W	Enables or disables this entry.	false	1.0
TunnelRef	string­(256)	W	This is the reference to an IPsec tunnel instance used by the LTE nFAPI interface service. For all root data models, which use the tunnel definition provided in [TR-262] the TunnelRef MUST point to the Tunnel instance defined in [TR-262]. If the root data model used is Device:2 [TR-181i2] the TunnelRef MUST point to IPsec tunnel instance defined in [TR-181i2]. If the referenced object is deleted, the parameter value MUST be set to an empty string. In case of a multiple nFAPI interfaces, each nFAPI interface can have its own tunnel or share a common tunnel. In the former case, the value of the TunnelRef parameter can contain a unique instance number. In the latter case, the value of the TunnelRef parameter used by some or all of the nFAPI interfaces can have the same instance number.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.	object	-	This object contains parameters relating to the LTE RAN level configuration.	-	1.0
MaxNumberOfPHY	unsignedInt	W	The maximum number of operational PHYs supported by the NFAPIInterface.{i} object instance.	-	1.0
MaxTotalBW	unsignedInt	W	The total maximum bandwidth, in MHz, supported by the supported by the NFAPIInterface.{i} object instance.	-	1.0
MaxTotalDLLayers	unsignedInt	W	The maximum total number of DL layers supported by the NFAPIInterface.{i} object instance.	-	1.0
MaxTotalULLayers	unsignedInt	W	The total number of UL layers supported by the NFAPIInterface.{i} object instance.	-	1.0
MaxTotalPower	int	W	The maximum transmit power, in dBm, of the NFAPIInterface.{i} object instance. Value is in 0.1dB steps with 0 = 0dBm.	-	1.0
RFNumberOfEntries	unsignedInt	-	The number of entries in the RF table.	-	1.0
PHYNumberOfEntries	unsignedInt	-	The number of entries in the PHY table.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.RF.{i}.	object	W	This object contains parameters relating to the RF, see [Section 6.1.7.1/3GPP-TS.32.592]. 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 CPE 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 RFIndex.	-	1.0
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.	-	1.0
RFIndex	unsignedInt	W	The unique index number for the PHY to associate with this instance of RF configuration. The value must match a value of the Capabilities.LTE.RAN.RF.{i}.RFIndex parameter of a Capabilities.LTE.RAN.RF.{i} object instance which is being configured by this object instance.	-	1.0
Enable	boolean	W	Enables or disables this entry.	false	1.0
BandsSupported	string­(64)	W	Comma-separated list (maximum list length 64) (at least 1 items) of unsigned integers. Indicates the LTE bands that the RF instance supports as defined in [Section 5.5/3GPP-TS.36.101]. At least one band MUST be supported and multiple bands MAY be supported. Each individual band is identified by arabic number (1, 2,...). The order of the band indicators in the string has no significance. The followings are examples of valid values: "1" (specifies only band-1 is supported) "1,2,11" (specifies 3 bands are supported) "2,11,1" (specifies 3 bands are supported)	-	1.0
MaxTransmitPower	int	W	The maximum transmit power, in dBm, for the RF chain of the RF object operating at the maximum supported bandwidth as defined in [3GPP-TS.36.104]. Value is in 0.1dB steps with 0 = 0dBm	-	1.0
NumberofAntennas	unsignedInt­[1, 2, 4, 8]	W	The maximum number of physical antenna ports supported.	-	1.0
MinDLFrequency	unsignedInt	W	Minimum supported DL frequency in 100KHz.	-	1.0
MaxDLFrequency	unsignedInt	W	Maximum supported DL frequency in 100KHz.	-	1.0
MinULFrequency	unsignedInt	W	Minimum supported UL frequency in 100KHz.	-	1.0
MaxULFrequency	unsignedInt	W	Maximum supported UL frequency in 100KHz.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.PHY.{i}.	object	W	This object contains parameters relating to the physical layer level configuration. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.	-	1.0
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. The value must match a value of the Capabilities.LTE.RAN.PHY.{i}.Alias parameter of a Capabilities.LTE.RAN.PHY.{i} object instance.	-	1.0
Enable	boolean	W	Enables or disables this entry.	false	1.0
DLBandwidth	string­(32)	W	Comma-separated list (maximum list length 32) (at least 1 items) of unsigned integers (value 6, 15, 25, 50, 75, or 100). Each item is a downlink transmission bandwidth, specified in number of Resource Blocks. In case there is more than one item in the list, the first item contains the most preferred value. Corresponds to parameter dl_Bandwidth in MIB (Master Information Block) in [Section 6.2.2/3GPP-TS.36.331] and to parameter NRB in [Table 5.6-1/3GPP-TS.36.101]. If LTE nFAPI interface service supports self-configuration capability for DLBandwidth and more than one item is configured, then LTE nFAPI interface service is expected to select one from the list and overwrite this parameter containing only the one selected. If LTE nFAPI interface service does not support self-configuration capability for DLBandwidth and more than one item is configured, then LTE nFAPI interface service accepts the first value and ignore the rest. If only one item is configured regardless of the self-configuration capability of LTE nFAPI interface service, the LTE nFAPI interface service accepts the value as an explicit configuration by the ACS.	-	1.0
ULBandwidth	string­(32)	W	Comma-separated list (maximum list length 32) (at least 1 items) of unsigned integers (value 6, 15, 25, 50, 75, or 100). Each item is an uplink transmission bandwidth, specified in number of Resource Blocks. In case there is more than one item in the list, the first item contains the most preferred value. Corresponds to parameter ul_Bandwidth in SIB2 in [Section 6.3.1/3GPP-TS.36.331] and to parameter NRB in [Table 5.6-1/3GPP-TS.36.101]. If LTE nFAPI interface service supports self-configuration capability for ULBandwidth and more than one item is configured, then LTE nFAPI interface service is expected to select one from the list and overwrite this parameter containing only the one selected. If LTE nFAPI interface service does not support self-configuration capability for ULBandwidth and more than one item is configured, then LTE nFAPI interface service accepts the first value and ignore the rest. If only one item is configured regardless of the self-configuration capability of LTE nFAPI interface service, the LTE nFAPI interface service accepts the value as an explicit configuration by the ACS.	-	1.0
DLLayers	unsignedInt­[1, 2, 4, 8]	W	Maximum number of DL layers supported by the PHY.	-	1.0
ULLayers	unsignedInt­[1, 2, 4]	W	Maximum number of UL layers supported by the PHY.	-	1.0
RFConfig	string	W	Comma-separated list (at least 1 items) of unsigned integers. Each item is a value of the CellConfig.LTE.RAN.RF.{i}.RFIndex parameter.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.	object	-	This object contains parameters relating to the transport.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.	object	-	This object contains parameters relating to SCTP as a transport protocol. SCTP is defined in [RFC4960] and [RFC3873].	-	1.0
Enable	boolean	W	Enables or disables the whole SCTP object and allows the setup or release of SCTP associations and their related streams.	-	1.0
HBInterval	unsignedInt­[1:]	W	Heartbeat interval in seconds.	30	1.0
MaxAssociationRetransmits	unsignedInt	W	Maximum number of consecutive retransmissions to a peer before an endpoint considers that the peer is unreachable and closes the association.	10	1.0
MaxInitRetransmits	unsignedInt	W	Number of retransmission per connection-attempt.	8	1.0
MaxPathRetransmits	unsignedInt	W	Maximum retransmission per destination address.	5	1.0
RTOInitial	unsignedInt	W	Initial value for Retransmit timeout in milliseconds. A retransmission time value of zero means immediate retransmission.	3000	1.0
RTOMax	unsignedInt	W	Maximum value for Retransmit timeout in milliseconds. A retransmission time value of zero means immediate retransmission.	6000	1.0
RTOMin	unsignedInt	W	Minimum value for Retransmit timeout in milliseconds. A retransmission time value of zero means immediate retransmission. The value of this parameter MUST be lower than or equal to RTOMax.	1000	1.0
ValCookieLife	unsignedInt	W	Valid cookie life in the 4-way start-up handshake procedure in milliseconds. The factory default value MUST be 60000.	60000	1.0
AssocNumberOfEntries	unsignedInt	-	The number of entries in the Assoc table.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Stats.	object	-	This object contains statistics and counters relating to the SCTP object.	-	1.0
OutOfBlues	unsignedInt	-	The number of correctly formed SCTP packets, including the proper checksum, but for which the receiver was unable to identify an appropriate association.	-	1.0
ChecksumErrors	unsignedInt	-	The number of SCTP packets received with an invalid checksum.	-	1.0
OutCtrlChunks	unsignedInt	-	The number of SCTP control chunks sent (retransmissions are not included).	-	1.0
OutOrderChunks	unsignedInt	-	The number of SCTP ordered data chunks sent (retransmissions are not included).	-	1.0
OutUnorderChunks	unsignedInt	-	The number of SCTP unordered chunks (data chunks in which the U bit is set to 1) sent (retransmissions are not included).	-	1.0
InCtrlChunks	unsignedInt	-	The number of SCTP control chunks received (no duplicate chunks included).	-	1.0
InOrderChunks	unsignedInt	-	The number of SCTP ordered data chunks received (no duplicate chunks included).	-	1.0
InUnorderChunks	unsignedInt	-	The number of SCTP unordered chunks (data chunks in which the U bit is set to 1) received (no duplicate chunks included).	-	1.0
FragUsrMsgs	unsignedInt	-	The number of user messages that have been sent fragmented.	-	1.0
ReasmUsrMsgs	unsignedInt	-	The number of user messages that have been received fragmented and submitted to the reassembly process.	-	1.0
OutSCTPPacks	unsignedInt	-	The number of SCTP packets sent. Retransmitted DATA chunks are included.	-	1.0
InSCTPPacks	unsignedInt	-	The number of SCTP packets received. Duplicates are included.	-	1.0
Discontinuity	dateTime	-	The time of the last discontinuity.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Assoc.{i}.	object	-	This object represents an SCTP connection between the nFAPI interface and the network VNF. The PrimaryPeerAddress and LocalPort represent the resolved IPAddress and port of an SCTP connection to an entry within the Control.LTE.VNF.VNFLinkServers parameter. At most one entry in this table can exist with a given value for Alias, or with the same values for PrimaryPeerAddress and LocalPort.	-	1.0
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.	-	1.0
Status	string	-	The status of this SCTP association entry. Enumeration of: Active (The Association is active) Progressing (The Association establishment is in progress) ShuttingDown (The Association graceful shutdown is in progress) Error (Indicates a locally defined error condition, OPTIONAL)	-	1.0
PrimaryPeerAddress	string­(45)	-	[IPAddress] The primary IP address of the peer SCTP association entity.	-	1.0
LocalPort	unsignedInt­[0:63999]	-	The local SCTP port number used for this SCTP association.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Assoc.{i}.Stats.	object	-	This object contains statistics and counters relating to the SCTP object.	-	1.0
InStreams	unsignedInt	-	The number of Inbound Streams according to the negotiation at association start-up.	-	1.0
OutStreams	unsignedInt	-	The number of Outbound Streams according to the negotiation at association start-up.	-	1.0
StartTime	dateTime	-	The start Time for the present SCTP association.	-	1.0
Discontinuity	dateTime	-	The time of the last discontinuity.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.UDP.	object	-	This object contains parameters relating to UDP Transport.	-	1.0
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.UDP.Stats.	object	-	This object contains statistics and counters relating to the SCTP Transport	-	1.0
SentPackets	unsignedInt	-	The number of sent UDP packets.	-	1.0
RcvPackets	unsignedInt	-	The number of received UDP packets.	-	1.0

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter
X_SCF_org_NFAPIService.{i}.
Alias
X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.PHY.{i}.
Alias
X_SCF_org_NFAPIService.{i}.Capabilities.LTE.RAN.RF.{i}.
Alias
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.
Alias
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.Tunnel.{i}.
Alias
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.RF.{i}.
Alias
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.CellConfig.LTE.RAN.PHY.{i}.
Alias
X_SCF_org_NFAPIService.{i}.NFAPIInterface.{i}.Transport.SCTP.Assoc.{i}.
Alias

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 via AddObject and DeleteObject is REQUIRED.
A	Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED.
D	Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED.

---

Generated by Broadband Forum report.pl#415+ (2016/12/08 version) on 2017/02/02 at 12:22:36 (TOOL CURRENTLY CHECKED OUT).
TR-069 Report report.exe --report=html --include=nFAPI-1-0-0_Data_Modelv4 --include=TR-069 Report TR-069 includes --loglevel=w0 --logoalt=Small Cell Forum --logoref=www.smallcellforum.org --logosrc=SmallCellForum-logo.png nFAPI-1-0-0.xml ...