TR-157
Component Object for CWMP
Broadband Forum
March 2009
RFC 793
Transmission Control Protocol
IETF
September 1981
http://www.ietf.org/rfc/rfc793.txt
RFC 1323
TCP Extensions for High Performance
IETF
May 1992
http://www.ietf.org/rfc/rfc1323.txt
RFC 2581
TCP Congestion Control
IETF
April 1999
http://www.ietf.org/rfc/rfc2581.txt
RFC 2582
The NewReno Modification to TCP's Fast Recovery Algorithm
IETF
April 1999
http://www.ietf.org/rfc/rfc2582.txt
RFC 2818
HTTP Over TLS
IETF
May 2000
http://www.ietf.org/rfc/rfc2818.txt
RFC 2974
Session Announcement Protocol
IETF
October 2000
http://www.ietf.org/rfc/rfc2974.txt
RFC 3926
FLUTE - File Delivery over Unidirectional Transport
IETF
October 2004
http://www.ietf.org/rfc/rfc3926.txt
DLNA Networked Device Interoperability Guidelines
DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles.
DLNA
October 2006
http://www.dlna.org/industry/certification/guidelines/
TS 102 824
Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services
ETSI
July 2008
http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769
ICSA Modular Firewall Certification Criteria
Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0
ICSA Labs
http://www.icsalabs.com/icsa/docs/html/communities/firewalls/pdf/criteria/SMB.pdf
ISO/IEC 13818-6:1998
Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC
ISO
1998
http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039
UPnP Device Architecture
UPnP Device Architecture 1.0
UPnP Forum
April 2008
http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf
USB 1.0
USB 1.0 Specification
USB-IF
January 1996
http://www.usb.org/developers/docs/
USB 2.0
USB 2.0 Specification
USB-IF
April 2000
http://www.usb.org/developers/docs/usb_20_122208.zip
USB 3.0
USB 3.0 Specification
USB-IF
November 2008
http://www.usb.org/developers/docs/usb_30_spec.zip
Status of the device's volatile physical memory.
The total physical RAM, in {{units}}, installed on the device.
The free physical RAM, in {{units}}, currently available on the device.
Status of the processes on the device.
The total amount of the CPU, in {{units}}, rounded up to the nearest whole {{units}}. In the case that multiple CPU are present, this value represents the average of all CPU.
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 {{bibref|TR-069a2|Section 3.2.1}}.
List of all processes running on the device.
The Process Identifier.
The name of the command that has caused the process to exist.
The size in {{units}} of the memory occupied by the process.
The priority of the process where 0 is highest.
The amount of time in {{units}} that the process has spent taking up CPU time since the process was started.
The current state that the process is in.
Status of the temperature of the device.
Number of entries in TemperatureSensor table.
This object represents information that the device has obtained via sampling an internal temperature sensor.
Indicates whether or not the temperature sensor is enabled.
The status of this temperature sensor.
The sensor is not currently sampling the temperature.
The sensor is currently sampling the temperature.
The sensor error currently prevents sampling the temperature.
When set to {{true}}, resets the temperature sensor.
The time at which this temperature sensor was reset.
Reset can be caused by:
* {{param|Status}} transition from {{enum|Disabled|Status}} to {{enum|Enabled|Status}}
* {{param|Reset}} set to {{true}}.
* An internal reset of the temperature sensor (including a reboot of the device).
The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.
Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors.
This temperature sensor's last good reading in {{units}}.
A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.
The time at which this temperature sensor's last good reading was obtained.
The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset.
This temperature sensor's lowest value reading in {{units}} since last reset.
A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.
The time at which this temperature sensor's lowest value was read.
The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset.
This temperature sensor's highest value reading in {{units}} since last reset.
A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.
The time at which this temperature sensor's highest value was read.
The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset.
This temperature sensor's low alarm value in {{units}}.
A value of -274 (which is below absolute zero) indicates a non configured value.
Initial time at which this temperature sensor's {{param|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 {{bibref|TR-106a2}}, indicates that an alarm has not been encountered since the last reset.
This temperature sensor's high alarm value in {{units}}.
A value of -274 (which is below absolute zero) indicates a non configured value.
Initial time at which this temperature sensor's {{param|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 {{bibref|TR-106a2}}, indicates that an alarm has not been encountered since the last reset.
This object defines the parameters that describe how the device handles network traffic.
The maximum number of {{units}} of outstanding data a sender can send on a particular connection prior to an acknowledgment {{bibref|RFC793}}. Any scaling factor SHOULD be included in this parameter {{bibref|RFC1323}}.
{{list}} Indicates the TCP congestion control mechanism(s) implemented. {{enum}}
Tahoe, Reno, and New Reno are defined in {{bibref|RFC2582}}
Represents the base TCP implementation in {{bibref|RFC793}} and elements of {{bibref|RFC2582}}
Represents the base TCP implementation in {{bibref|RFC793}} with the additional algorithms defined in {{bibref|RFC2581}}
Described as a modification to the Reno algorithms in {{bibref|RFC2582}}
An emerging TCP congestion control mechanism
This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069a2}}.
The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS.
Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.
Indicates the transfer types that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer types not indicated by this filter MUST NOT be included when the CPE notifies the ACS. {{enum}}
Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.
Upload and Download
{{list}} Indicates the file types that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types omitted from this list MUST NOT be included when the CPE notifies the ACS.
{{pattern}}
Additionally, the following format is defined to allow the unique definition of vendor-specific file types:
* ''"X <OUI> <Vendor-specific identifier>"''
<OUI> is replaced by a 6 hexadecimal-digit OUI (organizationally unique identifier) as defined in {{bibref|OUI}}, with all upper-case letters and any leading zeros included. The OUI used for a given vendor-specific file type MUST be one that is assigned to the organization that defined this file type (which is not necessarily the same as the vendor of the CPE or ACS).
Note that {{empty}} indicates that all file types are excluded from this filter, effectively disabling CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.
Download Only
Download Only
Download or Upload
Upload Only
For Vendor-Specific File Types, could be for either Download or Upload
This object contains parameters relating to remotely accessing the CPE's user interface.
Remote access is defined as any entity not of a local subnet attempting to connect to the CPE.
Remote access requires user authentication. To provide remote access authentication the CPE MUST support a {{object|.User.{i}.}} with at least one instance that has {{param|.User.{i}.RemoteAccessCapable}} set to {{true}}.
Enables/Disables remotely accessing the CPE’s user interface.
Destination TCP port required for remote access connection.
{{list}} Indicates the protocols that are supported by the CPE for the purpose of remotely accessing the user interface.
As defined in {{bibref|RFC2616}}
As defined in {{bibref|RFC2818}}
This is the protocol currently being used for remote access.
This object describes how to remotely manage the initial positioning of a user interface on a device's local display.
Controls whether the user is allowed to change the GUI window position on the local CPE's display.
Controls whether the user is allowed to resize the GUI window on the local CPE's display.
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 {{units}}.
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 {{units}}.
The width of the user interface within the local CPE's display, expressed in {{units}}.
The height of the user interface within the local CPE's display, expressed in {{units}}.
The width of the local CPE's display, expressed in {{units}}.
The height of the local CPE's display, expressed in {{units}}.
Number of entries in the User table.
This object contains parameters relating to the user characteristics.
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.
Allows this user to remotely access the UserInterface via the mechanism defined in {{object|.UserInterface.RemoteAccess.}}
Name of the current user. MUST NOT be {{empty}} for an enabled entry.
The user's password.
String describing the default language for the local configuration interface, specified according to {{bibref|RFC3066}}.
If {{empty}}, {{param|.UserInterface.CurrentLanguage}} is used.
This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters.
Configuration Object for UPnP Access.
Enables/Disables UPnP support.
Enables/Disables UPnP Media Server.
Enables/Disables UPnP Media Renderer.
Enables/Disables UPnP Wireless Access Point.
Enables/Disables UPnP QoS Device.
Enables/Disables UPnP QoS Policy Holder.
Enables/Disables UPnP IGD.
This object defines what UPnP capabilities this device has.
Numeric value indicating the version of supported architecture for UPnP.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP Media Server.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP Media Renderer.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP Wireless Access Point.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP Basic Device.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP Qos Device.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP Qos Policy Holder.
A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP IGD.
A value of 0 indicates no support.
UPnP {{bibref|UPnP-DAv1}} SSDP discovered root devices, embedded devices and embedded services.
The CPE MAY, but need not, retain some or all of the information in this object across reboots.
Number of entries in RootDevice table.
Number of entries in Device table.
Number of entries in Service table.
UPnP root device table. This table contains an entry for each UPnP root device that has been discovered via SSDP.
The status of the UPnP root device. {{enum}}
The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.
Device is active and UPnP lease has not expired.
Device is inactive because UPnP lease has expired.
Device is inactive because byebye message was received.
This UPnP root device's UUID (Universally Unique IDentifier) {{bibref|RFC4122}}, extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:
: ''02c29d2a-dbfd-2d91-99c9-306d537e9856''
{{pattern}}
The value of the USN (Unique Service Name) header for this UPnP root device. Three discovery messages are sent for root devices, and this SHOULD be the value of the USN header of the following form:
: ''uuid:device-UUID::urn:domain-name:device:deviceType:v''
SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, one of the other two forms MAY be used:
: ''uuid:device-UUID::upnp:rootdevice''
: ''uuid:device-UUID'' (for root device UUID)
The UPnP root device lease time in {{units}}, extracted from the CACHE-CONTROL header.
The value of the LOCATION header for this UPnP root device, which is the URL of the root device's DDD (Device Description Document).
The value of the SERVER header for this UPnP root device, which is a string of the following form:
: ''OS/version UPnP/udaversion product/version''
where '''UPnP''' is a literal string, '''udaversion''' is the version of the UPnP Device Architecture.
{{list}} Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device.
As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.
UPnP embedded device table. This table contains an entry for each UPnP embedded device that has been discovered via SSDP.
The status of the UPnP embedded device. {{enum}}
The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.
Device is active and UPnP lease has not expired.
Device is inactive because UPnP lease has expired.
Device is inactive because byebye message was received.
This UPnP embedded device's UUID (Universally Unique IDentifier) {{bibref|RFC4122}}, extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:
: ''02c29d2a-dbfd-2d91-99c9-306d537e9856''
{{pattern}}
The value of the USN (Unique Service Name) header for this UPnP embedded device. Two discovery messages are sent for embedded devices, and this SHOULD be the value of the USN header of the following form:
: ''uuid:device-UUID::urn:domain-name:device:deviceType:v''
SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, the other form MAY be used:
: ''uuid:device-UUID''
The UPnP embedded device lease time in {{units}}, extracted from the CACHE-CONTROL header.
The value of the LOCATION header for this UPnP embedded device, which is the URL of the root device's DDD (Device Description Document).
The value of the SERVER header for this UPnP embedded device, which is a string of the following form:
: ''OS/version UPnP/udaversion product/version''
where '''UPnP''' is a literal string, '''udaversion''' is the version of the UPnP Device Architecture.
{{list}} Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device.
As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.
UPnP embedded service table. This table contains an entry for each UPnP embedded service that has been discovered via SSDP.
The status of the UPnP embedded service. {{enum}}
The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.
Service is active and UPnP lease has not expired.
Service is inactive because UPnP lease has expired.
Service is inactive because byebye message was received.
The value of the USN (Unique Service Name) header for this UPnP embedded service. This is of the following form:
: ''uuid:device-UUID::urn:domain-name:service:serviceType:v''
The UPnP embedded service lease time in {{units}}, extracted from the CACHE-CONTROL header.
The value of the LOCATION header for this UPnP embedded service, which is the URL of the root device's DDD (Device Description Document).
The value of the SERVER header for this UPnP embedded service, which is a string of the following form:
: ''OS/version UPnP/udaversion product/version''
where '''UPnP''' is a literal string, '''udaversion''' is the version of the UPnP Device Architecture.
{{list}} Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service.
As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.
This object contains all DLNA related objects and parameters.
DLNA capabilities.
{{list}} Indicates the supported DLNA Home Network Device Classes {{bibref|DLNA-NDIG|Table 4-1}}.
{{list}} Indicates the supported DLNA Device Capabilities {{bibref|DLNA-NDIG|Table 4-2}}.
{{list}} Indicates the supported DLNA Home Infrastructure Device Classes {{bibref|DLNA-NDIG|Table 4-4}}.
{{list}} Indicates the DLNA Image Class Profile IDs supported by this device, from Tables 5-2 and 5-3 of {{bibref|DLNA-NDIG}}.
{{list}} Indicates the DLNA Audio Class Profile IDs supported by this device, from Tables 5-4 through 5-10 of {{bibref|DLNA-NDIG}}.
{{list}} Indicates the DLNA AV Class Profile IDs supported by this device, from Tables 5-11 through 5-15 of {{bibref|DLNA-NDIG}}.
{{list}} Indicates the DLNA Media Collection Profile IDs supported by this device {{bibref|DLNA-NDIG|Table 5-16}}.
{{list}} Indicates the DLNA Printer Class Profile IDs supported by this device {{bibref|DLNA-NDIG|Table 5-17}}.
Number of entries in the SmartCardReader table.
This object describes the characteristics of the smart card reader.
Enables or disables this smart card reader.
Indicates the status of this smart card reader.
Indicates the smart card reader is enabled and functioning properly.
Indicates the smart card reader is enabled and not functioning properly.
Human-readable name associated with this smart card reader.
When set to {{true}}, resets the SmartCard Reader and the associated SmartCard.
The time at which this SmartCard Reader was reset.
Reset can be caused by:
* {{param|Status}} transition from Disabled to Enabled
* {{param|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.
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 {{param|Reset}} parameter is used and not when a Smart Card is inserted or removed.
Counter incremented once each time the key is not available to decrypt it. This is a subset of the more general {{param|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 {{param|Reset}} parameter is used and not when a Smart Card is inserted or removed.
Status of currently associated smart card.
Status of the Smart Card.
Indicates that no Smart Card is inserted.
Indicates a Smart Card is present and working normally.
Indicates the Smart Card is present and in an error condition.
Smart Card Type. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to.
{{list}} Indicates Smart Card Application(s). {{param}} is only relevant when {{param|Type}} has a value of UICC, otherwise it is {{empty}}. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to.
The Smart Card Serial Number or {{empty}} if the Smart Card serial Number is not available, e.g. in the case of IPTV due to restrictions of the Service Delivery Platform.
The Smart Card answer to a reset action. Issued by the Smart Card upon reset.
This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.
Indicates availability of diagnostic data. {{enum}}
If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|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 {{enum|Complete}} (if the test completed successfully), or one of the Error values listed above.
If the value of this parameter is anything other than {{enum|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 {{enum|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 {{enum|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 {{enum|None}}.
While the test is in progress, setting this parameter to {{enum|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.
Results of self-test (vendor specific).
This object defines access to an IP-layer NS Lookup test for the specified IP interface.
When initiated, the NS Lookup test will contact {{param|DNSServer}} and look up {{param|HostName}} {{param|NumberOfRepetitions}} times.
There will be a {{object|Result}} instance for each time the device performs a DNS lookup, which is determined by the value of {{param|NumberOfRepetitions}}.
Any previous {{object|Result}} instances are removed when a new test is initiated.
Indicates availability of diagnostic data. {{enum}}
If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|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 {{enum|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 {{enum|Complete}} (if the test completed successfully), or one of the Error values listed above.
If the value of this parameter is anything other than {{enum|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 {{enum|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 {{enum|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 {{enum|None}}.
While the test is in progress, setting this parameter to {{enum|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.
Unable to resolve DNSServer Name
{{reference}} 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 {{empty}} is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface.
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.
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 {{empty}} is specified, the device's default DNS server will be used.
Timeout in {{units}} that indicates that a request has failed.
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.
Number of successfully executed repetitions.
Total number of Result entries from the most recent invocation of the test.
Results from the most recent invocation of the test, one instance per repetition.
Result Parameter to represent whether the NS Lookup was successful or not.
Errors for individual Result instances do not get bubbled up to {{param|.NSLookupDiagnostics.DiagnosticsState}}.
A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that {{param|.NSLookupDiagnostics.DiagnosticsState}} SHOULD be {{enum|Error_Other}}.
Result parameter to represent whether the answer is Authoritative or not.
Indicates that the NS Lookup failed to find the host.
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 {{empty}}.
{{list}} Indicates the IP Address results returned by the NS Lookup; if no response was provided, then this parameter is {{empty}}.
Result parameter to represent the actual DNS Server IP address that the NS Lookup used.
Response time (for the first response packet) in {{units}}, or 0 if no response was received.
Firewall configuration object.
How this firewall is configured. {{enum}}
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to.
The firewall implements the "Traffic Denied Inbound" and "Minimally Permit Common Services Outbound" components of the ICSA residential certification's Required Services Security Policy {{bibref|ICSA-Firewall}}.
All Outbound traffic and pinhole-defined Inbound traffic is allowed.
All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings.
A string identifying the firewall settings version currently used in the CPE, or {{empty}} if the firewall settings are not associated with a version.
The time at which the firewall settings most recently changed.
This object models the CPE's USB Host controllers.
See {{bibref|TR-157|Appendix I}} for Theory of Operation.
Number of entries in the Host table.
Table of CPE USB Host controllers.
Enables or disables the USB Host controller.
User-readable host controller name.
Type of USB Host
Open Host Controller Interface
Enhanced Host Controller Interface
Universal Host Controller Interface
Extensible Host Controller Interface
When set to {{true}}, reset the Host Controller and apply the reset signaling (see {{bibref|USB2.0|Chapter 7.1.7.5}}) to all of the Host Controller Hub downstream ports.
The value is not saved in the device's state and setting it to {{false}} has no effect.
When set to {{true}}, {{param}} enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see {{bibref|USB2.0}}, Chapters 4.3.2, 7.1.7.6, and 11.9).
When set to {{false}} {{param}} immediately disables the Host controller Power Management policy.
USB specification version with which the controller complies. Example: "1.1"
Number of entries in the Device table.
Table of connected USB devices.
Device number on USB bus.
USB specification version with which the device complies. Example: "1.1"
Class Code as assigned by USB-IF.
When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified.
Subclass code (assigned by USB-IF).
Device release number.
Protocol code (assigned by USB-IF).
Product ID (assigned by manufacturer).
Vendor ID (assigned by USB-IF).
Device Manufacturer string descriptor.
Device Product Class string descriptor.
Device SerialNumber string descriptor.
Hub port on parent device.
0 when no parent.
Speed of the USB device. {{enum}}
Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate.
1.5 Mbits/sec (187.5 KB/sec) defined in {{bibref|USB1.0}}
12 Mbits/sec (1.5 MB/sec) defined in {{bibref|USB1.0}}
480 Mbits/sec (60 MB/sec) defined in {{bibref|USB2.0}}
5.0 Gbits/sec (625 MB/sec) defined in {{bibref|USB3.0}}
{{reference}} This is a reference to the parent USB device (e.g. hub device).
Example:
: ''.USBHosts.Host.2.Device.3''
This is {{empty}} for a device connected to the Host controller (root hub).
Number of ports. Only applies for hub device, equal to 0 for other devices.
When {{true}} the associated Device is in a suspended (i.e. low-power) state (see {{bibref|USB2.0|Chapter 11.9}}).
When {{false}} the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see {{bibref|USB2.0|Chapter 9.1.1}}).
When {{true}} the associated device is at least partly powered by a local source (see {{bibref|USB2.0|Chapter 9.4.5}}).
When {{false}} the associated device draws all the current it needs from the USB bus.
Number of entries in the Configuration table.
Table of device configurations.
The identifier for each Device Configuration.
Number of entries in the Interface table.
Table of device interface descriptors.
Number of this interface (from USB interface descriptor).
Class Code as assigned by USB-IF.
When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified.
Subclass code (assigned by USB-IF).
Protocol code (assigned by USB-IF).
This object configures collection of periodic statistics for the device.
Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples.
This object provides a single set of global settings that affect the entire device unless overridden locally.
Minimum sample interval in {{units}} that the CPE is able to support.
A value of 0 indicates no specific minimum sample interval.
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.
Number of entries in SampleSet table.
Periodic statistics sample set table. Each sample set has its own sample interval etc.
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.
Indicates availability of Sample statistics. {{enum}}
The {{enum|Trigger}} value is only used for triggering the ACS to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}].
The transition from {{enum|Enabled}} to {{enum|Trigger}} to {{enum|Enabled}} MUST be instantaneous and so will result in only a single value change for notification purposes.
Collection is disabled.
Collection is enabled.
Collection is enabled and the ACS SHOULD now fetch the collected data.
The name of this sample set, which uniquely distinguishes each sample set.
The sample interval in {{units}}. Each statistic is measured over this sample interval.
The CPE MAY reject a request to set {{param}} to less than {{param|.PeriodicStatistics.MinSampleInterval}}.
Sample intervals MUST begin every {{param}} {{units}}, with no delay between samples.
If {{param}} is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.
For example, if {{param|ReportSamples}} is 24 and {{param}} is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.
The number of samples that the CPE will store and report for each statistic.
The CPE MUST permit {{param}} to be set to at least {{param|.PeriodicStatistics.MaxReportSamples}}.
If {{param}} 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 {{param}} is 24 and {{param|SampleInterval}} is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.
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 {{param|SampleInterval}}.
{{param}} is used only to set the "phase" of the sample and fetch intervals. The actual value of {{param}} can be arbitrarily far into the past or future.
This time reference also determines when the {{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} transitions that are controlled by {{param|FetchSamples}} will occur. If collection of periodic statistics is enabled and {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}] then each such {{param|Status}} transition MUST occur at this reference time plus or minus an integer multiple of {{param|FetchSamples}} * {{param|SampleInterval}} (the fetch interval).
If {{param}} 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 {{bibref|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 {{param}} parameter was set to the Unknown Time value.
For example, if {{param|SampleInterval}} is 3600 (an hour) and if {{param}} 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, {{param|FetchSamples}} is 24, then the fetch interval is 86400 (a day) and {{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} transitions will occur every day at UTC midnight.
Note that, if {{param}} 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 {{param|SampleInterval}}). This is why {{param}} is defined in terms of when sample intervals complete rather than start.
The number of sample intervals to be collected before transitioning {{param|Status}} from {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}}.
If this SampleSet is enabled and {{param}} is in the range [1:{{param|ReportSamples}}] then {{param|Status}} MUST transition from {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} on completion of every {{param}} sample intervals. Otherwise, the transition MUST NOT occur.
For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the CPE will store 25 values for each monitored parameter and the above {{param|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 {{param|ForceSample}}).
To disable this trigger mechanism and still collect sampled statistics, {{param}} can be set to either 0 or a value greater than {{param|ReportSamples}}.
When set to {{true}}, forces statistics for the current sample to be calculated and updated in the data model. Setting it to {{false}} has no effect. {{hidden}}
If this is the first time that {{param}} has been set to {{true}} during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters MUST be updated accordingly.
If this is not the first time that {{param}} has been set to {{true}} during the current sample interval, then the new values that were added as described in the previous paragraph, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters, MUST be updated accordingly.
Note that {{param}} just provides a "sneak preview" of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.
At the end of each sample interval, if {{param}} was set to {{true}} during the sample interval then the new values that were added as described above, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters, will be updated accordingly. In other words, the partial sample data that was created when {{param}} was set to {{true}} will be updated one last time at the end of the sample interval.
The absolute time at which the sample interval for the first stored sample (for each statistic) started.
The absolute time at which the sample interval for the last stored sample (for each statistic) ended.
If {{param|ForceSample}} has been used to force statistics for the current sample to be calculated and updated in the data model, then {{param}} MUST be updated to reflect the actual time over which stored data was collected.
{{list}} Each entry indicates the number of {{units}} during which data was collected during the sample interval.
Individual {{param}} values can be less than {{param|SampleInterval}}, for several reasons, including:
: {{param|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.
: {{param|ForceSample}} has been used to force statistics for the current sample to be calculated and updated in the data model.
Number of entries in Parameter table.
Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled.
Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a "sneak preview" of the current sample), or (c) at the end of the sample interval.
Enables or disables this object instance.
{{reference}} This is the parameter being monitored by the Periodic Statistics mechanism.
Controls how this parameter's value is sampled. {{enum}}
Parameters of non-numeric types can only support {{enum|Current}}. The value of the {{param}} MUST be ignored for such parameters.
Sampled value is current value
Sampled value is change in value since start of sample interval
Controls how this parameter's statistic is calculated from the sampled value(s). {{enum}}
Parameters of non-numeric types can only support {{enum|Latest}}. The value of the {{param}} MUST be ignored for such parameters.
{{param|SampleMode}} MUST be applied before {{param}}, i.e. the inputs to the calculation will have already accounted for {{param|SampleMode}}.
Statistic is sampled value at end of sample interval
Statistic is minimum sampled value during sample interval
Statistic is maximum sampled value during sample interval
Statistic is average (mean) sampled value during sample interval
The low threshold value that controls the calculation of {{param|Failures}}.
A value equal to {{param|HighThreshold}} disables the threshold/failure mechanism.
Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.
The high threshold value that controls the calculation of {{param|Failures}}.
A value equal to {{param|LowThreshold}} disables the threshold/failure mechanism.
Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.
{{list}} Each entry indicates the number of {{units}} during which data was collected for this parameter during the sample interval.
Individual {{param}} values can be less than {{param|.PeriodicStatistics.SampleSet.{i}.SampleInterval}}, for several reasons, including:
: Any of the reasons for which {{param|.PeriodicStatistics.SampleSet.{i}.SampleSeconds}} values might be less than {{param|.PeriodicStatistics.SampleSet.{i}.SampleInterval}}.
: The parameter doesn't exist, or was created or deleted during a sample interval.
{{list}} Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval.
For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set {{param}} to 1.
{{list}} Each entry indicates the value of the referenced parameter, as determined by {{param|SampleMode}}, during the sample interval.
The statistics values in this comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.
If the {{param|SampleMode}} parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.
Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for {{param|SampleMode}}) transitioned from the “in range” state to the “out of range” state, or between the “out of range (low)” and “out of range (high)” states. The states are defined as follows:
* "in range” : current value is greater than {{param|LowThreshold}} and less than {{param|HighThreshold}}.
* "out of range” : current value is less than or equal to {{param|LowThreshold}}, or greater than or equal to {{param|HighThreshold}}.
* "out of range (low)” : current value is less than or equal to {{param|LowThreshold}}.
* "out of range (high)” : current value is greater than or equal to {{param|HighThreshold}}.
Note that, if {{param|LowThreshold}} and {{param|HighThreshold}} are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment.
This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in {{bibref|TR-069a2|Section 3.2.1}}.
Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.
This object contains multicast announcement and query parameters used for the purpose of downloading files.
This object contains multicast announcement parameters used to download files.
Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files.
The status of the announcement service.
MAY be used by the CPE to indicate a locally defined error condition.
Number of entries in the Group table.
Multicast groups to which the CPE SHOULD listen for announcements.
Enable/disable listening to this multicast group.
The status of this group table entry.
MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to parse received announcements.
URL {{bibref|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 {{bibref|DVB-TS.102.824}} for an example of a URL format that identifies a SAP {{bibref|RFC2974}} stream that indicates how to use either FLUTE {{bibref|RFC3926}} or DSM-CC {{bibref|ISO-13818-6:1998}} to perform the download.
This object contains multicast query parameters used to download files.
Enable/disable CPE ability to autonomously query a server for the purpose of downloading files.
The status of the query service.
MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to contact query response server.
URL {{bibref|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 {{bibref|DVB-TS.102.824}} for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS.