The TR-069 Device Management supports configuration to adjust management settings in your RM system.

Backend Configurations Overview

The modules related to TR-069 device management support configuration via backend configurations, inheritable properties in the device management tree and system properties which allow the user to adjust management settings in his RM system.

The user can view and manage backend configurations through the user interface console, or programmatically using the Configuration Admin API.

In the Management Console, to view and edit backend configurations go to Dashboard -> System Configuration and then switch to the Configurations tab from the system configuration area on the left. The manual for managing backend configurations through the Console is available at Backend Bundles Configurations, found in the User Guide of the System Package documentation.

To setup TR-069 device management correctly when the database is MySQL and UTF8 encoding is used, set the property mprm.tr069.db.varCharColumnMaxLen=2000 into the default.prs file.

RM TR-069 Configuration

This configuration contains general TR-069 settings and handled by the TR-069 Device Management bundle - tr069dm.dm.be.jar, placed in (packages/tr06dm9/). It has a PID mprm.tr069acs.config and is visible in the Console under the TR069 Configuration name.


Property ID

User-Friendly Name

Type

Default Value

Description

mprm.tr069.enableBan

Enable Ban Protection

boolean

false

Defines if the ban-based protection mechanism should be enabled.

mprm.tr069.maxBadRequests

Maximum Bad Requests

int

3

Specifies the maximum number of failed requests that can be made to RM.

mprm.tr069.banPeriod

Ban Period

long

3600

Defines the time period in seconds during which no requests will be accepted from a banned IP address.

mprm.tr069.bannedIPCleanPeriod

Banned IP Clean Period

long

3600

Specifies the time period in seconds after which the expired restrictions for the banned IP must be cleaned. For an IP address the restrictions become expired after the ban period passes.

mprm.tr069.banTableCapacity

Ban Table Capacity

int

1000

Defines the capacity of the ban records table.

mprm.tr069.securityLogLevel

Security Log Level

int

1(All)

Defines which security events will be logged into RM Log Service. There are two possible values - 0 and 1, each corresponding to one of the following message types:

  • 0 – Errors and Warnings

  • 1 – All

mprm.tr069.makeStatistics

Make Statistics

boolean

true

Specifies whether to collect statistical information or not.

mprm.tr069.digestAuth.requestsCacheCapacity

The capacity of the cache with authentication requests

int

20000

Specifies the maximum count of kept digest authentication requests. If this count is reached, a new authentication request will lead to removing the oldest one. The session related to the removed request will be re-authenticated.

mprm.tr069.digestAuth.requestTimeout

The expiration time of authentication requests

long

180000

Indicates the timeout in milliseconds for expiration of an authentication request sent to a client and not receiving a response.

mprm.tr069.digestAuth.maxTimeToLive

The digest authenticated session max time to live

long

36000000

Specifies the maximum time-to-live in milliseconds of sessions with digest authentication.

mprm.tr069.digestAuth.offlineTimeout

The digest authenticated sessions offline timeout

long

3600000

The offline timeout in milliseconds of sessions with digest authentication.

mprm.tr069.exhaustInputStreamWhenUnauthorized

If should exhaust (read) the Http Request's Input Stream

boolean

true

Specifies if the ACS should exhaust (read) the input stream of incoming unauthorized HTTP requests (it is possible that some clients require it).

mprm.tr069.sendConnectionCloseOnWWWAuthenticate

If should sent 'Connection: close' on WWW Authenticate

boolean

false

Indicates if the TR-069 ACS should include in its response the "Connection: close" header upon unsuccessful WWW Authenticate.

mprm.tr069.connectTimeout

Connect Timeout

int

180

Contains the timeout in seconds for connection to a device.

mprm.tr069.readTimeout

Read Timeout

int

60

Contains the timeout for reading incoming data from a device.

TR-069 Download Manager Configuration

This configuration is related to downloading content on a TR-069 device. It has a PID mprm.tr069downloadman and is visible in the Management Console under the TR069 Download Manager Configuration name. The configuration is provided by the RM TR069 Download Manager (packages/tr069dm/tr069dm.download.be.jar) bundle.


Property ID

User-Friendly Name

Type

Default Value

Description

mprm.tr069.natSupportForDownload

NAT Support For Download

boolean

false

Specifies whether to support to resolve NAT-based addresses upon download.

mprm.tr069.secureDownload

Secure Download Mode

boolean

false

Specifies if downloading must involve security mechanisms.

mprm.tr069.downloadTimeout

Downloads Timeout

long

180

Defines the timeout for download.

mprm.tr069.downloadCleanPeriod

Downloads Clean Period

long

600

Specifies the time for cleaning the expired downloads.

mprm.tr069.default.type

Default Type

String

N/A

Configures the default TR-069 type which will be manifested to the target device when downloading a component from the Software Repository whose type is not associated with a specific TR-069 type. Possible values are:

  • N/A

  • 1 Firmware Upgrade Image

  • 2 Web Content

  • 3 Vendor Configuration File

  • 4 Tone File

  • 5 Ring File

