Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Architecture

string

R

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

• arm
• i386
• m68010
• m68k
• mipseb (big-endian)
• mipsel (little-endian)
• powerpc
• sh3eb (big-endian)
• sh3el (little-endian)
• x86_64 For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].

-

1.0

Total

unsignedInt

R

The total physical RAM, in kilobytes, installed on the device.

-

1.0

Free

unsignedInt

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

CPUUsage

unsignedInt(:100)

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

ProcessNumberOfEntries

unsignedInt

R

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

-

1.0

PID

unsignedInt

R

The Process Identifier.

-

1.0

Command

string(:256)

R

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

-

1.0

Size

unsignedInt

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Priority

unsignedInt(:99)

R

The priority of the process where 0 is highest.

-

1.0

CPUTime

unsignedInt

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

State

string

R

The current state that the process is in.

Enumeration of:

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

Active Notification requests for this parameter MAY be denied.

-

1.0

TemperatureSensorNumberOfEntries

unsignedInt

R

The number of entries in the TemperatureSensor table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

boolean

W

Indicates whether or not the temperature sensor is enabled.

-

1.0

Status

string

R

The status of this temperature sensor.

Enumeration of:

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

-

1.0

Reset

boolean

W

When set to true, resets the temperature sensor.

When read, this parameter returns false, regardless of the actual value.

-

1.0

ResetTime

dateTime

R

The time at which this temperature sensor was reset. Reset can be caused by:

• Status transition from Disabled to Enabled
• Reset set to true.
• An internal reset of the temperature sensor (including a reboot of the device). The Unknown Time value, as defined in [TR-106a2], indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.

-

1.0

Name

string(:256)

R

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

-

1.0

Value

int(-274:)

R

This temperature sensor's last good reading in degrees celsius. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

Active Notification requests for this parameter MAY be denied.

-

1.0

LastUpdate

dateTime

R

The time at which this temperature sensor's last good reading was obtained. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

Active Notification requests for this parameter MAY be denied.

-

1.0

MinValue

int(-274:)

R

This temperature sensor's lowest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

-

1.0

MinTime

dateTime

R

The time at which this temperature sensor's lowest value was read. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

-

1.0

MaxValue

int(-274:)

R

This temperature sensor's highest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

-

1.0

MaxTime

dateTime

R

The time at which this temperature sensor's highest value was read. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

-

1.0

LowAlarmValue

int(-274:)

W

This temperature sensor's low alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value.

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

-

1.0

LowAlarmTime

dateTime

R

Initial time at which this temperature sensor's LowAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset.

-

1.0

HighAlarmValue

int(-274:)

W

This temperature sensor's high alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value.

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

-

1.0

HighAlarmTime

dateTime

R

Initial time at which this temperature sensor's HighAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset.

-

1.0

PollingInterval

unsignedInt

W

The interval, measured in seconds, in which the device polls this TemperatureSensor. If the value is 0 then the device selects its own polling interval. If the value is greater than 0 then the device MUST use this value as the polling interval.

-

1.0

MaxTCPWindowSize

unsignedInt

R

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

-

1.0

TCPImplementation

string[]

R

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

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

-

1.0

Source

string

R

Identifies the source of the location data.

Enumeration of:

• GPS
• AGPS
• Manual
• External

External

1.0

AcquiredTime

dateTime

R

The time when the location was acquired.

-

1.0

ExternalSource

string

R

URL, MAC address, or other identifier that identifies an "External" source of this location. Meaningful only if Source has a value of External, otherwise it MUST be an empty string. If ExternalProtocol has a value of CWMP, this is the URL or IP address of the ACS.

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

-

1.0

ExternalProtocol

string

R

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

• <Empty> (An empty string)
• CWMP
• OMA-DM
• SNMP
• UPnP
• HELD
• DHCPv4
• DHCPv6
• LLDP-MED
• MLP
• Other Meaningful only if Source has a value of External, otherwise it MUST be an empty string.

CWMP

1.0

DataObject

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

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Name

string(:64)

R

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

-

1.0

MaximumSize

unsignedInt

R

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

-

1.0

Persistent

boolean

R

When true, the log file contents are preserved across a device reboot. When false, the log file contents will be purged when the device is rebooted.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

URL

string(:256)

R

URL ([RFC3986]) that describes some or all of the device's Current Supported Data Model. The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model. The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in [Annex B/TR-106a3], including any additional normative requirements referenced within the Schema. The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that UUID is a unique key, so the XML file referenced by this URL will never change. The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of "localhost" as URL host portion, When the "localhost" value is used, the ACS has the responsibility to substitute the "localhost" value with the host portion of the connection request URL. Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.

