RootDataModelVersion

string(:32)

R

Root data model version, e.g. 2.4. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based.

Possible patterns:

• 2\.\d+

This parameter MUST always be included in Inform messages.

-

2.4

InterfaceStackNumberOfEntries

unsignedInt

R

The number of entries in the InterfaceStack table.

-

2.0

DeviceCategory

string[]

R

Comma-separated list of strings. Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.

Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

-

2.8

Manufacturer

string(:64)

R

The manufacturer of the CPE (human readable string).

-

2.0

ManufacturerOUI

string(6)

R

Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

• [0-9A-F]{6}

The value MUST be a valid OUI as defined in [OUI].

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

-

2.0

ModelName

string(:64)

R

Model name of the CPE (human readable string).

Active Notification requests for this parameter MAY be denied.

-

2.0

ModelNumber

string(:64)

R

The model number of the device (human readable string), or an empty string if no model number is provided by the device.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31.

-

2.8

Description

string(:256)

R

A full description of the CPE device (human readable string).

Active Notification requests for this parameter MAY be denied.

-

2.0

ProductClass

string(:64)

R

Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique.

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

-

2.0

SerialNumber

string(:64)

R

Identifier of the particular device that is unique for the indicated class of product and manufacturer.

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

-

2.0

HardwareVersion

string(:64)

R

A string identifying the particular CPE model and version.

This parameter MUST always be included in Inform messages.

-

2.0

SoftwareVersion

string(:64)

R

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

This parameter MUST always be included in Inform messages.

Active Notification MUST always be enabled for this parameter.

-

2.0

ActiveFirmwareImage

string

R

A full path reference to the row in the FirmwareImage table representing the currently running firmware image.

-

2.12

BootFirmwareImage

string

W

A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots.

This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to 'true'). Out of the factory, this parameter should be set to point to the firmware image the CPE will attempt to boot when first powered on.

The firmware image instance referenced by this parameter must also have an Available parameter value of 'true'. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPE responding with a CWMP fault (9007).

In situations where the CPE cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPE MUST NOT modify this value to point to the alternate firmware image that is currently active.

-

2.12

AdditionalHardwareVersion

string[](:64)

R

Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply.

-

2.0

AdditionalSoftwareVersion

string[](:64)

R

Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply.

-

2.0

ProvisioningCode

string(:64)

W

Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters.

This parameter MUST always be included in Inform messages.

Active Notification MUST always be enabled for this parameter.

-

2.0

UpTime

unsignedInt

R

Time in seconds since the CPE was last restarted.

Active Notification requests for this parameter MAY be denied.

-

2.0

FirstUseDate

dateTime

R

Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset.

If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value.

Active Notification requests for this parameter MAY be denied.

-

2.0

FirmwareImageNumberOfEntries

unsignedInt

R

The number of entries in the FirmwareImage table.

-

2.12

VendorConfigFileNumberOfEntries

unsignedInt

R

The number of entries in the VendorConfigFile table.

-

2.0

ProcessorNumberOfEntries

unsignedInt

R

The number of entries in the Processor table.

-

2.1

VendorLogFileNumberOfEntries

unsignedInt

R

The number of entries in the VendorLogFile table.

-

2.1

LocationNumberOfEntries

unsignedInt

R

The number of entries in the Location table.

-

2.4

DeviceImageNumberOfEntries

unsignedInt

R

The number of entries in the DeviceImageFile table.

-

2.11

SupportedDataModelNumberOfEntries

unsignedInt

R

The number of entries in the SupportedDataModel table.

-

2.0

EnableCWMP

boolean

W

Enables and disables the CPE's support for CWMP.

false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS.

true means that CWMP support on the CPE is enabled.

The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true.

The factory default value MUST be true.

-

2.0

URL

string(:2048)

W

The [URL] for the CPE to connect to the ACS using the CPE WAN Management Protocol.

This parameter MUST be in the form of a valid HTTP or HTTPS URL.

The host portion of this URL is used by the CPE for validating the ACS certificate when using SSL or TLS.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

-

2.0

Username

string(:256)

W

Username used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This username is used only for HTTP-based authentication of the CPE.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

-

2.0

Password

string(:256)

W

Password used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This password is used only for HTTP-based authentication of the CPE.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

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

-

2.0

ScheduleReboot

dateTime

W

An absolute date and time in UTC at which time the CPE will perform a reboot.

If a CWMP session is in progress at the specified time, the CPE MUST wait until the session has ended before performing the reboot.

If the value specifies a date and time that has already passed (i.e., a past date and time), no reboot will be performed.

-

2.10

DelayReboot

int(-1:)

W

The number of seconds from the time the CWMP session in which this parameter value is set is ended until the CPE performs a reboot.

Whenever the CPE reboots, this value MUST be reset by the CPE to -1.

-

2.10

PeriodicInformEnable

boolean

W

Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call.

-

2.0

PeriodicInformInterval

unsignedInt(1:)

W

The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true.

-

2.0

PeriodicInformTime

dateTime

W

An absolute time reference in UTC to determine when the CPE will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the PeriodicInformInterval.

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

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

The Unknown Time value defined in [Section 3.2/TR-106] 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 Inform behavior MUST be the same as if the PeriodicInformTime parameter was set to the Unknown Time value.

-

2.0

ParameterKey

string(:32)

R

ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS.

The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified.

The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string.

This parameter MUST always be included in Inform messages.

Active Notification requests for this parameter MAY be denied.

-

2.0

ConnectionRequestURL

string(:2048)

R