mprm.tr069.expireTicketPeriod

Downloads Ticket Expire Period

int

30

Contains the expiration time in seconds of URL tickets after the first download success.

mprm.tr069.firmware.up.image

1 Firmware Upgrade Image

String[]

OSGi Bundle

Maps a concrete software type from the Software Repository with the Firmware Upgrade Images TR-069 type. Then, when selecting a component of this type from the repository, the content will be indicated as a Firmware Upgrade Image to the device.

mprm.tr069.firmware.web.content

2 Web Content

String[]

-

Maps a concrete software type from the Software Repository with the Web Content TR-069 type. Then, when selecting a component of this type from the repository, the content will be indicated as Web Content to the device.

mprm.tr069.vendor.conf.file

3 Vendor Configuration File

String[]

-

Maps a concrete software type from the Software Repository with the Vendor Configuration File TR-069 type. Then, when selecting a component of this type from the repository, the content will be indicated as a Vendor Configuration File to the device.

mprm.tr069.tone.file

4 Tone File

String[]

-

Maps a concrete software type from the Software Repository with the Tone File TR-069 type. Then, when selecting a component of this type from the repository, the content will be indicated as a Tone File to the device.

mprm.tr069.ringer.file

5 Ringer File

String[]

-

Maps a concrete software type from the Software Repository with the Ringer File TR-069 type. Then, when selecting a component of this type from the repository, the content will be indicated as a Ringer File to the device.

mprm.tr069.http.wwwAuth

Required client authentication when connects over HTTP

int

2

Configures the type of authentication when the download connection is over HTTP. Possible values are:

  • 0 – Anonymous

  • 1 – Basic

  • 2 – Digest

mprm.tr069.https.wwwAuth

Required client authentication when connects over HTTPS

int

1

Configures the type of authentication when the download connection is over HTTPS. Possible values are:

  • 0 – Anonymous

  • 1 – Basic

  • 2 – Digest

mprm.tr069.wwwAuthRealm

Realm of TR069 ACS for basic/digest authentication

String

RM TR069 ACS

Determines the realm of the TR-069 ACS for basic/digest authentication. This property is valuable only if basic or digest authentication is required for download via the mprm.tr069.http.wwwAuth or mprm.tr069.https.wwwAuth configuration properties.

mprm.tr069.wwwDigestAuthDomain

Domain of TR069 ACS for digest authentication

String[]

RM TR069 ACS

Specifies the domain of the TR-069 ACS for digest authentication. This property is valuable only if digest authentication is required for download via the mprm.tr069.http.wwwAuth or mprm.tr069.https.wwwAuth configuration properties..

mprm.tr069.wwwDigestAuthAlgorithm

Authentication algorithm for digest authentication

String

MD5

The authentication algorithm for digest authentication. This property is valuable only if digest authentication is required via the mprm.tr069.http.wwwAuth or mprm.tr069.https.wwwAuth configuration properties. Possible values are:

  • MD5

  • MD5-sess

mprm.tr069.wwwDigestAuthQOP

QOP for digest authentication

String

auth,auth-int

The QOP (Quality of Protection) for digest authentication. This property is valuable only if digest authentication is required via the mprm.tr069.http.wwwAuth or mprm.tr069.https.wwwAuth configuration properties. Possible values:

  • auth,auth-int

  • auth

  • auth-int

Inheritable TR-069 Device Properties

Inheritable properties are node settings in the device management tree related to specific device types. Inheritable properties can be set to a group of devices, and all member devices will inherit them unless the properties are specifically set to a concrete one. RM provides a collection of inheritable properties specifically for TR-069 devices.

The user can easily modify TR-069 inheritable properties by using the Console. They are shown under the TR069 Device category within the Device Node Properties of the group/device properties tab. If no new values are set for them, the default values inherited from the parent node of the devices management tree will be used. In this case, the parent node from which the default value is inherited, is shown in brackets in the Is Default Value field. See the Registering and Managing TR-069 Devices User Guide for more details.

General Properties


Property ID

User-Friendly Name

Type

Default Value

Description

mprm.tr069.offlineActionsMode

Offline Actions Mode

int

0

Specifies the mode for calling actions upon devices which are gone offline. There are three possible values:

  • 0 – Error

  • 1 – Launch Management Operation

  • 2 – Launch Management Operation and try connect

mprm.tr069.cookieMaxAge

Cookie Max Age

int

2147483647

Configures the maximum age of the cookies that the ACS uses to maintain device management sessions.

mprm.tr069.sessionLogLevel

Session Log Level

int

2

Defines what types of session events should be logged into the RM Log Service. There are three possible values:

  • 0 – No Debug

  • 1 – Errors And Warnings

  • 2 – All

Security Properties

The user can configure all security properties, except mprm.tr069.connReqPass (Connection Request Password), only for a device group.


Property ID

User-Friendly Name

Type

Default Value

Description

mprm.tr069.allow.autoregister

Allow TR069 Device Auto-registration

boolean

true

