Broadband Forum

Component Objects for CWMP
tr-157-1-5-0.xml

DATA MODEL DEFINITION

License

Copyright (c) 2009-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Summary

TR-157 Issue 1 Amendment 5

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

References

[ITU-X.733] ITU X.733, Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function, International Telecommunication Union, February 1992.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC5139] RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008.
[RFC5280] RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008.
[RFC5491] RFC 5491, GEOPRIV Presence Information Data Format Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations, IETF, March 2009.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.
[TR-069a3] TR-069 Amendment 3, CPE WAN Management Protocol, Broadband Forum, November 2010.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, February 2010.
[TR-157a3] TR-157 Amendment 3, Component Objects for CWMP, Broadband Forum, November 2010.

Legend

Object definition.
Mountable Object definition.
Mount Point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

TR-157:1.5 Data Model

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.5, then it will indicate support for version 1.5. The version number associated with each object and parameter is shown in the Version column.

Name Type Syntax Write Description Object Default Version Spec
PeriodicStatistics. object object​[1:1] -

This object configures collection of periodic statistics for the device.

Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples.

This object provides a single set of global settings that affect the entire device unless overridden locally.

- 1.0 TR-157
MinSampleInterval unsignedInt unsignedInt -

Minimum sample interval in seconds that the CPE is able to support.

A value of 0 indicates no specific minimum sample interval.

- 1.0 TR-157
MaxReportSamples unsignedInt unsignedInt -

Maximum number of samples of each statistic that the CPE is able to store and report.

A value of 0 indicates no specific maximum number of samples.

- 1.0 TR-157
SampleSetNumberOfEntries unsignedInt unsignedInt - The number of entries in the SampleSet table. - 1.0 TR-157
TR-157a2
PeriodicStatistics.​SampleSet.​{i}. object​[0:] object​[0:∞] W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for Name.

- 1.0 TR-157
Alias string​(64) Alias W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

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

- 1.0 TR-157a4
Enable boolean boolean W

Enables or disables collection of periodic statistics for this sample set.

When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

false 1.0 TR-157
Status string string -

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the ACS SHOULD now fetch the collected data)

The Trigger value is only used for triggering the ACS to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples].

The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.

"Disabled" 1.0 TR-157
Name string​(128) string​(128) W The name of this sample set, which uniquely distinguishes each sample set. <Empty> 1.0 TR-157
SampleInterval unsignedInt​(1:) unsignedInt​(1:) W

The sample interval in seconds. Each statistic is measured over this sample interval.

The CPE MAY reject a request to set SampleInterval to less than PeriodicStatistics.MinSampleInterval?.

Sample intervals MUST begin every SampleInterval seconds, with no delay between samples.

If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.

3600 1.0 TR-157
ReportSamples unsignedInt​(1:) unsignedInt​(1:) W

The number of samples that the CPE will store and report for each statistic.

The CPE MUST permit ReportSamples to be set to at least PeriodicStatistics.MaxReportSamples?.

If ReportSamples is changed while collection of periodic statistics is enabled, the CPE will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.

24 1.0 TR-157
TimeReference dateTime dateTime W

An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval.

TimeReference is used only to set the "phase" of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future.

This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval).

If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

The Unknown Time value defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals.

If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value.

For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc).

If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight.

Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start.

0001-01-01T00:00:00Z 1.0 TR-157
FetchSamples unsignedInt unsignedInt W

The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled.

If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur.

For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also ForceSample).

To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples.

0 1.0 TR-157
ForceSample boolean boolean W

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. When read, this parameter returns false, regardless of the actual value.

If this is the first time that ForceSample 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 ReportEndTime and all SampleSeconds parameters MUST be updated accordingly.

If this is not the first time that ForceSample 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 ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly.

Note that ForceSample 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 ForceSample was set to true during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample was set to true will be updated one last time at the end of the sample interval.

false 1.0 TR-157
ReportStartTime dateTime dateTime - The absolute time at which the sample interval for the first stored sample (for each statistic) started. <Empty> 1.0 TR-157
ReportEndTime dateTime dateTime -

The absolute time at which the sample interval for the last stored sample (for each statistic) ended.

If ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected.

<Empty> 1.0 TR-157
SampleSeconds unsignedInt​[] list of unsignedInt -

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval.

Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:

TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.
<Empty> 1.0 TR-157
ParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the Parameter table. 0 1.0 TR-157
TR-157a2
PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. object​[0:] object​[0:∞] W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled.

Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a "sneak preview" of the current sample), or (c) at the end of the sample interval.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for Reference.

- 1.0 TR-157
Alias string​(64) Alias W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

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