The HTTP [URL] for an ACS to make a Connection Request notification to the CPE.

In the form:

http://host:port/path

The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.

Note: If the host portion of the URL is a literal IPv6 address then it MUST be enclosed in square brackets (see [Section 3.2.2/RFC3986]).

This parameter MUST always be included in Inform messages.

Active Notification MUST by default be enabled for this parameter.

-

2.0

ConnectionRequestUsername

string(:256)

W

Username used to authenticate an ACS making a Connection Request to the CPE.

-

2.0

ConnectionRequestPassword

string(:256)

W

Password used to authenticate an ACS making a Connection Request to the CPE.

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

-

2.0

UpgradesManaged

boolean

W

Indicates whether or not the ACS will manage upgrades for the CPE. If true, the CPE SHOULD NOT use other means other than the ACS to seek out available upgrades. If false, the CPE MAY use other means for this purpose.

Note that an autonomous upgrade (reported via an "10 AUTONOMOUS TRANSFER COMPLETE" Inform Event code) SHOULD be regarded as a managed upgrade if it is performed according to ACS-specified policy.

-

2.0

KickURL

string(:2048)

R

Present only for a CPE that supports the Kicked RPC method.

LAN-accessible [URL] from which the CPE can be kicked to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE.

-

2.0

DownloadProgressURL

string(:2048)

R

Present only for a CPE that provides a LAN-side web page to show progress during a file download.

LAN-accessible [URL] to which a web-server associated with the ACS MAY redirect a user's browser on initiation of a file download to observer the status of the download.

-

2.0

DefaultActiveNotificationThrottle

unsignedInt

W

This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification.

In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met.

The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection.

The time of the last session completion does not need to be tracked across reboots.

-

2.0

CWMPRetryMinimumWaitInterval

unsignedInt(1:65535)

W

Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069].

A value of 5 corresponds to the default behavior that is described in [TR-069].

The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

-

2.0

CWMPRetryIntervalMultiplier

unsignedInt(1000:65535)

W

Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069].

This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.

A value of 2000 corresponds to the default behavior that is described in [TR-069].

The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

-

2.0

HTTPConnectionRequestEnable

boolean

W

Enables or disables HTTP connection request handling on the CPE.

If HTTP connection request handling is disabled (HTTPConnectionRequestEnable is set to false), ConnectionRequestURL MUST be set to an empty string and the CPE MUST close the port used by the HTTP connection request server.

The factory default value MUST be true.

-

2.11

UDPConnectionRequestAddress

string(:256)

R

Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069]).

This parameter is represented in the form of an Authority element as defined in [RFC3986]. The value MUST be in one of the following two forms:

host:port

host

• When STUNEnable is true, the host and port portions of this parameter MUST represent the public address and port corresponding to the NAT binding through which the ACS can send UDP Connection Request messages (once this information is learned by the CPE through the use of STUN).

• When STUNEnable is false, the host and port portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages.

The second form of this parameter MAY be used only if the port value is equal to 80.

Note: If the host portion of the URL is a literal IPv6 address then it MUST be enclosed in square brackets (see [Section 3.2.2/RFC3986]).

-

2.0

STUNEnable

boolean

W

Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests.

-

2.0

STUNServerAddress

string(:256)

W

Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable.

If is an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL.

-

2.0

STUNServerPort

unsignedInt(0:65535)

W

Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable.

By default, this SHOULD be the equal to the default STUN port, 3478.

-

2.0

STUNUsername

string(:256)

W

If is not an empty string, the value of the STUN USERNAME attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server).

If is an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity.

-

2.0

STUNPassword

string(:256)

W

The value of the STUN Password to be used in computing the MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server).

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

-

2.0

STUNMaximumKeepAlivePeriod

int(-1:)

W

If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port.

A value of -1 indicates that no maximum period is specified.

-

2.0

STUNMinimumKeepAlivePeriod

unsignedInt

W

If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489].

-

2.0

NATDetected

boolean

R

When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use.

A true value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE's source address and port.

When STUNEnable is false, this value MUST be false.

-

2.0

AliasBasedAddressing

boolean

R

Indicates whether or not the Alias-Based Addressing Mechanism is supported.

A true value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069].

This parameter MUST always be included in Inform messages.

-

2.3

InstanceMode

string

W

Instance identification mode as defined in [Section 3.6.1/TR-069]. When AliasBasedAddressing is true, InstanceMode is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. Enumeration of:

• InstanceNumber
• InstanceAlias

This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be InstanceNumber.

-

2.3

AutoCreateInstances

boolean

W

Enable or disable the Auto-Create Instance Mechanism. When AliasBasedAddressing is true, AutoCreateInstances indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in [A.3.2.1/TR-069]).

*A true value indicates that the CPE will perform auto-creation of instances when the Alias-Based Addressing Mechanism is used in SetParameterValues RPC.

*A false value indicates that the CPE will not create new object instances. Instead, it will reject the setting of parameters in unrecognized instances and respond with a fault code.

This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be false.

-

2.3

ManageableDeviceNumberOfEntries

unsignedInt

R

The number of entries in the ManageableDevice table.

-

2.0

ManageableDeviceNotificationLimit

unsignedInt

W

The minimum time, in seconds, between Active Notifications resulting from changes to the ManageableDeviceNumberOfEntries (if Active Notification is enabled).

-

2.7

EmbeddedDeviceNumberOfEntries

unsignedInt

R

The number of entries in the EmbeddedDevice table.

-

2.3

VirtualDeviceNumberOfEntries

unsignedInt