-

1.0

UUID

string(36)

R

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

-

1.0

URN

string(:256)

R

URN ([RFC3986]) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry. For example, if this table entry references a DT Instance that refers to the Device:1.3 Root Object, the value of this parameter would be urn:broadband-forum-org:tr-157-1-0-0, because TR-157 defines Device:1.3. If the DT Instance instead referred to a vendor-specific Root Object, e.g. X_EXAMPLE_Device:1.0 (derived from Device:1.3), the value of this parameter would be something like urn:example-com:device-1-0-0.

-

1.0

Features

string[]

R

Comma-separated list of strings. This parameter MUST list exactly the features that are defined using the top-level feature element in the DT Instance referenced by URL. For example, if the DT instance specified the following:

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

-

1.0

ManufacturerOUI

string(6)

R

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

• [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].

-

1.0

ProductClass

string(:64)

R

Identifier of the class of product of the associated CPE Proxier for which the serial number applies. An empty string indicates either that the CPE Proxier does not use a product class to differentiate its serial number.

-

1.0

SerialNumber

string(:64)

R

Serial number of the associated CPE Proxier.

-

1.0

ProxyProtocol

string()

R

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

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP-DM (see [UPnP-DM:1])
• ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.

-

1.0

Enable

boolean

W

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

-

1.0

OperationTypeFilter

string[]

W

Comma-separated list of strings. Indicates the Deployment Unit operations that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events. Operation types not indicated by this list MUST NOT be included when the CPE notifies the ACS. An empty string is essentially the same as setting Enable to false.

Each list item is an enumeration of:

• Install
• Update
• Uninstall

-

1.0

ResultTypeFilter

string

W

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

Enumeration of:

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

-

1.0

FaultCodeFilter

string[]

W

Comma-separated list of strings. Indicates the Deployment Unit state change fault codes that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events. State change fault codes omitted from this filter MUST NOT be included when the CPE notifies the ACS. This filter has no effect on the notification of a successful autonomous state change. This filter only applies when ResultTypeFilter is set to either Failure or Both. An empty string means that failed autonomous state changes will not be sent to the ACS.

Each list item is an enumeration of:

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

-

1.0

Enable

boolean

W

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

-

1.0

TransferTypeFilter

string

W

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

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

-

1.0

ResultTypeFilter

string

W

Indicates the transfer results that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer results omitted from this list MUST NOT be included when the CPE notifies the ACS. Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.

Enumeration of:

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

-

1.0

FileTypeFilter

string[](:1024)

W

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

Each list item matches one of:

• 1 Firmware Upgrade Image (Download Only)
• 2 Web Content (Download Only)
• 3 Vendor Configuration File (Download or Upload)
• 4 Vendor Log File (Upload Only)
• X [0-9A-F]{6} .* (For Vendor-Specific File Types, could be for either Download or Upload) Additionally, the following format is defined to allow the unique definition of vendor-specific file types:
• "X " is replaced by a 6 hexadecimal-digit OUI (organizationally unique identifier) as defined in [OUI], with all upper-case letters and any leading zeros included. The OUI used for a given vendor-specific file type MUST be one that is assigned to the organization that defined this file type (which is not necessarily the same as the vendor of the CPE or ACS). Note that an empty string indicates that all file types are excluded from this filter, effectively disabling CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.

-

1.0

ControllerID

string(:256)

R

Identifier of the controller that is responsible for a sub-network of Proxied Devices within the LAN. An empty string indicates that this Proxied Device either:

• Isn't part of a sub-network, within the LAN, with a controller entity.
• Doesn't need a ControllerID to ensure its ProxiedDeviceID is unique throughout the LAN.

-

1.0

ProxiedDeviceID

string(:256)

R

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

-

1.0

Reference

string

R

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

-

1.0

SupportedDataModel

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. Represents the CWMP-DT schema instance(s) that this Proxied Device is utilizing. The CWMP-DT schema instance is also the one being utilized by the object referenced within Reference.

-

1.0

Host

string[:32]

R

Comma-separated list (up to 32 items) of strings. None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. References the {{object: non-existent .LANDevice.{i}.Hosts.Host}} table entry(s), whether active or inactive, that corresponds to this proxied LAN device.

-

1.0

ProxyProtocol

string()

R

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

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP-DM (see [UPnP-DM:1])
• ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.

-

1.0

ProxyProtocolReference

string

R

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

-

1.0

DiscoveryProtocol

string[]

R

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device. Each list item is an enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP (see [UPnP-DAv1])
• ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a3] MUST be adhered to.