- 1.0 TR-157a4
Enable boolean boolean W Enables or disables this object instance. false 1.0 TR-157
Reference string​(256) string​(256) W The value MUST be the Path Name of a parameter. This is the parameter being monitored by the Periodic Statistics mechanism. <Empty> 1.0 TR-157
SampleMode string string W

Controls how this parameter's value is sampled. Enumeration of:

  • Current (Sampled value is current value)
  • Change (Sampled value is change in value since start of sample interval)

Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters.

"Current" 1.0 TR-157
CalculationMode string string W

Controls how this parameter's statistic is calculated from the sampled value(s). Enumeration of:

  • Latest (Statistic is sampled value at end of sample interval)
  • Minimum (Statistic is minimum sampled value during sample interval)
  • Maximum (Statistic is maximum sampled value during sample interval)
  • Average (Statistic is average (mean) sampled value during sample interval)

Parameters of non-numeric types can only support Latest. The value of the CalculationMode MUST be ignored for such parameters.

SampleMode MUST be applied before CalculationMode, i.e. the inputs to the calculation will have already accounted for SampleMode.

"Latest" 1.0 TR-157
LowThreshold int int W

The low threshold value that controls the calculation of Failures.

A value equal to HighThreshold disables the threshold/failure mechanism.

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
HighThreshold int int W

The high threshold value that controls the calculation of Failures.

A value equal to LowThreshold disables the threshold/failure mechanism.

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
SampleSeconds unsignedInt​[] list of unsignedInt -

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval.

Individual SampleSeconds values can be less than PeriodicStatistics.SampleSet.{i}.SampleInterval?, for several reasons, including:

Any of the reasons for which PeriodicStatistics.SampleSet.{i}.SampleSeconds? values might be less than PeriodicStatistics.SampleSet.{i}.SampleInterval?.
The parameter doesn't exist, or was created or deleted during a sample interval.
<Empty> 1.0 TR-157
SuspectData unsignedInt​[]​(:1) list of unsignedInt​(:1) -

Comma-separated list of unsigned integers (value 0 to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval.

For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1.

<Empty> 1.0 TR-157
Values string​[] list of string -

Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval.

The statistics values in this comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.

If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.

<Empty> 1.0 TR-157
Failures unsignedInt unsignedInt -

Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the "in range" state to the "out of range" state, or between the "out of range (low)" and "out of range (high)" states. The states are defined as follows:

Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment.

This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in [Section 3.2.1/TR-069a2].

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
TR-157a5
DeviceInfo. object object​[1:1] -   - 1.0 TR-157a3
VendorLogFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorLogFile table. - 1.0 TR-157a3
LocationNumberOfEntries unsignedInt unsignedInt - The number of entries in the Location table. - 1.0 TR-157a5
DeviceInfo.​VendorLogFile.​{i}. object​[0:] object​[0:∞] -

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.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

- 1.0 TR-157a3
Alias string​(64) Alias W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.0 TR-157a3
TR-157a4
Name string​(64) string​(64) -

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.

- 1.0 TR-157a3
MaximumSize unsignedInt unsignedInt - The maximum size of the log file in bytes. If the device doesn't know the maximum file size then MaximumSize will be 0. - 1.0 TR-157a3
TR-157a5
Persistent boolean boolean -

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.

- 1.0 TR-157a3
DeviceInfo.​Location.​{i}. object​[0:] object​[0:∞] W

This object contains Location information.

At most one entry in this table can exist with the same values for both Source and ExternalSource.

- 1.0 TR-157a5
Source string string -

Identifies the source of the location data. Enumeration of:

"External" 1.0 TR-157a5
AcquiredTime dateTime dateTime - The time when the location was acquired. - 1.0 TR-157a5
ExternalSource string string -

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

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

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

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

- 1.0 TR-157a5
ExternalProtocol string string -

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

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

"CWMP" 1.0 TR-157a5
DataObject string​(1200) string​(1200) W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP.

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

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

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

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

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

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

- 1.0 TR-157a5
UserInterface. object object​[1:1] -   - 1.0 TR-157
UserInterface.​RemoteAccess. object object​[1:1] -

This object contains parameters relating to remotely accessing the CPE's user interface.

Remote access is defined as any entity not of a local subnet attempting to connect to the CPE.

Remote access requires user authentication. To provide remote access authentication the CPE MUST support a "User" table with at least one instance that has "RemoteAccessCapable" set to true.

- 1.0 TR-157
TR-157a2
Enable boolean boolean W Enables/Disables remotely accessing the CPE"s user interface. - 1.0 TR-157
TR-157a5
Port unsignedInt​(:65535) unsignedInt​(:65535) W Destination TCP port required for remote access connection. - 1.0 TR-157
SupportedProtocols string​[] list of string -

Comma-separated list of strings. Indicates the protocols that are supported by the CPE for the purpose of remotely accessing the user interface. Each list item is an enumeration of:

- 1.0 TR-157
Protocol string string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 1.0 TR-157
SoftwareModules. object object​[1:1] - Top level object for dynamically managed software applications. - 1.0 TR-157a3
ExecEnvNumberOfEntries unsignedInt unsignedInt - The number of entries in the ExecEnv table. - 1.0 TR-157a3
DeploymentUnitNumberOfEntries unsignedInt unsignedInt - The number of entries in the DeploymentUnit table. - 1.0 TR-157a3
ExecutionUnitNumberOfEntries unsignedInt unsignedInt - The number of entries in the ExecutionUnit table. - 1.0 TR-157a3
SoftwareModules.​ExecEnv.​{i}. object​[0:] object​[0:∞] -

The Execution Environments that are available on the device, along with their properties and configurable settings.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

- 1.0 TR-157a3
Enable boolean boolean W

Indicates whether or not this ExecEnv 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 Idle.

If a ChangeDUState is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that ChangeDUState operation fails and the associated DUStateChangeComplete RPC will contain a FaultStruct for that operation.

If a SetParameterValues is attempted against the ExecutionUnit.{i}.RequestedState for an ExecutionUnit that is associated with a disabled ExecEnv 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 ExecEnv and the ACS disabled it, the CWMP management agent might be terminated leaving the device unmanageable.

- 1.0 TR-157a3
Status string string -

Indicates the status of this ExecEnv. Enumeration of:

- 1.0 TR-157a3
Reset boolean boolean W

Setting this parameter to true causes this ExecEnv 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:

  1. All Deployment Units that were installed after the last "0 BOOTSTRAP" Inform event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. 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
  4. 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
  5. The Execution Environment MUST be restored to the version and configuration present when the last "0 BOOTSTRAP" Inform event was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met

The value of this parameter is not part of the device configuration and is always false when read.

- 1.0 TR-157a3
Alias string​(64) Alias W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.0 TR-157a3
TR-157a4
Name string​(32) string​(32) - A Name provided by the CPE that adequately distinguishes this ExecEnv from all other ExecEnv instances. - 1.0 TR-157a3
Type string​(64) string​(64) - Indicates the complete type and specification version of this ExecEnv. - 1.0 TR-157a3
InitialRunLevel unsignedInt​(:65535) unsignedInt​(:65535) W

The run level that this ExecEnv 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 CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If the value of 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 ExecEnv.

- 1.0 TR-157a3
RequestedRunLevel int​(-1:65535) int​(-1:65535) W

Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this parameter's value will change the value of the CurrentRunLevel.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this ExecEnv.

The value of this parameter is not part of the device configuration and is always -1 when read.

- 1.0 TR-157a3
CurrentRunLevel int​(-1:65535) int​(-1:65535) -

The run level that this ExecEnv is currently operating in. This value is altered by changing the RequestedRunLevel parameter.

Upon startup (whether that is caused by a CPE Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or RequestedRunLevel will not impact the Run Level of this ExecEnv.

- 1.0 TR-157a3
InitialExecutionUnitRunLevel int​(-1:65535) int​(-1:65535) W

Indicates the initial value on creation for ExecutionUnit.{i}.RunLevel for all Execution Unit instances associated with this ExecEnv.

If the value of 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.

- 1.0 TR-157a5
Vendor string​(128) string​(128) - The vendor that produced this ExecEnv. - 1.0 TR-157a3
Version string​(32) string​(32) - The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification. - 1.0 TR-157a3
ParentExecEnv string string -

The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the parent ExecEnv of this ExecEnv.

If this value is an empty string then this is the Primary Execution Environment.

- 1.0 TR-157a3
AllocatedDiskSpace int​(-1:) int​(-1:) - The amount of disk space measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0 TR-157a3
AvailableDiskSpace int​(-1:) int​(-1:) - The amount of disk space measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes disk space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0 TR-157a3
AllocatedMemory int​(-1:) int​(-1:) - The amount of physical RAM measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0 TR-157a3
AvailableMemory int​(-1:) int​(-1:) - The amount of physical RAM measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv are started/stopped and consume the physical RAM. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0 TR-157a3
ActiveExecutionUnits string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances currently running on this ExecEnv. This parameter only contains ExecutionUnit instances that currently have a ExecutionUnit.{i}.Status of Active. - 1.0 TR-157a3
ProcessorRefList string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor? table, or an empty string. Represents the processors that this ExecEnv has available to it. - 1.0 TR-157a3
SoftwareModules.​DeploymentUnit.​{i}. object​[0:] object​[0:∞] -

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.

At most one entry in this table can exist with the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias.

- 1.0 TR-157a3
UUID string​(36) string​(36) -

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 [RFC4122] Version 3 (Name-Based) and [Annex H/TR-069a3].

This value MUST NOT be altered when the DeploymentUnit is updated.

- 1.0 TR-157a3
DUID string​(64) string​(64) - Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific. - 1.0 TR-157a3
Alias string​(64) Alias W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.0 TR-157a3
TR-157a4
Name string​(64) string​(64) -

Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit.

The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3].

- 1.0 TR-157a3
Status string string -

Indicates the status of this DeploymentUnit. Enumeration of:

  • Installing (This instance is in the process of being Installed and SHOULD transition to the Installed state)
  • Installed (This instance has been successfully Installed. The Resolved flag SHOULD also be referenced for dependency resolution)
  • Updating (This instance is in the process of being Updated and SHOULD transition to the Installed state)
  • Uninstalling (This instance is in the process of being Uninstalled and SHOULD transition to the Uninstalled state)
  • Uninstalled (This instance has been successfully Uninstalled. This status will typically not be seen within a DeploymentUnit instance)
- 1.0 TR-157a3
Resolved boolean boolean - Indicates whether or not this DeploymentUnit has resolved all of its dependencies. - 1.0 TR-157a3
URL string​(1024) string​(1024) - Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit. - 1.0 TR-157a3
Description string​(256) string​(256) - Textual description of this DeploymentUnit. The format of this value is Execution Environment specific. - 1.0 TR-157a3
Vendor string​(128) string​(128) -

The author of this DeploymentUnit formatted as a domain name.

The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3].

