TR-069 Training Series - Data Model Parameters

Most objects contain a set of elements containing sub-objects and parameters. Parameters are defined using the parameter element, and, like Objects, have a set of attributes and elements that describe how the parameter is to be used and its requirements.

Data Model attributes for Parameter Elements include:

  • Name: Unlike object names, the parameter name is just the literal name of the parameter, not the full path.
  • Access: Describes whether or not a parameter can be the subject of the SetParameterValues RPC. This can be set to readOnly or readWrite. For some parameters such as Wifi passwords, there are additional requirements in their description stating that any GetParameterValues RPC calls on that parameter must return empty values regardless of the value of the parameter, making it effectively “Write Only”.
  • activeNotify: Indicates the conditions around setting Active Notification on the parameter. If it is omitted, Active Notification is acceptable on this parameter. If it is set to “canDeny”, then the CWMP endpoint is allowed to reject requests to set this parameter for Active Notification. If it is set to “forceEnabled”, then Active Notification must always be enabled for this parameter, and changing it must always trigger a CWMP session.

  • ForcedInform: This is a boolean value that, when set to true, indicates that the parameter and its current value must be included in every Inform RPC.

Lastly, like with Objects, is the dm:version attribute, which indicates the version of the data model where this parameter was introduced or updated.

Parameters are described using several XML elements. These include:

  • Syntax: Describes the parameter’s data type and any, minimums, maximums, or pattern restrictions.
  • Default: Indicates the parameter’s default value if it has been unassigned.
  • Description: Lists the normative explanation of how the parameter is to be used.