-

1.0

DiscoveryProtocolReference

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol, or an empty string. For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

• {{object: non-existent .UPnP.Discovery.RootDevice}}
• {{object: non-existent .UPnP.Discovery.Device}}
• {{object: non-existent .UPnP.Discovery.Service}} For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

-

1.0

CommandProcessed

string

R

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

Enumeration of:

• Pending
• Retrying
• Success
• Error

-

1.0

CommandProcessingErrMsg

string(:1024)

R

Detailed CommandProcessed error description (vendor specific).

-

1.0

LastSyncTime

dateTime

R

The last time that the CPE Proxier synchronized the state of the Proxied Device. This parameter MUST be updated when a proxy command is executed successfully on the Proxied Device. The Unknown Time value, as defined in [TR-106a6], indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted.

-

1.0

ManufacturerOUI

string(6)

R

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

• [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].

-

1.0

ProductClass

string(:64)

R

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

-

1.0

SerialNumber

string(:64)

R

Serial number of the associated Proxied Device.

-

1.0

Host

string[:32]

R

Comma-separated list (up to 32 items) of strings. None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. References all the {{object: non-existent .LANDevice.{i}.Hosts.Host}} table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface.

-

1.0

ProxyProtocol

string()

R

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

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP-DM (see [UPnP-DM:1])
• ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.

-

1.0

ProxyProtocolReference

string

R

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

-

1.0

DiscoveryProtocol

string[]

R

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device. Each list item is an enumeration of:

• Z-Wave (see [Z-Wave])
• ZigBee (see [ZigBee])
• UPnP (see [UPnP-DAv1])
• ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a3] MUST be adhered to.

-

1.0

DiscoveryProtocolReference

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol, or an empty string. For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

• {{object: non-existent .UPnP.Discovery.RootDevice}}
• {{object: non-existent .UPnP.Discovery.Device}}
• {{object: non-existent .UPnP.Discovery.Service}} For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

-

1.0

Movable

boolean

W

Controls whether the user is allowed to change the GUI window position on the local CPE's display.

-

1.0

Resizable

boolean

W

Controls whether the user is allowed to resize the GUI window on the local CPE's display.

-

1.0

PosX

int

W

The horizontal position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

-

1.0

PosY

int

W

The vertical position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

-

1.0

Width

unsignedInt

W

The width of the user interface within the local CPE's display, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

-

1.0

Height

unsignedInt

W

The height of the user interface within the local CPE's display, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

-

1.0

DisplayWidth

unsignedInt

R

The width of the local CPE's display, expressed in pixels.

-

1.0

DisplayHeight

unsignedInt

R

The height of the local CPE's display, expressed in pixels.

-

1.0

UserNumberOfEntries

unsignedInt

R

The number of entries in the User table.

-

1.0

Enable

boolean

W

Enables/Disables remotely accessing the CPE's user interface.

-

1.0

Port

unsignedInt(:65535)

W

Destination TCP port required for remote access connection.

-

1.0

SupportedProtocols

string[]

R

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:

• HTTP (As defined in [RFC2616])
• HTTPS (As defined in [RFC2818])

-

1.0

Protocol

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

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

boolean

W

Enables/disables this user object instance. If the User being configured is currently accessing the device then a disable MUST apply to the next user session and the current user session MUST NOT be abruptly terminated.

false

1.0

RemoteAccessCapable

boolean

W

Allows this user to remotely access the UserInterface via the mechanism defined in {{object: non-existent .UserInterface.RemoteAccess.}}

false

1.0

Username

string(:64)

W

Name of the current user. MUST NOT be an empty string for an enabled entry.

<Empty>

1.0

Password

string(:64)

W

The user's password.

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

-

1.0

Language

string(:16)

W

String describing the default language for the local configuration interface, specified according to [RFC3066]. If an empty string, {{param: non-existent .UserInterface.CurrentLanguage}} is used.

<Empty>

1.0

HNDDeviceClass

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Network Device Classes [Table 4-1/DLNA-NDIG].

-

1.0

DeviceCapability

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Device Capabilities [Table 4-2/DLNA-NDIG].

-

1.0

HIDDeviceClass

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Infrastructure Device Classes [Table 4-4/DLNA-NDIG].

-

1.0

ImageClassProfileID

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Image Class Profile IDs supported by this device, from Tables 5-2 and 5-3 of [DLNA-NDIG].

-

1.0

AudioClassProfileID

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Audio Class Profile IDs supported by this device, from Tables 5-4 through 5-10 of [DLNA-NDIG].

-

1.0

