TR-157 Amendment 3 TR-069 Amendment 3 CPE WAN Management Protocol BBF TR December 2010 TR-106 Amendment 4 Data Model Template for TR-069 Enabled Devices Broadband Forum March 2010 http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf TR-157 Amendment 3 Componnent Objects for CWMP Broadband Forum December 2010 http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace IETF July 2005 http://www.ietf.org/rfc/rfc4122.txt ICSA Baseline Modular Firewall Certification Criteria Baseline module - version 4.1 ICSA Labs August 2008 http://www.icsalabs.com/sites/default/files/baseline.pdf ICSA Residential Modular Firewall Certification Criteria Required Services Security Policy - Residential Category module - version 4.1 ICSA Labs August 2008 http://www.icsalabs.com/sites/default/files/residential.pdf This parameter is DEPRECATED because the "voucher mechanism", as defined in {{bibref|TR-069a3|Annex C}} is deprecated in favor of the "Software Module Management mechanism" as described in {{bibref|TR-157a3|Appendix II}}. {{list}} The OptionName of each is identical to the OptionName element of the OptionStruct described in {{bibref|TR-069a3}}. Only those options are listed whose State indicates the option is enabled. A change to this value will cause {{param|LowAlarmTime}} to be reset. A change to this value will cause {{param|HighAlarmTime}} to be reset. The interval, measured in {{units}}, in which the device polls this {{object}}. 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. The firewall implements the "Traffic Denied Inbound" and "Minimally Permit Common Services Outbound" components of the ICSA residential certification's Required Services Security Policy {{bibref|ICSA-Residential}}. If DoS and vulnerability protections are implemented {{bibref|ICSA-Baseline}}, these are enabled. All Outbound traffic and pinhole-defined Inbound traffic is allowed. If DoS and vulnerability protections are implemented {{bibref|ICSA-Baseline}}, these are enabled. All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings (if supported and enabled). If DoS and vulnerability protections are implemented {{bibref|ICSA-Baseline}}, these are disabled. Result Parameter to represent whether the NS Lookup was successful or not. Errors for individual Result instances do not get bubbled up to {{param|#.DiagnosticsState}}. A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that {{param|#.DiagnosticsState}} SHOULD be {{enum|Error_Other|#.DiagnosticsState}}. {{numentries}} Each table entry represents a hardware or virtual processor that resides on this device. The architecture of the processor on the underlying hardware. {{enum}} For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106a4|Section 3.3}}. big-endian little-endian big-endian little-endian {{numentries}} Each table entry represents a Vendor Log File. This table of log files is informational only and does not allow the ACS to operate on these files in any way. 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}}. 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. The maximum size of the log file in {{units}}. If the device doesn’t know the maximum file size then {{param}} will be 0. 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. This object allows configuration of CPE policy for notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in {{bibref|TR-069a3}}. 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. 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 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}}. 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}}. 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-069a3|Annex H}}. 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. 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}}. 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-069a3|Annex H}}. 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 URL 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-069a3|Annex H}}. 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. 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}}. 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-106a4|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 {{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-157a3|Appendix II.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-157a3|Appendix II.3.2}} for more description and some examples. This parameter is DEPRECATED because the "voucher mechanism", as defined in {{bibref|TR-069a3|Annex C}} is deprecated in favor of the "Software Module Management mechanism" as described in {{bibref|TR-157a3|Appendix II}}. {{list}} The OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in {{bibref|TR-069a3}}. Only those options are listed whose State indicates the option is enabled.