- 1.0 TR-157a3
Version string​(32) string​(32) - Version of this DeploymentUnit. The format of this value is Execution Environment specific. - 1.0 TR-157a3
VendorLogList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile? table, or an empty string. Represents the vendor log files that have come into existence because of this DeploymentUnit. This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.

Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 1.0 TR-157a3
VendorConfigList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile? table, or an empty string. Represents the vendor config files that have come into existence because of this DeploymentUnit. This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.

Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 1.0 TR-157a3
ExecutionUnitList string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances that are associated with this DeploymentUnit instance. - 1.0 TR-157a3
ExecutionEnvRef string string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv instance where this DeploymentUnit instance is installed. - 1.0 TR-157a3
SoftwareModules.​ExecutionUnit.​{i}. object​[0:] object​[0:∞] -

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 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 ExecutionUnit 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 ExecutionUnit to come into existence) is being updated, all ExecutionUnit 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 ExecutionUnit to come into existence) is uninstalled, this instance is removed.

Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

At most one entry in this table can exist with a given value for EUID, or with a given value for Alias.

- 1.0 TR-157a3
EUID string​(64) string​(64) -

Execution Unit Identifier chosen by the ExecEnv during installation of the associated DeploymentUnit.

The format of this value is Execution Environment specific, but it MUST be unique across ExecEnv instances. Thus, it is recommended that this be a combination of the ExecEnv.{i}.Name and an Execution Environment local unique value.

- 1.0 TR-157a3
Alias string​(64) Alias W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.0 TR-157a3
TR-157a4
Name string​(32) string​(32) - The name of this ExecutionUnit as it pertains to its associated DeploymentUnit, which SHOULD be unique across all ExecutionUnit instances contained within its associated DeploymentUnit. - 1.0 TR-157a3
ExecEnvLabel string​(64) string​(64) - The name of this ExecutionUnit as provided by the ExecEnv, which SHOULD be unique across all ExecutionUnit instances contained within a specific ExecEnv. - 1.0 TR-157a3
Status string string -

Indicates the status of this ExecutionUnit. Enumeration of:

  • Idle (This instance is in an Idle state and not running)
  • Starting (This instance is in the process of Starting and SHOULD transition to the Active state)
  • Active (This instance is currently running)
  • Stopping (This instance is in the process of Stopping and SHOULD transition to the Idle state)
- 1.0 TR-157a3
RequestedState string string W

Indicates the state transition that the ACS is requesting for this ExecutionUnit. Enumeration of:

  • Idle (If this ExecutionUnit is currently in Starting or Active the CPE will attempt to Stop the Execution Unit; otherwise this requested state is ignored)
  • Active (If this ExecutionUnit is currently in Idle the CPE will attempt to Start the Execution Unit. If this ExecutionUnit is in Stopping the request is rejected and a fault raised. Otherwise this requested state is ignored)

If this ExecutionUnit 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.

The value of this parameter is not part of the device configuration and is always an empty string when read.