AVClassProfileID

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA AV Class Profile IDs supported by this device, from Tables 5-11 through 5-15 of [DLNA-NDIG].

-

1.0

MediaCollectionProfileID

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Media Collection Profile IDs supported by this device [Table 5-16/DLNA-NDIG].

-

1.0

PrinterClassProfileID

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Printer Class Profile IDs supported by this device [Table 5-17/DLNA-NDIG].

-

1.0

SmartCardReaderNumberOfEntries

unsignedInt

R

The number of entries in the SmartCardReader table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

boolean

W

Enables or disables this smart card reader.

-

1.0

Status

string

R

Indicates the status of this smart card reader.

Enumeration of:

• Disabled
• Enabled (Indicates the smart card reader is enabled and functioning properly)
• Error (Indicates the smart card reader is enabled and not functioning properly)

-

1.0

Name

string(:256)

R

Human-readable name associated with this smart card reader.

-

1.0

Reset

boolean

W

When set to true, resets the SmartCard Reader and the associated SmartCard.

When read, this parameter returns false, regardless of the actual value.

-

1.0

ResetTime

dateTime

R

The time at which this SmartCard Reader was reset. Reset can be caused by:

• Status transition from Disabled to Enabled
• Reset set to true.
• An internal reset of the SmartCard Reader (including a reboot of the device). Unknown Time value indicates that this SmartCard Reader has never been reset, which can only happen if it has never been enabled.

-

1.0

DecryptionFailedCounter

unsignedInt

R

Counter incremented once each time decryption cannot be carried out. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed.

Active Notification requests for this parameter MAY be denied.

-

1.0

DecryptionFailedNoKeyCounter

unsignedInt

R

Counter incremented once each time the key is not available to decrypt it. This is a subset of the more general DecryptionFailedCounter within the same object and thus will always be less than that parameter. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed.

Active Notification requests for this parameter MAY be denied.

-

1.0

Status

string

R

Status of the Smart Card.

Enumeration of:

• None (Indicates that no Smart Card is inserted)
• Running (Indicates a Smart Card is present and working normally)
• Error (Indicates the Smart Card is present and in an error condition)

-

1.0

Type

string

R

Smart Card Type. Enumeration of:

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

-

1.0

Application

string[]

R

Comma-separated list of strings. Indicates Smart Card Application(s). Application is only relevant when Type has a value of UICC, otherwise it is an empty string. Each list item is an enumeration of:

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

-

1.0

SerialNumber

string(:256)

R

The Smart Card Serial Number or an empty string if the Smart Card serial Number is not available, e.g. in the case of IPTV due to restrictions of the Service Delivery Platform.

-

1.0

ATR

string(:1024)

R

The Smart Card answer to a reset action. Issued by the Smart Card upon reset.

-

1.0

DiagnosticsState

string

W

Indicates availability of diagnostic data. Enumeration of:

• None (READONLY)
• Requested
• Complete (READONLY)
• Error_Internal (READONLY)
• Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

Active Notification requests for this parameter MAY be denied.

-

1.0

Results

string(:1024)

R

Results of self-test (vendor specific).

Active Notification requests for this parameter MAY be denied.

-

1.0

DiagnosticsState

string

W

Indicates availability of diagnostic data. Enumeration of:

• None (READONLY)
• Requested
• Complete (READONLY)
• Error_DNSServerNotResolved (Unable to resolve DNSServer Name, READONLY)
• Error_Internal (READONLY)
• Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

Active Notification requests for this parameter MAY be denied.

-

1.0

Interface

string(:256)

W

The value MUST be the Path Name of a table row. This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface.

-

1.0

HostName

string(:256)

W

Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name.

-

1.0

DNSServer

string(:256)

W

Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If an empty string is specified, the device's default DNS server will be used.

-

1.0

Timeout

unsignedInt

W

Timeout in milliseconds that indicates that a request has failed.

-

1.0

NumberOfRepetitions

unsignedInt

W

The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data.

-

1.0

SuccessCount

unsignedInt

R

Number of successfully executed repetitions.

Active Notification requests for this parameter MAY be denied.

-

1.0

ResultNumberOfEntries

unsignedInt

R

The number of entries in the Result table. Total number of Result entries from the most recent invocation of the test.

Active Notification requests for this parameter MAY be denied.

-

1.0

Status

string

R

Result Parameter to represent whether the NS Lookup was successful or not. Errors for individual Result instances do not get bubbled up to DiagnosticsState. A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that DiagnosticsState SHOULD be Error_Other.

Enumeration of:

• Success
• Error_DNSServerNotAvailable
• Error_HostNameNotResolved
• Error_Timeout
• Error_Other

