Parameters associated with the communication between the CPE and an ACS (allowed only in Device Root Object).
This object contains parameters relating to the CPE's association with an ACS.
URL 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.
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.
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.
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 should initiate the Inform method calls. Each Inform call must occur at this reference time plus or minus an integer multiple of the {{param|PeriodicInformInterval}}.
A zero dateTime value (0000-00-00T00:00:00) indicates that no particular time reference is specified. That is, the CPE may locally choose the time reference, required only to adhere to the specified {{param|PeriodicInformInterval}}.
{{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 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.
Present only for a CPE that supports the Kicked RPC method.
LAN-accessible URL 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 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.
Information to identify an Internet Gateway Device through which the CPE is connected (allowed only in Root Objects).
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.
General information about the device, including its identity and version information (allowed in Device Root and Service Objects).
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}}.
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.
Serial number of the CPE.
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''.
Comma-separated list of the OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in {{bibref|TR-069}}. 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 may wish to supply.
A comma separated list of any additional versions. Represents any additional software version information the vendor may 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.
Vendor-specific log(s).
Contains general configuration state (allowed in Device Root and Service Objects).
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.
Parameters associated with an NTP or SNTP time client on the CPE (allowed in Device Root and Service Objects).
This object contains parameters relating an NTP or SNTP time client in the CPE. Support for this object is Optional.
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
Parameters related to the user interface of the CPE (allowed in Device Root and Service Objects).
This object contains parameters relating to the user interface of the CPE. Support for this object is Optional.
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}}.
Parameters related to IP-based LAN connectivity of the CPE (allowed in Device Root and Service Objects).
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 may be associated with other interfaces is not considered part of the common data model defined in this specification.
Support for this object is Optional.
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 {{param|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.
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 is not required 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 is not required 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 is defines access to an IP-layer ping test for the default IP interface.
Indicates availability of diagnostic data. {{enum}}
Value may be set to {{enum|Requested}} to initiate the 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 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.
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}}
Value may be set to {{enum|Requested}} to initiate the 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 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.
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 top-level object for a Device.
See {{bibref|TR-106|section 3.7}}.
This object contains general services information.