LANDeviceNumberOfEntries

unsignedInt

R

Number of instances of LANDevice.

-

1.0

WANDeviceNumberOfEntries

unsignedInt

R

Number of instances of WANDevice.

-

1.0

UserNumberOfEntries

unsignedInt

R

The number of entries in the User table.

-

1.0

SmartCardReaderNumberOfEntries

unsignedInt

R

The number of entries in the SmartCardReader table.

-

1.0

DeviceCategory

string[]

R

Comma-separated list of strings. Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

-

1.0

Manufacturer

string(:64)

R

The manufacturer of the CPE (human readable string).

-

1.0

ManufacturerOUI

string(6)

R

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

• [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI]. 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.

-

1.0

ModelName

string(:64)

R

Model name of the CPE (human readable string).

-

1.0

ModelNumber

string(:64)

R

The model number of the device (human readable string), or an empty string if no model number is provided by the device. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31.

-

1.0

Description

string(:256)

R

A full description of the CPE device (human readable string).

-

1.0

ProductClass

string(:64)

R

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 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.

-

1.0

SerialNumber

string(:64)

R

Identifier of the particular device that is unique for the indicated class of product and manufacturer. 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.

-

1.0

HardwareVersion

string(:64)

R

A string identifying the particular CPE model and version.

This parameter MUST always be included in Inform messages.

-

1.0

SoftwareVersion

string(:64)

R

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 MUST always be included in Inform messages.

Active Notification MUST always be enabled for this parameter.

-

1.0

ModemFirmwareVersion

string(:64)

R

A string identifying the version of the modem firmware currently installed in the CPE. This is applicable only when the modem firmware is separable from the overall CPE software.

-

1.0

AdditionalHardwareVersion

string[](:64)

R

Comma-separated list (maximum number of characters 64) of strings. Any additional hardware version information the vendor might wish to supply.

-

1.0

AdditionalSoftwareVersion

string[](:64)

R

Comma-separated list (maximum number of characters 64) of strings. Any additional software version information the vendor might wish to supply.

-

1.0

ProvisioningCode

string(:64)

W

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. If not an empty string, this argument SHOULD be in the form of a hierarchical descriptor with one or more nodes specified. Each node in the hierarchy is represented as a 4-character sub-string, containing only numerals or upper-case letters. If there is more than one node indicated, each node is separated by a "." (dot). Examples: "TLCO" or "TLCO.GRP2".

This parameter MUST always be included in Inform messages.

Active Notification MUST always be enabled for this parameter.

-

1.0

UpTime

unsignedInt

R

Time in seconds since the CPE was last restarted.

Active Notification requests for this parameter MAY be denied.

-

1.0

FirstUseDate

dateTime

R

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.

-

1.0

DeviceLog

string(:32768)

R

Vendor-specific log(s).

Active Notification requests for this parameter MAY be denied.

-

1.0

VendorConfigFileNumberOfEntries

unsignedInt

R

Number of instances of VendorConfigFile.

-

1.0

SupportedDataModelNumberOfEntries

unsignedInt

R

The number of entries in the SupportedDataModel table.

-

1.0

ProcessorNumberOfEntries

unsignedInt

R

The number of entries in the Processor table.

-

1.0

VendorLogFileNumberOfEntries

unsignedInt

R

The number of entries in the VendorLogFile table.

-

1.0

LocationNumberOfEntries

unsignedInt

R

The number of entries in the Location table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Name

string(:64)

R

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.

-

1.0

Version

string(:16)

R

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 an empty string.

-

1.0

Date

dateTime

R

Date and time when the content of the current version of this vendor configuration file was first applied by the CPE.

-

1.0

Description

string(:256)

R

A description of the vendor configuration file (human-readable string).

-

1.0

Total

unsignedInt

R

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

-

1.0

Free

unsignedInt

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

CPUUsage

unsignedInt(:100)

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

ProcessNumberOfEntries

unsignedInt

R

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

-

1.0

PID

unsignedInt

R

The Process Identifier.

-

1.0

Command

string(:256)

R

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

-

1.0

Size

unsignedInt

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Priority

unsignedInt(:99)

R

The priority of the process where 0 is highest.

-

1.0

CPUTime

unsignedInt

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

State

string

R

The current state that the process is in.

Enumeration of:

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

Active Notification requests for this parameter MAY be denied.

-

1.0

TemperatureSensorNumberOfEntries

unsignedInt

R

The number of entries in the TemperatureSensor table.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Enable

boolean

W

Indicates whether or not the temperature sensor is enabled.

-

1.0

Status

string

R

The status of this temperature sensor.

Enumeration of:

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

-

1.0

Reset

boolean

W

When set to true, resets the temperature sensor.

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

-

1.0

ResetTime

dateTime

R

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

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

-

1.0

Name

string(:256)

R

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

-

1.0

Value

int(-274:)

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

LastUpdate

dateTime

R

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

Active Notification requests for this parameter MAY be denied.

-

1.0

MinValue

int(-274:)

R

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

-

1.0

MinTime

dateTime

R

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

-

1.0

MaxValue

int(-274:)

R

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

-

1.0

MaxTime

dateTime

R

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

-

1.0

LowAlarmValue

int(-274:)

W

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

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

-

1.0

LowAlarmTime

dateTime

R

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

-

1.0

HighAlarmValue

int(-274:)

W

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

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

-

1.0

HighAlarmTime

dateTime

R

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