- 1.0 TR-157a3
ExecutionFaultCode string string -

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter embodies the problem. The value of NoFault MUST be used when everything is working as intended. Enumeration of:

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

- 1.0 TR-157a3
ExecutionFaultMessage string​(256) string​(256) -

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem.

If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the ACS.

- 1.0 TR-157a3
AutoStart boolean boolean W

If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted.

If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the ACS or another Execution Unit.

- 1.0 TR-157a3
RunLevel unsignedInt​(:65535) unsignedInt​(:65535) W

Determines when this ExecutionUnit will be started.

If AutoStart is true and ExecEnv.{i}.CurrentRunLevel is greater than or equal to RunLevel, then this ExecutionUnit will be started.

If the value of ExecEnv.{i}.CurrentRunLevel is -1, then the associated 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 ExecutionUnit.

- 1.0 TR-157a3
Vendor string​(128) string​(128) - Vendor of this ExecutionUnit. - 1.0 TR-157a3
Version string​(32) string​(32) - Version of the ExecutionUnit. The format of this value is Execution Environment specific. - 1.0 TR-157a3
Description string​(256) string​(256) - Textual description of this ExecutionUnit. The format of this value is Execution Environment specific. - 1.0 TR-157a3
DiskSpaceInUse int​(-1:) int​(-1:) - The amount of disk space measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 1.0 TR-157a3
MemoryInUse int​(-1:) int​(-1:) - The amount of physical RAM measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 1.0 TR-157a3
References string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a table row. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit. See [Appendix II.3.2/TR-157a3] for more description and some examples.

NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the DeviceInfo.SupportedDataModel.{i}.? table.

- 1.0 TR-157a3
AssociatedProcessList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.ProcessStatus.Process? table, or an empty string. Represents the system processes that are active in the system because of this ExecutionUnit.

If Status is not Active it is expected that this list will be an empty string. Some ExecutionUnit instances MIGHT NOT have any system processes irrespective of the value of Status.

- 1.0 TR-157a3
VendorLogList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile? table, or an empty string. Represents the vendor log files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.

Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 1.0 TR-157a3
VendorConfigList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile? table, or an empty string. Represents the vendor config files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.

Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 1.0 TR-157a3
SupportedDataModelList string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel? table, or an empty string. Represents the CWMP-DT schema instances that have been introduced to this device because of the existence of this ExecutionUnit. - 1.0 TR-157a3
ExecutionEnvRef string string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv that this ExecutionUnit is associated with. - 1.0 TR-157a3
SoftwareModules.​ExecutionUnit.​{i}.​Extensions. object object​[1:1] -

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 References and SupportedDataModelList will be used to determine their locations.

See [Appendix II.3.2/TR-157a3] for more description and some examples.

- 1.0 TR-157a3
FaultMgmt. object object​[1:1] - This object contains parameters relating to Fault/Alarm Management. - 1.0 TR-157a5
SupportedAlarmNumberOfEntries unsignedInt unsignedInt - The number of entries in the SupportedAlarm table. - 1.0 TR-157a5
MaxCurrentAlarmEntries unsignedInt unsignedInt - The maximum number of entries allowed in the FaultMgmt.CurrentAlarm.{i}.? table. - 1.0 TR-157a5
CurrentAlarmNumberOfEntries unsignedInt unsignedInt - The number of entries in the CurrentAlarm table. - 1.0 TR-157a5
HistoryEventNumberOfEntries unsignedInt unsignedInt - The number of entries in the HistoryEvent table. - 1.0 TR-157a5
ExpeditedEventNumberOfEntries unsignedInt unsignedInt - The number of entries in the ExpeditedEvent table. - 1.0 TR-157a5
QueuedEventNumberOfEntries unsignedInt unsignedInt - The number of entries in the QueuedEvent table. - 1.0 TR-157a5
FaultMgmt.​SupportedAlarm.​{i}. object​[0:] object​[0:∞] -

Supported Alarm Entries which can be raised by the device.

The instance numbers for this table SHOULD be maintained across firmware upgrades of the device.

At most one entry in this table can exist with the same values for all of EventType, ProbableCause, SpecificProblem and PerceivedSeverity.

