{{docname|Device:2 Root Data Model for CWMP (TR-069)}}
{{appdate|November 2020}}
{{trname|TR-181i2a14}}
* Added WWC (5G Wireline Wireless Convergence), PDU (Protocol Data Unit) and FWE (5G Wireline wireless Encapsulation) top-level objects
* Updated Cellular object to be applicable to 5G Residential Gateways
* Extended support for TR-471 IP-layer metrics, including new IP-layer capacity test
* Supported LAN device time-based access-control
* Various Wi-Fi improvements
{{bibref|TR-069|Annex N}}
{{bibref|TR-069|Annex N.2.1}}
{{bibref|TR-069|Annex N.2.2.1}}
{{bibref|TR-069|Annex N.3.1}}
{{bibref|TR-069|Annex N.3.4}}
{{bibref|TR-069|Annex N.3.5}}
. If the CPE is unable to acquire a time, then the processing described by the dateTime type in {{bibref|TR-069|Table 12}} is followed
, as specified in {{bibref|TR-069|Annex K XMPP Connection Request}}
, as described in {{bibref|TR-069|Appendix III}}
Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.
{{numentries}}
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 {{bibref|TR-069|Section 3.2.1}}.
This table contains details of the device's Current Supported Data Model.
The table MUST describe the device's entire Supported Data Model. Therefore, if a device's Supported Data Model changes at run-time, entries will need to be added or removed as appropriate.
Each table entry MUST refer to only a single Root Object or Service Object. The device MAY choose to use more than one table entry for a given Root Object or Service Object.
Considering that every device has some form of a data model, this table MUST NOT be empty.
{{datatype|expand}}
The {{datatype}} 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 {{bibref|TR-106|Annex B}}, 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 {{param|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.
UUID ({{bibref|RFC4122}}) that is the value of the uuid attribute in the DT Instance referenced by {{param|URL}}.
URN ({{bibref|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''.
This parameter MUST list exactly the features that are defined using the top-level ''feature'' element in the DT Instance referenced by {{param|URL}}.
For example, if the DT instance specified the following:
:<feature name="DNSServer"/>
:<feature name="Router"/>
:<feature name="X_MyDeviceFeature"/>
then the value of this parameter might be ''DNSServer,Router,X_MyDeviceFeature''. The order in which the features are listed is not significant.
Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069|Annex J.1.1}}.
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. {{pattern}}
The value MUST be a valid OUI as defined in {{bibref|OUI}}.
Identifier of the class of product of the associated CPE Proxier for which the serial number applies.
{{empty}} indicates either that the CPE Proxier does not use a product class to differentiate its serial number.
Serial number of the associated CPE Proxier.
The protocol being used to communicate between the CPE Proxier and this Proxied Device. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
see {{bibref|ETSIM2MFA}}
This object contains information associated with a connected Internet Gateway Device.
Organizationally unique identifier of the associated Internet Gateway Device. {{pattern}}
{{empty}} indicates that there is no associated Internet Gateway Device that has been detected.
Identifier of the product class of the associated Internet Gateway Device. {{empty}} indicates either that there is no associated Internet Gateway Device that has been detected, or the Internet Gateway Device does not support the use of the product-class parameter.
Serial number of the associated Internet Gateway Device. {{empty}} indicates that there is no associated Internet Gateway Device that has been detected.
This object contains parameters relating to the CPE's association with an ACS.
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 {{datatype}} 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.
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.
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.
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.
The number of {{units}} 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.
Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call.
The duration in {{units}} of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if {{param|PeriodicInformEnable}} is {{true}}.
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 {{param|PeriodicInformInterval}}.
{{param}} is used only to set the ''phase'' of the periodic Informs. The actual value of {{param}} can be arbitrarily far into the past or future.
For example, if {{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers to a day in the future.
The Unknown Time value defined in {{bibref|TR-106|section 3.2}} 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 {{param|PeriodicInformInterval}}.
If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value.
{{param}} provides the ACS a reliable and extensible means to track changes made by the ACS. The value of {{param}} 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 {{param}} 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 {{param}} MUST NOT be modified.
The CPE MUST only modify the value of {{param}} as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of {{param}} MUST be set to {{empty}}.
The HTTP {{datatype}} 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 {{bibref|RFC3986|Section 3.2.2}}).
Username used to authenticate an ACS making a Connection Request to the CPE.
Password used to authenticate an ACS making a Connection Request to the CPE.
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.
Present only for a CPE that supports the Kicked RPC method.
LAN-accessible {{datatype}} 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.
Present only for a CPE that provides a LAN-side web page to show progress during a file download.
LAN-accessible {{datatype}} 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.
This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of {{units}} 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.
Configures the first session retry wait interval, in {{units}}, as specified in {{bibref|TR-069|section 3.2.1.1}}.
A value of 5 corresponds to the default behavior that is described in {{bibref|TR-069}}.
The device MUST use a random value between {{param}} and ({{param}} * {{param|CWMPRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
Configures the retry interval multiplier as specified in {{bibref|TR-069|section 3.2.1.1}}.
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 {{bibref|TR-069}}.
The device MUST use a random value between {{param|CWMPRetryMinimumWaitInterval}} and ({{param|CWMPRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
Enables or disables HTTP connection request handling on the CPE.
If HTTP connection request handling is disabled ({{param}} is set to {{false}}), {{param|ConnectionRequestURL}} MUST be set to {{empty}} and the CPE MUST close the port used by the HTTP connection request server.
Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see {{bibref|TR-069|Annex G}}).
This parameter is represented in the form of an Authority element as defined in {{bibref|RFC3986}}. The value MUST be in one of the following two forms:
: host:port
: host
* When {{param|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 {{param|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 {{bibref|RFC3986|Section 3.2.2}}).
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.
Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via {{param|STUNEnable}}.
If is {{empty}} and {{param|STUNEnable}} is {{true}}, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL.
Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via {{param|STUNEnable}}.
By default, this SHOULD be the equal to the default STUN port, 3478.
If is not {{empty}}, 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 {{empty}}, the CPE MUST NOT send STUN Binding Requests with message integrity.
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).
If STUN Is enabled, the maximum period, in {{units}}, 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.
If STUN Is enabled, the minimum period, in {{units}}, 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 {{bibref|RFC3489}}.
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 {{param|STUNEnable}} is {{false}}, this value MUST be {{false}}.
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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}.
Instance identification mode as defined in {{bibref|TR-069|3.6.1}}. When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. {{enum}}
This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.
Enable or disable the Auto-Create Instance Mechanism. When {{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in {{bibref|TR-069|A.3.2.1}}).
*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.
{{numentries}}
The minimum time, in seconds, between Active Notifications resulting from changes to the {{param|ManageableDeviceNumberOfEntries}} (if Active Notification is enabled).
{{numentries}}
{{numentries}}
The connection request methods supported by this {{object}}. {{enum}}
The connection request method as specified in {{bibref|TR-069|Section 3.2.2 ACS Connection Initiation}}, '''REQUIRED'''
The connection request method as specified in {{bibref|TR-069|Annex G Connection Request via NAT Gateway}}
The connection request method as specified in {{bibref|TR-069|Annex K XMPP Connection Request}}
{{reference|the {{object|.XMPP.Connection}} instance that is used for connection requests to this {{object}}}}
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 {{list}} 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 {{param}} 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 {{empty}} then all Jabber IDs are allowed and an XMPP Connection Request can not be deemed invalid due to the "from" address.
The value MUST be the value of the {{param|.XMPP.Connection.{i}.JabberID}} contained in the {{object|.XMPP.Connection}} instance referenced by the {{param|ConnReqXMPPConnection}} parameter.
If the {{param|ConnReqXMPPConnection}} parameter is empty or the {{object|.XMPP.Connection}} instance being reference is disabled, then this value will be empty.
If the {{object|.XMPP.Connection}} instance being referenced by the {{param|ConnReqXMPPConnection}} parameter is lost ({{param|.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 {{param|.XMPP.Connection.{i}.JabberID}} can be established. If the new {{param|.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.
Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in {{bibref|TR-069|Section 3.4.7}}. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.
As defined in {{bibref|RFC2616|Section 3.5}}
As defined in {{bibref|RFC2616|Section 3.5}}
As defined in {{bibref|RFC2616|Section 3.5}}
The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when communicating with the ACS.
Indicates the Lightweight Notification Protocol(s) supported by this CPE. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.
As defined in {{bibref|TR-069|Annex M}}
The value of this parameter represents the protocol(s) that will be used by the CPE when sending Lightweight Notifications.
{{empty}} means that Lightweight Notifications are disabled, despite any SetParameterAttributes that have been configured on various parameters.
The duration in {{units}} 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.
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 {{param|LightweightNotificationTriggerInterval}}. {{param}} is used only to set the ''phase'' of the Passive Lightweight Notification. The actual value of {{param}} can be arbitrarily far into the past or future.
For example, if {{param|LightweightNotificationTriggerInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers to a day in the future. The Unknown Time value defined in {{bibref|TR-106|section 3.2}} 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 {{param|LightweightNotificationTriggerInterval}}. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value.
Host name or address to be used when sending the UDP Lightweight Notifications.
{{param}} is only applicable when {{param|LightweightNotificationProtocolsUsed}} contains the {{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration.
If {{param}} is not implemented or is {{empty}}, and UDP Lightweight Notifications are supported, the destination host MUST be the same as the ACS (as contained in the host portion of the {{param|URL}}).
The port number to be used when sending UDP Lightweight Notifications.
{{param}} is only applicable when {{param|LightweightNotificationProtocolsUsed}} contains the {{enum|UDP|LightweightNotificationProtocolsUsed}} enumeration.
If {{param}} is not implemented and UDP Lightweight Notifications are supported, the destination port MUST be 7547.
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].
{{numentries}}
Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to {{bibref|TR-069|Annex F}} as indicated by the presence of the DHCP option specified in that Annex.
A non-volatile handle used to reference this instance. {{param}} provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.
This parameter was DEPRECATED because {{object}} is a transient object.
This parameter is OBSOLETED in 2.14.
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. {{pattern}}
The value MUST be a valid OUI as defined in {{bibref|OUI}}.
Serial number of the Device as provided to the Gateway by the Device.
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 {{empty}}.
{{list}} {{reference}} References all the {{object|.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''
This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069}}.
The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS.
Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.
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. {{enum}}
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.
Upload and Download
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.
The autonomous file transfer completed successfully; i.e., the FaultCode was zero
The autonomous file transfer did not complete successfully; i.e., the FaultCode was non-zero
Success and Failure
{{list}} 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.
{{pattern}}
Additionally, the following format is defined to allow the unique definition of vendor-specific file types:
* ''"X <OUI> <Vendor-specific identifier>"''
<OUI> is replaced by a 6 hexadecimal-digit OUI (organizationally unique identifier) as defined in {{bibref|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 {{empty}} indicates that all file types are excluded from this filter, effectively disabling CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.
Download Only
Download Only
Download or Upload
Upload Only
For Vendor-Specific File Types, could be for either Download or Upload
This object contains multicast announcement and query parameters used for the purpose of downloading files.
This object contains multicast announcement parameters used to download files.
Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files.
The status of the announcement service.
MAY be used by the CPE to indicate a locally defined error condition.
{{numentries}}
Multicast groups to which the CPE SHOULD listen for announcements.
{{datatype|expand}}
Enable/disable listening to this multicast group.
The status of this group table entry.
MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to parse received announcements.
The {{datatype}} 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 {{bibref|DVB-TS.102.824}} for an example of a URL format that identifies a SAP {{bibref|RFC2974}} stream that indicates how to use either FLUTE {{bibref|RFC3926}} or DSM-CC {{bibref|ISO-13818-6:1998}} to perform the download.
This object contains multicast query parameters used to download files.
Enable/disable CPE ability to autonomously query a server for the purpose of downloading files.
The status of the query service.
MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to contact query response server.
The {{datatype}} 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 {{bibref|DVB-TS.102.824}} for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS.
This object allows configuration of CPE policy for notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in {{bibref|TR-069}}.
The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of Deployment Unit state changes that were not specifically requested via CWMP.
Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events to the ACS.
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. {{empty}} is essentially the same as setting {{param|Enable}} to {{false}}.
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.
The autonomous state change completed successfully; i.e., the FaultCode was zero
The autonomous state change did not complete successfully; i.e., the FaultCode was non-zero
All result types independent of Success or Failure
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 {{param|ResultTypeFilter}} is set to either {{enum|Failure|ResultTypeFilter}} or {{enum|Both|ResultTypeFilter}}. {{empty}} means that failed autonomous state changes will not be sent to the ACS.
Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism {{bibref|TR-069|Annex J.1.2}} for proxying devices.
Identifier of the controller that is responsible for a sub-network of Proxied Devices within the LAN.
{{empty}} indicates that this Proxied Device either:
* Isn't part of a sub-network, within the LAN, with a controller entity.
* Doesn't need a {{param}} to ensure its {{param|ProxiedDeviceID}} is unique throughout the LAN.
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 {{param|ControllerID}}). If the {{param|ControllerID}} is {{empty}} this {{param}} is unique across the LAN.
{{noreference}}The value MUST be the path name of a table row. If the referenced object is deleted, this {{object}} 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 {{bibref|TR-069|Annex J.1.2}}.
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 {{param|Reference}}.
References the {{object|.Hosts.Host}} table entry(s), whether active or inactive, that corresponds to this proxied LAN device.
The protocol being used to communicate between the CPE Proxier and this Proxied Device. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
see {{bibref|ETSIM2MFA}}
{{reference|a protocol object that uses the {{param|ProxyProtocol}}}}
{{list|that represents the discovery protocol(s) for this proxied device}}
{{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DAv1}}
see {{bibref|ETSIM2MFA}}
{{list}} {{reference|an object discovered using one or more protocols listed in {{param|DiscoveryProtocol}}|ignore}}
For objects discovered by the UPnP discovery protocol, the {{param}} would contain items that are references to instances of the following:
* {{object|.UPnP.Discovery.RootDevice}}
* {{object|.UPnP.Discovery.Device}}
* {{object|.UPnP.Discovery.Service}}
For objects discovered by the ETSI-M2M discovery protocol, the {{param}} would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.
Whether or not the CPE Proxier has successfully communicated all pending configuration commands down to the Proxied Device.
Detailed {{param|CommandProcessed}} error description (vendor specific).
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 {{bibref|TR-106}}, indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted.
Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069|Annex I.1.1}} for proxying devices.
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. {{pattern}}
The value MUST be a valid OUI as defined in {{bibref|OUI}}.
Identifier of the class of product of the associated Proxied Device for which the serial number applies.
Serial number of the associated Proxied Device.
{{list}} {{reference}} References all the {{object|.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.
The protocol being used to communicate between the CPE Proxier and this Proxied Device. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
see {{bibref|ETSIM2MFA}}
{{reference|a protocol object that uses the {{param|ProxyProtocol}}}}
{{list|that represents the discovery protocol(s) for this proxied device}}
{{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DAv1}}
see {{bibref|ETSIM2MFA}}
{{list}} {{reference|an object discovered using one or more protocols listed in {{param|DiscoveryProtocol}}|ignore}}
For objects discovered by the UPnP discovery protocol, the {{param}} would contain items that are references to instances of the following:
* {{object|.UPnP.Discovery.RootDevice}}
* {{object|.UPnP.Discovery.Device}}
* {{object|.UPnP.Discovery.Service}}
For objects discovered by the ETSI-M2M discovery protocol, the {{param}} would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.
Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of {{bibref|TR-069|Annex L}}.
NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069.
When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in {{units}}), 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.
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.
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}}.
Indicates that the CPE is capable of CR-Aware Standby.
Indicates that the CPE is capable of Timer-Aware Standby.
If {{param|NetworkAwarenessCapable}} and this parameter are both {{true}}, the CPE MUST NOT go into a non CR-Aware Standby state.
If {{param|SelfTimerCapable}} and this parameter are both {{true}}, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.
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 {{param|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 {{param|SelfTimerCapable}} is {{false}}, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.
This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.
Any Parameter (identified by {{param|ParameterName}}) contained in this table MUST be included within the ParameterList argument of the Inform RPC whenever any Event within the {{param|EventList}} is being delivered.
This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.
Enables or disables this {{object}}.
{{datatype|expand}}
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 {{object|#.InformParameter}} instance is not included in the Inform’s ParameterList argument.
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 {{bibref|TR-069|Section 3.7.1.5}}), 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 {{bibref|TR-069|Section A.3.3.1}}.
{{empty}} means all events except "4 VALUE CHANGE".
Parameters related to CPE behavior in order to issue a Heartbeat event to the ACS using the Inform method call.
If this object is supported then the CPE MUST support the requirements of {{bibref|TR-069|Annex O}}.
When {{true}}, Heartbeat events are enabled to be sent to the ACS based on the values of the {{param|ReportingInterval}} and {{param|InitiationTime}} parameters.
The duration in {{units}} of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if {{param|Enable}} is {{true}}.
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 {{param|ReportingInterval}}.
{{param}} is used only to set the ''phase'' of the Heartbeat event Informs. The actual value of {{param}} can be arbitrarily far into the past or future.
For example, if {{param|ReportingInterval}} is 60 (one minute) and if {{param}} 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 {{param}} refers to a day in the future.
The Unknown Time value defined in {{bibref|TR-106|section 3.2}} 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 {{param}} parameter was set to the Unknown Time value.
Top level object for dynamically managed software applications.
{{numentries}}
{{numentries}}
{{numentries}}
The Execution Environments that are available on the device, along with their properties and configurable settings.
Indicates whether or not this {{object}} is enabled.
Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it.
When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to {{enum|Idle|#.ExecutionUnit.{i}.Status}}.
If a ChangeDUState is attempted on a {{object|#.DeploymentUnit}} that is to be applied against a disabled {{object}}, that ChangeDUState operation fails and the associated DUStateChangeComplete RPC will contain a FaultStruct for that operation.
If a SetParameterValues is attempted against the {{param|#.ExecutionUnit.{i}.RequestedState}} for an {{object|#.ExecutionUnit}} that is associated with a disabled {{object}} a CWMP Fault will be issued in response.
Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an {{object}} and the ACS disabled it, the CWMP management agent might be terminated leaving the device unmanageable.
Indicates the status of this {{object}}.
Setting this parameter to {{true}} causes this {{object}} to revert back to the state it was in when the device last issued a "0 BOOTSTRAP" Inform event. The following requirements dictate what MUST happen for the reset to be complete:
# All Deployment Units that were installed after the last "0 BOOTSTRAP" Inform event MUST be removed
# All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
# Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last "0 BOOTSTRAP" Inform event was issued
# Any Deployment Unit that was present when the last "0 BOOTSTRAP" Inform event was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last "0 BOOTSTRAP" Inform event was issued
# The Execution Environment MUST be restored to the version and configuration present when the last "0 BOOTSTRAP" Inform event was issued
# The Execution Environment MUST be restarted after all other restoration requirements have been met
{{datatype|expand}}
A Name provided by the CPE that adequately distinguishes this {{object}} from all other {{object}} instances.
Indicates the complete type and specification version of this {{object}}.
The run level that this {{object}} will be in upon startup (whether that is caused by a CPE Boot or the Execution Environment starting).
Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.
If the value of {{param|CurrentRunLevel}} is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this {{object}}.
Provides a mechanism to remotely manipulate the run level of this {{object}}, meaning that altering this parameter's value will change the value of the {{param|CurrentRunLevel}}.
Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.
Setting this value when {{param|CurrentRunLevel}} is -1 has no impact to the Run Level of this {{object}}.
The run level that this {{object}} is currently operating in. This value is altered by changing the {{param|RequestedRunLevel}} parameter.
Upon startup (whether that is caused by a CPE Boot or the Execution Environment starting) {{param}} will be equal to {{param|InitialRunLevel}}, unless Run Levels are not supported by this {{object}} in which case {{param}} will be -1.
Run levels dictate which Execution Units will be started. Execution Units will be started if {{param}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.
If {{param}} is -1 then Run Levels are not supported by this {{object}} and setting {{param|InitialRunLevel}} or {{param|RequestedRunLevel}} will not impact the Run Level of this {{object}}.
Indicates the initial value on creation for {{param|#.ExecutionUnit.{i}.RunLevel}} for all Execution Unit instances associated with this {{object}}.
If the value of {{param|CurrentRunLevel}} is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit.
The vendor that produced this {{object}}.
The Version of this {{object}} as specified by the Vendor that implemented this {{object}}, not the version of the specification.
Represents the parent {{object}} of this {{object}}.
If this value is {{empty}} then this is the Primary Execution Environment.
The amount of disk space measured in {{units}} allocated to this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of disk space measured in {{units}} currently available to this {{object}}. This value changes as the {{object|#.ExecutionUnit}} instances associated with this {{object}} consumes disk space. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} allocated to this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently available to this {{object}}. This value changes as the {{object|#.ExecutionUnit}} instances associated with this {{object}} are started/stopped and consume the physical RAM. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
Represents the {{object|#.ExecutionUnit}} instances currently running on this {{object}}. This parameter only contains {{object|#.ExecutionUnit}} instances that currently have a {{param|#.ExecutionUnit.{i}.Status}} of {{enum|Active|#.ExecutionUnit.{i}.Status}}.
Represents the processors that this {{object}} has available to it.
This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit.
A new instance of this table gets created during the installation of a Software Module.
A Universally Unique Identifier either provided by the ACS, or generated by the CPE, at the time of Deployment Unit Installation. The format of this value is defined by {{bibref|RFC4122}} Version 3 (Name-Based) and {{bibref|TR-181i2|Annex C}}.
This value MUST NOT be altered when the {{object}} is updated.
Deployment Unit Identifier chosen by the targeted {{object|#.ExecEnv}}. The format of this value is Execution Environment specific.
{{datatype|expand}}
Indicates the Name of this {{object}}, which is chosen by the author of the Deployment Unit.
The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}.
Indicates the status of this {{object}}.
This instance is in the process of being Installed and SHOULD transition to the {{enum|Installed}} state.
This instance has been successfully Installed. The {{param|Resolved}} flag SHOULD also be referenced for dependency resolution.
This instance is in the process of being Updated and SHOULD transition to the {{enum|Installed}} state.
This instance is in the process of being Uninstalled and SHOULD transition to the {{enum|Uninstalled}} state.
This instance has been successfully Uninstalled. This status will typically not be seen within a {{object}} instance.
Indicates whether or not this {{object}} has resolved all of its dependencies.
Contains the {{datatype}} used by the most recent ChangeDUState RPC to either Install or Update this {{object}}.
Textual description of this {{object}}. The format of this value is Execution Environment specific.
The author of this {{object}} formatted as a domain name.
The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}.
Version of this {{object}}. The format of this value is Execution Environment specific.
Represents the vendor log files that have come into existence because of this {{object}}. This does not include any vendor log files that have come into existence because of {{object|#.ExecutionUnit}} instances that are contained within this {{object}}.
When this {{object}} is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.
Not all {{object}} instances will actually have a corresponding vendor log file, in which case the value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence because of this {{object}}. This does not include any vendor config files that have come into existence because of {{object|#.ExecutionUnit}} instances that are contained within this {{object}}.
When this {{object}} is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.
Not all {{object}} instances will actually have a corresponding vendor config file, in which case the value of this parameter will be {{empty}}.
Represents the {{object|#.ExecutionUnit}} instances that are associated with this {{object}} instance.
Represents the {{object|#.ExecEnv}} instance where this {{object}} instance is installed.
This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit.
Each {{object|#.DeploymentUnit}} that is installed can have zero or more Execution Units.
Once a Deployment Unit is installed it populates this table with its contained Execution Units.
When the Deployment Unit (that caused this {{object}} to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this {{object}} to come into existence) is being updated, all {{object}} instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started.
When the Deployment Unit (that caused this {{object}} to come into existence) is uninstalled, this instance is removed.
Each {{object}} MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the {{object|Extensions}} object.
Execution Unit Identifier chosen by the {{object|#.ExecEnv}} during installation of the associated {{object|#.DeploymentUnit}}.
The format of this value is Execution Environment specific, but it MUST be unique across {{object|#.ExecEnv}} instances. Thus, it is recommended that this be a combination of the {{param|#.ExecEnv.{i}.Name}} and an Execution Environment local unique value.
{{datatype|expand}}
The name of this {{object}} as it pertains to its associated {{object|#.DeploymentUnit}}, which SHOULD be unique across all {{object}} instances contained within its associated {{object|#.DeploymentUnit}}.
The name of this {{object}} as provided by the {{object|#.ExecEnv}}, which SHOULD be unique across all {{object}} instances contained within a specific {{object|#.ExecEnv}}.
Indicates the status of this {{object}}.
This instance is in an Idle state and not running.
This instance is in the process of Starting and SHOULD transition to the {{enum|Active}} state.
This instance is currently running.
This instance is in the process of Stopping and SHOULD transition to the {{enum|Idle}} state.
Indicates the state transition that the ACS is requesting for this {{object}}. {{enum}}
If this {{object}} is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a CWMP Fault MUST be generated.
If this {{object}} is currently in {{enum|Starting|Status}} or {{enum|Active|Status}} the CPE will attempt to Stop the Execution Unit; otherwise this requested state is ignored.
If this {{object}} is currently in {{enum|Idle|Status}} the CPE will attempt to Start the Execution Unit. If this {{object}} is in {{enum|Stopping|Status}} the request is rejected and a fault raised. Otherwise this requested state is ignored.
If while running or transitioning between states this {{object}} identifies a fault this parameter embodies the problem. The value of {{enum|NoFault}} MUST be used when everything is working as intended. {{enum}}
For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}.
If while running or transitioning between states this {{object}} identifies a fault this parameter provides a more detailed explanation of the problem.
If {{param|ExecutionFaultCode}} has the value of {{enum|NoFault|ExecutionFaultCode}} then the value of this parameter MUST be {{empty}} and ignored by the ACS.
If {{true}} and the {{param|RunLevel}} verification is also met, then this {{object}} will be automatically started by the device after its {{object|#.ExecEnv}} is either rebooted or restarted.
If {{false}} this {{object}} will not be started after its {{object|#.ExecEnv}} is either rebooted or restarted until it is explicitly commanded to do so by either the ACS or another Execution Unit.
Determines when this {{object}} will be started.
If {{param|AutoStart}} is {{true}} and {{param|#.ExecEnv.{i}.CurrentRunLevel}} is greater than or equal to {{param}}, then this {{object}} will be started.
If the value of {{param|#.ExecEnv.{i}.CurrentRunLevel}} is -1, then the associated {{object|#.ExecEnv.}} doesn't support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this {{object}}.
Vendor of this {{object}}.
Version of the {{object}}. The format of this value is Execution Environment specific.
Textual description of this {{object}}. The format of this value is Execution Environment specific.
The amount of disk space measured in {{units}} currently being used by this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently being used by this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this {{object}}. See {{bibref|TR-069|Appendix VI.3.2}} for more description and some examples.
NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this {{object}} has caused to come into existence can be discovered via the {{object|.DeviceInfo.SupportedDataModel.{i}.}} table.
Represents the system processes that are active in the system because of this {{object}}.
If {{param|Status}} is not {{enum|Active|Status}} it is expected that this list will be {{empty}}. Some {{object}} instances MIGHT NOT have any system processes irrespective of the value of {{param|Status}}.
Represents the vendor log files that have come into existence because of this {{object}}.
When the {{object|#.DeploymentUnit}} (that caused this {{object}} to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.
Not all {{object}} instances will actually have a corresponding vendor log file, in which case the value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence because of this {{object}}.
When the {{object|#.DeploymentUnit}} (that caused this {{object}} to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.
Not all {{object}} instances will actually have a corresponding vendor config file, in which case the value of this parameter will be {{empty}}.
Represents the CWMP-DT schema instances that have been introduced to this device because of the existence of this {{object}}.
Represents the {{object|#.ExecEnv}} that this {{object}} is associated with.
This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit.
It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of {{param|#.References}} and {{param|#.SupportedDataModelList}} will be used to determine their locations.
See {{bibref|TR-069|Appendix VI.3.2}} for more description and some examples.
The {{object}} object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture {{bibref|ETSIM2MFA}}.
{{numentries}}
This object represents an instance of a Service Capability Layer (SCL) for a M2M device or gateway.
The {{object}} MAY be maintained by the ACS or by the CPE.
When the {{object}} provides the administration of an SCL that is represented as a {{object|.SoftwareModules.ExecutionUnit}} the {{object}} is maintained in the {{param|.SoftwareModules.ExecutionUnit.{i}.References}} parameter.
Section 5.1.2 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the high level event flows for SCL registration.
Section 9.3.2.6.2 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the creation/registration of SCLs.
Section 9.3.2.6.4 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the update/re-registration of SCLs.
Section 9.3.2.6.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the deletion/deregistration of SCLs.
{{keys}}
Administratively enables or disables this instance.
{{datatype|expand}}
{{list}} The list represents an unordered set of URIs {{bibref|RFC3986}}.
A list item is a URI string that represents a SCL to which the this {{object}} will announce original (local) resources.
The AnnouncedToSCL has an interest in the discovery of the local resource. Section 9.2.1.14 Announced Resource of the M2M Functional Architecture {{bibref|ETSIM2MFA}} provides a description of this behavior of an Announced Resource.
Section 9.3.2.28 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} and Section 10.3.2.7 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} describes the process of announcing and deannouncing of resources within a SCL.
{{numentries}}
{{numentries}}
{{numentries}}
This object is represents the administration properties used when a NSCL requests discovery of resources within this {{object|##.SCL}} instance.
Section 9.3.2.27 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the process of discovery of resources within a SCL.
The maximum number of URIs {{bibref|RFC3986}} for discovered resources contained in a discovery result.
This parameter and the {{param|MaxSizeOfDiscovAnswer}} parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter.
A value of 0 indicates that the SCL does not have a limit for this parameter.
The maximum size in bytes of the Discovery Answer.
This parameter and the {{param|MaxNumberOfDiscovRecords}} parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter.
A value of 0 indicates that the SCL does not have a limit for this parameter.
This object represents the properties and status necessary for a SCL to reregister with one or more NSCLs.
{{list}} The list represents a priority ordered set of URIs {{bibref|RFC3986}}. The item that is first in the list has the highest priority.
A list item is a URI {{bibref|RFC3986}} string that represents a NSCL that this {{object|##.SCL}} instance can use in order to attempt registration.
When modified the contents of this parameter replace the {{param}} received during the bootstrap procedure.
{{list}} The list represents the string tokens used as keys when searching for this {{object|##.SCL}} instance.
Sections 9.2.3.6.2 and 9.2.3.6.4 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describe the usage for this parameter.
URI {{bibref|RFC3986}} that represents the identifier of the access right resource. The value of this parameter is maintained by the NSCL and used by the SCL as a default access right identifier for re-registration to NSCLs.
The duration, in {{units}}, that the SCL will use in its next re-registration attempt. Any negative value represents an infinite duration.
{{command}} When set to {{true}}, triggers an immediate re-registration action where the SCL re-registers with the SCLs in the {{param|RegTargetNSCLList}} .
This object represents the status of the Reregistration action.
The progress, in {{units}}, of the Reregistration action. The progress is measured from 0-100%. A value of 0 indicates that the action has not started. A value of 100 indicates that the action has completed.
The completion status of the Reregistration operation. Enumeration of:
{{enum}}
This object describes the parameters necessary to administer the store-and-forward (SAF) handling policies applied to requests to access remotely hosted resources.
Policies are described by instances of {{object}}. Which instances of {{object}} are used by the SCL is determined by the {{param|PolicyScope}} parameter.
Section 9.3.1.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} and Section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} describe the behavior for SAF processing.
There is at most one {{object}} instance with the {{param|PolicyScope}} containing a specific application id (APP-ID) URI value within the list.
There is exactly one {{object}} instance with a {{param|PolicyScope}} value of "default".
Administratively enables or disables this instance.
{{datatype|expand}}
The parameter defines the scope of the policies contained in this instance of a {{object|#.SAFPolicySet}}.
The parameter value is:
*a list of unordered set of URIs {{bibref|RFC3986}} that represents an M2M application id (APP-ID)
*the value of "default"
*{{empty}}
When this parameter is set to a list of application id (APP-ID) URIs {{bibref|RFC3986}}, the scope indicates that the policies are applicable to requests coming from any specific application on that list.
When this parameter is set to a string with the value "default", the scope indicates that the policies are the default policies for this {{object|##.SCL}} instance.
When this parameter is set to {{empty}}, the value represents an unknown {{object|#.SAFPolicySet}} and the {{object|#.SAFPolicySet}} is not to be used.
{{numentries}}
This table contains the SAF-handling policies which are controlled by the Access Network Provider(s).
{{keys}}
Administratively enables or disables this instance.
{{datatype|expand}}
This parameter is the name of the access network provider and used to determine for which access network the policies defined in the {{object|#.ANPPolicy}} table will apply.
{{numentries}}
{{numentries}}
This table contains a list of block periods for a {{object|##.ANPPolicy}}.
A block period defines how long the device will wait before re-trying to establish connectivity via the access network after the previous attempt has failed.
Administratively enables or disables this instance.
{{datatype|expand}}
Number of consecutively failed access attempts for which the {{param|BlockDuration}} will be used to block the next access attempt.
The SCL will apply the {{object}} entry with the largest number of consecutive failed attempts that is smaller or equal to the actual number of consecutive failed attempts.
The duration, in {{units}}, to which to block further access attempts.
This table contains the Request Category (RCAT) policy items for defining when it is appropriate to use the access network for processing requests.
Administratively enables or disables this instance.
{{datatype|expand}}
An RCAT is a string that represents a request category used for policy enforcement.
{{numentries}}
This table contains the schedules that define when it is appropriate to use the access network for processing requests for the specified value of the {{param|#.RCAT}}.
The combination of all instances of the {{object|AbsTimeSpan}} along with the {{param|Schedules}} parameter makes up the complete schedule for this instance of a {{object}}.
The {{param|Schedules}} parameter defines a recurrence of the schedule. If instances of {{object|AbsTimeSpan}} exist, these instances places constraints on the schedule recurrence.
If the value of the {{param|Schedules}} parameter is {{empty}}, at least one enabled instance of {{object|AbsTimeSpan}} MUST exist.
Processing behavior for the use of RCAT Schedules is defined in section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} document.
Administratively enables or disables this instance.
{{datatype|expand}}
The list is a set of schedule strings.
A schedule string is formatted according to the date and time fields defined CRONTAB input file definition in {{bibref|POSIXBase}}.
The {{param}} parameter is used to set the recurrence of the schedule.
The timezone used for this parameter is dependent upon the existence of instances of {{object|AbsTimeSpan}} for this {{object}}. If instances of {{object|AbsTimeSpan}} exist, then the timezone of the {{object|AbsTimeSpan}} is used otherwise the UTC timezone is used for this {{param}} parameter.
Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in {{bibref|TR-106|section 3.2.3}}
Example of CRONTAB string:
*"* 0-6 * * 1-5" would mean every minute for the period from 0:00h to 6:00h (inclusive) on any week day (Monday through Friday) and would be represented as "*%200-6%20*%20*%201-5"
*"*/15 22-23,0-4 * * 1-5" would mean every 15 minutes for the period from 22:00h to 04:00h on any week day (Monday through Friday) and would be represented as "*/15%2022-23%2C0-4%20*%20*%201-5"
{{numentries}}
This object defines an instance of a time span used for determining an RCAT schedule.
An instance of the {{object}} represents the time span in which the schedule recurrence defined in {{param|#.Schedules}} is constrained.
{{object}} instances with unknown values for the {{param|StartTime}} or {{param|EndTime}} are ignored.
All instances of the {{object}} within this {{object|##.Schedule}} MUST utilize the same time zone.
Administratively enables or disables this instance.
{{datatype|expand}}
Date and time that represents the start of the time span.
The value 0001-01-01T00:00:00Z represents an unknown value.
The device MUST reject requests to set the {{param}} value greater than the {{param|EndTime}} value.
Date and time that represents the end of the time span.
The value 9999-12-31T23:59:59Z represents an infinite time span from the start time.
The value 0001-01-01T00:00:00Z represents an unknown value.
The device MUST reject requests to set the {{param}} value less than or equal the {{param|StartTime}} value.
This object maintains the SAF handling policies' properties that are controlled by the M2M service provider for a request.
The default RCAT value to use for requests to remotely hosted resources during SAF-handling when no RCAT value was specified in the request.
{{numentries}}
This object maintains a list of properties to be used for forwarding requests with a specified {{param|RCAT}}.
Processing behavior for the use of M2M Service Provider policies is defined in section 10.3.1.2.2.1 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} document.
Administratively enables or disables this instance.
{{datatype|expand}}
An RCAT is a string that represents a request category used for policy enforcement.
The tolerable duration, in {{units}}, that a request of the given RCAT category can be pending in SAF handling when a request from an M2M Application does not specify a tolerable delay.
A value of -1 represents an infinite duration.
The threshold of maximum number of pending requests permitted to be held for a specified RCAT.
A value of 0 indicates that the request should be transmitted immediately.
This parameter defines the maximum size of the request queue for pending requests permitted to be held for a specified RCAT.
The format of the string is an integer with an appended memory unit (B - Bytes, K - 1024 Bytes, M - 1048576 Bytes, G -1073741824, T - 1099511627776 Bytes).
When the value is {{empty}} the memory threshold criteria for the associated RCATList will be ignored in SAF handling.
{{pattern}}
{{empty}}
The list is a prioritized set of Access Networks where the preference of using an Access Network is based on order of the list items with the lowest order list item as the most preferred Access Network.
The M2M Area Network information provides administration capabilities for remote management (REM) of M2M Devices (D', d) that are attached to this {{object|##.SCL}} instance.
This object provides the administration of the properties needed by the SCL to remotely manage M2M Devices within a specific type of M2M Area network as defined by {{param|AreaNwkType}}.
Multiple instances of {{object}} with the same {{param|AreaNwkType}} is permitted.
Section 5.3.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the REM functionality expected of a SCL for an M2M Device.
URI {{bibref|RFC3986}} that represents the identifier of the instance.
Devices (D' and d) that connect to an SCL are said to be "attached devices" and are organized by M2M Area Networks within the {{object|##.SCL}} instance. The {{param}} is an implementation-chosen string that indicates the type of M2M Area Network.
{{list}} {{reference}}
The list represents the M2M Devices (D', d) that are attached to this {{object|##.SCL}} instance that are within this {{object}} instance. The list does not contain an instance for this CPE.
{{numentries}}
This object contains an instance of a property extension (name value pair) for this {{object|##.AreaNwkInstance}} instance.
For example, if the {{param|#.AreaNwkType}} is ZigBee the {{object|##.AreaNwkInstance}} will contain ZigBee specific parameters that have not been modeled for the M2M Area network.
At a minimum, a property instance MUST exist that defines an attribute that describes the IP layer address type (e.g., IPv4, IPv6, non-IP) of this M2M Area Network.
The name of the property
The value of the property.
The M2M Area Network Device Information provides the administration capability to the SCL for maintenance of M2M Devices (D', d) that are attached to this {{object|##.SCL}} instance.
While discovery and identification of devices by the M2M Gateway or Device (CPE) is implementation specific, each device is represented by an instance of the {{object|.Hosts.Host}} table.
When the M2M Device is managed by the CWMP endpoint of the CPE, the {{object}} is expected to be referenced by an instance of one of the following tables:
*{{object|.ManagementServer.EmbeddedDevice}}
*{{object|.ManagementServer.VirtualDevice}}
Section 5.3.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the REM functionality expected of a SCL to a M2M Device.
This object instance provides the administration properties required by a SCL to remotely manage an instance of a M2M Device within a M2M area network.
A M2M Device is associated with an instance of a {{object|#.AreaNwkInstance}}.
This table contains parameters and information of the M2M Device related to each {{object|#.AreaNwkInstance}} instance.
Instances of this table are created and deleted by the CPE. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device.
{{reference}}
{{list}} {{reference|the {{object|.Hosts.Host}} table entry that represents an active or inactive M2M Device}}
{{list}} {{reference}} References all the {{object|.Hosts.Host}} table entries, whether active or inactive, that represent the reachable neighbors of this M2M Device (D' or d).
The list is an unordered set of URIs {{bibref|RFC3986}}.
A list item is an URI string that represents an application id (APP-ID) for the M2M D'A applications residing on the M2M Device for the associated {{object|#.AreaNwkInstance}}.
Table B.58 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes this parameter.
The interval, in {{units}}, between sleep periods for the device.
A value of 0 represents a device that does not sleep.
Note: When this value is modified, the CPE could modify the {{param}} for this M2M Device in other Area Networks.
The duration, in {{units}}, of a sleep period.
The value 0 represents an unknown value.
Note: When this value is modified, the CPE could modify the {{param}} for this M2M Device in other Area Networks.
The sleep status of the device.
Enumeration of:
{{enum}}
Whether or not this M2M Device is currently attached to this {{object|##.SCL}} instance.
The ability to list inactive M2M Devices is OPTIONAL. If the CPE includes inactive M2MDevices in this table, {{param}} is set to {{false}} for each inactive M2M Device. The length of time an inactive M2M Device remains listed in this table is a local matter to the CPE.
{{numentries}}
This object contains an instance of a property extension (name value pair) for this {{object|##.AreaNwkDeviceInfoInstance}} instance.
For example, if the {{param|##.AreaNwkInstance.{i}.AreaNwkType}} value is ZigBee, this {{object|##.AreaNwkDeviceInfoInstance}} contains ZigBee-specific parameters that are not formally modeled for this {{object|##.AreaNwkDeviceInfoInstance}} instance.
The name of the property
The value of the property.
This object is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL.
{{datatype|expand}}
The PacketCaptureDiagnostics object. This diagnostic is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format.
{{datatype|expand}}
{{numentries}}
This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER) diagnostics parameters.
This object is for the CPE, aka the Transmission Unit - Remote end (TU-R).
Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD management entity}}.
{{datatype|expand}}
This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN) diagnostics parameters.
This object is for the CPE, aka the Transmission Unit - Remote end (TU-R).
Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD management entity}}.
{{datatype|expand}}
This object contains DSL Single-Ended Line Test - Processed (SELT-P) diagnostics parameters.
This object is for the CPE, aka the Transmission Unit - Remote end (TU-R).
Reference: ITU-T Recommendation {{bibref|G.996.2}}.
{{datatype|expand}}
This object provides access to an ATM-layer F5 OAM loopback test.
{{datatype|expand}}
HPNA PHY throughput diagnostics configuration and results.
When diagnostics are requested, all HPNA nodes for which the {{param|##.Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
{{datatype|expand}}
{{numentries}} This is the number of PHY diagnostics results.
HPNA performance monitoring configuration and results.
Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network.
{{datatype|expand}}
G.hn PHY throughput diagnostics configuration and results.
When diagnostics are requested, all G.hn nodes for which the {{param|##.Interface.{i}.PHYThroughputDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
{{datatype|expand}}
G.hn Performance Monitoring diagnostics configuration and results.
When diagnostics are requested, all G.hn nodes for which the {{param|##.Interface.{i}.PerformanceMonitoringDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
{{datatype|expand}}
This object provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The {{param|Type}} parameter is used to select which type of test to perform.
CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network).
{{datatype|expand}}
This object defines access to other WiFi SSIDs that this device is able to receive.
{{datatype|expand}}
{{numentries}}
This object provides access to an IP-layer ping test.
{{datatype|expand}}
The CPE can not reach the requested Ping host address
This object defines access to an IP-layer trace-route test for the specified IP interface.
{{datatype|expand}}
The CPE can not reach the requested TraceRoute host address
{{numentries}}
This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.
Files received in the DownloadDiagnostics do not require file storage on the CPE device.
{{datatype|expand}}
{{numentries}}
{{numentries}}
This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.
Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.
{{datatype|expand}}
{{numentries}}
{{numentries}}
This object defines the diagnostics configuration for a UDP Echo test {{bibref|TR-143|Appendix A.1}} defined in {{bibref|RFC862}} or a UDP Echo Plus test defined in {{bibref|TR-143|Appendix A.1}}.
{{datatype|expand}}
{{numentries}}
This object defines the diagnostics configuration for a IP Layer Capacity test. IP Layer Capacity measurement is specified in {{bibref|TR-471}}.
Files received in the IP Layer Capacity test do not require file storage on the CPE device.
{{datatype|expand}}
{{numentries}}
This object provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out.
{{datatype|expand}}
This object defines access to an IP-layer NS Lookup test for the specified IP interface.
When initiated, the NS Lookup test will contact {{param|DNSServer}} and look up {{param|HostName}} {{param|NumberOfRepetitions}} times.
There will be a {{object|Result}} instance for each time the device performs a DNS lookup, which is determined by the value of {{param|NumberOfRepetitions}}.
Any previous {{object|Result}} instances are removed when a new test is initiated.
{{datatype|expand}}
Unable to resolve DNSServer Name
{{numentries}}
Total number of Result entries from the most recent invocation of the test.
This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.
{{datatype|expand}}
When set to {{true}}, this {{object|#}} instance's WiFi security settings are reset to their factory default values. The affected settings include {{param|ModeEnabled}}, {{param|WEPKey}}, {{param|PreSharedKey}}, {{param|KeyPassphrase}}, {{param|SAEPassphrase}}, and {{param|#.WPS.PIN}} (if applicable).
If the parameter cannot be set, the CPE MUST reject the request as an invalid parameter value. Possible failure reasons include a lack of default values or if {{param|ModeEnabled}} is an Enterprise type, i.e. {{enum|WPA-Enterprise|ModesSupported}}, {{enum|WPA2-Enterprise|ModesSupported}}, {{enum|WPA3-Enterprise|ModesSupported}}, or {{enum|WPA-WPA2-Enterprise|ModesSupported}}.
When set to {{true}}, the {{object}} will renew its DHCPv6-supplied information (i.e. the CPE will do a renew or information request as needed, updating both stateful and stateless parameter values discovered by this Client instance).
Setting this to {{true}} will cause a reset on the GPS Hardware. Setting this to {{false}} has no effect.
When set to {{true}}, resets the temperature sensor.
Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.
When set to true, resets {{param|.LANConfigSecurity.ConfigPassword}} to its factory value.
This MUST NOT be used by the CPE if the {{param|.ManagementServer.UpgradesManaged}} parameter is {{true}}.
This MUST NOT be used by the CPE if the {{param|.ManagementServer.UpgradesManaged}} parameter is {{true}}.
When set to {{true}}, reset the Host Controller and apply the reset signaling (see {{bibref|USB2.0|Chapter 7.1.7.5}}) to all of the Host Controller Hub downstream ports.
The value is not saved in the device's state and setting it to {{false}} has no effect.
When set to {{true}}, the device MUST tear down the existing PPP connection represented by this object and establish a new one.
The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.
Reset on a disabled interface is a no-op (not an error).
When set to {{true}}, the device MUST tear down the existing IP connection represented by this object and establish a new one.
The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.
Reset on a disabled interface is a no-op (not an error).
When set to {{true}}, the DHCP client will renew its DHCP lease.
When set to {{true}}, the device MUST reset the session by performing an initial authentication attempt as defined in {{bibref|802.1x-2004|9.6.1.3}}, Initialize Port by sending out the EAP start message.
The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call.
When set to {{true}}, the device MUST disconnect (forced unauthentication) the resource.
The device MUST initiate the disconnect after completion of the current CWMP session. The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call.
When set to {{true}}, resets the SmartCard Reader and the associated SmartCard.
When set to {{true}}, forces statistics for the current sample to be calculated and updated in the data model. Setting it to {{false}} has no effect. {{hidden}}
If this is the first time that {{param}} has been set to {{true}} during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters MUST be updated accordingly.
If this is not the first time that {{param}} has been set to {{true}} during the current sample interval, then the new values that were added as described in the previous paragraph, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters, MUST be updated accordingly.
Note that {{param}} just provides a "sneak preview" of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.
At the end of each sample interval, if {{param}} was set to {{true}} during the sample interval then the new values that were added as described above, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters, will be updated accordingly. In other words, the partial sample data that was created when {{param}} was set to {{true}} will be updated one last time at the end of the sample interval.
Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}).
If the MQTT client is in a different state, the parameter has no effect.
This action parameter may be used to immediately apply changes in the MQTT connection settings.
Disconnects the MQTT bridge to the remote MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT bridge is currently connected to the remote MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}).
If the MQTT bridge is in a different state, the parameter has no effect.
This action parameter may be used to immediately apply changes in the MQTT connection settings.
This parameter represents a request to reset or reboot the WiFi sub-system without resetting or rebooting the device.
When set to {{true}}, the CPE must send a magic packet over its active Ethernet interfaces.
This profile implies support for all of the Gateway requirements defined in {{bibref|TR-069|Annex F}}.
Note: This profile is valid for G.992.1 modems.
Note: This profile is valid for G.992.3 and G.992.5 modems.
Note: This profile is valid for G.993.2 modems.
This profile only applies to Internet Gateway Devices that are acting as CPE behind a NAT gateway as described in {{bibref|TR-069|Annex G}}, and implies support for all of the CPE requirements defined within Annex G.
Note that support for this profile implies support for the requirements of {{bibref|TR-069|Annex L}}.
This profile is IPv4 specific.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv6 capable devices.
This table is REQUIRED to support sending of option 60 (Vendor Class Identifier) and option 77 (User Class Identifier) values.
This table is REQUIRED to support requesting of option 60 (Vendor Class Identifier), option 61 (Client Identifier) and option 77 (User Class Identifier) values.
Adds client authentication, will handling and extends statistics
Note that support for this profile implies support for the requirements of {{bibref|TR-069|Annex O}}.