Active Notification requests for this parameter MAY be denied.

-

1.0

AnswerType

string

R

Result parameter to represent whether the answer is Authoritative or not.

Enumeration of:

• None (Indicates that the NS Lookup failed to find the host)
• Authoritative
• NonAuthoritative

Active Notification requests for this parameter MAY be denied.

-

1.0

HostNameReturned

string(:256)

R

Result parameter to represent the fully qualified name for the Host Name in the calling parameter (e.g. HostName.DomainName); if no response was provided, then this parameter is an empty string.

Active Notification requests for this parameter MAY be denied.

-

1.0

IPAddresses

string(:45)[:10]

R

[IPAddress] Comma-separated list (up to 10 items) of IP Addresses. Indicates the IP Address results returned by the NS Lookup; if no response was provided, then this parameter is an empty string.

Active Notification requests for this parameter MAY be denied.

-

1.0

DNSServerIP

string(:45)

R

[IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used.

Active Notification requests for this parameter MAY be denied.

-

1.0

ResponseTime

unsignedInt

R

Response time (for the first response packet) in milliseconds, or 0 if no response was received.

Active Notification requests for this parameter MAY be denied.

-

1.0

Config

string

W

How this firewall is configured. Enumeration of:

• High (The firewall implements the "Traffic Denied Inbound" and "Minimally Permit Common Services Outbound" components of the ICSA residential certification's Required Services Security Policy [ICSA-Residential]. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
• Low (All Outbound traffic and pinhole-defined Inbound traffic is allowed. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
• Off (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 [ICSA-Baseline], these are disabled) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.

-

1.0

Version

string(:16)

R

A string identifying the firewall settings version currently used in the CPE, or an empty string if the firewall settings are not associated with a version.

-

1.0

LastChange

dateTime

R

The time at which the firewall settings most recently changed.

-

1.0

HostNumberOfEntries

unsignedInt

R

The number of entries in the Host table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

boolean

W

Enables or disables the USB Host controller.

-

1.0

Name

string(:64)

R

User-readable host controller name.

-

1.0

Type

string

R

Type of USB Host

Enumeration of:

• OHCI (Open Host Controller Interface)
• EHCI (Enhanced Host Controller Interface)
• UHCI (Universal Host Controller Interface)
• xHCI (Extensible Host Controller Interface)

-

1.0

Reset

boolean

W

When set to true, reset the Host Controller and apply the reset signaling (see [Chapter 7.1.7.5/USB2.0]) to all of the Host Controller Hub downstream ports. The value is not saved in the device's state and setting it to false has no effect.

When read, this parameter returns false, regardless of the actual value.

-

1.0

PowerManagementEnable

boolean

W

When set to true, PowerManagementEnable enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see [USB2.0], Chapters 4.3.2, 7.1.7.6, and 11.9). When set to false PowerManagementEnable immediately disables the Host controller Power Management policy.

-

1.0

USBVersion

string(:4)

R

USB specification version with which the controller complies. Example: "1.1"

-

1.0

DeviceNumberOfEntries

unsignedInt

R

The number of entries in the Device table.

-

1.0

DeviceNumber

unsignedInt

R

Device number on USB bus.

-

1.0

USBVersion

string(:4)

R

USB specification version with which the device complies. Example: "1.1"

-

1.0

DeviceClass

hexBinary(:1)

R

Class Code as assigned by USB-IF. When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified.

-

1.0

DeviceSubClass

hexBinary(:1)

R

Subclass code (assigned by USB-IF).

-

1.0

DeviceVersion

unsignedInt(:65535)

R

Device release number.

-

1.0

DeviceProtocol

hexBinary(:1)

R

Protocol code (assigned by USB-IF).

-

1.0

ProductID

unsignedInt(:65535)

R

Product ID (assigned by manufacturer).

-

1.0

VendorID

unsignedInt(:65535)

R

Vendor ID (assigned by USB-IF).

-

1.0

Manufacturer

string(:64)

R

Device Manufacturer string descriptor.

-

1.0

ProductClass

string(:64)

R

Device Product Class string descriptor.

-

1.0

SerialNumber

string(:64)

R

Device SerialNumber string descriptor.

-

1.0

Port

unsignedInt(:255)

R

Hub port on parent device. 0 when no parent.

-

1.0

USBPort

string

R

None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. This is a reference to the USB host device to which this (external) USB device is connected.

-

1.0

Rate

string

R

Speed of the USB device. Enumeration of:

• Low (1.5 Mbits/sec (187.5 KB/sec) defined in [USB1.0])
• Full (12 Mbits/sec (1.5 MB/sec) defined in [USB1.0])
• High (480 Mbits/sec (60 MB/sec) defined in [USB2.0])
• Super (5.0 Gbits/sec (625 MB/sec) defined in [USB3.0]) Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate.

-

1.0

Parent

string

R

The value MUST be the Path Name of a row in the Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the parent USB device (e.g. hub device). This is an empty string for a device connected to the Host controller (root hub).

-

1.0

MaxChildren

unsignedInt

R

Number of ports. Only applies for hub device, equal to 0 for other devices.

-

1.0

IsSuspended

boolean

R

When true the associated Device is in a suspended (i.e. low-power) state (see [Chapter 11.9/USB2.0]). When false the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see [Chapter 9.1.1/USB2.0]).

-

1.0

IsSelfPowered

boolean

R

When true the associated device is at least partly powered by a local source (see [Chapter 9.4.5/USB2.0]). When false the associated device draws all the current it needs from the USB bus.

-

1.0

ConfigurationNumberOfEntries

unsignedInt

R

The number of entries in the Configuration table.

-

1.0

ConfigurationNumber

unsignedInt

R

The identifier for each Device Configuration.

-

1.0

InterfaceNumberOfEntries

unsignedInt

R

The number of entries in the Interface table.

-

1.0

InterfaceNumber

unsignedInt(:255)

R

Number of this interface (from USB interface descriptor).

-

1.0

InterfaceClass

hexBinary(:1)

R

Class Code as assigned by USB-IF. When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified.

-

1.0

InterfaceSubClass

hexBinary(:1)

R

Subclass code (assigned by USB-IF).

-

1.0

InterfaceProtocol

hexBinary(:1)

R

Protocol code (assigned by USB-IF).

-

1.0

Enable

boolean

W

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

-

1.0

Status

string

R

The status of the announcement service.

Enumeration of:

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

-

1.0

GroupNumberOfEntries

unsignedInt

R

The number of entries in the Group table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

boolean

W

Enable/disable listening to this multicast group.

false

1.0

Status

string

R

The status of this group table entry.

Enumeration of:

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

Disabled

1.0

URL

string(:256)

W

URL [RFC3986] encoding the group address, source and port on which to listen, and other protocol information, e.g. expected announcement format. Depending on the application, the messages identified by this URL MAY directly contain the data to be downloaded, or alternatively MAY contain information informing the CPE how to obtain the data to be downloaded via a separate mechanism, which itself could involve a unicast or a multicast download protocol. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SAP [RFC2974] stream that indicates how to use either FLUTE [RFC3926] or DSM-CC [ISO-13818-6:1998] to perform the download.

<Empty>

1.0

Enable

boolean

W

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

-

1.0

Status

string

R

The status of the query service.

Enumeration of:

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

-

1.0

URL

string(:256)

W

URL [RFC3986] of the query response server. Depending on the application, the protocol described by this URL MAY be a SOAP interface, or MAY be any other RPC mechanism. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS.

-

1.0

ExecEnvNumberOfEntries

unsignedInt

R

The number of entries in the ExecEnv table.

-

1.0

DeploymentUnitNumberOfEntries

unsignedInt

R

The number of entries in the DeploymentUnit table.

-

1.0

ExecutionUnitNumberOfEntries

unsignedInt

R

The number of entries in the ExecutionUnit table.

-

1.0

Enable

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

Status

string

R

Indicates the status of this ExecEnv.

Enumeration of:

• Up
• Error (OPTIONAL)
• Disabled

-

1.0

Reset

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

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Name

string(:32)

R

A Name provided by the CPE that adequately distinguishes this ExecEnv from all other ExecEnv instances.

-

1.0

Type

string(:64)

R

Indicates the complete type and specification version of this ExecEnv.

-

1.0

InitialRunLevel

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

RequestedRunLevel

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.

-

1.0

CurrentRunLevel

int(-1:65535)

R

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

InitialExecutionUnitRunLevel

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

Vendor

string(:128)

R

The vendor that produced this ExecEnv.

-

1.0

Version

string(:32)

R

The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification.

-

1.0

ParentExecEnv

string

R

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

AllocatedDiskSpace

int(-1:)

R

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

AvailableDiskSpace

int(-1:)

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

AllocatedMemory

int(-1:)

R

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

AvailableMemory

int(-1:)

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

ActiveExecutionUnits

string[]

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

ProcessorRefList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. Represents the processors that this ExecEnv has available to it.

-

1.0

UUID

string(:36)

R

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

DUID

string(:64)

R

Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Name

string(:64)

R

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

Status

string

R

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)