- 1.0 TR-157a5
EventType string​(64) string​(64) - Indicates the type of event. - 1.0 TR-157a5
ProbableCause string​(64) string​(64) - Qualifies the alarm and provides further information than EventType. - 1.0 TR-157a5
SpecificProblem string​(128) string​(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support unique indexing of the table using SpecificProblem.

The string can be set to "*" to indicate the default case if only a subset of SpecificProblem are to be contained within the table.

- 1.0 TR-157a5
PerceivedSeverity string string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

This will be an empty string if the device doesn't support unique indexing of the table using PerceivedSeverity.

The string can be set to "*" to indicate the default case if only a subset of PerceivedSeverity are to be contained within the table.

- 1.0 TR-157a5
ReportingMechanism string string W

Indicates the reporting mechanism setting of the alarm. Enumeration of:

- 1.0 TR-157a5
FaultMgmt.​CurrentAlarm.​{i}. object​[0:] object​[0:∞] -

Contains all currently active alarms (whose FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity? is not Cleared?).

Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table.

If maximum entries as indicated by FaultMgmt.MaxCurrentAlarmEntries? is reached, the next event overrides the object with the oldest AlarmChangedTime.

When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier, or with the same values for all of EventType, ProbableCause and SpecificProblem.

- 1.0 TR-157a5
AlarmIdentifier string​(64) string​(64) - Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 1.0 TR-157a5
AlarmRaisedTime dateTime dateTime - Indicates the date and time when the alarm was first raised by the device. - 1.0 TR-157a5
AlarmChangedTime dateTime dateTime - Indicates the date and time when the alarm was last changed by the device. - 1.0 TR-157a5
ManagedObjectInstance string​(512) string​(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this CurrentAlarm. - 1.0 TR-157a5
EventType string​(64) string​(64) - Indicates the type of event. - 1.0 TR-157a5
ProbableCause string​(64) string​(64) - Qualifies the alarm and provides further information than EventType. - 1.0 TR-157a5
SpecificProblem string​(128) string​(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
PerceivedSeverity string string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 1.0 TR-157a5
AdditionalText string​(256) string​(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
AdditionalInformation string​(256) string​(256) - This contains additional information about the alarm and is vendor defined. - 1.0 TR-157a5
FaultMgmt.​HistoryEvent.​{i}. object​[0:] object​[0:∞] -

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}.? are simultaneously entered into the this table. This table also contains alarm clearing events.

Active alarms at the time of a power failure or reboot might not get an alarm clearing event.

This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.HistoryEventNumberOfEntries?.

If maximum instance number FaultMgmt.HistoryEventNumberOfEntries? is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records.

At most one entry in this table can exist with the same values for both EventTime and AlarmIdentifier.

- 1.0 TR-157a5
EventTime dateTime dateTime - Indicates the date and time when the alarm event occurs. - 1.0 TR-157a5
AlarmIdentifier string​(64) string​(64) - Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 1.0 TR-157a5
NotificationType string string -

Indicates the reason for the specific alarm notification event. Enumeration of:

- 1.0 TR-157a5
ManagedObjectInstance string​(512) string​(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this HistoryEvent. - 1.0 TR-157a5
EventType string​(64) string​(64) - Indicates the type of event. - 1.0 TR-157a5
ProbableCause string​(64) string​(64) - Qualifies the alarm and provides further information than EventType. - 1.0 TR-157a5
SpecificProblem string​(128) string​(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
PerceivedSeverity string string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 1.0 TR-157a5
AdditionalText string​(256) string​(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
AdditionalInformation string​(256) string​(256) - This contains additional information about the alarm and is vendor defined. - 1.0 TR-157a5
FaultMgmt.​ExpeditedEvent.​{i}. object​[0:] object​[0:∞] -

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}.? are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}.? has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism? set to 0 Expedited?. This table also contains alarm clearing events.

This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.ExpeditedEventNumberOfEntries?.

Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4].

If maximum instance number FaultMgmt.ExpeditedEventNumberOfEntries? is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records.

When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier.

- 1.0 TR-157a5
EventTime dateTime dateTime -

Indicates the date and time when the alarm event occurs.

For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4].

- 1.0 TR-157a5
AlarmIdentifier string​(64) string​(64) -

Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm.

For an unpopulated entry, the value is an empty string.

- 1.0 TR-157a5
NotificationType string string -

Indicates the reason for the specific alarm notification event. Enumeration of:

- 1.0 TR-157a5
ManagedObjectInstance string​(512) string​(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this ExpeditedEvent. - 1.0 TR-157a5
EventType string​(64) string​(64) - Indicates the type of event. - 1.0 TR-157a5
ProbableCause string​(64) string​(64) - Qualifies the alarm and provides further information than EventType. - 1.0 TR-157a5
SpecificProblem string​(128) string​(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
PerceivedSeverity string string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 1.0 TR-157a5
AdditionalText string​(256) string​(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
AdditionalInformation string​(256) string​(256) - This contains additional information about the alarm and is vendor defined. - 1.0 TR-157a5
FaultMgmt.​QueuedEvent.​{i}. object​[0:] object​[0:∞] -

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}.? are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}.? has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism? set to 1 Queued?. This table also contains alarm clearing events.

This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.QueuedEventNumberOfEntries?.

Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4].

If maximum instance number FaultMgmt.QueuedEventNumberOfEntries? is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records.

When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier.

- 1.0 TR-157a5
EventTime dateTime dateTime -

Indicates the date and time when the alarm event occurs.

For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4].

- 1.0 TR-157a5
AlarmIdentifier string​(64) string​(64) -

Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm.

For an unpopulated entry, the value is an empty string.

- 1.0 TR-157a5
NotificationType string string -

Indicates the reason for the specific alarm notification event. Enumeration of:

- 1.0 TR-157a5
ManagedObjectInstance string​(512) string​(512) - Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this QueuedEvent. - 1.0 TR-157a5
EventType string​(64) string​(64) - Indicates the type of event. - 1.0 TR-157a5
ProbableCause string​(64) string​(64) - Qualifies the alarm and provides further information than EventType. - 1.0 TR-157a5
SpecificProblem string​(128) string​(128) -

Provides further qualification on the alarm beyond EventType and ProbableCause.

This is vendor defined and will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
PerceivedSeverity string string -

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

- 1.0 TR-157a5
AdditionalText string​(256) string​(256) -

This provides a textual string which is vendor defined.

This will be an empty string if the device doesn't support inclusion of this information.

- 1.0 TR-157a5
AdditionalInformation string​(256) string​(256) - This contains additional information about the alarm and is vendor defined. - 1.0 TR-157a5
Security. object object​[1:1] - This object contains general information related to managing security features on the device. - 1.0 TR-157a5
CertificateNumberOfEntries unsignedInt unsignedInt - The number of entries in the Certificate table. - 1.0 TR-157a5
Security.​Certificate.​{i}. object​[0:] object​[0:∞] -

This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280].

At most one entry in this table can exist with the same values for both SerialNumber and Issuer.

- 1.0 TR-157a5
Enable boolean boolean W Enables or disables this certificate. - 1.0 TR-157a5
LastModif dateTime dateTime - The last modification time of this certificate. - 1.0 TR-157a5
SerialNumber string​(64) string​(64) - The Serial Number field in an X.509 certificate, see [RFC5280]. - 1.0 TR-157a5
Issuer string​(256) string​(256) - The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 1.0 TR-157a5
NotBefore dateTime dateTime - The beginning of the certificate validity period; i.e. the Not Before field in an X.509 certificate, see [RFC5280]. - 1.0 TR-157a5
NotAfter dateTime dateTime - The end of the certificate validity period; i.e., the Not After field in an X.509 certificate, see [RFC5280]. - 1.0 TR-157a5
Subject string​(256) string​(256) - The Distinguished Name (DN) of the entity associated with the Public Key; i.e., the Subject field in an X.509 certificate, see [RFC5280]. - 1.0 TR-157a5
SubjectAlt string​(256)​[] list​(256) of string -

Comma-separated list (maximum number of characters 256) of strings. Each item is a DNS Name.

The Subject Alternative Names extension field in an X.509 certificate, see [RFC5280].

- 1.0 TR-157a5
SignatureAlgorithm string​(256) string​(256) - The algorithm used in signing the certificate; i.e. the Signature Algorithm field in an X.509 certificate, see [RFC5280]. - 1.0 TR-157a5

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter
SoftwareModules.ExecutionUnit.{i}.Status

Parameters for which Active Notification MAY be Denied

Parameter
PeriodicStatistics.SampleSet.{i}.
Alias
PeriodicStatistics.SampleSet.{i}.
SampleSeconds
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Alias
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SampleSeconds
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SuspectData
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Values
DeviceInfo.VendorLogFile.{i}.
Alias
SoftwareModules.ExecEnv.{i}.
Alias
SoftwareModules.ExecEnv.{i}.
AvailableDiskSpace
SoftwareModules.ExecEnv.{i}.
AvailableMemory
SoftwareModules.ExecEnv.{i}.
ActiveExecutionUnits
SoftwareModules.DeploymentUnit.{i}.
Alias
SoftwareModules.DeploymentUnit.{i}.
Status
SoftwareModules.ExecutionUnit.{i}.
Alias
SoftwareModules.ExecutionUnit.{i}.
DiskSpaceInUse
SoftwareModules.ExecutionUnit.{i}.
MemoryInUse

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

PeriodicStatsBase:1 Profile

This table defines the PeriodicStatsBase:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
PeriodicStatistics. P
MinSampleInterval R
MaxReportSamples R
SampleSetNumberOfEntries R
PeriodicStatistics.​SampleSet.​{i}. C
Name W
SampleInterval W
ReportSamples W
ReportStartTime R
ReportEndTime R
SampleSeconds R
ParameterNumberOfEntries R
PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. C
Reference W
SampleSeconds R
SuspectData R
Values R

PeriodicStatsAdv:1 Profile

The PeriodicStatsAdv:1 profile for the TR-157:1 data model is defined as the union of the PeriodicStatsBase:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
PeriodicStatistics.​SampleSet.​{i}. C
Enable W
Status R
TimeReference W
FetchSamples W
ForceSample W
PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. C
Enable W
SampleMode W
CalculationMode W
LowThreshold W
HighThreshold W
Failures R

VendorLogFiles:1 Profile

This table defines the VendorLogFiles:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
DeviceInfo.​VendorLogFile.​{i}. P
Name R
MaximumSize R
Persistent R

SM_ExecEnvs:1 Profile

This table defines the SM_ExecEnvs:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
SoftwareModules. P
ExecEnvNumberOfEntries R
SoftwareModules.​ExecEnv.​{i}. P
Enable W
Status R
Name R
Type R
Vendor R
Version R
AllocatedDiskSpace R
AvailableDiskSpace R
AllocatedMemory R
AvailableMemory R
ActiveExecutionUnits R

SM_DeployAndExecUnits:1 Profile

This table defines the SM_DeployAndExecUnits:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
SoftwareModules. P
DeploymentUnitNumberOfEntries R
ExecutionUnitNumberOfEntries R
SoftwareModules.​DeploymentUnit.​{i}. P
UUID R
DUID R
Name R
Status R
Resolved R
URL R
Description R
Vendor R
Version R
VendorLogList R
VendorConfigList R
ExecutionUnitList R
ExecutionEnvRef R
SoftwareModules.​ExecutionUnit.​{i}. P
EUID R
Name R
ExecEnvLabel R
Status R
RequestedState W
ExecutionFaultCode R
ExecutionFaultMessage R
Vendor R
Version R
Description R
References R
AssociatedProcessList R
VendorLogList R
VendorConfigList R
SupportedDataModelList R
ExecutionEnvRef R
SoftwareModules.​ExecutionUnit.​{i}.​Extensions. P

SM_Baseline:1 Profile

This table defines the SM_Baseline:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
SoftwareModules. P
ExecEnvNumberOfEntries R
DeploymentUnitNumberOfEntries R
ExecutionUnitNumberOfEntries R
SoftwareModules.​ExecEnv.​{i}. P
Enable W
Status R
Name R
Type R
Vendor R
Version R
ActiveExecutionUnits R
SoftwareModules.​DeploymentUnit.​{i}. P
UUID R
DUID R
Name R
Status R
Resolved R
URL R
Vendor R
Version R
ExecutionUnitList R
ExecutionEnvRef R
SoftwareModules.​ExecutionUnit.​{i}. P
EUID R
Name R
ExecEnvLabel R
Status R
RequestedState W
ExecutionFaultCode R
ExecutionFaultMessage R
Vendor R
Version R
References R
SupportedDataModelList R
SoftwareModules.​ExecutionUnit.​{i}.​Extensions. P

Location:1 Profile

This table defines the Location:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
DeviceInfo. P
LocationNumberOfEntries R
DeviceInfo.​Location.​{i}. C
Source R
AcquiredTime R
ExternalSource R
ExternalProtocol R
DataObject W

FaultMgmtSupportedAlarms:1 Profile

This table defines the FaultMgmtSupportedAlarms:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
FaultMgmt. P
SupportedAlarmNumberOfEntries R
FaultMgmt.​SupportedAlarm.​{i}. P
EventType R
ProbableCause R
SpecificProblem R
PerceivedSeverity R
ReportingMechanism W

FaultMgmtActive:1 Profile

This table defines the FaultMgmtActive:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
FaultMgmt. P
CurrentAlarmNumberOfEntries R
FaultMgmt.​CurrentAlarm.​{i}. P
AlarmIdentifier R
AlarmRaisedTime R
AlarmChangedTime R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtHistory:1 Profile

This table defines the FaultMgmtHistory:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
FaultMgmt. P
HistoryEventNumberOfEntries R
FaultMgmt.​HistoryEvent.​{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtExpedited:1 Profile

This table defines the FaultMgmtExpedited:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
FaultMgmt. P
ExpeditedEventNumberOfEntries R
FaultMgmt.​ExpeditedEvent.​{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtQueued:1 Profile

This table defines the FaultMgmtQueued:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.5.

Name Requirement
FaultMgmt. P
QueuedEventNumberOfEntries R
FaultMgmt.​QueuedEvent.​{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 17:14:47 (INTERIM VERSION).
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --nomodels --automodel --report=html --outfile=tr-157-1-5-0.html tr-157-1-5-0.xml