-

1.0

PollingInterval

unsignedInt

W

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

-

1.0

MaxTCPWindowSize

unsignedInt

R

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

-

1.0

TCPImplementation

string[]

R

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

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

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

URL

string(:256)

R

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

-

1.0

UUID

string(36)

R

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

-

1.0

URN

string(:256)

R

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

-

1.0

Features

string[]

R

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

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

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Architecture

string

R

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

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

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

Active Notification requests for this parameter MAY be denied.

-

1.0

Name

string(:64)

R

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

-

1.0

MaximumSize

unsignedInt

R

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

-

1.0

Persistent

boolean

R

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

-

1.0

ManufacturerOUI

string(6)

R

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

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

-

1.0

ProductClass

string(:64)

R

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

-

1.0

SerialNumber

string(:64)

R

Serial number of the associated CPE Proxier.

-

1.0

ProxyProtocol

string()

R

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

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

-

1.0

Source

string

R

Identifies the source of the location data.

Enumeration of:

• GPS
• AGPS
• Manual
• External

External

1.0

AcquiredTime

dateTime

R

The time when the location was acquired.

-

1.0

ExternalSource

string

R

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

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

-

1.0

ExternalProtocol

string

R

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

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

CWMP

1.0

DataObject

string(:1200)

W

The currently valid location information. Writable only when ExternalProtocol has a value of CWMP. If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491].

If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). If obtained by an external source this is the location information as received. If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. CWMP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). Only zero or one Location object instance with value CWMP MUST exist at any given time.

-

1.0

PersistentData

string(:256)

W

Arbitrary user data that MUST persist across CPE reboots.

-

1.0

ConfigFile

string(:32768)

W

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.

-

1.0

EnableCWMP

boolean

W

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 factory default value MUST be true. 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.

-

1.0

URL

string(:256)

W

URL, as defined in [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 [RFC2616]. 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.

-

1.0

Username

string(:256)

W

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.

-

1.0

Password

string(:256)

W

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.

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.

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

-

1.0

PeriodicInformEnable

boolean

W

Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call.

-

1.0

PeriodicInformInterval

unsignedInt(1:)

W

The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true.

-

1.0

PeriodicInformTime

dateTime

W

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 PeriodicInformInterval. PeriodicInformTime is used only to set the "phase" of the periodic Informs. The actual value of PeriodicInformTime can be arbitrarily far into the past or future. For example, if PeriodicInformInterval is 86400 (a day) and if PeriodicInformTime 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 PeriodicInformTime refers to a day in the future. The Unknown Time value defined in [Section 2.2/TR-098a2] 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 Inform behavior MUST be the same as if the PeriodicInformTime parameter was set to the Unknown Time value.

-

1.0

ParameterKey

string(:32)

R

ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey 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 ParameterKey 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 ParameterKey MUST NOT be modified. The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string.

This parameter MUST always be included in Inform messages.

Active Notification requests for this parameter MAY be denied.

-

1.0

ConnectionRequestURL

string(:256)

R

HTTP URL, as defined in [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.

This parameter MUST always be included in Inform messages.

Active Notification MUST by default be enabled for this parameter.

-

1.0

ConnectionRequestUsername

string(:256)

W

Username used to authenticate an ACS making a Connection Request to the CPE.

-

1.0

ConnectionRequestPassword

string(:256)

W

Password used to authenticate an ACS making a Connection Request to the CPE.

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

-

1.0

UpgradesManaged

boolean

W

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 upgade if it is performed according to ACS-specified policy.

-

1.0

KickURL

string(:256)

R

Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in [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.

-

1.0

DownloadProgressURL

string(:256)

R

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 [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.

-

1.0

DefaultActiveNotificationThrottle

unsignedInt

W

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.

-

1.0

UDPConnectionRequestAddress

string(:256)

R

Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069a2]). This parameter is represented in the form of an Authority element as defined in [RFC3986]. The value MUST be in one of the following two forms:

host:port

host When 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 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".

-

1.0

UDPConnectionRequestAddressNotificationLimit

unsignedInt

W

The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled).

-

1.0

STUNEnable

boolean

W

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.

-

1.0

STUNServerAddress

string(:256)

W

Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. If an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL.

-

1.0

STUNServerPort

unsignedInt(0:65535)

W

Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. By default, this SHOULD be the equal to the default STUN port, 3478.

-

1.0

STUNUsername

string(:256)

W

If not an empty string, 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 an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity.

-

1.0

STUNPassword

string(:256)

W

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 an empty string, regardless of the actual value.

-

1.0

STUNMaximumKeepAlivePeriod

int(-1:)

W

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.

-

1.0

STUNMinimumKeepAlivePeriod

unsignedInt

W

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 [RFC3489].

-

1.0

NATDetected

boolean

R

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 STUNEnable is false, this value MUST be false.

-

1.0

AliasBasedAddressing

boolean

R

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 [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4].

This parameter MUST always be included in Inform messages.

-

1.0

ManageableDeviceNumberOfEntries

unsignedInt

R

Number of entries in the ManageableDevice table.

-

1.0

ManageableDeviceNotificationLimit

unsignedInt

W

The minimum time, in seconds, between Active Notifications resulting from changes to the ManageableDeviceNumberOfEntries (if Active Notification is enabled).

-

1.0

EmbeddedDeviceNumberOfEntries

unsignedInt

R

The number of entries in the EmbeddedDevice table.

-

1.0

VirtualDeviceNumberOfEntries

unsignedInt

R

The number of entries in the VirtualDevice table.

-

1.0

InstanceMode

string

W

Instance identification mode as defined in [Section 3.6.1/TR-069a4]. When AliasBasedAddressing is true, InstanceMode is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. Enumeration of:

• InstanceNumber
• InstanceAlias This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be InstanceNumber.

-

1.0

AutoCreateInstances

boolean

W

Enable or disable the Auto-Create Instance Mechanism. When AliasBasedAddressing is true, AutoCreateInstances indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in [A.3.2.1/TR-069a4]). *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.