R

The number of entries in the VirtualDevice table.

-

2.3

SupportedConnReqMethods

string[]

R

Comma-separated list of strings. The connection request methods supported by this ManagementServer. Each list item is an enumeration of:

• HTTP (The connection request method as specified in [Section 3.2.2 ACS Connection Initiation/TR-069], REQUIRED)
• STUN (The connection request method as specified in [Annex G Connection Request via NAT Gateway/TR-069], OPTIONAL)
• XMPP (The connection request method as specified in [Annex K XMPP Connection Request/TR-069], OPTIONAL)

-

2.7

ConnReqXMPPConnection

string

W

The value MUST be the Path Name of the XMPP.Connection instance that is used for connection requests to this ManagementServer. If the referenced object is deleted, the parameter value MUST be set to an empty string.

-

2.7

ConnReqAllowedJabberIDs

string(:256)[:32]()

W

When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza will contian a "from" address that contains the Jabber ID of the initiating entity.

This parameter is a Comma-separated list (up to 32 items) (length ) of strings (maximum number of characters per item 256). Each entry represents a Jabber ID, or address, that is allowed to initiate an XMPP Connection Request.

Each Jabber ID is allowed to be either a "Full JID" (containing a local-part, domain-part, and resource-part in the following format: "local-part@domain-part/resource-part") or a "Bare JID" (containing a local-part and a domain-part in the following format: "local-part@domain-part"). "Full JID" entries require an exact match whereas "Bare JID" entries are a wildcard match and will match any Jabber ID with the same local-part and domain-part independent of the resource-part.

For example, if ConnReqAllowedJabberIDs contained "ACS1@tr069.example.com, ACS2@tr-069.example.com/resource1" then the following incoming "from" addresses would be allowed:

• "ACS1@tr069.example.com/resource1"

• "ACS1@tr069.example.com/resource2"

• "ACS2@tr069.example.com/resource1"

And the following incoming "from" addresses would not be allowed:

• "ACS2@tr069.example.com/resource2"

• "ACS@tr069.example.com/resource"

If this Parameter is an empty string then all Jabber IDs are allowed and an XMPP Connection Request can not be deemed invalid due to the "from" address.

-

2.7

ConnReqJabberID

string

R

The value MUST be the value of the XMPP.Connection.{i}.JabberID contained in the XMPP.Connection instance referenced by the ConnReqXMPPConnection parameter.

If the ConnReqXMPPConnection parameter is empty or the XMPP.Connection instance being reference is disabled, then this value will be empty.

If the XMPP.Connection instance being referenced by the ConnReqXMPPConnection parameter is lost (XMPP.Connection.{i}.Status parameter changes from Enabled to some other value), then the value of this parameter MUST remain unchanged until the connection can be reestablished and a new XMPP.Connection.{i}.JabberID can be established. If the new XMPP.Connection.{i}.JabberID is identical to the existing value, then the value of this parameter MUST NOT be altered and a VALUE CHANGE event MUST NOT be generated.

Active Notification MUST by default be enabled for this parameter.

-

2.7

HTTPCompressionSupported

string[]

R

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in [Section 3.4.7/TR-069]. Each list item is an enumeration of:

• GZIP (As defined in [Section 3.5/RFC2616])
• Compress (As defined in [Section 3.5/RFC2616])
• Deflate (As defined in [Section 3.5/RFC2616])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.7

HTTPCompression

string

W

The value MUST be a member of the list reported by the HTTPCompressionSupported parameter, or else be Disabled. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when communicating with the ACS.

The factory default value MUST be Disabled.

-

2.7

LightweightNotificationProtocolsSupported

string[]

R

Comma-separated list of strings. Indicates the Lightweight Notification Protocol(s) supported by this CPE. Each list item is an enumeration of:

• UDP (As defined in [Annex M/TR-069])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.7

LightweightNotificationProtocolsUsed

string[]

W

Comma-separated list of strings. Each list item MUST be a member of the list reported by the LightweightNotificationProtocolsSupported parameter, or else be an empty string. The value of this parameter represents the protocol(s) that will be used by the CPE when sending Lightweight Notifications.

An empty string means that Lightweight Notifications are disabled, despite any SetParameterAttributes that have been configured on various parameters.

-

2.7

LightweightNotificationTriggerInterval

unsignedInt(0:)

W

The duration in seconds of the interval for which the CPE MUST attempt to deliver any pending Passive Lightweight Notifications.

A value of 0 means that the trigger interval is effectively disabled. In this case pending Passive Lightweight Notifications are only sent when triggered by an Active Lightweight Notification.

-

2.12

LightweightNotificationTriggerTime

dateTime

W

An absolute time reference in UTC to determine when the CPE will initiate the Lightweight Notification (in the case that there are pending Passive Lightweight Notifications that need to be delivered). Each Passive Lightweight Notification (that is waiting for the Lightweight Notification Trigger mechanism for delivery) MUST occur at this reference time plus or minus an integer multiple of the LightweightNotificationTriggerInterval. LightweightNotificationTriggerTime is used only to set the phase of the Passive Lightweight Notification. The actual value of LightweightNotificationTriggerTime can be arbitrarily far into the past or future.

For example, if LightweightNotificationTriggerInterval is 86400 (a day) and if LightweightNotificationTriggerTime is set to UTC midnight on some day (in the past, present, or future) then Lightweight Notifications for pending Passive Lightweight Notifications will occur every day at UTC midnight. These MUST begin on the very next midnight, even if LightweightNotificationTriggerTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106] 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 LightweightNotificationTriggerInterval. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the LightweightNotificationTriggerTime parameter was set to the Unknown Time value.

-

2.12

UDPLightweightNotificationHost

string(:256)

W

Host name or address to be used when sending the UDP Lightweight Notifications.

UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationHost is not implemented or is an empty string, and UDP Lightweight Notifications are supported, the destination host MUST be the same as the ACS (as contained in the host portion of the URL).

-

2.7

UDPLightweightNotificationPort

unsignedInt

W

The port number to be used when sending UDP Lightweight Notifications.

UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationPort is not implemented and UDP Lightweight Notifications are supported, the destination port MUST be 7547.

-

2.7

InstanceWildcardsSupported

boolean

R

Indicates whether or not instance wildcards are supported.

A true value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069].

-

2.12

InformParameterNumberOfEntries

unsignedInt

R

The number of entries in the InformParameter table.

-

2.8

ManufacturerOUI

string(6)

R

Organizationally unique identifier of the Device manufacturer as provided to the Gateway by the Device. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

• [0-9A-F]{6}

The value MUST be a valid OUI as defined in [OUI].

Active Notification requests for this parameter MAY be denied.

-

2.0

SerialNumber

string(:64)

R

Serial number of the Device as provided to the Gateway by the Device.

Active Notification requests for this parameter MAY be denied.

-

2.0

ProductClass

string(:64)

R

Identifier of the class of product for which the Device's serial number applies as provided to the Gateway by the Device.

If the Device does not provide a Product Class, then this parameter MUST be an empty string.

Active Notification requests for this parameter MAY be denied.

-

2.0

Host

string[](:1024)

R

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this physical LAN device. There can be multiple such entries if the device has more than one network interface.

For example: Device.Hosts.Host.1,Device.Hosts.Host.5

-

2.0

Enable

boolean

W

Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.

-

2.0

TransferTypeFilter

string

W

Indicates the transfer types that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer types not indicated by this filter MUST NOT be included when the CPE notifies the ACS. Enumeration of:

• Upload
• Download
• Both (Upload and Download)

Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.

-

2.0

ResultTypeFilter

string

W

Indicates the transfer results that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer results omitted from this list MUST NOT be included when the CPE notifies the ACS.

Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.

Enumeration of:

• Success (The autonomous file transfer completed successfully; i.e., the FaultCode was zero)
• Failure (The autonomous file transfer did not complete successfully; i.e., the FaultCode was non-zero)
• Both (Success and Failure)

-

2.0

FileTypeFilter

string[](:1024)

W

Comma-separated list (maximum number of characters 1024) of strings. Indicates the file types that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types omitted from this list MUST NOT be included when the CPE notifies the ACS.

Each list item matches one of:

• 1 Firmware Upgrade Image (Download Only)
• 2 Web Content (Download Only)
• 3 Vendor Configuration File (Download or Upload)
• 4 Vendor Log File (Upload Only)
• X [0-9A-F]{6} .* (For Vendor-Specific File Types, could be for either Download or Upload)

Additionally, the following format is defined to allow the unique definition of vendor-specific file types:

• "X "

is replaced by a 6 hexadecimal-digit OUI (organizationally unique identifier) as defined in [OUI], with all upper-case letters and any leading zeros included. The OUI used for a given vendor-specific file type MUST be one that is assigned to the organization that defined this file type (which is not necessarily the same as the vendor of the CPE or ACS).

Note that an empty string indicates that all file types are excluded from this filter, effectively disabling CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.

-

2.0

Enable

boolean

W

Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files.

-

2.0

Status

string

R

The status of the announcement service.

Enumeration of:

• Disabled
• Enabled
• Error (MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)

-

2.0

GroupNumberOfEntries

unsignedInt

R

The number of entries in the Group table.

-

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

Active Notification requests for this parameter MAY be denied.

-

2.3

Enable

boolean

W

Enable/disable listening to this multicast group.

false

2.0

Status

string

R

The status of this group table entry.

Enumeration of:

• Disabled
• Enabled
• Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to parse received announcements, OPTIONAL)

Disabled

2.0

URL

string(:2048)

W

The [URL] encoding the group address, source and port on which to listen, and other protocol information, e.g. expected announcement format.

Depending on the application, the messages identified by this URL MAY directly contain the data to be downloaded, or alternatively MAY contain information informing the CPE how to obtain the data to be downloaded via a separate mechanism, which itself could involve a unicast or a multicast download protocol.

Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SAP [RFC2974] stream that indicates how to use either FLUTE [RFC3926] or DSM-CC [ISO-13818-6:1998] to perform the download.

-

2.0

Enable

boolean

W

Enable/disable CPE ability to autonomously query a server for the purpose of downloading files.

-

2.0

Status

string

R

The status of the query service.

Enumeration of:

• Disabled
• Enabled
• Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to contact query response server, OPTIONAL)

-

2.0

URL

string(:2048)

W

The [URL] of the query response server.

Depending on the application, the protocol described by this URL MAY be a SOAP interface, or MAY be any other RPC mechanism.

Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS.

-

2.0

Enable

boolean

W

Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events to the ACS.

-

2.1

OperationTypeFilter

string[]

W

Comma-separated list of strings. Indicates the Deployment Unit operations that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events.

Operation types not indicated by this list MUST NOT be included when the CPE notifies the ACS. An empty string is essentially the same as setting Enable to false.

Each list item is an enumeration of:

• Install
• Update
• Uninstall

-

2.1

ResultTypeFilter

string

W