Active Notification requests for this parameter MAY be denied.

-

1.0

Resolved

boolean

R

Indicates whether or not this DeploymentUnit has resolved all of its dependencies.

-

1.0

URL

string(:1024)

R

Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit.

-

1.0

Description

string(:256)

R

Textual description of this DeploymentUnit. The format of this value is Execution Environment specific.

-

1.0

Vendor

string(:128)

R

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

Version

string(:32)

R

Version of this DeploymentUnit. The format of this value is Execution Environment specific.

-

1.0

VendorLogList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be 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

VendorConfigList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be 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

ExecutionUnitList

string[]

R

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

ExecutionEnvRef

string

R

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

EUID

string(:64)

R

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

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Name

string(:32)

R

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

ExecEnvLabel

string(:64)

R

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

Status

string

R

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)

Active Notification MUST by default be enabled for this parameter.

-

1.0

RequestedState

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.

-

1.0

ExecutionFaultCode

string

R

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:

• NoFault
• FailureOnStart
• FailureOnAutoStart
• FailureOnStop
• FailureWhileActive
• DependencyFailure
• UnStartable 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

ExecutionFaultMessage

string(:256)

R

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

AutoStart

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

RunLevel

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

Vendor

string(:128)

R

Vendor of this ExecutionUnit.

-