The factory default value MUST be false.

-

1.0

CWMPRetryMinimumWaitInterval

unsignedInt(1:65535)

W

Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2]. A value of 5 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

-

1.0

CWMPRetryIntervalMultiplier

unsignedInt(1000:65535)

W

Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2]. 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 [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

-

1.0

SupportedConnReqMethods

string[]

R

Comma-separated list of strings. The connection request methods supported by this ManagementServer. Each list item is an enumeration of:

• HTTP (The connection request method as specified in [Section 3.2.2 ACS Connection Initiation/TR-069], REQUIRED)
• STUN (The connection request method as specified in [Annex G Connection Request via NAT Gateway/TR-069], OPTIONAL)
• XMPP (The connection request method as specified in [Annex K XMPP Connection Request/TR-069a5], OPTIONAL)

-

1.0

ConnReqXMPPConnection

string

W

The value MUST be the Path Name of the XMPP.Connection instance that is used for connection requests to this ManagementServer. If the referenced object is deleted, the parameter value MUST be set to an empty string.

-

1.0

ConnReqAllowedJabberIDs

string(:256)[:32]

W

When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza will contian a "from" address that contains the Jabber ID of the initiating entity. This parameter is a Comma-separated list (up to 32 items) of strings (maximum number of characters per item 256). Each entry represents a Jabber ID, or address, that is allowed to initiate an XMPP Connection Request. Each Jabber ID is allowed to be either a "Full JID" (containing a local-part, domain-part, and resource-part in the following format: "local-part@domain-part/resource-part") or a "Bare JID" (containing a local-part and a domain-part in the following format: "local-part@domain-part"). "Full JID" entries require an exact match whereas "Bare JID" entries are a wildcard match and will match any Jabber ID with the same local-part and domain-part independent of the resource-part. For example, if ConnReqAllowedJabberIDs contained "ACS1@tr069.example.com, ACS2@tr-069.example.com/resource1" then the following incoming "from" addresses would be allowed:

• "ACS1@tr069.example.com/resource1"
• "ACS1@tr069.example.com/resource2"
• "ACS2@tr069.example.com/resource1" And the following incoming "from" addresses would not be allowed:
• "ACS2@tr069.example.com/resource2"
• "ACS@tr069.example.com/resource" If this Parameter is an empty string then all Jabber IDs are allowed and an XMPP Connection Request can not be deemed invalid due to the "from" address.

-

1.0

ConnReqJabberID

string

R

The value MUST be the value of the XMPP.Connection.{i}.JabberID contained in the XMPP.Connection instance referenced by the ConnReqXMPPConnection parameter. If the ConnReqXMPPConnection parameter is empty or the XMPP.Connection instance being reference is disabled, then this value will be empty. If the XMPP.Connection instance being referenced by the ConnReqXMPPConnection parameter is lost (XMPP.Connection.{i}.Status parameter changes from Enabled to some other value), then the value of this parameter MUST remain unchanged until the connection can be reestablished and a new XMPP.Connection.{i}.JabberID can be established. If the new XMPP.Connection.{i}.JabberID is identical to the existing value, then the value of this parameter MUST NOT be altered and a VALUE CHANGE event MUST NOT be generated.

Active Notification MUST by default be enabled for this parameter.

-

1.0

HTTPCompressionSupported

string[]

R

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in [Section 3.4.7/TR-069a5]. Each list item is an enumeration of:

• GZIP (As defined in [Section 3.5/RFC2616])
• Compress (As defined in [Section 3.5/RFC2616])
• Deflate (As defined in [Section 3.5/RFC2616]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a7] MUST be adhered to.

-

1.0

HTTPCompression

string

W

The value MUST be a member of the list reported by the HTTPCompressionSupported parameter, or else be Disabled. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when communicating with the ACS.

The factory default value MUST be Disabled.

-

1.0

LightweightNotificationProtocolsSupported

string[]

R

Comma-separated list of strings. Indicates the Lightweight Notification Protocol(s) supported by this CPE. Each list item is an enumeration of:

• UDP (As defined in [Annex M/TR-069a5]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a7] MUST be adhered to.

-

1.0

LightweightNotificationProtocolsUsed

string[]

W

Comma-separated list of strings. Each list item MUST be a member of the list reported by the LightweightNotificationProtocolsSupported parameter, or else be an empty string. The value of this parameter represents the protocol(s) that will be used by the CPE when sending Lightweight Notifications. An empty string means that Lightweight Notifications are disabled, despite any SetParameterAttributes that have been configured on various parameters.

-

1.0

UDPLightweightNotificationHost

string(:256)

W

Host name or address to be used when sending the UDP Lightweight Notifications. UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration. If UDPLightweightNotificationHost is not implemented or is an empty string, and UDP Lightweight Notifications are supported, the destination host MUST be the same as the ACS (as contained in the host portion of the URL).

-

1.0

UDPLightweightNotificationPort

unsignedInt

W

The port number to be used when sending UDP Lightweight Notifications. UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration. If UDPLightweightNotificationPort is not implemented and UDP Lightweight Notifications are supported, the destination port MUST be 7547.

-

1.0

InformParameterNumberOfEntries

unsignedInt

R

The number of entries in the InformParameter table.

-

1.0

ManufacturerOUI

string(:6)

R

Organizationally unique identifier of the Device manufacturer as provided to the Gateway by the Device. 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 [OUI].

Active Notification requests for this parameter MAY be denied.

-

1.0

SerialNumber

string(:64)

R

Serial number of the Device as provided to the Gateway by the Device.

Active Notification requests for this parameter MAY be denied.

-

1.0

ProductClass

string(:64)

R

Identifier of the class of product for which the Device's serial number applies as provided to the Gateway by the Device. If the Device does not provide a Product Class, then this parameter MUST be an empty string.

Active Notification requests for this parameter MAY be denied.

-

1.0

Host

string[](:1024)

R

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a Host table row. If the referenced object is deleted, the corresponding item MUST be removed from the list. This list MUST include an item for each Host table entry, whether active or inactive, that corresponds to this physical LAN Device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. For example: InternetGatewayDevice.LANDevice.1.Hosts.Host.1,InternetGatewayDevice.LANDevice.1.Hosts.Host.5

-

1.0

Enable

boolean

W

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

-

1.0

TransferTypeFilter

string

W

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

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

-

1.0

ResultTypeFilter

string

W

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

Enumeration of:

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

-

1.0

FileTypeFilter

string[](:1024)

W

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

Each list item matches one of:

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

-

1.0

Enable

boolean

W

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

-

1.0

OperationTypeFilter

string[]

W

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

Each list item is an enumeration of:

• Install
• Update
• Uninstall

-

1.0

ResultTypeFilter

string

W

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

Enumeration of:

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

-

1.0

FaultCodeFilter

string[]

W

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

Each list item is an enumeration of:

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

-

1.0

ControllerID

string(:256)

R

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

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

-

1.0

ProxiedDeviceID

string(:256)

R

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

-

1.0

Reference

string

R

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

-

1.0

SupportedDataModel

string[]

R

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instance(s) that this Proxied Device is utilizing. The CWMP-DT schema instance is also the one being utilized by the object referenced within Reference.

-

1.0

Host

string[:32]

R

Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the LANDevice.{i}.Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References the LANDevice.{i}.Hosts.Host table entry(s), whether active or inactive, that corresponds to this proxied LAN device.

-

1.0

ProxyProtocol

string()

R

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

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

-

1.0

ProxyProtocolReference

string

R

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

-

1.0

DiscoveryProtocol

string[]

R

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

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

-

1.0

DiscoveryProtocolReference

string[]

R

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

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

-

1.0

CommandProcessed

string

R

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

Enumeration of:

• Pending
• Retrying
• Success
• Error

-

1.0

CommandProcessingErrMsg

string(:1024)

R

Detailed CommandProcessed error description (vendor specific).

-

1.0

LastSyncTime

dateTime

R

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

-

1.0

ManufacturerOUI

string(6)

R

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

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

-

1.0

ProductClass

string(:64)

R

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

-

1.0

SerialNumber

string(:64)

R

Serial number of the associated Proxied Device.

-

1.0

Host

string[:32]

R

Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the LANDevice.{i}.Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the LANDevice.{i}.Hosts.Host table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface.

-

1.0

ProxyProtocol

string()

R

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

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

-

1.0

ProxyProtocolReference

string

R

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

-

1.0

DiscoveryProtocol

string[]

R

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

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

-

1.0

DiscoveryProtocolReference

string[]

R

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

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

-

1.0

CRUnawarenessMaxDuration

int(-1:)

W

When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in seconds), the CPE MUST issue a WAKEUP Event. If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for having been non CR-aware.