Specifies whether non-registered TR069 devices will be accepted and will be registered automatically in RM within a specific group. Setting this property is useful only on a group node.

mprm.tr069.httpsOnly

HTTPS mode

boolean

false

Specifies if only HTTPS requests will be allowed.

mprm.tr069.acceptableIPs

Acceptable IPs

String

-

Contains a filter for acceptable IP addresses. A connecting device will be accepted only if its address matches this filter. The format of this property is <IP_address>/<subnet_mask>. By default, all addresses are acceptable.

mprm.tr069.unacceptableIPs

Unacceptable IPs

String

-

Contains a filter for not acceptable IP addresses. A connecting device will not be accepted if its address matches this filter. The format of this property is <IP_address>/<subnet_mask>.

mprm.tr069.http.wwwAuth

Required client authentication when connects over HTTP

int

2

Specifies the type of authentication if the client connection is over HTTP. Possible values are:

  • 0 – Anonymous

  • 1 – Basic

  • 2 – Digest

mprm.tr069.https.wwwAuth

Required client authentication when connects over HTTPS

int

1

Specifies the type of authentication when the client connection is over HTTPS. Possible values are:

  • 0 – Anonymous

  • 1 – Basic

  • 2 – Digest

mprm.tr069.wwwAuthRealm

Realm of TR069 ACS for basic/digest authentication

String

RM TR069 ACS

Contains the realm of the TR-069 ACS for basic/digest authentication. This property is valuable only if basic or digest authentication is required via the mprm.tr069.http.wwwAuth and mprm.tr069.https.wwwAuth inheritable properties.

mprm.tr069.wwwDigestAuthDomain

Domain of TR069 ACS for digest authentication

String[]

RM TR069 ACS

Contains the domain of the TR-069 ACS for digest authentication. This property is valuable only if digest authentication is required via the mprm.tr069.http.wwwAuth and mprm.tr069.https.wwwAuth inheritable properties.

mprm.tr069.wwwDigestAuthAlgorithm

Authentication algorithm for digest authentication

String

MD5

Specifies the algorithm for digest authentication. This property is valuable only if digest authentication is required. Possible values are:

  • MD5

  • MD5-sess

mprm.tr069.wwwDigestAuthQOP

QOP for digest authentication

String

auth,auth-int

Contains the QOP (Quality of Protection) for digest authentication. This property is valuable only if digest authentication is required. Possible values are:

  • auth,auth-int

  • auth

  • auth-int

mprm.tr069.connReqPass

Connection Request Password

String

admin

Contains the password that will be used when the ACS requests a connection with a client.

Session Properties

Property ID

User-Friendly Name

Type

Default Value

Description

mprm.tr069.cwmpNamespace

CWMP Namespace

String

"" (CPE Namespace)

Configures the CWMP namespace identifier that will be used for encoding the SOAP messages. Possible values are:

  • urn:dslforum-org:cwmp-1-0

  • urn:dslforum-org:cwmp-1-1

  • urn:dslforum-org:cwmp-1-2

  • "" - CPE Namespace. RM will use the namespace received from the CPE.

mprm.tr069.sendContentLength

Send Content-Length

boolean

false

Indicates if the ACS must send a Content-Length header in the HTTP requests.

mprm.tr069.persist

Keep Persistent Sessions

boolean

false

Specifies if the server will maintain a persistent session with a device for the period denoted by the mprm.tr069.sessionTimeout property ("Session Expire Time") or if it will leave the session to expire (be closed) according to the default TR-069 protocol rules.

mprm.tr069.ping.message

Persistent Session Ping Message

int

0

Specifies the ping message which the RM ACS will send to the client in the case of persistent connection. Possible values are:

  • 0 - GetParameterNames For ""

  • 1 - GetParameterNames For "InternetGatewayDevice."

  • 2 - NoMoreRequests = false

mprm.tr069.pingPeriod

Persistent Session Heartbeat Time

int

10

Configures how often in seconds the connection will be "pinged" with a trivial TR-069 command, specified with the mprm.tr069.ping.message property ("Persistent Session Ping Message").

mprm.tr069.sessionTimeout

Session Expire Time

int

300

Specifies how long in seconds the server will keep an inactive session to a device.

Synchronization Properties

Property ID

User-Friendly Name

Type

Default Value

Description

mprm.tr069.maxParameterInfoReqPerCall

Max Parameter Info Requests Per Call

int

2048

Contains the maximum parameter information (value or attributes) per message.

mprm.tr069.excludePaths

Exclude Paths

String[]

{root}.Services.OSGi.{i}.BundleResources.,{root}.Services.OSGi.{i}.ServiceState., {root}.Services.OSGi.{i}.PackageState.

Specifies parameter paths to exclude upon synchronization. For example: {root}.Services.X_Acme.. The exclude paths should be partial paths (ending with a dot) and should be separated with commas.

mprm.tr069.excludeValuePaths

Exclude Value Paths

String[]

-

Contains parameter values to exclude by default upon synchronization. For example: {root}.Services.X_Acme., {root}.Services.X_Acme.MyToBigValue.