Indicates the Deployment Unit state change results that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events. State change results omitted from this filter MUST NOT be included when the CPE notifies the ACS.

Enumeration of:

• Success (The autonomous state change completed successfully; i.e., the FaultCode was zero)
• Failure (The autonomous state change did not complete successfully; i.e., the FaultCode was non-zero)
• Both (All result types independent of Success or Failure)

-

2.1

FaultCodeFilter

string[]

W

Comma-separated list of strings. Indicates the Deployment Unit state change fault codes that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events. State change fault codes omitted from this filter MUST NOT be included when the CPE notifies the ACS.

This filter has no effect on the notification of a successful autonomous state change. This filter only applies when ResultTypeFilter is set to either Failure or Both. An empty string means that failed autonomous state changes will not be sent to the ACS.

Each list item is an enumeration of:

• 9001
• 9003
• 9012
• 9013
• 9015
• 9016
• 9017
• 9018
• 9022
• 9023
• 9024
• 9025
• 9026
• 9027
• 9028
• 9029
• 9030
• 9031
• 9032

-

2.1

ControllerID

string(:256)

R

Identifier of the controller that is responsible for a sub-network of Proxied Devices within the LAN.

An empty string indicates that this Proxied Device either:

• Isn't part of a sub-network, within the LAN, with a controller entity.

• Doesn't need a ControllerID to ensure its ProxiedDeviceID is unique throughout the LAN.

-

2.3

ProxiedDeviceID

string(:256)

R

Idenitfier of the Proxied Device.

This is an opaque string that is unique to the Proxied Device within a specific sub-network within the LAN (identified by the ControllerID). If the ControllerID is an empty string this ProxiedDeviceID is unique across the LAN.

-

2.3

Reference

string

R

The value MUST be the path name of a table row. If the referenced object is deleted, this EmbeddedDevice instance MUST also be removed. Represents the instance of a multi-instanced object that is directly controlled by, and has come into existence because of, this Proxied Device that utilizes the Embedded Object Mechanism [Annex J.3/TR-069].

-

2.3

SupportedDataModel

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instance(s) that this Proxied Device is utilizing. The CWMP-DT schema instance is also the one being utilized by the object referenced within Reference.

-

2.3

Host

string[:32]()

R

Comma-separated list (up to 32 items) (length ) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References the Hosts.Host table entry(s), whether active or inactive, that corresponds to this proxied LAN device.

-

2.3

ProxyProtocol

string

R

The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP-DM (see [UPnP-DM:1])
• ETSI-M2M (see [ETSIM2MFA])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.3

ProxyProtocolReference

string

R

The value MUST be the Path Name of a protocol object that uses the ProxyProtocol.

-

2.6

DiscoveryProtocol

string[]

R

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

Each list item is an enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP (see [UPnP-DAv1])
• ETSI-M2M (see [ETSIM2MFA])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.6

DiscoveryProtocolReference

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol, or an empty string.

For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

• UPnP.Discovery.RootDevice

• UPnP.Discovery.Device

• UPnP.Discovery.Service

For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

-

2.6

CommandProcessed

string

R

Whether or not the CPE Proxier has successfully communicated all pending configuration commands down to the Proxied Device.

Enumeration of:

• Pending
• Retrying
• Success
• Error

-

2.3

CommandProcessingErrMsg

string(:1024)

R

Detailed CommandProcessed error description (vendor specific).

-

2.3

LastSyncTime

dateTime

R

The last time that the CPE Proxier synchronized the state of the Proxied Device. This parameter MUST be updated when a proxy command is executed successfully on the Proxied Device.

The Unknown Time value, as defined in [TR-106], indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted.

-

2.3

ManufacturerOUI

string(6)

R

Organizationally unique identifier of the associated Proxied Device. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

• [0-9A-F]{6}

The value MUST be a valid OUI as defined in [OUI].

-

2.3

ProductClass

string(:64)

R

Identifier of the class of product of the associated Proxied Device for which the serial number applies.

-

2.3

SerialNumber

string(:64)

R

Serial number of the associated Proxied Device.

-

2.3

Host

string[:32]()

R

Comma-separated list (up to 32 items) (length ) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface.

-

2.3

ProxyProtocol

string

R

The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP-DM (see [UPnP-DM:1])
• ETSI-M2M (see [ETSIM2MFA])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.3

ProxyProtocolReference

string

R

The value MUST be the Path Name of a protocol object that uses the ProxyProtocol.

-

2.6

DiscoveryProtocol

string[]

R

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

Each list item is an enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP (see [UPnP-DAv1])
• ETSI-M2M (see [ETSIM2MFA])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.6

DiscoveryProtocolReference

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol, or an empty string.

For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

• UPnP.Discovery.RootDevice

• UPnP.Discovery.Device

• UPnP.Discovery.Service

For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

-

2.6

CRUnawarenessMaxDuration

int(-1:)

W

When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in seconds), the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for having been non CR-aware.

The factory default value MUST be -1.

-

2.7

MaxMissedPeriodic

int(-1:)

W

When waking up from a non fully Timer-Aware Standby that made it miss more than this parameter's value Periodic Contacts, the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for exceeding that limit.

The factory default value MUST be -1.

-

2.7

NotifyMissedScheduled

boolean

W

When waking up from a non fully Timer-Aware Standby that made it miss at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if this parameter is true.

The factory default value MUST be false.

-

2.7

NetworkAwarenessCapable

boolean

R

Indicates that the CPE is capable of CR-Aware Standby.

-

2.7

SelfTimerCapable

