TR-181 Issue 1 Amendment 3 (import BulkDataCollection component)
Device:1.10 root data model
A non-volatile handle used to reference this instance.
'''This is intended only for use in protocol-independent "common"
definitions, and MUST NOT be used in protocol-specific definitions.'''
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
{{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}},
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.
IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.
All IPv4 addresses and subnet masks MUST be represented as strings in
IPv4 dotted-decimal notation. Here are some examples of valid IPv4
address textual representations:
* 216.52.29.100
* 192.168.1.254
All IPv6 addresses MUST be represented using any of the 3 standard
textual representations defined in {{bibref|RFC4291}} Sections 2.2.1,
2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but
use of lower-case letters is RECOMMENDED. Here are some examples of valid
IPv6 address textual representations:
* 1080:0:0:800:ba98:3210:11aa:12dd
* 1080::800:ba98:3210:11aa:12dd
* 0:0:0:0:0:0:13.1.68.3
IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are
discussed in {{bibref|RFC4007|Section 6}}.
Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be
represented as empty strings unless otherwise specified by the parameter
definition.
All MAC addresses are represented as strings of 12 hexadecimal digits
(digits 0-9, letters A-F or a-f) displayed as six pairs of digits
separated by colons. Unspecified or inapplicable MAC addresses MUST be
represented as empty strings unless otherwise specified by the parameter
definition.
3GPP TS 23.107
Quality of Service (QoS) concept and architecture
3GPP SA WG2
https://www.3gpp.org/ftp/Specs/html-info/23107.htm
3GPP TS 25.171
Requirements for support of Assisted Global Positioning System (A-GPS)
3GPP RAN WG4
https://www.3gpp.org/ftp/Specs/html-info/25171.htm
3GPP TS 32.582
Telecommunications management; Home Node B (HNB) Operations,
Administration, Maintenance and Provisioning (OAM&P); Information
model for Type 1 interface HNB to HNB Management System (HMS)
3GPP SA WG5
https://www.3gpp.org/ftp/Specs/html-info/32582.htm
3GPP TS 32.584
Telecommunications management; Home Node B (HNB) Operations,
Administration, Maintenance and Provisioning (OAM&P); XML
definitions for Type 1 interface HNB to HNB Management Systems (HMS)
3GPP SA WG5
https://www.3gpp.org/ftp/Specs/html-info/32584.htm
3GPP TS 32.592
Telecommunications management; Home enhanced Node B (HeNB) Operations,
Administration, Maintenance and Provisioning (OAM&P); Information
model for Type 1 interface HeNB to HeNB Management System (HeMS)
3GPP SA WG5
https://www.3gpp.org/ftp/Specs/html-info/32592.htm
S.S0132-0 v1.0
Femtocell Security Framework
3GPP2
January 2010
https://www.3gpp2.org/Public_html/Specs/S.S0132-0_v1.0_Femtocell_Security_Framework.pdf
X.S0011-005-C
cdma2000 Wireless IP Network Standard: Accounting Services and 3GPP2
RADIUS VSAs
3GPP2
August 2003
https://www.3gpp2.org/Public_html/Specs/X.S0011-005-C_v1.0_110703.pdf
Organizationally Unique Identifiers (OUIs)
https://standards.ieee.org/faqs/regauth
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
IEEE
March 1997
https://standards.ieee.org/regauth/oui/tutorials/EUI64.html
TS 102 824
Digital Video Broadcasting (DVB);Remote Management and Firmware Update
System for DVB IP Services
ETSI
July 2008
https://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769
http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769
ITU X.733
Information technology - Open Systems Interconnection - Systems
Management: Alarm reporting function
International Telecommunication Union
February 1992
https://www.itu.int/rec/T-REC-X.733/en
IANA Uniform Resource Identifier (URI) Schemes Registry
Uniform Resource Identifier (URI) Schemes
IANA
https://www.iana.org/assignments/uri-schemes
ISO/IEC 13818-6:1998
Information Technology - Generic coding of moving pictures and
associated audio information - Part 6: Extensions for DSM-CC
ISO
1998
https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039
http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039
RFC 793
Transmission Control Protocol
IETF
RFC
September 1981
https://www.rfc-editor.org/rfc/rfc793
http://www.ietf.org/rfc/rfc793.txt
RFC 862
Echo Protocol
IETF
RFC
1983
https://www.rfc-editor.org/rfc/rfc862
RFC 959
File Transfer Protocol
IETF
RFC
1985
https://www.rfc-editor.org/rfc/rfc958
RFC 1323
TCP Extensions for High Performance
IETF
RFC
May 1992
https://www.rfc-editor.org/rfc/rfc1323
http://www.ietf.org/rfc/rfc1323.txt
RFC 2581
TCP Congestion Control
IETF
RFC
April 1999
https://www.rfc-editor.org/rfc/rfc2581
http://www.ietf.org/rfc/rfc2581.txt
RFC 2582
The NewReno Modification to TCP's Fast Recovery Algorithm
IETF
RFC
April 1999
https://www.rfc-editor.org/rfc/rfc2582
http://www.ietf.org/rfc/rfc2582.txt
RFC 2616
Hypertext Transfer Protocol - HTTP/1.1
IETF
RFC
1999
https://www.rfc-editor.org/rfc/rfc2616
RFC 2818
HTTP Over TLS
IETF
RFC
May 2000
https://www.rfc-editor.org/rfc/rfc2818
http://www.ietf.org/rfc/rfc2818.txt
RFC 2974
Session Announcement Protocol
IETF
RFC
October 2000
https://www.rfc-editor.org/rfc/rfc2974
http://www.ietf.org/rfc/rfc2974.txt
RFC 3066
Tags for the Identification of Languages
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3066
RFC 3489
STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network
Address Translators (NATs)
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3489
RFC 3926
FLUTE - File Delivery over Unidirectional Transport
IETF
RFC
October 2004
https://www.rfc-editor.org/rfc/rfc3926
http://www.ietf.org/rfc/rfc3926.txt
RFC 3986
Uniform Resource Identifier (URI): Generic Syntax
IETF
RFC
https://www.rfc-editor.org/rfc/rfc3986
RFC 4007
IPv6 Scoped Address Architecture
IETF
RFC
https://www.rfc-editor.org/rfc/rfc4007
RFC 4122
A Universally Unique IDentifier (UUID) URN Namespace
IETF
RFC
2005
https://www.rfc-editor.org/rfc/rfc4122
http://www.ietf.org/rfc/rfc4122.txt
RFC 4291
IP Version 6 Addressing Architecture
IETF
RFC
2006
https://www.rfc-editor.org/rfc/rfc4291
RFC 4301
Security Architecture for the Internet Protocol
IETF
December 2005
https://www.rfc-editor.org/rfc/rfc4301
RFC 4307
Cryptographic Algorithms for Use in the Internet Key Exchange Version 2
(IKEv2)
IETF
December 2005
https://www.rfc-editor.org/rfc/rfc4307
RFC 4632
Classless Inter-domain Routing (CIDR): The Internet Address Assignment
and Aggregation Plan
IETF
2006
https://www.rfc-editor.org/rfc/rfc4632
RFC 4835
Cryptographic Algorithm Implementation Requirements for Encapsulating
Security Payload (ESP) and Authentication Header (AH)
IETF
RFC
2007
https://www.rfc-editor.org/rfc/rfc4835
RFC 5139
Revised Civic Location Format For Presence Information Data Format
Location Object (PIDF-LO)
IETF
February 2008
https://www.rfc-editor.org/rfc/rfc5139
RFC 5280
Internet X.509 Public Key Infrastructure Certificate and Certificate
Revocation List (CRL) Profile
IETF
May 2008
https://www.rfc-editor.org/rfc/rfc5280
RFC 5491
GEOPRIV Presence Information Data Format Location Object (PIDF-LO)
Usage Clarification, Considerations, and Recommendations
IETF
March 2009
https://www.rfc-editor.org/rfc/rfc5491
RFC7159
The JavaScript Object Notation (JSON) Data Interchange Format
IETF
RFC
March 2014
https://www.rfc-editor.org/rfc/rfc7159
RFC 7230
Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
IETF
RFC
June 2014
https://www.rfc-editor.org/rfc/rfc7230
RFC 7252
The Constrained Application Protocol (CoAP)
IETF
RFC
June 2014
https://www.rfc-editor.org/rfc/rfc7252
RFC 8141
Uniform Resource Names (URNs)
IETF
RFC
April 2017
https://www.rfc-editor.org/rfc/rfc8141
TR-069 Amendment 2
CPE WAN Management Protocol
Broadband Forum
TR
December 2007
TR-069 Amendment 3
CPE WAN Management Protocol
Broadband Forum
TR
November 2010
TR-069 Amendment 4
CPE WAN Management Protocol
Broadband Forum
TR
July 2011
TR-069 Amendment 6
CPE WAN Management Protocol
Broadband Forum
TR
April 2018
TR-098 Amendment 2
Internet Gateway Device Data Model for TR-069
Broadband Forum
TR
September 2008
TR-098 Amendment 2 Corrigendum 1
Internet Gateway Device Data Model for TR-069
Broadband Forum
TR
December 2014
TR-106 Amendment 2
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
November 2008
TR-106 Amendment 3
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
September 2009
TR-106 Amendment 4
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
February 2010
http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf
TR-106 Amendment 6
Data Model Template for TR-069-Enabled Devices
Broadband Forum
TR
July 2011
TR-106 Amendment 8
Data Model Template for CWMP Endpoints and USP Agents
Broadband Forum
TR
May 2018
TR-143 Amendment 1 Corrigendum 1
Enabling Network Throughput Performance Tests and Statistical
Monitoring
Broadband Forum
TR
August 2015
TR-157 Amendment 3
Component Objects for CWMP
Broadband Forum
TR
November 2010
http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf
TR-157 Amendment 5
Component Objects for CWMP
Broadband Forum
TR
November 2011
TR-157 Amendment 10
Component Objects for CWMP
Broadband Forum
TR
November 2015
TR-181 Issue 1
Device Data Model for TR-069
Broadband Forum
TR
February 2010
TR-181 Issue 2 Amendment 15
Device Data Model
Broadband Forum
TR
January 2022
TR-196 Issue 2
Femto Access Point Service Data Model
Broadband Forum
TR
November 2011
TR-232
Bulk Data Collection
Broadband Forum
Technical Report
May 2012
TR-262
Femto Component Objects
Broadband Forum
TR
November 2011
DLNA Networked Device Interoperability Guidelines
DLNA Networked Device Interoperability Guidelines, Volume 2: Media
Format Profiles.
DLNA
October 2006
https://www.dlna.org/industry/certification/guidelines/
http://www.dlna.org/industry/certification/guidelines/
ICSA Baseline Modular Firewall Certification Criteria
Baseline module - version 4.1
ICSA Labs
2008
https://www.icsalabs.com/sites/default/files/baseline.pdf
http://www.icsalabs.com/sites/default/files/baseline.pdf
ICSA Residential Modular Firewall Certification Criteria
Required Services Security Policy - Residential Category module -
version 4.1
ICSA Labs
2008
https://www.icsalabs.com/sites/default/files/residential.pdf
http://www.icsalabs.com/sites/default/files/residential.pdf
IPDR File Transfer Protocol
IPDR/File Transfer Protocol
TM Forum
https://www.ipdr.org/public/
http://www.ipdr.org/public/
IPDR Streaming Protocol
IPDR Streaming Protocol (IPDR/SP) Specification
TM Forum
https://www.ipdr.org/public/
http://www.ipdr.org/public/
IPDR XDR Encoding Format
IPDR/XDR Encoding Format
TM Forum
https://www.ipdr.org/public/
http://www.ipdr.org/public/
IPDR XML File Encoding Format
IPDR/XML File Encoding Format
TM Forum
https://www.ipdr.org/public/
http://www.ipdr.org/public/
Simple Object Access Protocol (SOAP) 1.1
W3C
https://www.w3.org/TR/2000/NOTE-SOAP-20000508
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
http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf
UPnP Device Management:1
UPnP Device Management v1
https://openconnectivity.org/developer/specifications/upnp-resources/upnp/device-management1-2
USB 1.0
USB 1.0 Specification
USB-IF
January 1996
https://www.usb.org/documents
http://www.usb.org/developers/docs/
USB 2.0
USB 2.0 Specification
USB-IF
April 2000
https://www.usb.org/documents
http://www.usb.org/developers/docs/usb_20_122208.zip
USB 3.0
USB 3.0 Specification
USB-IF
November 2008
https://www.usb.org/documents
http://www.usb.org/developers/docs/usb_30_spec.zip
Z-Wave
Z-Wave website
https://www.z-wave.com
ZigBee
ZigBee Alliance website
https://csa-iot.org/all-solutions/zigbee
ZigBee 2007 Specification
ZigBee 2007 Specification
ZigBee Alliance
October 2007
https://csa-iot.org/all-solutions/zigbee
The top-level object for a Device.
See {{bibref|TR-106|section 3.7}}.
This parameter is DEPRECATED because
{{object|DeviceInfo.SupportedDataModel}} and associated Device Type
XML documents (DT Instances) provide a more granular and scalable way
of describing the device's data model. Therefore its value MAY be
{{empty}} if (and only if) {{object|DeviceInfo.SupportedDataModel}}
is supported.
{{numentries}}
{{numentries}}
This object contains general services information.
This object contains general device information.
The manufacturer of the CPE (human readable string).
Organizationally unique identifier of the device manufacturer.
Represented as a six hexadecimal-digit value using all upper-case
letters and including any leading zeros. The value MUST be a valid
OUI as defined in {{bibref|OUI}}.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
Any change would indicate that it's a new device and would therefore
require a BOOTSTRAP Inform.
Model name of the CPE (human readable string).
A full description of the CPE device (human readable string).
Identifier of the class of product for which the serial number
applies. That is, for a given manufacturer, this parameter is used to
identify the product or class of product over which the
{{param|SerialNumber}} parameter is unique.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
Any change would indicate that it's a new device and would therefore
require a BOOTSTRAP Inform.
Serial number of the CPE.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
Any change would indicate that it's a new device and would therefore
require a BOOTSTRAP Inform.
A string identifying the particular CPE model and version.
A string identifying the software version currently installed in the
CPE. To allow version comparisons, this element SHOULD be in the form
of dot-delimited integers, where each successive integer represents a
more minor category of variation. For example, ''3.0.21'' where the
components mean: ''Major.Minor.Build''.
This parameter is DEPRECATED because the "voucher mechanism", as
defined in {{bibref|TR-069a3|Annex C}} is deprecated in favor of the
"Software Module Management mechanism" as described in
{{bibref|TR-157a3|Appendix II}}. {{list}} The OptionName of each is
identical to the OptionName element of the OptionStruct described in
{{bibref|TR-069a3}}. Only those options are listed whose State
indicates the option is enabled.
A comma-separated list of any additional versions. Represents any
additional hardware version information the vendor might wish to
supply.
A comma-separated list of any additional versions. Represents any
additional software version information the vendor might wish to
supply.
Identifier of the primary service provider and other provisioning
information, which MAY be used by the ACS to determine service
provider-specific customization and provisioning parameters.
Current operational status of the device.
Time in seconds since the CPE was last restarted.
Date and time in UTC that the CPE first both successfully established
an IP-layer network connection and acquired an absolute time
reference using NTP or equivalent over that network connection. The
CPE MAY reset this date after a factory reset.
If NTP or equivalent is not available, this parameter, if present,
SHOULD be set to the Unknown Time value.
Vendor-specific log(s).
{{numentries}}
The number of entries in the {{object|VendorConfigFile}} table.
{{numentries}}
{{numentries}}
{{numentries}}
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.
{{numentries}} Since a Process can come and go very quickly, the CPE
SHOULD place a locally specified limit on the frequency at which it
will notify the ACS of value changes, as described in
{{bibref|TR-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.
{{numentries}}
This object represents information that the device has obtained via
sampling an internal temperature sensor.
{{datatype|expand}}
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.
A change to this value will cause {{param|LowAlarmTime}} to be reset.
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.
A change to this value will cause {{param|HighAlarmTime}} to be
reset.
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.
The interval, measured in {{units}}, in which the device polls this
{{object}}. If the value is 0 then the device selects its own polling
interval. If the value is greater than 0 then the device MUST use
this value as the polling interval.
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 table contains details of the device's Current Supported Data
Model. The table MUST describe the device's entire Supported Data
Model. Therefore, if a device's Supported Data Model changes at
run-time, entries will need to be added or removed as appropriate. Each
table entry MUST refer to only a single Root Object or Service Object.
The device MAY choose to use more than one table entry for a given Root
Object or Service Object. Considering that every device has some form
of a data model, this table MUST NOT be empty.
{{datatype|expand}}
URL ({{bibref|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 {{bibref|TR-106a3|Annex B}}, including
any additional normative requirements referenced within the Schema.
The XML file referenced by this URL MUST NOT change while the CPE is
running, and SHOULD NOT change across a CPE reboot. Note that, if the
same XML file is to be used for multiple CPE, this strongly suggests
that the XML file referenced by this URL should ''never'' change. The
URL MAY permit the XML file to be accessed at run-time, in which
case, the XML file MAY be located within the CPE. Behavior in the
event of an invalid URL, failure to access the referenced XML file,
or an invalid XML file, is implementation-dependent.
URN ({{bibref|RFC3986}}) that is the value of the spec attribute in
the DM (data model) Instance that defines the Root Object or Service
Object referenced by this table entry. For example, if this table
entry references a DT Instance that refers to the ''Device: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''.
This parameter MUST list exactly the features that are defined using
the top-level ''feature'' element in the DT Instance referenced by
{{param|URL}}. For example, if the DT instance specified the
following:
:<feature name="DNSServer"/>
:<feature name="Router"/>
:<feature name="X_MyDeviceFeature"/> then the value of this
parameter might be ''DNSServer,Router,X_MyDeviceFeature''. The order
in which the features are listed is not significant.
Every instance of this object is a Vendor Configuration File, and
contains parameters associated with the Vendor Configuration File. This
table of Vendor Configuration Files is for information only and does
not allow the ACS to operate on these files in any way. Whenever the
CPE successfully downloads a configuration file as a result of the
Download RPC with the FileType argument of ''3 Vendor Configuration
File'', the CPE MUST update this table. If the name of the file
(determined as described in the definition of the {{param|Name}}
parameter) differs from that of any existing instance, then the CPE
MUST create a new instance to represent this file. If instead, the name
of the file is identical to that of an existing instance, then the CPE
MUST update the content of the existing instance with the new version,
date, and (optionally) description of the file.{{nokeys}}
Name of the vendor configuration file. If the CPE is able to obtain
the name of the configuration file from the file itself, then the
value of this parameter MUST be set to that name. Otherwise, if the
CPE can extract the file name from the URL used to download the
configuration file, then the value of this parameter MUST be set to
that name. Otherwise, the value of this parameter MUST be set to the
value of the TargetFileName argument of the Download RPC used to
download this configuration file.
A string identifying the configuration file version currently used in
the CPE. If the CPE is able to obtain the version of the
configuration file from the file itself, then the value of this
parameter MUST be set to the obtained value. Otherwise, the value of
this parameter MUST be {{empty}}.
Date and time when the content of the current version of this vendor
configuration file was first applied by the CPE.
A description of the vendor configuration file (human-readable
string).
{{datatype|expand}}
Each table entry represents a hardware or virtual processor that
resides on this device.
{{datatype|expand}}
The architecture of the processor on the underlying hardware.
{{enum}} For processor architectures not included in this list, the
vendor MAY include vendor-specific values, which MUST use the format
defined in {{bibref|TR-106a4|Section 3.3}}.
big-endian
little-endian
big-endian
little-endian
Each table entry represents a Vendor Log File. This table of log files
is informational only and does not allow the ACS to operate on these
files in any way.
{{datatype|expand}}
Name of the log file. Typically this will be the full file system
path, but provided that it is guaranteed to be unique across current
and future log files, it MAY be a shorter name derived from the file
system path, or be derived via another mechanism.
The maximum size of the log file in {{units}}. If the device doesn’t
know the maximum file size then {{param}} will be 0.
When {{true}}, the log file contents are preserved across a device
reboot. When {{false}}, the log file contents will be purged when the
device is rebooted.
Represents the associated CPE Proxier for a Proxied Device that
utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069a4|Annex
J.1.1}}.
Organizationally unique identifier of the associated CPE Proxier.
Represented as a six hexadecimal-digit value using all upper-case
letters and including any leading zeros. {{pattern}} The value MUST
be a valid OUI as defined in {{bibref|OUI}}.
Identifier of the class of product of the associated CPE Proxier for
which the serial number applies. {{empty}} indicates either that the
CPE Proxier does not use a product class to differentiate its serial
number.
Serial number of the associated CPE Proxier.
The protocol being used to communicate between the CPE Proxier and
this Proxied Device. {{enum}} Vendors can extend the enumerated
values with vendor specific extensions, in which case the rules
outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to.
see {{bibref|Z-Wave}}
see {{bibref|ZigBee}}
see {{bibref|UPnP-DM:1}}
This object contains Location information.
Identifies the source of the location data.
The time when the location was acquired.
URL, MAC address, or other identifier that identifies an "External"
source of this location. Meaningful only if {{param|Source}} has a
value of {{enum|External|Source}}, otherwise it MUST be {{empty}}. If
{{param|ExternalProtocol}} has a value of
{{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the
ACS.
Protocol used to acquire a location from an "External" source.
{{enum}} Meaningful only if {{param|Source}} has a value of
{{enum|External|Source}}, otherwise it MUST be {{empty}}.
{{empty}}
The currently valid location information. Writable only when
{{param|ExternalProtocol}} has a value of
{{enum|CWMP|ExternalProtocol}}. If obtained through the local
GPS/AGPS then the location information is formatted according to
{{bibref|RFC5491}}.
If manually configured then location information will be
XML-formatted according to {{bibref|RFC5491}} (geographical
information) and {{bibref|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 {{bibref|RFC5491}} (geographical
information) and {{bibref|RFC5139}} (civic addresses). Only zero or
one Location object instance with value
{{enum|CWMP|ExternalProtocol}} MUST exist at any given time.
This object contains parameters relating to the CPE's association with
an ACS.
Enables and disables the CPE's support for CWMP. {{false}} means that
CWMP support in the CPE is disabled, in which case the device MUST
NOT send any Inform messages to the ACS or accept any Connection
Request notifications from the ACS. {{true}} means that CWMP support
on the CPE is enabled. The subscriber can re-enable the CPE's CWMP
support either by performing a factory reset or by using a LAN-side
protocol to change the value of this parameter back to {{true}}.
URL, as defined in {{bibref|RFC3986}}, for the CPE to connect to the
ACS using the CPE WAN Management Protocol. This parameter MUST be in
the form of a valid HTTP or HTTPS URL. The ''host'' portion of this
URL is used by the CPE for validating the ACS certificate when using
SSL or TLS. Note that on a factory reset of the CPE, the value of
this parameter might be reset to its factory value. If an ACS
modifies the value of this parameter, it SHOULD be prepared to
accommodate the situation that the original value is restored as the
result of a factory reset.
Username used to authenticate the CPE when making a connection to the
ACS using the CPE WAN Management Protocol. This username is used only
for HTTP-based authentication of the CPE.
Note that on a factory reset of the CPE, the value of this parameter
might be reset to its factory value. If an ACS modifies the value of
this parameter, it SHOULD be prepared to accommodate the situation
that the original value is restored as the result of a factory reset.
Password used to authenticate the CPE when making a connection to the
ACS using the CPE WAN Management Protocol. This password is used only
for HTTP-based authentication of the CPE. When read, this parameter
returns {{empty}}, regardless of the actual value.
Note that on a factory reset of the CPE, the value of this parameter
might be reset to its factory value. If an ACS modifies the value of
this parameter, it SHOULD be prepared to accommodate the situation
that the original value is restored as the result of a factory reset.
Whether or not the CPE MUST periodically send CPE information to the
ACS using the Inform method call.
The duration in seconds of the interval for which the CPE MUST
attempt to connect with the ACS and call the Inform method if
{{param|PeriodicInformEnable}} is {{true}}.
An absolute time reference in UTC to determine when the CPE will
initiate the periodic Inform method calls. Each Inform call MUST
occur at this reference time plus or minus an integer multiple of the
{{param|PeriodicInformInterval}}. {{param}} is used only to set the
''phase'' of the periodic Informs. The actual value of {{param}} can
be arbitrarily far into the past or future. For example, if
{{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} is
set to UTC midnight on some day (in the past, present, or future)
then periodic Informs will occur every day at UTC midnight. These
MUST begin on the very next midnight, even if {{param}} refers to a
day in the future. The Unknown Time value defined in
{{bibref|TR-106a2|section 3.2}} indicates that no particular time
reference is specified. That is, the CPE MAY locally choose the time
reference, and needs only to adhere to the specified
{{param|PeriodicInformInterval}}. If absolute time is not available
to the CPE, its periodic Inform behavior MUST be the same as if the
{{param}} parameter was set to the Unknown Time value.
{{param}} provides the ACS a reliable and extensible means to track
changes made by the ACS. The value of {{param}} MUST be equal to the
value of the ParameterKey argument from the most recent successful
SetParameterValues, AddObject, or DeleteObject method call from the
ACS. The CPE MUST set {{param}} to the value specified in the
corresponding method arguments if and only if the method completes
successfully and no fault response is generated. If a method call
does not complete successfully (implying that the changes requested
in the method did not take effect), the value of {{param}} MUST NOT
be modified. The CPE MUST only modify the value of {{param}} as a
result of SetParameterValues, AddObject, DeleteObject, or due to a
factory reset. On factory reset, the value of {{param}} MUST be set
to {{empty}}.
HTTP URL, as defined in {{bibref|RFC3986}}, for an ACS to make a
Connection Request notification to the CPE. In the form:
: http://host:port/path The ''host'' portion of the URL MAY be the IP
address for the management interface of the CPE in lieu of a host
name.
Username used to authenticate an ACS making a Connection Request to
the CPE.
Password used to authenticate an ACS making a Connection Request to
the CPE. When read, this parameter returns {{empty}}, regardless of
the actual value.
Indicates whether or not the ACS will manage upgrades for the CPE. If
{{true}}, the CPE SHOULD NOT use other means other than the ACS to
seek out available upgrades. If {{false}}, the CPE MAY use other
means for this purpose. Note that an autonomous upgrade (reported via
an "10 AUTONOMOUS TRANSFER COMPLETE" Inform Event code) SHOULD be
regarded as a managed upgrade if it is performed according to
ACS-specified policy.
Present only for a CPE that supports the Kicked RPC method.
LAN-accessible URL, as defined in {{bibref|RFC3986}}, from which the
CPE can be ''kicked'' to initiate the Kicked RPC method call. MUST be
an absolute URL including a host name or IP address as would be used
on the LAN side of the CPE.
Present only for a CPE that provides a LAN-side web page to show
progress during a file download. LAN-accessible URL, as defined in
{{bibref|RFC3986}}, to which a web-server associated with the ACS MAY
redirect a user's browser on initiation of a file download to
observer the status of the download.
This parameter is used to control throttling of active notifications
sent by the CPE to the ACS. It defines the minimum number of seconds
that the CPE MUST wait since the end of the last session with the ACS
before establishing a new session for the purpose of delivering an
active notification. In other words, if CPE needs to establish a new
session with the ACS for the sole purpose of delivering an active
notification, it MUST delay establishing such a session as needed to
ensure that the minimum time since the last session completion has
been met. The time is counted since the last successfully completed
session, regardless of whether or not it was used for active
notifications or other purposes. However, if connection to the ACS is
established for purposes other than just delivering active
notifications, including for the purpose of retrying a failed
session, such connection MUST NOT be delayed based on this parameter
value, and the pending active notifications MUST be communicated
during that connection. The time of the last session completion does
not need to be tracked across reboots.
Address and port to which an ACS MAY send a UDP Connection Request to
the CPE (see {{bibref|TR-069a2|Annex G}}). This parameter is
represented in the form of an Authority element as defined in
{{bibref|RFC3986}}. The value MUST be in one of the following two
forms:
: host:port
: host
* When {{param|STUNEnable}} is {{true}}, the ''host'' and ''port''
portions of this parameter MUST represent the public address and
port corresponding to the NAT binding through which the ACS can
send UDP Connection Request messages (once this information is
learned by the CPE through the use of STUN).
* When {{param|STUNEnable}} is {{false}}, the ''host'' and ''port''
portions of the URL MUST represent the local IP address and port on
which the CPE is listening for UDP Connection Request messages. The
second form of this parameter MAY be used only if the port value is
equal to ''80''.
The minimum time, in seconds, between Active Notifications resulting
from changes to the {{param|UDPConnectionRequestAddress}} (if Active
Notification is enabled).
Enables or disables the use of STUN by the CPE. This applies only to
the use of STUN in association with the ACS to allow UDP Connection
Requests.
Host name or IP address of the STUN server for the CPE to send
Binding Requests if STUN is enabled via {{param|STUNEnable}}. If is
{{empty}} and {{param|STUNEnable}} is {{true}}, the CPE MUST use the
address of the ACS extracted from the host portion of the ACS URL.
Port number of the STUN server for the CPE to send Binding Requests
if STUN is enabled via {{param|STUNEnable}}. By default, this SHOULD
be the equal to the default STUN port, 3478.
If is not {{empty}}, the value of the STUN USERNAME attribute to be
used in Binding Requests (only if message integrity has been
requested by the STUN server). If is {{empty}}, the CPE MUST NOT send
STUN Binding Requests with message integrity.
The value of the STUN Password to be used in computing the
MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if
message integrity has been requested by the STUN server). When read,
this parameter returns {{empty}}, regardless of the actual value.
If STUN Is enabled, the maximum period, in seconds, that STUN Binding
Requests MUST be sent by the CPE for the purpose of maintaining the
binding in the Gateway. This applies specifically to Binding Requests
sent from the UDP Connection Request address and port. A value of -1
indicates that no maximum period is specified.
If STUN Is enabled, the minimum period, in seconds, that STUN Binding
Requests can be sent by the CPE for the purpose of maintaining the
binding in the Gateway. This limit applies only to Binding Requests
sent from the UDP Connection Request address and port, and only those
that do not contain the BINDING-CHANGE attribute. This limit does not
apply to retransmissions following the procedures defined in
{{bibref|RFC3489}}.
When STUN is enabled, this parameter indicates whether or not the CPE
has detected address and/or port mapping in use. A {{true}} value
indicates that the received MAPPED-ADDRESS in the most recent Binding
Response differs from the CPE's source address and port. When
{{param|STUNEnable}} is {{false}}, this value MUST be {{false}}.
Indicates whether or not the Alias-Based Addressing Mechanism is
supported. A {{true}} value indicates that the CPE supports the
Alias-Based Addressing Mechanism, as defined in
{{bibref|TR-069a4|3.6.1}} and described in {{bibref|TR-069a4|Appendix
II}}.
Configures the first session retry wait interval, in seconds, as
specified in {{bibref|TR-069a2|section 3.2.1.1}}. A value of 5
corresponds to the default behavior that is described in
{{bibref|TR-069a2}}. The device MUST use a random value between
{{param}} and ({{param}} * {{param|CWMPRetryIntervalMultiplier}} /
1000) as the first retry wait interval. Other values in the retry
pattern MUST be calculated using this value as a starting point.
Configures the retry interval multiplier as specified in
{{bibref|TR-069a2|section 3.2.1.1}}. This value is expressed in units
of 0.001. Hence the values of the multiplier range between 1.000 and
65.535. A value of 2000 corresponds to the default behavior that is
described in {{bibref|TR-069a2}}. The device MUST use a random value
between {{param|CWMPRetryMinimumWaitInterval}} and
({{param|CWMPRetryMinimumWaitInterval}} * {{param}} / 1000) as the
first retry wait interval. Other values in the retry pattern MUST be
calculated using this value as a starting point.
Instance identification mode as defined in {{bibref|TR-069a4|3.6.1}}.
When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by
the ACS to control whether the CPE will use Instance Numbers or
Instance Aliases in returned Path Names. {{enum}} This parameter is
REQUIRED for any CPE supporting Alias-Based Addressing.
Enable or disable the Auto-Create Instance Mechanism. When
{{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates
whether or not the CPE will automatically create instances while
processing a SetParameterValues RPC (as defined in
{{bibref|TR-069a4|A.3.2.1}}).
*A {{true}} value indicates that the CPE will perform auto-creation
of instances when the Alias-Based Addressing Mechanism is used in
SetParameterValues RPC.
*A {{false}} value indicates that the CPE will not create new object
instances. Instead, it will reject the setting of parameters in
unrecognized instances and respond with a fault code. This parameter
is REQUIRED for any CPE supporting Alias-Based Addressing.
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
Indicates the transfer results that MUST be included when the CPE
notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer
results omitted from this list MUST NOT be included when the CPE
notifies the ACS. Note that this includes any backup or restore
operations that were not specifically requested by the ACS. A backup
is regarded as an Upload and a restore is regarded as a Download.
The autonomous file transfer completed successfully; i.e., the
FaultCode was zero
The autonomous file transfer did not complete successfully;
i.e., the FaultCode was non-zero
Success and Failure
{{list}} Indicates the file types that MUST be included when the CPE
notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types
omitted from this list MUST NOT be included when the CPE notifies the
ACS. {{pattern}} Additionally, the following format is defined to
allow the unique definition of vendor-specific file types:
* ''"X <OUI> <Vendor-specific identifier>"'' <OUI>
is replaced by a 6 hexadecimal-digit OUI (organizationally unique
identifier) as defined in {{bibref|OUI}}, with all upper-case
letters and any leading zeros included. The OUI used for a given
vendor-specific file type MUST be one that is assigned to the
organization that defined this file type (which is not necessarily
the same as the vendor of the CPE or ACS). Note that {{empty}}
indicates that all file types are excluded from this filter,
effectively disabling CPE notification of AUTONOMOUS TRANSFER
COMPLETE events to the ACS.
Download Only
Download Only
Download or Upload
Upload Only
For Vendor-Specific File Types, could be for either Download or
Upload
This object allows configuration of CPE policy for notification of "12
AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in
{{bibref|TR-069a3}}. The CPE policy determines the conditions under
which the CPE notifies the ACS of the completion of Deployment Unit
state changes that were not specifically requested via CWMP.
Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE
COMPLETE" events to the ACS.
Indicates the Deployment Unit operations that MUST be included when
the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE"
events. Operation types not indicated by this list MUST NOT be
included when the CPE notifies the ACS. {{empty}} is essentially the
same as setting {{param|Enable}} to {{false}}.
Indicates the Deployment Unit state change results that MUST be
included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE
CHANGE COMPLETE" events. State change results omitted from this
filter MUST NOT be included when the CPE notifies the ACS.
The autonomous state change completed successfully; i.e., the
FaultCode was zero
The autonomous state change did not complete successfully;
i.e., the FaultCode was non-zero
All result types independent of Success or Failure
Indicates the Deployment Unit state change fault codes that MUST be
included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE
CHANGE COMPLETE" events. State change fault codes omitted from this
filter MUST NOT be included when the CPE notifies the ACS. This
filter has no effect on the notification of a successful autonomous
state change. This filter only applies when
{{param|ResultTypeFilter}} is set to either
{{enum|Failure|ResultTypeFilter}} or {{enum|Both|ResultTypeFilter}}.
{{empty}} means that failed autonomous state changes will not be sent
to the ACS.
This object contains information associated with a connected Internet
Gateway Device.
Organizationally unique identifier of the associated Internet Gateway
Device. {{empty}} indicates that there is no associated Internet
Gateway Device that has been detected.
Identifier of the product class of the associated Internet Gateway
Device. {{empty}} indicates either that there is no associated
Internet Gateway Device that has been detected, or the Internet
Gateway Device does not support the use of the product-class
parameter.
Serial number of the associated Internet Gateway Device. {{empty}}
indicates that there is no associated Internet Gateway Device that
has been detected.
This object contains general configuration parameters.
Arbitrary user data that MUST persist across CPE reboots.
A dump of the currently running configuration on the CPE. This
parameter enables the ability to backup and restore the last known
good state of the CPE. It returns a vendor-specific document that
defines the state of the CPE. The document MUST be capable of
restoring the CPE's state when written back to the CPE using
SetParameterValues.
An alternative to this parameter, e.g. when the configuration file is
larger than the parameter size limit, is to use the Upload and
Download RPCs with a FileType of ''1 Vendor Configuration File''.
This object contains parameters relating an NTP or SNTP time client in
the CPE.
Enables or disables the NTP or SNTP time client.
First NTP timeserver. Either a host name or IP address.
Second NTP timeserver. Either a host name or IP address.
Third NTP timeserver. Either a host name or IP address.
Fourth NTP timeserver. Either a host name or IP address.
Fifth NTP timeserver. Either a host name or IP address.
The current date and time in the CPE's local time zone.
The local time zone definition, encoded according to IEEE 1003.1
(POSIX). The following is an example value:
: EST+5 EDT,M4.1.0/2,M10.5.0/2
Status of Time support on the CPE. {{enum}} The
{{enum|Unsynchronized}} value indicates that the CPE's absolute time
has not yet been set. The {{enum|Synchronized}} value indicates that
the CPE has acquired accurate absolute time; its current time is
accurate. The {{enum|Error_FailedToSynchronize}} value indicates that
the CPE failed to acquire accurate absolute time; its current time is
not accurate. The {{enum|Error}} value MAY be used by the CPE to
indicate a locally defined error condition.
This object contains parameters relating to the user interface of the
CPE.
Present only if the CPE provides a password-protected LAN-side user
interface. Indicates whether or not the local user interface MUST
require a password to be chosen by the user. If {{false}}, the choice
of whether or not a password is used is left to the user.
Present only if the CPE provides a password-protected LAN-side user
interface and supports LAN-side Auto-Configuration. Indicates whether
or not a password to protect the local user interface of the CPE MAY
be selected by the user directly, or MUST be equal to the password
used by the LAN-side Auto-Configuration protocol.
Indicates that a CPE upgrade is available, allowing the CPE to
display this information to the user.
Indicates the date and time in UTC that the warranty associated with
the CPE is to expire.
The name of the customer's ISP.
The help desk phone number of the ISP.
The URL of the ISP's home page.
The URL of the ISP's on-line support page.
Base64 encoded GIF or JPEG image. The binary image is constrained to
4095 bytes or less.
Un-encoded binary image size in bytes. If ISPLogoSize input value is
0 then the ISPLogo is cleared. ISPLogoSize can also be used as a
check to verify correct transfer and conversion of Base64 string to
image size.
The URL of the ISP's mail server.
The URL of the ISP's news server.
The color of text on the GUI screens in RGB hexidecimal notation
(e.g., FF0088).
The color of the GUI screen backgrounds in RGB hexidecimal notation
(e.g., FF0088).
The color of buttons on the GUI screens in RGB hexidecimal notation
(e.g., FF0088).
The color of text on buttons on the GUI screens in RGB hexidecimal
notation (e.g., FF0088).
The server the CPE can check to see if an update is available for
direct download to it. This MUST NOT be used by the CPE if the
{{param|.ManagementServer.UpgradesManaged}} parameter is {{true}}.
The server where a user can check via a web browser if an update is
available for download to a PC. This MUST NOT be used by the CPE if
the {{param|.ManagementServer.UpgradesManaged}} parameter is
{{true}}.
Comma-separated list of user-interface languages that are available,
where each language is specified according to RFC 3066
{{bibref|RFC3066}}.
Current user-interface language, specified according to RFC 3066
{{bibref|RFC3066}}.
This object contains parameters relating to remotely accessing the
CPE's user interface. Remote access is defined as any entity not of a
local subnet attempting to connect to the CPE. Remote access requires
user authentication. To provide remote access authentication the CPE
MUST support a "User" table with at least one instance that has
"RemoteAccessCapable" set to {{true}}.
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}}.
This object contains parameters relating to IP-based LAN connectivity
of a device. This object relates only to IP-layer LAN capabilities.
Lower-layer aspects of LAN connectivity are not considered part of the
common data model defined in this specification. For a device that
contains multiple IP interfaces, the scope of this object is limited to
the default IP interface. Data that might be associated with other
interfaces is not considered part of the common data model defined in
this specification.
The method used to assign an address to this interface. {{enum}} The
ability to modify this parameter is OPTIONAL.
The current IP address assigned to this interface. The ability to
modify this parameter is OPTIONAL, and this parameter cannot be
modified if the {{param|AddressingType}} is
{{enum|DHCP|AddressingType}}.
The current subnet mask. The ability to modify this parameter is
OPTIONAL, and this parameter cannot be modified if the
{{param|AddressingType}} is {{enum|DHCP|AddressingType}}.
The IP address of the current default gateway for this interface. The
ability to modify this parameter is OPTIONAL, and this parameter
cannot be modified if the {{param|AddressingType}} is
{{enum|DHCP|AddressingType}}.
Comma-separated list of IP address of the DNS servers for this
interface. The ability to modify this parameter is OPTIONAL, and this
parameter cannot be modified if the {{param|AddressingType}} is
{{enum|DHCP|AddressingType}}. If this parameter is modifiable, the
device MAY ignore any DNS servers beyond the first two in the list.
The physical address of this interface. Writable only if
{{param|MACAddressOverride}} is present and equal to {{true}}.
Whether the value of MACAddress parameter can be overridden.
* When {{true}}, {{param|MACAddress}} is writable.
* When {{false}}, {{param|MACAddress}} is not writable, and the
default MAC address assigned by the device SHOULD be restored.
Number of entries in the DHCP option table.
This object is for configuration of DHCP options. Each instance of this
object represents a DHCP option to be included by the DHCP client in
client requests. The DHCP client MAY include any other options not
specified in this table.
{{datatype|expand}}
Whether this entry represents a request to the DHCP server, or a
value to be sent by the DHCP client.
* When {{true}}, this entry represents a request. In this case, the
DHCP client MUST include the specified {{param|Tag}} in the
Parameter Request List, as defined in RFC 2132. The {{param|Value}}
parameter is ignored in this case.
* When {{false}}, this entry represents a value to be sent by the
DHCP client. In this case, the DHCP client MUST include a DHCP
option formed from the {{param|Tag}} and {{param|Value}} parameters
(with the Length derived from the length of the {{param|Value}}
parameter).
Tag of the DHCP option as defined in RFC 2132.
Base64 encoded octet string to be used as the Value of the DHCP
option if {{param|Request}} is {{false}}.
This object contains statistics for the default IP interface.
The time in seconds that this IP interface has been connected.
* If the IP interface is using DHCP, this is the time that the DHCP
client has been only in the Bound or Renewing states and the
lower-layer interface has continuously maintained a link.
* If the IP interface is using static addressing, this is the time
that the lower-layer interface has continuously maintained a link.
Total number of IP payload bytes sent over this interface since the
device was last restarted as specified in
{{param|.DeviceInfo.UpTime}}.
Total number of IP payload bytes received over this interface since
the device was last restarted as specified in
{{param|.DeviceInfo.UpTime}}.
Total number of IP packets sent over this interface since the device
was last restarted as specified in {{param|.DeviceInfo.UpTime}}.
Total number of IP packets received over this interface since the
device was last restarted as specified in
{{param|.DeviceInfo.UpTime}}.
Number of seconds since the beginning of the period used for
collection of CurrentDay statistics. The device MAY align the
beginning of each CurrentDay interval with days in the UTC time zone,
but does not need to do so.
Total number of IP payload bytes sent over this interface since the
beginning of the current-day interval as specified by
{{param|CurrentDayInterval}}.
Total number of IP payload bytes received over this interface since
the beginning of the current-day interval as specified by
{{param|CurrentDayInterval}}.
Total number of IP packets sent over this interface since the
beginning of the current-day interval as specified by
{{param|CurrentDayInterval}}.
Total number of IP packets received over this interface since the
beginning of the current-day interval as specified by
{{param|CurrentDayInterval}}.
Number of seconds since the beginning of the period used for
collection of QuarterHour statistics. The device MAY align the
beginning of each QuarterHour interval with real-time quarter-hour
intervals, but does not need to do so.
Total number of IP payload bytes sent over this interface since the
beginning of the quarter-hour interval as specified by
{{param|QuarterHourInterval}}.
Total number of IP payload bytes received over this interface since
the beginning of the quarter-hour interval as specified by
{{param|QuarterHourInterval}}.
Total number of IP packets sent over this interface since the
beginning of the quarter-hour interval as specified by
{{param|QuarterHourInterval}}.
Total number of IP packets received over this interface since the
beginning of the quarter-hour interval as specified by
{{param|QuarterHourInterval}}.
This object defines access to an IP-layer ping test for the default IP
interface.
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 {{param}} 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.
Host name or address of the host to ping.
Number of repetitions of the ping test to perform before reporting
the results.
Timeout in milliseconds for the ping test.
Size of the data block in bytes to be sent for each ping.
DiffServ codepoint to be used for the test packets. By default the
CPE SHOULD set this value to zero.
Result parameter indicating the number of successful pings (those in
which a successful response was received prior to the timeout) in the
most recent ping test.
Result parameter indicating the number of failed pings in the most
recent ping test.
Result parameter indicating the average response time in milliseconds
over all repetitions with successful responses of the most recent
ping test. If there were no successful responses, this value MUST be
zero.
Result parameter indicating the minimum response time in milliseconds
over all repetitions with successful responses of the most recent
ping test. If there were no successful responses, this value MUST be
zero.
Result parameter indicating the maximum response time in milliseconds
over all repetitions with successful responses of the most recent
ping test. If there were no successful responses, this value MUST be
zero.
This object is defines access to an IP-layer trace-route test for the
default IP interface.
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 {{param}} 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.
Host name or address of the host to find a route to.
Timeout in milliseconds for the trace route test.
Size of the data block in bytes to be sent for each trace route.
The maximum number of hop used in outgoing probe packets (max TTL).
The default is 30 hops.
DiffServ codepoint to be used for the test packets. By default the
CPE SHOULD set this value to zero.
Result parameter indicating the response time in milliseconds the
most recent trace route test. If a route could not be determined,
this value MUST be zero.
Result parameter indicating the number of hops within the discovered
route. If a route could not be determined, this value MUST be zero.
Result parameter indicating the components of the discovered route. If
a route could not be determined, there will be no instances of this
object.
Result parameter indicating the Host Name or IP Address of a hop
along the discovered route.
The capabilities of the device. This is a constant read-only object,
meaning that only a firmware upgrade will cause these values to be
altered.
The capabilities of the Performance Diagnostics
(''DownloadDiagnostics'' and ''UploadDiagnostics'') for the device.
Supported ''DownloadDiagnostics'' transport protocols for a CPE
device.
Supported ''UploadDiagnostics'' transport protocols for a CPE device.
This object defines the diagnostics configuration for a HTTP and FTP
DownloadDiagnostics Test. Files received in the DownloadDiagnostics do
not require file storage on the CPE device.
Indicate the 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 {{param}} 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|Completed}} (if the test completed successfully), or
one of the ''Error'' values listed above. If the value of this
parameter is anything other than {{enum|Completed}}, 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 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.
{{reference|the IP-layer interface over which the test is to be
performed}} The value of this parameter MUST be either a valid
interface or {{empty}}. An attempt to set this parameter to a
different value MUST be rejected as an invalid parameter value. If
{{empty}} is specified, the CPE MUST use the default routing
interface.
The URL, as defined in {{bibref|RFC3986}}, for the CPE to perform the
download on. This parameter MUST be in the form of a valid HTTP
{{bibref|RFC2616}} or FTP {{bibref|RFC959}} URL.
* When using FTP transport, FTP binary transfer MUST be used.
* When using HTTP transport, persistent connections MUST be used and
pipelining MUST NOT be used.
* When using HTTP transport the HTTP Authentication MUST NOT be used.
The DiffServ code point for marking packets transmitted in the test.
The default value SHOULD be zero.
Ethernet priority code for marking packets transmitted in the test
(if applicable). The default value SHOULD be zero.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the client sends the GET
command.
* For FTP this is the time at which the client sends the RTRV
command.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the first data packet is
received.
* For FTP this is the time at which the client receives the first
data packet on the data connection.
End of transmission in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the last data packet is
received.
* For FTP this is the time at which the client receives the last
packet on the data connection.
The test traffic received in bytes during the FTP/HTTP transaction
including FTP/HTTP headers, between {{param|BOMTime}} and
{{param|EOMTime}},
The total number of bytes received on the Interface between
{{param|BOMTime}} and {{param|EOMTime}}.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the TCP socket open (SYN) was
sent for the HTTP connection.
* For FTP this is the time at which the TCP socket open (SYN) was
sent for the data connection. Note: Interval of 1 microsecond
SHOULD be supported.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the TCP ACK to the socket
opening the HTTP connection was received.
* For FTP this is the time at which the TCP ACK to the socket opening
the data connection was received. Note: Interval of 1 microsecond
SHOULD be supported.
This object defines the diagnostics configuration for a HTTP or FTP
UploadDiagnostics test. Files sent by the UploadDiagnostics do not
require file storage on the CPE device, and MAY be an arbitrary stream
of bytes.
Indicate the 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 {{param}} 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|Completed}} (if the test completed successfully), or
one of the ''Error'' values listed above. If the value of this
parameter is anything other than {{enum|Completed}}, 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.
{{reference|the IP-layer interface over which the test is to be
performed}} The value of this parameter MUST be either a valid
interface or an empty string. An attempt to set this parameter to a
different value MUST be rejected as an invalid parameter value. If
{{empty}} is specified, the CPE MUST use the default routing
interface.
The URL, as defined in {{bibref|RFC3986}}, for the CPE to Upload to.
This parameter MUST be in the form of a valid HTTP {{bibref|RFC2616}}
or FTP {{bibref|RFC959}} URL.
* When using FTP transport, FTP binary transfer MUST be used.
* When using HTTP transport, persistent connections MUST be used and
pipelining MUST NOT be used.
* When using HTTP transport the HTTP Authentication MUST NOT be used.
DiffServ code point for marking packets transmitted in the test. The
default value SHOULD be zero.
Ethernet priority code for marking packets transmitted in the test
(if applicable). The default value SHOULD be zero.
The size of the file (in bytes) to be uploaded to the server. The CPE
MUST insure the appropriate number of bytes are sent.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the client sends the PUT command
* For FTP this is the time at which the STOR command is sent.
Begin of transmission time in UTC, which MUST be specified to
microsecond precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the first data packet is sent.
* For FTP this is the time at which the client receives the ready for
transfer notification.
End of transmission in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time when the HTTP successful response code is
received.
* For FTP this is the time when the client receives a transfer
complete.
The total number of bytes sent on the Interface between
{{param|BOMTime}} and {{param|EOMTime}}.
Request time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the time at which the TCP socket open (SYN) was
sent for the HTTP connection.
* For FTP this is the time at which the TCP socket open (SYN) was
sent for the data connection Note: Interval of 1 microsecond SHOULD
be supported.
Response time in UTC, which MUST be specified to microsecond
precision. For example: 2008-04-09T15:01:05.123456
* For HTTP this is the Time at which the TCP ACK to the socket
opening the HTTP connection was received.
* For FTP this is the Time at which the TCP ACK to the socket opening
the Data connection was received. Note: Interval of 1 microsecond
SHOULD be supported.
This object allows the CPE to be configured to perform the UDP Echo
Service defined in {{bibref|RFC862}} and UDP Echo Plus Service defined
in {{bibref|TR-143|Appendix A.1}}.
MUST be enabled to receive UDP echo. When enabled from a disabled
state all related timestamps, statistics and UDP Echo Plus counters
are cleared.
{{reference|IP-layer interface over which the CPE MUST listen and
receive UDP echo requests on}} The value of this parameter MUST be
either a valid interface or {{empty}}. An attempt to set this
parameter to a different value MUST be rejected as an invalid
parameter value. If {{empty}} is specified, the CPE MUST listen and
receive UDP echo requests on all interfaces. Note: Interfaces behind
a NAT MAY require port forwarding rules configured in the Gateway to
enable receiving the UDP packets.
The Source IP address of the UDP echo packet. The CPE MUST only
respond to a UDP echo from this source IP address.
The UDP port on which the UDP server MUST listen and respond to UDP
echo requests.
If {{true}} the CPE will perform necessary packet processing for UDP
Echo Plus packets.
{{true}} if UDP Echo Plus is supported.
Incremented upon each valid UDP echo packet received.
Incremented for each UDP echo response sent.
The number of UDP received bytes including payload and UDP header
after the UDPEchoConfig is enabled.
The number of UDP responded bytes, including payload and UDP header
sent after the UDPEchoConfig is enabled.
Time in UTC, which MUST be specified to microsecond precision. For
example: 2008-04-09T15:01:05.123456, The time that the server
receives the first UDP echo packet after the UDPEchoConfig is
enabled.
Time in UTC, which MUST be specified to microsecond precision. For
example: 2008-04-09T15:01:05.123456 The time that the server receives
the most recent UDP echo packet.
This object contains parameters relating to the user characteristics.
{{datatype|expand}}
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.
This object defines the UPnP devices and UPnP services that are
implemented by the CPE.
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.
Enables/Disables UPnP-DM Basic Management.
Enables/Disables UPnP-DM Configuration Management.
Enables/Disables UPnP-DM Software Management.
This object defines what UPnP capabilities this device has.
Numeric value indicating the major version of the supported UPnP
architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is
supported the value is 2. A value of 0 indicates no UPnP support.
Numeric value indicating the minor version of the supported UPnP
architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is
supported the value is 0. If {{param|UPnPArchitecture}} is 0 then
this parameter SHOULD be ignored.
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.
Numeric value indicating the supported revision for UPnP-DM Basic
Management. A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP-DM
Configuration Management. A value of 0 indicates no support.
Numeric value indicating the supported revision for UPnP-DM Software
Management. 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.
{{numentries}}
{{numentries}}
{{numentries}}
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}}.
This object describes the characteristics of the smart card reader.
{{datatype|expand}}
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.
{{numentries}} 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|#.DiagnosticsState}}. A failure on a specific attempt does
not mean that the overall test failed, but a failure on all attempts
means that {{param|#.DiagnosticsState}} SHOULD be
{{enum|Error_Other|#.DiagnosticsState}}.
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-Residential}}. If DoS and vulnerability
protections are implemented {{bibref|ICSA-Baseline}}, these are
enabled.
All Outbound traffic and pinhole-defined Inbound traffic is
allowed. If DoS and vulnerability protections are implemented
{{bibref|ICSA-Baseline}}, these are enabled.
All Inbound and Outbound traffic is allowed, and the CPE is
only protected by NAT settings (if supported and enabled). If
DoS and vulnerability protections are implemented
{{bibref|ICSA-Baseline}}, these are disabled.
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.
{{numentries}}
Table of CPE USB Host controllers.
{{datatype|expand}}
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"
{{numentries}}
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). 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.
{{numentries}}
Table of device configurations.
The identifier for each Device Configuration.
{{numentries}}
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.
{{numentries}}
Periodic statistics sample set table. Each sample set has its own
sample interval etc.
{{datatype|expand}}
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.
{{numentries}}
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.
{{datatype|expand}}
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.
{{numentries}}
Multicast groups to which the CPE SHOULD listen for announcements.
{{datatype|expand}}
Enable/disable listening to this multicast group.
The status of this group table entry.
MAY be used by the CPE to indicate a locally defined error
condition, e.g. unable to parse received announcements.
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.
Top level object for dynamically managed software applications.
{{numentries}}
{{numentries}}
{{numentries}}
The Execution Environments that are available on the device, along with
their properties and configurable settings.
Indicates whether or not this {{object}} is enabled. Disabling an
enabled Execution Environment stops it, while enabling a disabled
Execution Environment starts it. When an Execution Environment is
disabled, Deployment Units installed to that Execution Environment
will be unaffected, but any Execution Units currently running on that
Execution Environment will automatically transition to
{{enum|Idle|#.ExecutionUnit.{i}.Status}}. If a ChangeDUState is
attempted on a {{object|#.DeploymentUnit}} that is to be applied
against a disabled {{object}}, that ChangeDUState operation fails and
the associated DUStateChangeComplete RPC will contain a FaultStruct
for that operation. If a SetParameterValues is attempted against the
{{param|#.ExecutionUnit.{i}.RequestedState}} for an
{{object|#.ExecutionUnit}} that is associated with a disabled
{{object}} a CWMP Fault will be issued in response. Disabling an
Execution Environment could place the device in a non-manageable
state. For example, if the operating system itself was modeled as an
{{object}} and the ACS disabled it, the CWMP management agent might
be terminated leaving the device unmanageable.
Indicates the status of this {{object}}.
Setting this parameter to {{true}} causes this {{object}} to revert
back to the state it was in when the device last issued a "0
BOOTSTRAP" Inform event. The following requirements dictate what MUST
happen for the reset to be complete:
# All Deployment Units that were installed after the last "0
BOOTSTRAP" Inform event MUST be removed
# All persistent storage, configuration files, and log files that
were associated with the removed Deployment Units MUST be removed
# Any Deployment Unit that is still installed against the Execution
Environment MUST be restored to the version present when the last
"0 BOOTSTRAP" Inform event was issued
# Any Deployment Unit that was present when the last "0 BOOTSTRAP"
Inform event was issued, but was subsequently uninstalled and is
now not present, MUST be installed with the version that was
present when the last "0 BOOTSTRAP" Inform event was issued
# The Execution Environment MUST be restored to the version and
configuration present when the last "0 BOOTSTRAP" Inform event was
issued
# The Execution Environment MUST be restarted after all other
restoration requirements have been met
{{datatype|expand}}
A Name provided by the CPE that adequately distinguishes this
{{object}} from all other {{object}} instances.
Indicates the complete type and specification version of this
{{object}}.
The run level that this {{object}} will be in upon startup (whether
that is caused by a CPE Boot or the Execution Environment starting).
Run levels dictate which Execution Units will be started. Execution
Units will be started if {{param|CurrentRunLevel}} is greater than or
equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and
{{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. If the value of
{{param|CurrentRunLevel}} is -1, then the value of this parameter is
irrelevant when read and setting its value has no impact on the Run
Level of this {{object}}.
Provides a mechanism to remotely manipulate the run level of this
{{object}}, meaning that altering this parameter's value will change
the value of the {{param|CurrentRunLevel}}. Run levels dictate which
Execution Units will be started. Execution Units will be started if
{{param|CurrentRunLevel}} is greater than or equal to
{{param|#.ExecutionUnit.{i}.RunLevel}} and
{{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. Setting this
value when {{param|CurrentRunLevel}} is -1 has no impact to the Run
Level of this {{object}}.
The run level that this {{object}} is currently operating in. This
value is altered by changing the {{param|RequestedRunLevel}}
parameter. Upon startup (whether that is caused by a CPE Boot or the
Execution Environment starting) {{param}} will be equal to
{{param|InitialRunLevel}}, unless Run Levels are not supported by
this {{object}} in which case {{param}} will be -1. Run levels
dictate which Execution Units will be started. Execution Units will
be started if {{param}} is greater than or equal to
{{param|#.ExecutionUnit.{i}.RunLevel}} and
{{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. If {{param}} is
-1 then Run Levels are not supported by this {{object}} and setting
{{param|InitialRunLevel}} or {{param|RequestedRunLevel}} will not
impact the Run Level of this {{object}}.
Indicates the initial value on creation for
{{param|#.ExecutionUnit.{i}.RunLevel}} for all Execution Unit
instances associated with this {{object}}. If the value of
{{param|CurrentRunLevel}} is -1, then the value of this parameter is
irrelevant when read and setting its value has no impact on the Run
Level of any Execution Unit.
The vendor that produced this {{object}}.
The Version of this {{object}} as specified by the Vendor that
implemented this {{object}}, not the version of the specification.
Represents the parent {{object}} of this {{object}}. If this value is
{{empty}} then this is the Primary Execution Environment.
The amount of disk space measured in {{units}} allocated to this
{{object}}. A value of -1 MUST be used for {{object}} instances where
this parameter is not applicable.
The amount of disk space measured in {{units}} currently available to
this {{object}}. This value changes as the {{object|#.ExecutionUnit}}
instances associated with this {{object}} consumes disk space. A
value of -1 MUST be used for {{object}} instances where this
parameter is not applicable.
The amount of physical RAM measured in {{units}} allocated to this
{{object}}. A value of -1 MUST be used for {{object}} instances where
this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently available
to this {{object}}. This value changes as the
{{object|#.ExecutionUnit}} instances associated with this {{object}}
are started/stopped and consume the physical RAM. A value of -1 MUST
be used for {{object}} instances where this parameter is not
applicable.
Represents the {{object|#.ExecutionUnit}} instances currently running
on this {{object}}. This parameter only contains
{{object|#.ExecutionUnit}} instances that currently have a
{{param|#.ExecutionUnit.{i}.Status}} of
{{enum|Active|#.ExecutionUnit.{i}.Status}}.
Represents the processors that this {{object}} has available to it.
This table serves as the Deployment Unit inventory and contains status
information about each Deployment Unit. A new instance of this table
gets created during the installation of a Software Module.
A Universally Unique Identifier either provided by the ACS, or
generated by the CPE, at the time of Deployment Unit Installation.
The format of this value is defined by {{bibref|RFC4122}} Version 3
(Name-Based) and {{bibref|TR-069a3|Annex H}}. This value MUST NOT be
altered when the {{object}} is updated.
Deployment Unit Identifier chosen by the targeted
{{object|#.ExecEnv}}. The format of this value is Execution
Environment specific.
{{datatype|expand}}
Indicates the Name of this {{object}}, which is chosen by the author
of the Deployment Unit. The value of this parameter is used in the
generation of the {{param|UUID}} based on the rules defined in
{{bibref|TR-069a3|Annex H}}.
Indicates the status of this {{object}}.
This instance is in the process of being Installed and SHOULD
transition to the {{enum|Installed}} state.
This instance has been successfully Installed. The
{{param|Resolved}} flag SHOULD also be referenced for
dependency resolution.
This instance is in the process of being Updated and SHOULD
transition to the {{enum|Installed}} state.
This instance is in the process of being Uninstalled and SHOULD
transition to the {{enum|Uninstalled}} state.
This instance has been successfully Uninstalled. This status
will typically not be seen within a {{object}} instance.
Indicates whether or not this {{object}} has resolved all of its
dependencies.
Contains the URL used by the most recent ChangeDUState RPC to either
Install or Update this {{object}}.
Textual description of this {{object}}. The format of this value is
Execution Environment specific.
The author of this {{object}} formatted as a domain name. The value
of this parameter is used in the generation of the {{param|UUID}}
based on the rules defined in {{bibref|TR-069a3|Annex H}}.
Version of this {{object}}. The format of this value is Execution
Environment specific.
Represents the vendor log files that have come into existence because
of this {{object}}. This does not include any vendor log files that
have come into existence because of {{object|#.ExecutionUnit}}
instances that are contained within this {{object}}. When this
{{object}} is uninstalled the vendor log files referenced here SHOULD
be removed from the CPE. Not all {{object}} instances will actually
have a corresponding vendor log file, in which case the value of this
parameter will be {{empty}}.
Represents the vendor config files that have come into existence
because of this {{object}}. This does not include any vendor config
files that have come into existence because of
{{object|#.ExecutionUnit}} instances that are contained within this
{{object}}. When this {{object}} is uninstalled the vendor config
files referenced here SHOULD be removed from the CPE. Not all
{{object}} instances will actually have a corresponding vendor config
file, in which case the value of this parameter will be {{empty}}.
Represents the {{object|#.ExecutionUnit}} instances that are
associated with this {{object}} instance.
Represents the {{object|#.ExecEnv}} instance where this {{object}}
instance is installed.
This table serves as the Execution Unit inventory and contains both
status information about each Execution Unit as well as configurable
parameters for each Execution Unit. Each {{object|#.DeploymentUnit}}
that is installed can have zero or more Execution Units. Once a
Deployment Unit is installed it populates this table with its contained
Execution Units. When the Deployment Unit (that caused this {{object}}
to come into existence) is updated, this instance MAY be removed and
new instances MAY come into existence. While the Deployment Unit (that
caused this {{object}} to come into existence) is being updated, all
{{object}} instances associated with the Deployment Unit will be
stopped until the update is complete at which time they will be
restored to the state that they were in before the update started. When
the Deployment Unit (that caused this {{object}} to come into
existence) is uninstalled, this instance is removed. Each {{object}}
MAY also contain a set of vendor specific parameters displaying status
and maintaining configuration that reside under the
{{object|Extensions}} object.
Execution Unit Identifier chosen by the {{object|#.ExecEnv}} during
installation of the associated {{object|#.DeploymentUnit}}. The
format of this value is Execution Environment specific, but it MUST
be unique across {{object|#.ExecEnv}} instances. Thus, it is
recommended that this be a combination of the
{{param|#.ExecEnv.{i}.Name}} and an Execution Environment local
unique value.
{{datatype|expand}}
The name of this {{object}} as it pertains to its associated
{{object|#.DeploymentUnit}}, which SHOULD be unique across all
{{object}} instances contained within its associated
{{object|#.DeploymentUnit}}.
The name of this {{object}} as provided by the {{object|#.ExecEnv}},
which SHOULD be unique across all {{object}} instances contained
within a specific {{object|#.ExecEnv}}.
Indicates the status of this {{object}}.
This instance is in an Idle state and not running.
This instance is in the process of Starting and SHOULD
transition to the {{enum|Active}} state.
This instance is currently running.
This instance is in the process of Stopping and SHOULD
transition to the {{enum|Idle}} state.
Indicates the state transition that the ACS is requesting for this
{{object}}. {{enum}} If this {{object}} is associated with an
Execution Environment that is disabled and an attempt is made to
alter this value, then a CWMP Fault MUST be generated.
If this {{object}} is currently in {{enum|Starting|Status}} or
{{enum|Active|Status}} the CPE will attempt to Stop the
Execution Unit; otherwise this requested state is ignored.
If this {{object}} is currently in {{enum|Idle|Status}} the CPE
will attempt to Start the Execution Unit. If this {{object}} is
in {{enum|Stopping|Status}} the request is rejected and a fault
raised. Otherwise this requested state is ignored.
If while running or transitioning between states this {{object}}
identifies a fault this parameter embodies the problem. The value of
{{enum|NoFault}} MUST be used when everything is working as intended.
{{enum}} For fault codes not included in this list, the vendor MAY
include vendor-specific values, which MUST use the format defined in
{{bibref|TR-106a4|Section 3.3}}.
If while running or transitioning between states this {{object}}
identifies a fault this parameter provides a more detailed
explanation of the problem. If {{param|ExecutionFaultCode}} has the
value of {{enum|NoFault|ExecutionFaultCode}} then the value of this
parameter MUST {{empty}} and ignored by the ACS.
If {{true}} and the {{param|RunLevel}} verification is also met, then
this {{object}} will be automatically started by the device after its
{{object|#.ExecEnv}} is either rebooted or restarted. If {{false}}
this {{object}} will not be started after its {{object|#.ExecEnv}} is
either rebooted or restarted until it is explicitly commanded to do
so by either the ACS or another Execution Unit.
Determines when this {{object}} will be started. If
{{param|AutoStart}} is {{true}} and
{{param|#.ExecEnv.{i}.CurrentRunLevel}} is greater than or equal to
{{param}}, then this {{object}} will be started. If the value of
{{param|#.ExecEnv.{i}.CurrentRunLevel}} is -1, then the associated
{{object|#.ExecEnv.}} doesn't support Run Levels, thus the value of
this parameter is irrelevant when read and setting its value has no
impact to the Run Level of this {{object}}.
Vendor of this {{object}}.
Version of the {{object}}. The format of this value is Execution
Environment specific.
Textual description of this {{object}}. The format of this value is
Execution Environment specific.
The amount of disk space measured in {{units}} currently being used
by this {{object}}. A value of -1 MUST be used for {{object}}
instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently being used
by this {{object}}. A value of -1 MUST be used for {{object}}
instances where this parameter is not applicable.
Represents the instances of multi-instanced objects that are directly
controlled by, and have come into existence because of, this
{{object}}. See {{bibref|TR-157a3|Appendix II.3.2}} for more
description and some examples. NOTE: All other objects and parameters
(i.e. not multi-instanced objects) that this {{object}} has caused to
come into existence can be discovered via the
{{object|.DeviceInfo.SupportedDataModel.{i}.}} table.
Represents the system processes that are active in the system because
of this {{object}}. If {{param|Status}} is not {{enum|Active|Status}}
it is expected that this list will be {{empty}}. Some {{object}}
instances MIGHT NOT have any system processes irrespective of the
value of {{param|Status}}.
Represents the vendor log files that have come into existence because
of this {{object}}. When the {{object|#.DeploymentUnit}} (that caused
this {{object}} to come into existence) is uninstalled the vendor log
files referenced here SHOULD be removed from the CPE. Not all
{{object}} instances will actually have a corresponding vendor log
file, in which case the value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence
because of this {{object}}. When the {{object|#.DeploymentUnit}}
(that caused this {{object}} to come into existence) is uninstalled
the vendor config files referenced here SHOULD be removed from the
CPE. Not all {{object}} instances will actually have a corresponding
vendor config file, in which case the value of this parameter will be
{{empty}}.
Represents the CWMP-DT schema instances that have been introduced to
this device because of the existence of this {{object}}.
Represents the {{object|#.ExecEnv}} that this {{object}} is
associated with.
This object proposes a general location for vendor extensions specific
to this Execution Unit, which allows multiple Execution Units to expose
parameters without the concern of conflicting parameter names. These
vendor extensions are related to displaying status and maintaining
configuration for this Execution Unit. It is also possible for the
Execution Unit to expose status and configuration parameters within
Service objects or as embedded objects and parameters directly within
the root data model, in which case the combination of
{{param|#.References}} and {{param|#.SupportedDataModelList}} will be
used to determine their locations. See {{bibref|TR-157a3|Appendix
II.3.2}} for more description and some examples.
This object contains general information related to managing security
features on the device.
{{numentries}}
This table provides information about all types of public key-based
credentials, such as X.509 certificates, see {{bibref|RFC5280}}.
Enables or disables this certificate.
The last modification time of this certificate.
The Serial Number field in an X.509 certificate, see
{{bibref|RFC5280}}.
The Issuer field in an X.509 certificate, see {{bibref|RFC5280}};
i.e. the Distinguished Name (DN) of the entity who has signed the
certificate.
The beginning of the certificate validity period; i.e. the Not Before
field in an X.509 certificate, see {{bibref|RFC5280}}.
The end of the certificate validity period; i.e., the Not After field
in an X.509 certificate, see {{bibref|RFC5280}}.
The Distinguished Name (DN) of the entity associated with the Public
Key; i.e., the Subject field in an X.509 certificate, see
{{bibref|RFC5280}}.
{{list}} Each item is a DNS Name. The Subject Alternative Names
extension field in an X.509 certificate, see {{bibref|RFC5280}}.
The algorithm used in signing the certificate; i.e. the Signature
Algorithm field in an X.509 certificate, see {{bibref|RFC5280}}.
This object contains parameters relating to Fault/Alarm Management.
{{numentries}}
The maximum number of entries allowed in the
{{object|.FaultMgmt.CurrentAlarm.{i}.}} table.
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Supported Alarm Entries which can be raised by the device. The instance
numbers for this table SHOULD be maintained across firmware upgrades of
the device.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
Provides further qualification on the alarm beyond
{{param|EventType}} and {{param|ProbableCause}}. This is vendor
defined and will be {{empty}} if the device doesn't support unique
indexing of the table using {{param}}. The string can be set to "*"
to indicate the default case if only a subset of {{param}} are to be
contained within the table.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}} This will be {{empty}} if the device
doesn't support unique indexing of the table using {{param}}. The
string can be set to "*" to indicate the default case if only a
subset of {{param}} are to be contained within the table.
{{empty}}
Indicates the reporting mechanism setting of the alarm. {{enum}}
The device inserts the alarm into the
{{object|.FaultMgmt.ExpeditedEvent.{i}.}} table and the
{{object|.FaultMgmt.ExpeditedEvent.{i}.}} table.
The device inserts the alarm into the
{{object|.FaultMgmt.QueuedEvent.{i}.}} table and the
{{object|.FaultMgmt.QueuedEvent.{i}.}} table.
The device inserts the alarm into the
{{object|.FaultMgmt.HistoryEvent.{i}.}} table.
The device ignores the alarm.
Contains all currently active alarms (whose
{{param|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}} is not
{{enum|Cleared|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}}).
Newly raised alarms result in a new entry in this table being added,
any changes to the alarm as a result of an update event are updated in
the existing table entry, and a clear event raised against an alarm
results in the alarm being removed from this table.
If maximum entries as indicated by
{{param|.FaultMgmt.MaxCurrentAlarmEntries}} is reached, the next event
overrides the object with the oldest {{param|AlarmChangedTime}}. When a
new alarm replaces an existing alarm, then all parameter values for
that instance are considered as changed for the purposes of value
change notifications to the ACS (even if their new values are identical
to those of the prior alarm).
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.
Indicates the date and time when the alarm was first raised by the
device.
Indicates the date and time when the alarm was last changed by the
device.
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 {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
Provides further qualification on the alarm beyond
{{param|EventType}} and {{param|ProbableCause}}. This is vendor
defined and will be {{empty}} if the device doesn't support inclusion
of this information.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
Alarm events added or updated in
{{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into
the this table. This table also contains alarm clearing events. Active
alarms at the time of a power failure or reboot might not get an alarm
clearing event. This object has a fixed number of entries with instance
numbers from 1 to {{param|.FaultMgmt.HistoryEventNumberOfEntries}}. If
maximum instance number
{{param|.FaultMgmt.HistoryEventNumberOfEntries}} is reached, the next
event overrides the object with instance number 1. Subsequent entries
override objects at sequentially increasing instance numbers. This
logic provides for automatic "rolling" of records.
Indicates the date and time when the alarm event occurs.
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.
Indicates the reason for the specific alarm notification event.
{{enum}}
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 {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
Provides further qualification on the alarm beyond
{{param|EventType}} and {{param|ProbableCause}}. This is vendor
defined and will be {{empty}} if the device doesn't support inclusion
of this information.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
Alarm events added or updated in
{{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into
the this table if their corresponding entry in
{{object|.FaultMgmt.SupportedAlarm.{i}.}} has
{{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to
{{enum|0 Expedited|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}.
This table also contains alarm clearing events. This object has a fixed
number of entries with instance numbers from 1 to
{{param|.FaultMgmt.ExpeditedEventNumberOfEntries}}. Initially the table
starts with all instances having {{param|EventTime}} set to the Unknown
Time value, as defined in {{bibref|TR-106a4}}. If maximum instance
number {{param|.FaultMgmt.ExpeditedEventNumberOfEntries}} is reached,
the next event overrides the object with instance number 1. Subsequent
entries override objects at sequentially increasing instance numbers.
This logic provides for automatic "rolling" of records. When a new
alarm replaces an existing alarm, then all parameter values for that
instance are considered as changed for the purposes of value change
notifications to the ACS (even if their new values are identical to
those of the prior alarm).
Indicates the date and time when the alarm event occurs. For an
unpopulated entry, the value is the Unknown Time as defined in
{{bibref|TR-106a4}}.
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 {{empty}}.
Indicates the reason for the specific alarm notification event.
{{enum}}
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 {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
Provides further qualification on the alarm beyond
{{param|EventType}} and {{param|ProbableCause}}. This is vendor
defined and will be {{empty}} if the device doesn't support inclusion
of this information.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
Alarm events added or updated in
{{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into
the this table if their corresponding entry in
{{object|.FaultMgmt.SupportedAlarm.{i}.}} has
{{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to
{{enum|1 Queued|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}.
This table also contains alarm clearing events. This object has a fixed
number of entries with instance numbers from 1 to
{{param|.FaultMgmt.QueuedEventNumberOfEntries}}. Initially the table
starts with all instances having {{param|EventTime}} set to the Unknown
Time value, as defined in {{bibref|TR-106a4}}. If maximum instance
number {{param|.FaultMgmt.QueuedEventNumberOfEntries}} is reached, the
next event overrides the object with instance number 1. Subsequent
entries override objects at sequentially increasing instance numbers.
This logic provides for automatic "rolling" of records. When a new
alarm replaces an existing alarm, then all parameter values for that
instance are considered as changed for the purposes of value change
notifications to the ACS (even if their new values are identical to
those of the prior alarm).
Indicates the date and time when the alarm event occurs. For an
unpopulated entry, the value is the Unknown Time as defined in
{{bibref|TR-106a4}}.
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 {{empty}}.
Indicates the reason for the specific alarm notification event.
{{enum}}
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 {{object}}.
Indicates the type of event.
Qualifies the alarm and provides further information than
{{param|EventType}}.
Provides further qualification on the alarm beyond
{{param|EventType}} and {{param|ProbableCause}}. This is vendor
defined and will be {{empty}} if the device doesn't support inclusion
of this information.
Indicates the relative level of urgency for operator attention, see
{{bibref|ITU-X.733}}. {{enum}}
This provides a textual string which is vendor defined. This will be
{{empty}} if the device doesn't support inclusion of this
information.
This contains additional information about the alarm and is vendor
defined.
This object is the container for all Femto related component objects,
to prevent pollution of the so-called global namespace of the BBF with
FAP specific objects.
This object contains the parameters relating to the GPS scan.
Enables or disables GPS scans during the device start up.
Enables or disables periodic GPS scans.
When {{param|ScanPeriodically}} is {{true}}, this value indicates the
interval in {{units}} which GPS scan is performed.
An absolute time reference in UTC to determine when the CPE will
initiate the periodic GPS scan. Each GPS scan MUST occur at (or as
soon as possible after) this reference time plus or minus an integer
multiple of the {{param|PeriodicInterval}}. {{param}} is used only to
set the "phase" of the GPS scan. The actual value of {{param}} can be
arbitrarily far into the past or future. For example, if
{{param|PeriodicInterval}} is 86400 (a day) and if {{param}} is set
to UTC midnight on some day (in the past, present, or future) then
periodic GPS scans will occur every day at UTC midnight. These MUST
begin on the very next midnight, even if {{param}} refers to a day in
the future. The Unknown Time value defined in
{{bibref|TR-106a4|Section 3.2}} indicates that no particular time
reference is specified. That is, the CPE MAY locally choose the time
reference, and needs only to adhere to the specified
PeriodicInformInterval. If absolute time is not available to the CPE,
its periodic GPS scan behavior MUST be the same as if {{param}}
parameter was set to the Unknown Time value.
Whether or not the device SHOULD maintain a continuous GPS lock (e.g.
as a frequency stability source).
Specifies the time-out value in {{units}} since the scan started
after which the scan will time out. A timed out scan is to be
reported as {{enum|Error_TIMEOUT|ScanStatus}} with
{{param|ErrorDetails}} indicating "Timed out"
Indicates the current status of this scan.
The scan has not been executed and there are no valid scan
results available
Provides more detail when the {{param|ScanStatus}} is either
{{enum|Error|ScanStatus}} or {{enum|Error_TIMEOUT|ScanStatus}}.
The date and time when the last GPS scan completed.
Specifies the date and time, when the GPS scan last completed
successfully. This value is retained across reboot and is only reset
after another scan completes successfully or {{param|GPSReset}} is
set to {{true}}. The values for {{param|LockedLatitude}},
{{param|LockedLongitude}} and {{param|NumberOfSatellites}} correspond
to this time. If a scan has never succeeded before, the value will be
the Unknown Time value, as defined in {{bibref|TR-106a4|Section
3.2}}.
This parameter specifies the latitude of the device's position in
degrees, multiplied by 1 million. The positive value signifies the
direction, north of the equator. The negative value signifies the
direction, south of the equator. Range is from: 90d00.00' South
(-90,000,000) to 90d00.00' North (90,000,000). Example: A latitude of
13d19.43' N would be represented as 13,323,833, derived as
(13*1,000,000)+((19.43*1,000,000)/60). Latitude of 50d00.00' S would
be represented as value -50,000,000. This value is retained across
reboots and is only reset after another scan completes successfully
or {{param|GPSReset}} is set to {{true}}. If a scan has never
succeeded before, the value 0 is reported.
This parameter specifies the longitude of the device's position in
degrees, multiplied by 1 million. The positive value signifies the
direction, east of the prime meridian. The negative value signifies
the direction, west of the prime meridian. Range is from: 180d00.00'
West (-180,000,000) to 180d00.00' East (180,000,000). Example: A
longitude of 13d19.43' E would be represented as 13,323,833, derived
as (13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00.00' W
would be represented as value -50,000,000. This value is retained
across reboots and is only reset after another scan completes
successfully or {{param|GPSReset}} is set to {{true}}. If a scan has
never succeeded before, the value 0 is reported.
The number of satellites that were locked during the test execution.
The greater the number of satellites the better the precision of the
results. This value is retained across reboots and is only reset
after another scan completes successfully or {{param|GPSReset}} is
set to {{true}}. If a scan has never succeeded before, the value 0 is
reported.
Setting this to {{true}} will cause a reset on the GPS Hardware.
Setting this to {{false}} has no effect.
When {{param|#.ContinuousGPS}} is {{true}}, the parameters in this
object contain the GPS status as it is continuously monitored. When
{{param|#.ContinuousGPS}} is {{false}}, the parameters in this object
are not being updated and their values are not accurate.
The value is {{true}} if the location fix is currently valid (i.e.
GPS receiver is currently tracking satellite signals), otherwise it
is {{false}}. After a reboot the value is {{false}} until the GPS
receivers has a valid current position.
The value is {{true}} if {{param|CurrentFix}} has transitioned to
{{true}} at least once since {{param|#.ContinuousGPS}} was enabled,
otherwise it is {{false}}. After a reboot the value is {{false}}
until {{param|CurrentFix}} has transitioned to {{true}} again. The
GPS coordinates ({{param|Latitude}}, {{param|Longitude}}, and
{{param|Elevation}}) are not valid until {{param}} has a value of
{{true}}.
The value is {{true}} if the timing synchronization is good,
otherwise it is {{false}}. After a reboot the value is {{false}}
until the timing is synchronized again.
This parameter represents the most recent latitude reading for the
device's position in degrees, multiplied by 1 million. The positive
value signifies the direction, north of the equator. The negative
value signifies the direction, south of the equator. Range is from:
90 deg 00.00' South (-90,000,000) to 90 deg 00.00' North
(90,000,000). Example: A latitude of 13 deg 19.43' N would be
represented as 13,323,833, derived as
(13*1,000,000)+((19.43*1,000,000)/60). Latitude of 50 deg 00.00' S
would be represented as value -50,000,000. {{param}} is not valid
until {{param|GotFix}} is {{true}}. If the parameter has never been
set before, the value 0 is reported. The value SHOULD be maintained
over a reboot.
This parameter represents the most recent longitude reading for the
device's position in degrees, multiplied by 1 million. The positive
value signifies the direction, east of the prime meridian. The
negative value signifies the direction, west of the prime meridian.
Range is from: 180d00.00' West (-180,000,000) to 180d00.00' East
(180,000,000). Example: A longitude of 13d19.43' E would be
represented as 13,323,833, derived as
(13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00.00' W
would be represented as value -50,000,000. {{param}} is not valid
until {{param|GotFix}} is {{true}}. If the parameter has never been
set before, the value 0 is reported. The value SHOULD be maintained
over a reboot.
This parameter represents the most recent elevation reading for the
device's position in {{units}}, relative to the WGS84 ellipsoid. The
positive value signifies the direction, above sea level. The negative
value signifies the direction, below sea level. Range is from:
5,000.000 meters below sea level (-5,000,000) to 25,000.000 meters
above sea level (25,000,000). {{param}} is not valid until
{{param|GotFix}} is {{true}}. If the parameter has never been set
before, the value 0 is reported. The value SHOULD be maintained over
a reboot.
Represents the date and time when the last GPS Fix was acquired. The
Unknown Time value defined in {{bibref|TR-106a4|Section 3.2}} is used
when {{param|GotFix}} is {{false}}. This applies too after a reboot
of the device until a valid location is determined and
{{param|GotFix}} transsitions to {{true}}.
Number of {{units}} of continuous GPS fix time. After a reboot this
value is reset to 0.
Number of {{units}} to wait for first GPS fix before declaring a GPS
fault. A value of -1 means that there is no timeout and no fault
logging.
The number of satellites the receiver is tracking.
The interval in {{units}} at which the GPS tracking information gets
reported.
The output of the GPS receiver's status.
Indicates whether the {{param|Latitude}}, {{param|Longitude}}, and
{{param|Elevation}} values are determined via a GPS Fix (where the
value of this parameter would be {{enum|Real}}) or via some other
means (where the value of this parameter would be
{{enum|Reference}}).
The timer duration, in {{units}}, for which the device waits for GPS
to acquire lock.
This object contains parameters for the configuration of the Assisted
Global Positioning System (A-GPS) server. See also
{{bibref|3GPP-TS.25.171|Section 3.2}}
Enables or disables the {{object}} entry.
A-GPS server host name or IP address.
The port to use when communicating to the A-GPS Server.
Username to be used by the device to authenticate with the A-GPS
server. This string is set to {{empty}} if no authentication is used.
Password to be used by the device to authenticate with the A-GPS
server. This string is set to {{empty}} if no authentication is used.
This parameter specifies the reference latitude for an A-GPS request
position in degrees, multiplied by 1 million. The positive value
signifies the direction, north of the equator. The negative value
signifies the direction, south of the equator. Range is from:
90d00.00' South (-90,000,000) to 90d00.00' North (90,000,000).
Example: A latitude of 13d19.43' N would be represented as
13,323,833, derived as (13*1,000,000)+((19.43*1,000,000)/60).
Latitude of 50d00.00' S would be represented as value -50,000,000.
This parameter specifies the reference longitude for an A-GPS request
position in degrees, multiplied by 1 million. The positive value
signifies the direction, east of the prime meridian. The negative
value signifies the direction, west of the prime meridian. Range is
from: 180d00.00' West (-180,000,000) to 180d00.00' East
(180,000,000). Example: A longitude of 13d19.43' E would be
represented as 13,323,833, derived as
(13*1,000,000)+((19.43*1,000,000)/60). A longitude of 50d00'00'' W
would be represented as value -50,000,000.
The value is {{true}} if the device has successfully contacted and
received A-GPS info from the A-GPS server, otherwise the value is
{{false}}. After a reboot the value is {{false}} until the server
could be contacted again.
This object contains parameters relating to Tunneling.
{{numentries}}
{{numentries}}
{{numentries}}
The maximum number of virtual interfaces.
{{numentries}}
If the SecGW parameters are configured then this parameter determines
whether the CWMP traffic will be sent across the IPsec tunnel(s) or
outside of the IPsec tunnel(s). If {{false}} then the CWMP traffic
will be sent outside of the IPsec tunnel(s). If {{true}} then the
CWMP traffic will be sent across the IPsec tunnel(s).
Indicates the maximum number of child SAs per IKE session that the
device is capable of supporting.
Indicates the maximum number of IKE sessions the device is capable of
supporting at any given time.
This object contains parameters relating to IKEv2 and IPsec crypto
profiles, which are essentially a subset of the typical IPsec SPD.
{{bibref|RFC4301}}. For Cdma2000 devices, see also
{{bibref|3GPP2-S.S0132}}.
Enables and disables this entry.
{{datatype|expand}}
Specifies the Security mechanism and set of credentials used by the
device to authenticate itself (either an instance of the
''.Security.Certificate.'' object defined in {{bibref|TR-157a5}} or
an instance of the
''.Services.FAPService.{i}.Transport.Security.Secret.'' object
defined in {{bibref|TR-196i2}}). {{reference}} If the value is an
{{empty}}, the device chooses the authentication method based on
local policy. In order to configure the device for both device and
hosting-party authentication, the object is populated with an enabled
instance of the ''.Security.Certificate.''. object.
Controls the maximum number of child SAs that can be negotiated by a
single IKE session.
IKEv2 encryption algorithm. {{bibref|RFC4307}} For CDMA2000 devices,
see also {{bibref|3GPP2-S.S0132}}.
IKEv2 pseudo-random function. {{bibref|RFC4307}} For CDMA2000
devices, see also {{bibref|3GPP2-S.S0132}}.
IKEv2 integrity function. {{bibref|RFC4307}} For CDMA2000 devices,
see also {{bibref|3GPP2-S.S0132}}.
IKEv2 pseudo-random function. {{bibref|RFC4307}} For CDMA2000
devices, see also {{bibref|3GPP2-S.S0132}}.
IPsec encryption algorithm. {{bibref|RFC4835|Section 3.1.1}} For
CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
IPsec integrity function. {{bibref|RFC4835|Section 3.1.1}} For
CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
The size of the Anti-Replay Window. If 0 Sequence Number Verification
is disabled. For UMTS devices, see {{bibref|3GPP-TS.32.582}} and
{{bibref|3GPP-TS.32.584}}. For LTE devices, see
{{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
IKEv2 SA rekey timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
IPsec SA rekey timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
IPsec SA rekey timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
DPD timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
NAT-T keepalive timeout in {{units}}. For UMTS devices, see
{{bibref|3GPP-TS.32.582}} and {{bibref|3GPP-TS.32.584}}. For LTE
devices, see {{bibref|3GPP-TS.32.592}}. For CDMA2000 devices, see
{{bibref|3GPP2-S.S0132}}.
Maximum fragment size, in {{units}}, from device before Encryption.
For CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
Indicates if the 'Do Not Fragment' bit needs to be turned on/off. For
CDMA2000 devices, see also {{bibref|3GPP2-S.S0132}}.
IKE IPsec Security Association Table. This Table is a member of the
IPsec Security Association Database (SAD). {{bibref|RFC4301}}.
The status of this IKE SA entry.
This value MAY be used by the CPE to indicate a locally defined
error condition.
The IP address of the peer SecGW.
The time that the current IKE SA was set up.
The current IP address assigned to this interface by IKEv2.
The current subnet mask assigned to this interface by IKEv2.
{{list}} Each item is an IP Address of a DNS server for this
interface assigned to this interface by IKEv2.
{{list}} Each item is an IP address of a DHCP server for this
interface. A non empty list instructs the CPE to send any internal
DHCP request to the address contained within this parameter.
The number of inbound packets discarded by the IKE SA due to
Integrity checking errors.
The number of inbound packets discarded by the IKE SA due to other
errors, such as anti-replay errors.
The number of inbound packets discarded by the IKE SA due to
authentication errors.
Child IPsec Security Association Table. This Table is a member of the
IPsec Security Association Database (SAD). {{bibref|RFC4301}}.
{{reference}}
SPI value of the Child SA.
Traffic Direction. If {{true}} this Child SA refers to outbound
traffic. If {{false}} this Child SA refers to inbound traffic.
The time that the current Child SA was set up.
The measured traffic in {{units}} transferred by the Child SA.
The number of inbound {{units}} discarded by the Child SA due to
integrity checking errors.
The number of inbound {{units}} discarded by the Child SA due to
anti-replay errors.
Virtual Interfaces used for associating the tunnel (ephemeral) childSA
pairs with QoS Classification and Queue tables as defined in
{{bibref|TR-098a2}}
(InternetGatewayDevice.QueueManagement.Classification.{i}. and
InternetGatewayDevice.QueueManagement.Queue.{i}.) or
{{bibref|TR-181i2}} (Device.QoS.Classification.{i}. and
Device.QoS.Queue.{i}.).
Enables and disables this entry.
{{datatype|expand}}
{{reference}} If multiple instances of VirtualInterface point to the
same CryptoProfile instance, the associated
{{param|#.CryptoProfile.{i}.MaxChildSA}} determines whether a new IKE
session will be created (dynamically) to negotiate the child SA(s)
for each of the virtual interfaces; otherwise, they are negotiated
through the same IKE session.
DSCP to mark the outer IP header for traffic that is associated with
this virtual interface. A value of -1 indicates copy from the
incoming packet. A value of -2 indicates automatic marking of DSCP as
defined for the UMTS QoS class {{bibref|3GPP-TS.23.107}} or CDMA2000
Subscriber QoS profile {{bibref|3GPP2-X.S0011}}. De-tunneled packets
are never re-marked.
This object contains parameters relating to Performance Management in a
Femto-related environment.
{{numentries}}
This object contains parameters relating to File Management
configuration for uploading of Performance Files to a designated File
Server. Each table entry can be referenced by zero or more
radio-specific objects contained in the FAPService instances. The
periodic upload will upload data for all of the radio-specific objects
that reference it.
Enables or disables this entry. If this entry is disabled then its
periodic uploads are not performed.
{{datatype|expand}}
URL specifying the destination file location. HTTP and HTTPS
transports MUST be supported. Other transports MAY be supported. This
argument specifies only the destination file location, and does not
indicate in any way the name or location of the local file to be
uploaded.
Username to be used by the device to authenticate with the file
server. This string is set to {{empty}} if no authentication is used.
Password to be used by the device to authenticate with the file
server. This string is set to {{empty}} if no authentication is used.
The duration in {{units}} of the interval for which the device MUST
create a Performance File and attempt to upload the file to
{{param|URL}} if {{param|Enable}} is {{true}}.
An absolute time reference in UTC to determine when the device will
initiate the periodic file upload. Each file upload MUST occur at
this reference time plus or minus an integer multiple of the
{{param|PeriodicUploadInterval}}. {{param}} is used only to set the
"phase" of the periodic uploads. The actual value of {{param}} can be
arbitrarily far into the past or future. For example, if
{{param|PeriodicUploadInterval}} is 86400 (a day) and if {{param}} is
set to UTC midnight on some day (in the past, present, or future)
then periodic file uploads will occur every day at UTC midnight.
These MUST begin on the very next midnight, even if {{param}} refers
to a day in the future. The Unknown Time value as defined in
{{bibref|TR-106a4|Section 3.2}} indicates that no particular time
reference is specified. That is, the device MAY locally choose the
time reference, and is REQUIRED only to adhere to the specified
{{param|PeriodicUploadInterval}}. If absolute time is not available
to the device, its periodic file upload behavior MUST be the same as
if the {{param}} parameter was set to the Unknown Time value.
This object defines the data model for the following Femtozone APIs.
* Femto Awareness
* SMS
* MMS
* Terminal Location Femto Awareness, SMS, MMS, and Terminal Location
APIs are defined in the Release 1 API Specifications of the Service
SIG in the Femto Forum (non public document).
{{bibref|TR-262|appendix I}} provides the "Theory of Operation" for
the usage of this object.
Version of Femto Application Platform running on this device
Enable or disable the Femto ApplicationPlatform
Current state of the Femto Application Platform.
The Femto Application Platform is not available
The Femto Application Platform is available
The FemtoApplicationPlatform is in the process of being reset
and will transition to the {{enum|Disabled}} state when the
reset operation is completed
The FemtoApplicationPlatform is being initialized and will
transition to the {{enum|Enabled}} state once the
initialization is completed
Determines how many Femtozone Applications can be supported by the
Femto Application Platform simultaneously.
Specifies how many Femtozone Applications are currently communicating
with the Femto Application Platform.
This object contains parameters related to the capabilities of the
Femtozone Application Platform and the Femtozone APIs.
Specifies whether the Femto Application Platform supports
Presence-Based Femtozone Applications
Specifies whether the Femto Awareness API is supported on this
device.
Specifies whether the SMS API is supported on this device.
Specifies whether the SubscribeToNotificationsOfSMSSentToApplication
functionality is supported by the FAP SMS API.
Specifies whether the QuerySMSDeliveryStatus functionality is
supported by the FAP SMS API.
Specifies whether the MMS API is supported on this device.
Specifies whether the QueryMMSDeliveryStatus functionality is
supported by the FAP MMS API.
Specifies whether the SubscribeToNotificationsOfMMSSentToApplication
functionality is supported by the FAP MMS API.
Specifies whether the Terminal Location API is supported on this
device.
Specifies the supported methods that 3rd Party Applications can use
to authenticate with the Femto Application Platform at
initialization. Comma separated list of strings.
Specifies the supported access levels that 3rd Party Applications can
request when authenticating with the Femto Application Platform at
initialization. This access level is with respect to resources within
the Femto Application Platform only (not to be confused with Access
Mode parameter in .FAPService.{i}.AccessMgmt).
Specifies the supported types of addresses SMSs can be sent to.
Specifies the supported types of addresses MMSs can be sent to.
This object contains parameters related to the operation of the
Femtozone APIs.
Specifies how 3rd Party Applications have to authenticate against
Femto APIs in order to use it. {{reference}} '''''Note:''''' The
credentials are not part of the data model and have to be supplied
externally.
This is the reference to the IPsec tunnel instance to be used by the
Application Platform traffic. If InternetGatewayDevice:1
{{bibref|TR-098}} or Device:1 {{bibref|TR-181i1}}) is used as root
data model the {{param}} MUST point to a row in the
''.FAP.Tunnel.IKESA.{i}.'' table. If the root data model used is
Device:2 {{bibref|TR-181i2}} than the {{param}} MUST point to an
tunnel instance defined in this data model. If the referenced object
is deleted, the parameter value MUST be set to an empty string.
This object contains parameters related to the Femto Awareness API.
Enable or disable FemtoAwareness API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to Femto Awareness API.
Determines the Max Number of different Applications that can send
Requests to Femto Awareness API.
Specifies Identifier of the Femtozone.
Specifies whether the Mobile Station International Subscriber
Directory Number (MSISDN) has to be used as UserIdentifier in Femto
Awareness Notifications. A value of {{true}} means that the MSISDN is
send as user identifier, a value of {{false}} means that an anonymous
reference is used.
Specifies whether the OPTIONAL Argument "Callback Data" has to be
used in Responses to Requests to "Subscribe To Femto Awareness
Notifications".
Specifies whether the OPTIONAL Argument "Timezone" has to be used in
Responses to Requests to "Query Femtocell Status".
This object contains parameters related to the SMS API.
Enable or disable SMS API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to SMS API.
Determines the Max Number of different Applications that can send
Requests to SMS API.
Determines the Minimum Time Interval in {{units}} between two
consecutive Send SMS Requests by the same Application.
Enable or disable "QuerySMSDeliveryStatus" Operation on SMS API. When
disabled, QuerySMSDeliveryStatus Requests to SMS API are ignored.
Enable or disable
"SubscribeToNotificationsOfMessageSentToApplication" Operation on SMS
API. When disabled, SubscribeTo
NotificationsOfMessageSentToApplication Requests to SMS API are
ignored.
This object contains parameters related to the MMS API.
Enable or disable MMS API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to MMS API.
Determines the Max Number of different Applications that can send
Requests to MMS API.
Determines the Minimum Time Interval in {{units}} between two
consecutive Send MMS Requests by the same Application.
Enable or disable "QuerySMSDeliveryStatus" Operation on MMS API. When
disabled, QuerySMSDeliveryStatus Requests to MMS API are ignored.
Enable or disable "SubscribeTo
NotificationsOfMessageSentToApplication" Operation on MMS API. When
disabled, SubscribeTo NotificationsOfMessageSentToApplication
Requests to MMS API are ignored.
This object contains parameters related to the TerminalLocation API.
Enable or disable TerminalLocation API exposure on FAP
Enable or disable Request queueing for the API
Determines how FAP handles simultaneous requests from different
Applications to TerminalLocation API.
Determines the Max Number of different Applications that can send
Requests to TerminalLocation API.
Specifies Terminal Address Format to be used in QueryMobileLocation
Responses.
Include or exclude FAP Longitude and Latitude arguments in Responses
to QueryMobileLocation Requests.
Include or exclude FAP Altitude argument in Responses to
QueryMobileLocation Requests .
Specifies Response Timestamp in {{units}}.
This object contains parameters related to the monitoring of the
Femtozone Application Platform and the Femtozone APIs.
Enables and disables this entry.
Specifies the interval in {{units}} used to collect the monitoring
measurements.
Specifies the total number of authentication requests received by the
Femto Application Platform. The counter will be reset whenever the
device reboots or the {{param|Enable}} parameter is set to {{true}}.
Specifies the number of authentication requests received by the Femto
Application Platform that were rejected. The counter will be reset
whenever the device reboots or the {{param|Enable}} parameter is set
to {{true}}.
This object contains parameters related to the Monitoring of the
FemtoAwareness API.
Specifies whether the FemtoAwareness API is currently available on
this device (the API could be disabled or could have exhausted its
resources)
Specifies the current number of Applications using the Femto
Awareness API.
Specifies the state of the Femto Awareness API Queue.
Specifies the current number of requests waiting in the Femto
Awareness API Queue.
Specifies the number of requests in the Femto Awareness API Queue
that have been received. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
Specifies the number of requests in the Femto Awareness API Queue
that have been discarded. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
This object contains parameters related to the Monitoring of the SMS
API.
Specifies whether the SMS API is currently available on this device
(the API could be disabled or could have exhausted its resources)..
Specifies the current number of Applications using the SMS API.
Specifies the state of the SMS API Queue.
Specifies the current number of requests waiting in the SMS API
Queue.
Specifies the number of requests in the SMS API Queue that have been
received. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
Specifies the number of requests in the SMS API Queue that have been
discarded. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
This object contains parameters related to the Monitoring of the MMS
API.
Specifies whether the MMS API is currently available on this device
(the API could be disabled or could have exhausted its resources)..
Specifies the current number of Applications using the MMS API.
Specifies the state of the MMS API Queue.
Specifies the current number of requests waiting in the MMS API
Queue.
Specifies the number of requests in the MMS API Queue that have been
received. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
Specifies the number of requests in the MMS API Queue that have been
discarded. The counter will be reset whenever the device reboots or
the {{param|#.Enable}} parameter is set to {{true}}.
This object contains parameters related to the Monitoring of the
TerminalLocation API.
Specifies whether the TerminalLocation API is currently available on
this device (the API could be disabled or could have exhausted its
resources)..
Specifies the current number of Applications using the Terminal
Location API.
Specifies the state of the Terminal Location API Queue.
Specifies the current number of requests waiting in the Terminal
Location API Queue.
Specifies the number of requests in the Terminal Location API Queue
that have been received. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
Specifies the number of requests in the Terminal Location API Queue
that have been discarded. The counter will be reset whenever the
device reboots or the {{param|#.Enable}} parameter is set to
{{true}}.
Bulk Data collection utilizes the IPDR solution to collect data from
devices based on a service specification described in
{{bibref|TR-232}}. Bulk Data Collection Profiles are measured over a
reporting interval (which can be aligned with absolute time) and are
made available to the collection server. This object provides bulk data
collection capabilities and global collection settings that affect the
entire device.
Enables or disables all collection profiles. If {{false}}, bulk data
will not be collected or reported.
Indicates the status of the Bulk Data Collection mechanism.
Bulk Data Collection is enabled and working as intended.
Bulk Data Collection is disabled.
Bulk Data Collection is enabled, but there is an error
condition preventing the successful collection of bulk data.
Minimum reporting interval in {{units}} that the CPE is capable of
supporting. A value of 0 indicates no minimum reporting interval.
Represents the IPDR Protocols that this device is capable of
supporting.
IPDR Streaming Protocol {{bibref|IPDR-SP}}
IPDR File Transfer Protocol {{bibref|IPDR-FTP}}
Represents the IPDR Encoding Types that this device is capable of
supporting.
{{bibref|IPDR-XML}}
{{bibref|IPDR-XDR}}
The maximum number of profiles that can exist at any given time.
Specifically, the maximum number of {{object|Profile.{i}.}} instances
that the ACS can create. If the value of this parameter is -1, then
it means that the CPE doesn't have a limit to the number of profiles
that can exist.
The maximum number of parameters that can be referenced via the bulk
data collection mechanism. Specifically, the maximum number of
parameters that can be referenced via
{{param|Profile.{i}.Parameter.{i}.Reference}} across all Profile and
Parameter instances (including the expansion of partial paths within
the Reference parameter). If the value of this parameter is -1, then
it means that the CPE doesn't have a limit to the number of parameter
that can be referenced via the bulk data collection mechanism.
{{numentries}}
A set of Bulk Data Collection profiles. Each profile represents a bulk
data report, including its own timing configuration, communications
configuration, and set of parameters. This allows the ACS to configure
multiple reports to be generated at different times for different sets
of data.
Enables or disables this specific bulk data profile. If {{false}},
this profile will not be collected or reported.
{{datatype|expand}}
The IPDR Protocol being used for this collection profile.
The IPDR Encoding Type being used for this collection profile.
The reporting interval in {{units}}. Each report is generated based
on this interval and {{param|TimeReference}}. The CPE MAY reject a
request to set {{param}} to less than
{{param|#.MinReportingInterval}}. Reporting intervals MUST begin
every {{param}} {{units}}. If {{param}} is changed while collection
is enabled, the first reporting interval begins immediately. For
example, if {{param}} is 86400 (a day) and if {{param|TimeReference}}
is set to UTC midnight on some day (in the past, present, or future)
then the CPE will generate (and transmit, if the {{param|Protocol}}
parameter is set to {{enum|Streaming|#.Protocols}}) its report at
midnight every 24 hours.
An absolute time reference in UTC to determine when will be
transmitted. Each reporting interval MUST complete at this reference
time plus or minus an integer multiple of
{{param|ReportingInterval}}, unless unable to due to higher
prioritized operations. {{param}} is used only to set the "phase" of
the reporting intervals. The actual value of {{param}} can be
arbitrarily far into the past or future. If {{param}} is changed
while collection of bulk data is enabled, the first reporting
interval begins immediately. The Unknown Time value as 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 reporting intervals.
If absolute time is not available to the CPE, its reporting interval
behavior MUST be the same as if the {{param}} parameter was set to
the Unknown Time value. For example, if {{param|ReportingInterval}}
is 86400 (a day) and if {{param}} is set to UTC midnight on some day
(in the past, present, or future) then the CPE will generate (and
transmit, if in a "ITPush" mode) its report at midnight every 24
hours. Note that, if {{param}} is set to a time other than the
Unknown Time, the first reporting interval (which has to begin
immediately) will almost certainly be shorter than
{{param|ReportingInterval}}). This is why {{param}} is defined in
terms of when reporting intervals complete rather than start.
This is the host name or IP Address of the IPDR Collector to be used
by the CPE to stream bulk data records if this collection profile is
configured for the IPDR Streaming Protocol {{bibref|IPDR-SP}} (the
{{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
This is the port number of the IPDR Collector to be used by the CPE
to stream bulk data records if this collection profile is configured
for the IPDR Streaming Protocol {{bibref|IPDR-SP}} (the
{{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
This is the IANA default port for {{bibref|IPDR-SP}}
This is the unique identification of an IPDR Session to be used when
this collection profile is configured for the IPDR Streaming Protocol
{{bibref|IPDR-SP}} (the {{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}). An ACS MUST NOT configure multiple
IPDR Streaming Protocol collection profiles with the same {{param}}.
Doing so MUST cause the CPE to fail the SetParameterValues. Within
the IPDR Streaming Protocol specification the Session ID has a type
of a single 'char', but we are restricting the range even further
(ASCII values of '0' - '9' and 'A' - 'Z'.
ASCII values of '0' - '9'
ASCII values of 'A' - 'Z'
This is the URL within the CPE that is used by an IPDR Collector to
retrieve the IPDRDocs when this collection profile is configured for
the IPDR File Transfer Protocol {{bibref|IPDR-FTP}} (the
{{param|Protocol}} parameter has a value of
{{enum|File|#.Protocols}}).
Username used for authentication of the {{param|FileTransferURL}}.
This is the {{param}} that the IPDR Collector uses to access the CPE
when this collection profile is configured for the IPDR File Transfer
Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a
value of {{enum|File|#.Protocols}}).
Password used for authentication of the {{param|FileTransferURL}}.
This is the {{param}} that the IPDR Collector uses to access the CPE
when this collection profile is configured for the IPDR File Transfer
Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a
value of {{enum|File|#.Protocols}}).
If this collection profile is configured for the IPDR File Transfer
Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a
value of {{enum|File|#.Protocols}}) then the control file names will
be of the following format:
:
<ControlFilePrefix>_<ControlFilePolicy>.<ControlFileSuffix>
Where the following rules apply:
* ControlFilePrefix MUST NOT contain an underscore '_' or any other
character not suitable for a file name.
* ControlFilePolicy MUST contain one or more ‘N’ characters, where
the number of ‘N’ characters denotes the number of digits in the
sequence number, including leading zeros as necessary to match the
number of ‘N’ characters.
* ControlFileSuffix is a file extension. For example,
BulkData_NNNN.log where "BulkData" would be the prefix, "NNNN"
would be the policy, and "log" would be the suffix. Files adhering
to this file format would look like: BulkData_0000.log,
BulkData_0001.log, etc.
{{numentries}}
Bulk data parameter table. Each entry in this table represents a
parameter (or set of parameters if a partial path is provided) to be
collected and reported.
Represents the parameter(s) that are part of this Bulk Data
collection profile. In the case where a partial parameter path is
specified all sub-objects and contained parameters will be part of
the bulk data collected and reported. If the path name refers to an
object then it MUST end with a '.'.