The factory default value MUST be -1.

-

1.0

MaxMissedPeriodic

int(-1:)

W

When waking up from a non fully Timer-Aware Standby that made it miss more than this parameter's value Periodic Contacts, the CPE MUST issue a WAKEUP Event. If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for exceeding that limit.

The factory default value MUST be -1.

-

1.0

NotifyMissedScheduled

boolean

W

When waking up from a non fully Timer-Aware Standby that made it miss at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if this parameter is true.

The factory default value MUST be false.

-

1.0

NetworkAwarenessCapable

boolean

R

Indicates that the CPE is capable of CR-Aware Standby.

-

1.0

SelfTimerCapable

boolean

R

Indicates that the CPE is capable of Timer-Aware Standby.

-

1.0

CRAwarenessRequested

boolean

W

If NetworkAwarenessCapable and this parameter are both true, the CPE MUST NOT go into a non CR-Aware Standby state.

The factory default value MUST be false.

-

1.0

PeriodicAwarenessRequested

boolean

W

If SelfTimerCapable and this parameter are both true, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.

The factory default value MUST be false.

-

1.0

ScheduledAwarenessRequested

boolean

W

If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact: *if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby; *if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.

-

1.0

Enable

boolean

W

Enables or disables this InformParameter.

false

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

-

1.0

ParameterName

string(:256)

W

A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE. If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.

<Empty>

1.0

EventList

string[]