boolean

R

Indicates that the CPE is capable of Timer-Aware Standby.

-

2.7

CRAwarenessRequested

boolean

W

If NetworkAwarenessCapable and this parameter are both true, the CPE MUST NOT go into a non CR-Aware Standby state.

The factory default value MUST be false.

-

2.7

PeriodicAwarenessRequested

boolean

W

If SelfTimerCapable and this parameter are both true, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.

The factory default value MUST be false.

-

2.7

ScheduledAwarenessRequested

boolean

W

If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact:

*if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby;

*if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.

-

2.7

Enable

boolean

W

Enables or disables this InformParameter.

false

2.8

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.

-

2.8

ParameterName

string(:256)

W

A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE.

If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.

<Empty>

2.8

EventList

string[]

W

Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC.

All Inform Events (see [Section 3.7.1.5/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069].

An empty string means all events except "4 VALUE CHANGE".

<Empty>

2.8

Enable

boolean

W

When true, Heartbeat events are enabled to be sent to the ACS based on the values of the ReportingInterval and InitiationTime parameters.

-

2.12

ReportingInterval

unsignedInt(30:)

W

The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if Enable is true.

-

2.12

InitiationTime

dateTime

W

An absolute time reference in UTC to determine when the CPE will initiate the Heartbeat event Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the ReportingInterval.

InitiationTime is used only to set the phase of the Heartbeat event Informs. The actual value of InitiationTime can be arbitrarily far into the past or future.

For example, if ReportingInterval is 60 (one minute) and if InitiationTime is set to UTC midnight on some day (in the past, present, or future) then Heartbeat Informs will occur every minute at the next UTC midnight. These MUST begin on the very next midnight, even if InitiationTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. The CPE MUST locally choose a random time reference.

If absolute time is not available to the CPE, its Heartbeat Inform behavior MUST be the same as if the InitiationTime parameter was set to the Unknown Time value.

-

2.12

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.

Active Notification requests for this parameter MAY be denied.

-

2.0

Name

string(:64)

R

Name of the vendor configuration file.

If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name.

Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name.

{{template: non-existent VENDORCONFIGFILE-NAME}}

-

2.0

Version

string(:16)

R

A string identifying the configuration file version currently used in the CPE.

If the CPE is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value.

Otherwise, the value of this parameter MUST be an empty string.

-

2.0

Date

dateTime

R

Date and time when the content of the current version of this vendor configuration file was first applied by the CPE.

-

2.0

Description

string(:256)

R

A description of the vendor configuration file (human-readable string).

-

2.0

UseForBackupRestore

boolean

R

When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes.

Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific.

-

2.7

Total

unsignedInt

R

The total physical volatile RAM, in KiB, installed on the device.

-

2.0

Free

unsignedInt

R

The free physical volatile RAM, in KiB, currently available on the device.

Active Notification requests for this parameter MAY be denied.

-

2.0

TotalPersistent

unsignedInt

R

The sum total physical Non-Volatile Memory (NVM), in KiB, installed on the device. This memory persists across reboots and can be used by the system, applications, or users.

-

2.15

FreePersistent

unsignedInt

R

The sum total free physical Non-Volatile Memory (NVM), in KiB, currently available on the device. This memory persists across reboots and is available for use by the system, applications, or users.

Active Notification requests for this parameter MAY be denied.

-

2.15

CPUUsage

unsignedInt(:100)

R

The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU.

Active Notification requests for this parameter MAY be denied.

-

2.0

ProcessNumberOfEntries

unsignedInt

R

The number of entries in the Process table.

Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in [Section 3.2.1/TR-069].

-

2.0

PID

unsignedInt

R

The Process Identifier.

-

2.0

Command

string(:256)

R

The name of the command that has caused the process to exist.

-

2.0

Size

unsignedInt

R

The size in KiB of the memory occupied by the process.

Active Notification requests for this parameter MAY be denied.

-

2.0

Priority

unsignedInt(:99)

R

The priority of the process where 0 is highest.

-

2.0

CPUTime

unsignedInt

R

The amount of time in milliseconds that the process has spent taking up CPU time since the process was started.

Active Notification requests for this parameter MAY be denied.

-

2.0

State

string

R

The current state that the process is in.

Enumeration of:

• Running
• Sleeping
• Stopped
• Idle (OPTIONAL)
• Uninterruptible (OPTIONAL)
• Zombie (OPTIONAL)

Active Notification requests for this parameter MAY be denied.

-

2.0

TemperatureSensorNumberOfEntries

unsignedInt

R

The number of entries in the TemperatureSensor table.

-

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

Active Notification requests for this parameter MAY be denied.

-

2.3

Enable

boolean

W

Indicates whether or not the temperature sensor is enabled.

-

2.0

Status

string

R

The status of this temperature sensor.

Enumeration of:

• Disabled (The sensor is not currently sampling the temperature)
• Enabled (The sensor is currently sampling the temperature)
• Error (The sensor error currently prevents sampling the temperature)

-

2.0

Reset

boolean

W

When set to true, resets the temperature sensor.

-

2.0

ResetTime

dateTime

R

The time at which this temperature sensor was reset.

Reset can be caused by:

• Status transition from Disabled to Enabled

• Reset parameter is set to true.

• An internal reset of the temperature sensor (including a reboot of the device).

The Unknown Time value, as defined in [TR-106], indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.

-

2.0

Name

string(:256)

R

Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors.

-

2.0

Value

int(-274:)

R

This temperature sensor's last good reading in degrees celsius.

A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

Active Notification requests for this parameter MAY be denied.

-

2.0

LastUpdate

dateTime

R

The time at which this temperature sensor's last good reading was obtained.

The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset.

Active Notification requests for this parameter MAY be denied.

-

2.0

MinValue

int(-274:)

R

This temperature sensor's lowest value reading in degrees celsius since last reset.

A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

-

2.0

MinTime

dateTime

R

The time at which this temperature sensor's lowest value was read.

The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset.

-

2.0

MaxValue

int(-274:)

R

This temperature sensor's highest value reading in degrees celsius since last reset.

A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

-

2.0

MaxTime

dateTime

R

The time at which this temperature sensor's highest value was read.

The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset.

-

2.0

LowAlarmValue

int(-274:)

W

This temperature sensor's low alarm value in degrees celsius.

A value of -274 (which is below absolute zero) indicates a non configured value.

A change to this value will cause LowAlarmTime to be reset.

-

2.0

LowAlarmTime

dateTime

R

Initial time at which this temperature sensor's LowAlarmValue was encountered.

This value is only set the first time the alarm is seen and not changed until the next reset.

The Unknown Time value, as defined in [TR-106], indicates that an alarm has not been encountered since the last reset.

-

2.0

HighAlarmValue

int(-274:)

W

This temperature sensor's high alarm value in degrees celsius.

A value of -274 (which is below absolute zero) indicates a non configured value.

A change to this value will cause HighAlarmTime to be reset.

-

2.0

PollingInterval

unsignedInt

W

The interval, measured in seconds, in which the device polls this TemperatureSensor.

If the value is 0 then the device selects its own polling interval.

If the value is greater than 0 then the device MUST use this value as the polling interval.

-

2.1

HighAlarmTime

dateTime

R

Initial time at which this temperature sensor's HighAlarmValue was encountered.

This value is only set the first time the alarm is seen and not changed until the next reset.

The Unknown Time value, as defined in [TR-106], indicates that an alarm has not been encountered since the last reset.

-

2.0

MaxTCPWindowSize

unsignedInt

R

The maximum number of bytes of outstanding data a sender can send on a particular connection prior to an acknowledgment [RFC793]. Any scaling factor SHOULD be included in this parameter [RFC1323].

-

2.0

TCPImplementation

string[]

R

Comma-separated list of strings. Indicates the TCP congestion control mechanism(s) implemented. Each list item is an enumeration of:

• Tahoe (Represents the base TCP implementation in [RFC793] and elements of [RFC2582])
• Reno (Represents the base TCP implementation in [RFC793] with the additional algorithms defined in [RFC2581])
• New Reno (Described as a modification to the Reno algorithms in [RFC2582])
• Vegas (An emerging TCP congestion control mechanism)

Tahoe, Reno, and New Reno are defined in [RFC2582]

-

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

Active Notification requests for this parameter MAY be denied.

-

2.3

Architecture

string

R

The architecture of the processor on the underlying hardware. Enumeration of:

• arm
• i386
• m68010
• m68k
• mipseb (big-endian)
• mipsel (little-endian)
• powerpc
• sh3eb (big-endian)
• sh3el (little-endian)
• x86_64

For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106].