1.0

Version

string(:32)

R

Version of the ExecutionUnit. The format of this value is Execution Environment specific.

-

1.0

Description

string(:256)

R

Textual description of this ExecutionUnit. The format of this value is Execution Environment specific.

-

1.0

DiskSpaceInUse

int(-1:)

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

MemoryInUse

int(-1:)

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

References

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of a table row, or an empty string. 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 {{object: non-existent .DeviceInfo.SupportedDataModel.{i}.}} table.

-

1.0

AssociatedProcessList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be 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

VendorLogList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be 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

VendorConfigList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be 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

SupportedDataModelList

string[]

R

Comma-separated list of strings. None of the possible target objects exist in this data model, so the parameter value MUST be 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

ExecutionEnvRef

string

R

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

SupportedAlarmNumberOfEntries

unsignedInt

R

The number of entries in the SupportedAlarm table.

-

1.0

MaxCurrentAlarmEntries

unsignedInt

R

The maximum number of entries allowed in the {{object: non-existent .FaultMgmt.CurrentAlarm.{i}.}} table.

-

1.0

CurrentAlarmNumberOfEntries

unsignedInt

R

The number of entries in the CurrentAlarm table.

-

1.0

HistoryEventNumberOfEntries

unsignedInt

R

The number of entries in the HistoryEvent table.

-

1.0

ExpeditedEventNumberOfEntries

unsignedInt

R

The number of entries in the ExpeditedEvent table.

-

1.0

QueuedEventNumberOfEntries

unsignedInt

R

The number of entries in the QueuedEvent table.

-

1.0

EventType

string(:64)

R

Indicates the type of event.

-

1.0

ProbableCause

string(:64)

R

Qualifies the alarm and provides further information than EventType.

-

1.0

SpecificProblem

string(:128)

R

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

PerceivedSeverity

string

R

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

• <Empty> (An empty string)
• ***
• Cleared
• Critical
• Major
• Minor
• Warning
• Indeterminate 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

ReportingMechanism

string

W

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

• 0 Expedited (The device inserts the alarm into the {{object: non-existent .FaultMgmt.ExpeditedEvent.{i}.}} table and the {{object: non-existent .FaultMgmt.ExpeditedEvent.{i}.}} table)
• 1 Queued (The device inserts the alarm into the {{object: non-existent .FaultMgmt.QueuedEvent.{i}.}} table and the {{object: non-existent .FaultMgmt.QueuedEvent.{i}.}} table)
• 2 Logged (The device inserts the alarm into the {{object: non-existent .FaultMgmt.HistoryEvent.{i}.}} table)
• 3 Disabled (The device ignores the alarm)

-

1.0

AlarmIdentifier

string(:64)

R

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

AlarmRaisedTime

dateTime

R

Indicates the date and time when the alarm was first raised by the device.

-

1.0

AlarmChangedTime

dateTime

R

Indicates the date and time when the alarm was last changed by the device.

-

1.0

ManagedObjectInstance

string(:512)

R

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

EventType

string(:64)

R

Indicates the type of event.

-

1.0

ProbableCause

string(:64)

R

Qualifies the alarm and provides further information than EventType.

-

1.0

SpecificProblem

string(:128)

R

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

PerceivedSeverity

string

R

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

• Critical
• Major
• Minor
• Warning
• Indeterminate

-

1.0

AdditionalText

string(:256)

R

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

AdditionalInformation

string(:256)

R

This contains additional information about the alarm and is vendor defined.

-

1.0

EventTime

dateTime

R

Indicates the date and time when the alarm event occurs.

-

1.0

AlarmIdentifier

string(:64)

R

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

NotificationType

string

R

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

• NewAlarm
• ChangedAlarm
• ClearedAlarm

-

1.0

ManagedObjectInstance

string(:512)

R

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

EventType

string(:64)

R

Indicates the type of event.

-

1.0

ProbableCause

string(:64)

R

Qualifies the alarm and provides further information than EventType.

-

1.0

SpecificProblem

string(:128)

R

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

PerceivedSeverity

string

R

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

• Cleared
• Critical
• Major
• Minor
• Warning
• Indeterminate

-

1.0

AdditionalText

string(:256)

R

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

AdditionalInformation

string(:256)

R

This contains additional information about the alarm and is vendor defined.

-

1.0

EventTime

dateTime

R

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

AlarmIdentifier

string(:64)

R

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

NotificationType

string

R

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

• NewAlarm
• ChangedAlarm
• ClearedAlarm

-

1.0

ManagedObjectInstance

string(:512)

R

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

EventType

string(:64)

R

Indicates the type of event.

-

1.0

ProbableCause

string(:64)

R

Qualifies the alarm and provides further information than EventType.

-

1.0

SpecificProblem

string(:128)

R

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

PerceivedSeverity

string

R

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

• Cleared
• Critical
• Major
• Minor
• Warning
• Indeterminate

-

1.0

AdditionalText

string(:256)

R

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

AdditionalInformation

string(:256)

R

This contains additional information about the alarm and is vendor defined.

-

1.0

EventTime

dateTime

R

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

AlarmIdentifier

string(:64)

R

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

NotificationType

string

R

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

• NewAlarm
• ChangedAlarm
• ClearedAlarm

-

1.0

ManagedObjectInstance

string(:512)

R

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

EventType

string(:64)

R

Indicates the type of event.

-

1.0

ProbableCause

string(:64)

R

Qualifies the alarm and provides further information than EventType.

-

1.0

SpecificProblem

string(:128)

R

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

PerceivedSeverity

string

R

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

• Cleared
• Critical
• Major
• Minor
• Warning
• Indeterminate

-

1.0

AdditionalText

string(:256)

R

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

AdditionalInformation

string(:256)

R

This contains additional information about the alarm and is vendor defined.

-

1.0

CertificateNumberOfEntries

unsignedInt

R

The number of entries in the Certificate table.

-

1.0

Enable

boolean

W

Enables or disables this certificate.

-

1.0

LastModif

dateTime

R

The last modification time of this certificate.

-

1.0

SerialNumber

string(:64)

R

The Serial Number field in an X.509 certificate, see [RFC5280].

-

1.0

Issuer

string(:256)

R

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

NotBefore

dateTime

R

The beginning of the certificate validity period; i.e. the Not Before field in an X.509 certificate, see [RFC5280].

-

1.0

NotAfter

dateTime

R

The end of the certificate validity period; i.e., the Not After field in an X.509 certificate, see [RFC5280].

-

1.0

Subject

string(:256)

R

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

SubjectAlt

string[](:256)

R

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

SignatureAlgorithm

string(:256)

R

The algorithm used in signing the certificate; i.e. the Signature Algorithm field in an X.509 certificate, see [RFC5280].

-

1.0

MinSampleInterval

unsignedInt

R

Minimum sample interval in seconds that the CPE is able to support. A value of 0 indicates no specific minimum sample interval.

-

1.0

MaxReportSamples

unsignedInt

R

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

SampleSetNumberOfEntries

unsignedInt

R

The number of entries in the SampleSet table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

• If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

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

Status

string

R

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

Name

string(:128)

W

The name of this sample set, which uniquely distinguishes each sample set.

<Empty>

1.0

SampleInterval

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 {{param: non-existent .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

ReportSamples

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 {{param: non-existent .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

TimeReference

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

FetchSamples

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

ForceSample

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

ReportStartTime

dateTime

R

The absolute time at which the sample interval for the first stored sample (for each statistic) started.

<Empty>

1.0

ReportEndTime

dateTime

R

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

SampleSeconds

unsignedInt[]

R

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.

Active Notification requests for this parameter MAY be denied.

<Empty>

1.0

ParameterNumberOfEntries

unsignedInt

R

The number of entries in the Parameter table.

0

1.0