W

Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC. All Inform Events (see [Section 3.7.1.5/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069]. An empty string means all events except "4 VALUE CHANGE".

<Empty>

1.0

Enable

boolean

W

Enables or disables the NTP or SNTP time client.

-

1.0

NTPServer1

string(:64)

W

First NTP timeserver. Either a host name or IP address.

-

1.0

NTPServer2

string(:64)

W

Second NTP timeserver. Either a host name or IP address.

-

1.0

NTPServer3

string(:64)

W

Third NTP timeserver. Either a host name or IP address.

-

1.0

NTPServer4

string(:64)

W

Fourth NTP timeserver. Either a host name or IP address.

-

1.0

NTPServer5

string(:64)

W

Fifth NTP timeserver. Either a host name or IP address.

-

1.0

CurrentLocalTime

dateTime

R

The current date and time in the CPE's local time zone.

Active Notification requests for this parameter MAY be denied.

-

1.0

LocalTimeZoneName

string(:64)

W

Name of the local time zone (human readable string).

The name SHOULD be encoded according to IEEE 1003.1 (POSIX). The following is an example value: EST+5EDT,M4.1.0/2,M10.5.0/2

-

1.0

Status

string

R

Status of Time support on the CPE. Enumeration of:

• Disabled
• Unsynchronized
• Synchronized
• Error_FailedToSynchronize
• Error (OPTIONAL) The Unsynchronized value indicates that the CPE's absolute time has not yet been set. The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate. The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate. The Error value MAY be used by the CPE to indicate a locally defined error condition.

-

1.0

UserDatabaseSupported

boolean

R

Present only if the CPE provides a password-protected LAN-side user interface. Indicates whether or not the CPE supports a user database that provides per-user passwords that can be used for accessing the local user interface.

-

1.0

PasswordRequired

boolean

W

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.

-

1.0

PasswordUserSelectable

boolean

W

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.

-

1.0

UpgradeAvailable

boolean

W

Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user.

-

1.0

WarrantyDate

dateTime

W

Indicates the date and time in UTC that the warranty associated with the CPE is to expire.

-

1.0

ISPName

string(:64)

W

The name of the customer's ISP.

-

1.0

ISPHelpDesk

string(:32)

W

The help desk phone number of the ISP.

-

1.0

ISPHomePage

string(:256)

W

The URL of the ISP's home page.

-

1.0

ISPHelpPage

string(:256)

W

The URL of the ISP's on-line support page.

-

1.0

ISPLogo

base64(0:4095)

W

Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less.

-

1.0

ISPLogoSize

unsignedInt(0:4095)

W

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.

-

1.0

ISPMailServer

string(:256)

W

The URL of the ISP's mail server.

-

1.0

ISPNewsServer

string(:256)

W

The URL of the ISP's news server.

-

1.0

TextColor

string(:6)

W

The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088).

-

1.0

BackgroundColor

string(:6)

W

The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088).

-

1.0

ButtonColor

string(:6)

W

The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088).

-

1.0

ButtonTextColor

string(:6)

W

The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088).

-

1.0

AutoUpdateServer

string(:256)

W

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 InternetGatewayDevice.ManagementServer.UpgradesManaged parameter is true.

-

1.0

UserUpdateServer

string(:256)

W

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 InternetGatewayDevice.ManagementServer.UpgradesManaged parameter is true.

-

1.0

ExampleLogin

string(:40)

W

An example of a correct login, according to ISP-specific rules.

-

1.0

ExamplePassword

string(:30)

W

An example of a correct password, according to ISP-specific rules.

-

1.0

AvailableLanguages

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. Available user-interface languages, where each language is specified according to RFC 3066 [RFC3066].

-

1.0

SharedPassword

boolean

W

Present only if the CPE provides a password-protected LAN-side user interface. Indicates whether or not a single shared password MUST protect the local user interface, or whether per-user passwords can be used. If either UserDatabaseSupported or PasswordUserSelectable is false, the CPE MUST ignore the value of this parameter.

-

1.0

CurrentLanguage

string(:16)

W

Current user-interface language, specified according to RFC 3066 [RFC3066].

-

1.0

Enable

boolean

W

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

-

1.0

Port

unsignedInt(:65535)

W

Destination TCP port required for remote access connection.

-

1.0

SupportedProtocols

string[]

R

Comma-separated list of strings. Indicates the protocols that are supported by the CPE for the purpose of remotely accessing the user interface.

Each list item is an enumeration of:

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

-

1.0

Protocol

string

W

The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access.

-

1.0

Movable

boolean

W

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

-

1.0

Resizable

boolean

W

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

-

1.0

PosX

int

W

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

Active Notification requests for this parameter MAY be denied.

-

1.0

PosY

int

W

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Width

unsignedInt

W

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Height

unsignedInt

W

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

Active Notification requests for this parameter MAY be denied.

-

1.0

DisplayWidth

unsignedInt

R

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

-

1.0

DisplayHeight

unsignedInt

R

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

-

1.0

DefaultConnectionService

string(:256)

W

Specifies the default WAN interface. The content is the full hierarchical parameter name of the default layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1.

-

1.0

ForwardNumberOfEntries

unsignedInt

R

Number of forwarding instances.

-

1.0

Enable

boolean

W

Enables or disables the forwarding entry. On creation, an entry is disabled by default.

false

1.0

Status

string

R

Indicates the status of the forwarding entry.

Enumeration of:

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

Disabled

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value. This parameter can only be modified if StaticRoute is true

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