-

2.1

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.

Active Notification requests for this parameter MAY be denied.

-

2.1

Name

string(:64)

R

Name of the log file.

Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism.

-

2.1

MaximumSize

unsignedInt

R

The maximum size of the log file in bytes. If the device doesn't know the maximum file size then MaximumSize will be 0.

-

2.1

Persistent

boolean

R

When true, the log file contents are preserved across a device reboot.

When false, the log file contents will be purged when the device is rebooted.

-

2.1

Source

string

R

Identifies the source of the location data.

Enumeration of:

• GPS
• AGPS
• Manual
• External

External

2.4

AcquiredTime

dateTime

R

The time when the location was acquired.

-

2.4

ExternalSource

string

R

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

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

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

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

-

2.4

ExternalProtocol

string

R

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

• <Empty> (An empty string)
• CWMP
• USP (Added in 2.13)
• OMA-DM
• SNMP
• UPnP
• HELD
• DHCPv4
• DHCPv6
• LLDP-MED
• MLP
• Other

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

CWMP

2.4

DataObject

string(:1200)

W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP or USP.

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

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

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

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

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

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

-

2.4

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.

Active Notification requests for this parameter MAY be denied.

-

2.11

Location

string

R

The location of the device that represents the image as the user looks at the front of the device in its typical orientation (e.g., on-end, flat).

Enumeration of:

• Front
• Back
• Left
• Right
• Top
• Bottom

-

2.11

Image

base64

R

The device image in PNG, JPEG or GIF format.

-

2.11

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.

-

2.12

Name

string(:64)

R

Firmware/software image name. Descriptive text of the image or filename.

The value of Name is an empty string if Status is anything other than Active, Available, InstallationFailed, or ActivationFailed.

-

2.12

Version

string(:64)

R

A string identifying the version of the firmware image represented by this FirmwareImage. Whenever this firmware image is active (ie, the device has booted this firmware image), the value of the DeviceInfo.SoftwareVersion parameter MUST be the same as the value contained in this parameter.

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

The value of Version is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed.

-

2.12

Available

boolean

W

Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true.

This value MUST be set to true by the device whenever a new firmware image is installed.

This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter.

Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it.

-

2.12

Status

string

R

Status of the firmware image, as determined by the Agent. Enumeration of:

• NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
• Active (This Firmware Image instance is the currently active image, added in 2.14)
• Downloading (This Firmware Image instance is being downloaded)
• Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
• Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
• DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
• ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
• InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
• ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)

-

2.12

BootFailureLog

string

R

If the Agent is unable to boot into this firmware image, when specified, the Agent can use this parameter to record some information as to why the boot failed.

If the Agent successfully boots into this firmware, the value of this parameter SHOULD be an empty string. When a new firmware image is installed into this object instance, this parameter MUST be cleared.

The length of this string is defined as implementation-specific by the Agent.

-

2.12

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.

Active Notification requests for this parameter MAY be denied.

-

2.3

URL

string(:2048)

R

The [URL] that describes some or all of the device's currently Supported Data Model.

The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model.

The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in [Annex B/TR-106], including any additional normative requirements referenced within the Schema.

The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that UUID is a unique key, so the XML file referenced by this URL will never change.

The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of "localhost" as URL host portion, When the "localhost" value is used, the ACS has the responsibility to substitute the "localhost" value with the host portion of the connection request URL.

Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.

-

2.0

UUID

string(36)

R

[UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL.

-

2.6

URN

string(:256)

R

URN ([RFC3986]) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry.

For example, if this table entry references a DT Instance that refers to the Device:2.13 Root Object, the value of this parameter would be urn:broadband-forum-org:tr-181-2-13-0. If the DT Instance instead referred to a vendor-specific Root Object, e.g. X_EXAMPLE_Device:1.0 (derived from Device:1.3), the value of this parameter would be something like urn:example-com:device-1-0-0.

-

2.0

Features

string[]

R

Comma-separated list of strings. This parameter MUST list exactly the features that are defined using the top-level feature element in the DT Instance referenced by URL.

For example, if the DT instance specified the following:

then the value of this parameter might be DNSServer,Router,X_MyDeviceFeature. The order in which the features are listed is not significant.

-

2.0

ManufacturerOUI

string(6)

R

Organizationally unique identifier of the associated CPE Proxier. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

• [0-9A-F]{6}

The value MUST be a valid OUI as defined in [OUI].

-

2.3

ProductClass

string(:64)

R

Identifier of the class of product of the associated CPE Proxier for which the serial number applies.

An empty string indicates either that the CPE Proxier does not use a product class to differentiate its serial number.

-

2.3

SerialNumber

string(:64)

R

Serial number of the associated CPE Proxier.

-

2.3

ProxyProtocol

string

R

The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP-DM (see [UPnP-DM:1])
• ETSI-M2M (see [ETSIM2MFA])

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.

-

2.3

Enable

boolean

W

Enables or disables the NTP or SNTP time client.

-

2.0

Status

string

R

Status of Time support on the CPE. Enumeration of:

• Disabled
• Unsynchronized
• Synchronized
• Error_FailedToSynchronize
• Error (OPTIONAL)

The Unsynchronized value indicates that the CPE's absolute time has not yet been set.

The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate.

The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate.

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

-

2.0

NTPServer1

string(:64)

W

First NTP timeserver. Either a host name or IP address.

-

2.0

NTPServer2

string(:64)

W

Second NTP timeserver. Either a host name or IP address.

-

2.0

NTPServer3

string(:64)

W

Third NTP timeserver. Either a host name or IP address.

-

2.0

NTPServer4

string(:64)

W

Fourth NTP timeserver. Either a host name or IP address.

-

2.0

NTPServer5

string(:64)

W

Fifth NTP timeserver. Either a host name or IP address.

-

2.0

CurrentLocalTime

dateTime

R

The current date and time in the CPE's local time zone.

Active Notification requests for this parameter MAY be denied.

-

2.0

LocalTimeZone

string(:256)

W

The local time zone definition, encoded according to IEEE 1003.1 (POSIX). The following is an example value:

EST+5 EDT,M4.1.0/2,M10.5.0/2

-

2.0

Enable

boolean

W

Enables and disables the CPE's user interface.

The factory default value MUST be true.

-

2.11

PasswordRequired

boolean

W

Present only if the CPE provides a password-protected LAN-side user interface.

Indicates whether or not the local user interface MUST require a password to be chosen by the user. If false, the choice of whether or not a password is used is left to the user.

-

2.0

PasswordUserSelectable

boolean

W

Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.

Indicates whether or not a password to protect the local user interface of the CPE MAY be selected by the user directly (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword).

-

2.0

PasswordReset

boolean

W

Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.

When set to true, resets LANConfigSecurity.ConfigPassword to its factory value.

-

2.0

UpgradeAvailable

boolean

W

Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user.

-

2.0

WarrantyDate

dateTime

W

Indicates the date and time in UTC that the warranty associated with the CPE is to expire.

-

2.0

ISPName

string(:64)

W

The name of the customer's ISP.

-

2.0

ISPHelpDesk

string(:32)

W

The help desk phone number of the ISP.

-

2.0

ISPHomePage

string(:2048)

W

The [URL] of the ISP's home page.

-

2.0

ISPHelpPage

string(:2048)

W

The [URL] of the ISP's on-line support page.

-

2.0

ISPLogo

base64(0:4095)

W

Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less.

-

2.0

ISPLogoSize

unsignedInt(0:4095)

W

Un-encoded binary image size in bytes.

If ISPLogoSize input value is 0 then the ISPLogo is cleared.

ISPLogoSize can also be used as a check to verify correct transfer and conversion of Base64 string to image size.

-

2.0

ISPMailServer

string(:2048)

W

The [URL] of the ISP's mail server.

-

2.0

ISPNewsServer

string(:2048)