Active Notification requests for this parameter MAY be denied.

-

1.0

StaticRoute

boolean

R

If true, this route is a Static route.

true

1.0

DestIPAddress

string(:45)

W

[IPAddress] Destination address. An empty string or a value of "0.0.0.0" indicates no destination address is specified.

A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string or "0.0.0.0" is a default route.

<Empty>

1.0

DestSubnetMask

string(:45)

W

[IPAddress] Destination subnet mask. An empty string or a value of "0.0.0.0" indicates no destination subnet mask is specified.

If a destination subnet mask is specified, the DestSubnetMask is ANDed with the destination address before comparing with the DestIPAddress. Otherwise, the full destination address is used as is. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string or "0.0.0.0" is a default route.

<Empty>

1.0

SourceIPAddress

string(:45)

W

[IPAddress] Source address. An empty string or a value of "0.0.0.0" indicates no source address is specified.

<Empty>

1.0

SourceSubnetMask

string(:45)

W

[IPAddress] Source subnet mask. An empty string or a value of "0.0.0.0" indicates no source subnet mask is specified.

If a source subnet mask is specified, the SourceSubnetMask is ANDed with the source address before comparing with the SourceIPAddress. Otherwise, the full source address is used as is.

<Empty>

1.0

GatewayIPAddress

string(:45)

W

[IPAddress] IP address of the gateway. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other.

<Empty>

1.0

Interface

string(:256)

W

Specifies the egress interface associated with this entry. The value MUST be the Path Name of the layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. For a route that was configured by setting GatewayIPAddress but not Interface, read access to Interface MUST return the full hierarchical parameter name for the route's egress interface.

-

1.0

ForwardingMetric

int(-1:)

W

Forwarding metric. A value of -1 indicates this metric is not used.

-1

1.0

MTU

unsignedInt(1:1540)

W

The maximum allowed size of an Ethernet frame for this route.

-

1.0

ForwardingPolicy

int(-1:)

W

Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the QueueManagement object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows.

-1

1.0

ConfigPassword

string(:64)

W

A password to allow LAN access to protected auto-configuration services. If the CPE supports TR-064 (LAN-side DSL CPE Configuration Protocol), this parameter is to be used as the dslf-config password (as defined in TR-064). If the CPE has a user interface with password protection enabled, this parameter is also to be used as the user password for password-protected operations. However, this parameter MUST NOT be used to set the user password if the parameter InternetGatewayDevice.UserInterface.PasswordUserSelectable is true.

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

-

1.0

DiagnosticsState

string

W

Indicates availability of diagnostic data. Enumeration of:

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Interface

string(:256)

W

The value MUST be the Path Name of the WAN or LAN IP-layer interface over which the test is to be performed. This identifies the source IP address to use when performing the test. The following is a WAN interface example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1 The following is a LAN interface example: InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1 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 an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

-

1.0

Host

string(:256)

W

Host name or address of the host to ping.

-

1.0

NumberOfRepetitions

unsignedInt(1:)

W

Number of repetitions of the ping test to perform before reporting the results.

-

1.0

Timeout

unsignedInt(1:)

W

Timeout in milliseconds for the ping test.

-

1.0

DataBlockSize

unsignedInt(1:65535)

W

Size of the data block in bytes to be sent for each ping.

-

1.0

DSCP

unsignedInt(0:63)

W

DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.

-

1.0

SuccessCount

unsignedInt

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

FailureCount

unsignedInt

R

Result parameter indicating the number of failed pings in the most recent ping test.

Active Notification requests for this parameter MAY be denied.

-

1.0

AverageResponseTime

unsignedInt

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

MaximumResponseTime

unsignedInt

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

MinimumResponseTime

unsignedInt

R

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.

Active Notification requests for this parameter MAY be denied.

-

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

LANEthernetInterfaceNumberOfEntries

unsignedInt

R

Number of instances of LANEthernetInterfaceConfig in this LANDevice.

0

1.0

LANUSBInterfaceNumberOfEntries

unsignedInt

R

Number of instances of LANUSBInterfaceConfig in this LANDevice.

0

1.0

LANWLANConfigurationNumberOfEntries

unsignedInt

R

Number of instances of WLANConfiguration in this LANDevice.

0

1.0

MACAddress

string(:17)

R

[MACAddress] The MAC address associated with the IP interface modeled by this LANDevice instance. This is the MAC address that is returned in response to an ARP request for any of the IP interface's IP addresses. It is also the source MAC address in all IP traffic sent over the IP interface. If no single MAC address meets the above criteria, the value of this parameter MUST be the all-zero MAC address 00:00:00:00:00:00.

-

1.0

DHCPServerConfigurable

boolean

W

Enables the configuration of the DHCP server on the LAN interface. If this variable is set to false, the CPE SHOULD restore its default DHCP server settings.

true

1.0

DHCPServerEnable

boolean

W

Enables or disables the DHCP server on the LAN interface.

false

1.0

MinAddress

string(:45)

W

[IPAddress] Specifies first address in the pool to be assigned by the DHCP server on the LAN interface.

This parameter MUST have a valid value before the DHCP server can be enabled.

-

1.0

MaxAddress

string(:45)

W

[IPAddress] Specifies last address in the pool to be assigned by the DHCP server on the LAN interface.

This parameter MUST have a valid value before the DHCP server can be enabled.

-

1.0

ReservedAddresses

string(:45)[](:256)

W

[IPAddress] Comma-separated list (maximum number of characters 256) of IP Addresses. Addresses marked reserved from the address allocation pool.

<Empty>

1.0

SubnetMask

string(:45)

W

[IPAddress] Specifies the client's network subnet mask.

This parameter MUST have a valid value before the DHCP server can be enabled.

-

1.0

DNSServers

string(:45)[](:64)

W

[IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL.

-

1.0

DomainName

string(:64)

W

Sets the domain name to provide to clients on the LAN interface.

-

1.0

IPRouters

string(:45)[](:64)

W

[IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. IP addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL.

-

1.0

DHCPLeaseTime

int(-1:)

W

Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease.

86400

1.0

UseAllocatedWAN

string

W

Controls use of addresses from the associated WAN connection. Enumeration of:

• Normal
• UseAllocatedSubnet (DEPRECATED)
• Passthrough If Normal, the address pool is directly configured by the ACS. If {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}}, behavior is the same as for Passthrough with an empty PassthroughMACAddress. For this reason, {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}} is DEPRECATED. If Passthrough, and PassthroughMACAddress is an empty string, the configured values of the MinAddress, MaxAddress, SubnetMask and DNSServers parameters are ignored. The corresponding address pool values are instead taken from the WAN connection specified by AssociatedConnection. If Passthrough, and PassthroughMACAddress is not an empty string, the LAN Host identified by PassthroughMACAddress is given a WAN IP address from the WAN connection specified by AssociatedConnection. Other LAN Hosts are treated as for Normal. Use of PassthroughMACAddress does not cover the case where more than one LAN Host is to be given a WAN IP address. This can be achieved by using a DHCP conditional serving pool.

Normal

1.0

AssociatedConnection

string(:256)

W

The value MUST be the Path Name of the connection instance to be used for address allocation if UseAllocatedWAN is set to {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}} or Passthrough. The content is the full hierarchical parameter name of a WAN-side layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. If UseAllocatedWAN is {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}} or Passthrough, this parameter MUST have a valid value before the DHCP server can be enabled.

-

1.0

PassthroughLease

unsignedInt

W

DHCP lease time in seconds given to the LAN Host that is used to passthrough a WAN IP address if UseAllocatedWAN is Passthrough. Note: A temporary private IP address with short lease (for example, 1 min) might be given to the passthrough LAN Host before the WAN IP address is acquired.

600

1.0

PassthroughMACAddress

string(:17)

W

[MACAddress] Hardware address of the LAN Host that is used to passthrough a WAN IP address if UseAllocatedWAN is Passthrough. Note: an empty string indicates that no specific LAN Host is designated, and results in the same behavior as the (DEPRECATED) {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}}.

-

1.0

AllowedMACAddresses

string(:17)[](:512)

W

[MACAddress] Comma-separated list (maximum number of characters 512) of MAC Addresses. Hardware addresses that are allowed to connect to this connection if MACAddressControlEnabled is 1 for a given interface.

-

1.0

IPInterfaceNumberOfEntries

unsignedInt

R

The number of entries in the IPInterface table.

0

1.0

DHCPStaticAddressNumberOfEntries

unsignedInt

R

The number of entries in the DHCPStaticAddress table.

0

1.0

DHCPOptionNumberOfEntries

unsignedInt

R

The number of entries in the DHCPOption table.

0

1.0

DHCPConditionalPoolNumberOfEntries

unsignedInt

R

The number of entries in the DHCPConditionalServingPool table.

0

1.0

Enable

boolean

W

Enables or disables this entry. On creation, an entry is disabled by default.

false

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

IPInterfaceIPAddress

string(:45)

W

[IPAddress] IP address of the LAN-side interface of the CPE.

<Empty>

1.0

IPInterfaceSubnetMask

string(:45)

W

[IPAddress] Subnet mask of the LAN-side interface of the IGD.

<Empty>

1.0

IPInterfaceAddressingType

string

W

Represents the addressing method used to assign the LAN-side IP address of the CPE on this interface.

Enumeration of:

• DHCP
• Static
• AutoIP

DHCP

1.0

Enable

boolean

W

Enables or disables the DHCPStaticAddress table entry. Disabling an entry does not return the IP address to the pool.

false

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Chaddr

string(:17)

W

[MACAddress] Hardware address (MAC address) of the physical interface of the DHCP client. This parameter MUST have a valid value before the table entry can be enabled.

<Empty>

1.0

Yiaddr

string(:45)

W

[IPAddress] IP address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address). This parameter MUST have a valid value before the table entry can be enabled.

<Empty>

1.0

Enable

boolean

W

Enables or disables this DHCPOption table entry.

false

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Tag

unsignedInt(1:254)

W

Option tag as defined in RFC 2132 [RFC2132].

-

1.0

Value

base64(0:255)

W

Base64 encoded option value.

<Empty>

1.0

Enable

boolean

W

Enables or disables the DHCPConditionalServingPool entry.

false

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

PoolOrder

unsignedInt(1:)

W

Position of the pool entry in the order of precedence. A value of 1 indicates the first entry considered. For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value on creation of a DHCPConditionalServingPool table entry MUST be one greater than the largest current value.

-

1.0

SourceInterface

string[](:1024)

W

Pool association criterion. Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of the layer 2 ingress interfaces associated with this entry, i.e. the corresponding LAN**InterfaceConfig or WLANConfiguration objects. For example: InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2,InternetGatewayDevice.LANDevice.1.WLANConfiguration.3 an empty string indicates this entry is to apply to all layer 2 interface objects under this LANDevice instance.

<Empty>

1.0

VendorClassID

string(:256)

W

Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132 [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. An empty string indicates this criterion is not used for conditional serving.

<Empty>

1.0

VendorClassIDExclude

boolean

W

If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified.

false

1.0

VendorClassIDMode

string

W

VendorClassID pattern match criterion. Enumeration of:

• Exact
• Prefix
• Suffix
• Substring For example, if VendorClassID is "Example" then an Option 60 value of "Example device" will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.

Exact

1.0

ClientID

string(:256)

W

Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132 [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for conditional serving.

<Empty>

1.0

ClientIDExclude

boolean

W

If false, matching packets are those that match the ClientID entry, if specified. If true, matching packets are those that do not match the ClientID entry, if specified.

false

1.0

UserClassID

string(:256)

W

Pool association criterion. Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004 [RFC3004]. An empty string indicates this criterion is not used for conditional serving.

<Empty>

1.0

UserClassIDExclude

boolean

W

If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified.

false

1.0

Chaddr

string(:17)

W

[MACAddress] Pool association criterion. Hardware address (MAC address.) of the physical interface of the DHCP client. An empty string indicates this criterion is not used for conditional serving.

<Empty>

1.0

ChaddrMask

string(:17)

W

[MACAddress] Bit-mask for the MAC address, where matching of a packet's MAC address with the Chaddr is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the Chaddr are to be used for conditional serving classification.

<Empty>

1.0

ChaddrExclude

boolean

W

If false, matching packets are those that match the (masked) Chaddr entry, if specified. If true, matching packets are those that do not match the (masked) Chaddr entry, if specified.

false

1.0

LocallyServed

boolean

W

If true, then the local DHCP server will assign an IP address from the specific address pool specified in this object. If false, the DHCP server will send the request to the DHCPServerIPAddress configured for this pool.

true

1.0

MinAddress

string(:45)

W

[IPAddress] Specifies first address in the pool to be assigned by the DHCP server on the LAN interface. This parameter is configurable only if UseAllocatedWAN is Normal. This parameter MUST have a valid value before this pool can be enabled.

-

1.0

MaxAddress

string(:45)

W

[IPAddress] Specifies last address in the pool to be assigned by the DHCP server on the LAN interface. This parameter is configurable only if UseAllocatedWAN is Normal. This parameter MUST have a valid value before this pool can be enabled.

-

1.0

ReservedAddresses

string(:45)[](:512)

W

[IPAddress] Comma-separated list (maximum number of characters 512) of IP Addresses. IP addresses marked reserved from the address allocation pool.

<Empty>

1.0

SubnetMask

string(:45)

W

[IPAddress] Specifies the client's network subnet mask. This parameter is configurable only if UseAllocatedWAN is Normal. This parameter MUST have a valid value before this pool can be enabled.

-

1.0

DNSServers

string(:45)[](:64)

W

[IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. This parameter is configurable only if UseAllocatedWAN is Normal.

-

1.0

DomainName

string(:64)

W

Sets the domain name to provide to clients on the LAN interface.

-

1.0

IPRouters

string(:45)[](:64)

W

[IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. IP addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL.

-

1.0

DHCPLeaseTime

int(-1:)

W

Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease.

86400

1.0

UseAllocatedWAN

string

W

Controls whether the MinAddress, MaxAddress, SubnetMask and DNSServers parameters are configurable or are taken from the associated WAN connection. Enumeration of:

• Normal
• Passthrough If Normal, the above-mentioned pool parameters are directly configured by the ACS. If Passthrough, the above-mentioned pool parameters cannot be configured by the ACS. Their values are instead taken from the WAN connection specified by AssociatedConnection.

Normal

1.0

AssociatedConnection

string(:256)

W

The value MUST be the Path Name of the connection instance to be used for address allocation if UseAllocatedWAN is set to Passthrough. The content is the full hierarchical parameter name of a WAN-side layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. If UseAllocatedWAN is Passthrough, this parameter MUST have a valid value before this pool can be enabled.

-

1.0

DHCPServerIPAddress

string(:45)

W

[IPAddress] IP address of the DHCP server, where the request has to be sent to when there is a conditional match with this pool and LocallyServed is false. If this parameter is not configured, then the DHCP request is dropped.

-

1.0

DHCPStaticAddressNumberOfEntries

unsignedInt

R

The number of entries in the DHCPStaticAddress table.

0

1.0

DHCPOptionNumberOfEntries

unsignedInt

R

The number of entries in the DHCPOption table.

0

1.0

Enable

boolean

W

Enables or disables the DHCPStaticAddress table entry. Disabling an entry does not return the IP address to the pool.

false

1.0

Alias

string(:64)

W

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

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

• Its value MUST NOT be empty.

• Its value MUST start with a letter.

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

• The CPE MUST NOT change the parameter value.

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

Active Notification requests for this parameter MAY be denied.

-

1.0

Chaddr

string(:17)

W

[MACAddress] Hardware address (MAC address) of the physical interface of the DHCP client. This parameter MUST have a valid value before the table entry can be enabled.

<Empty>

1.0

Yiaddr

string(:45)

W

[IPAddress] IP address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address). This parameter MUST have a valid value before the table entry can be enabled.

<Empty>

1.0