RootDataModelVersion

string(:32)

R

Root data model version, e.g. 2.4. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based.

Possible patterns:

• 2\.\d+

-

2.12

InterfaceStackNumberOfEntries

unsignedInt

R

The number of entries in the InterfaceStack table.

-

2.12

ProxiedDeviceNumberOfEntries

unsignedInt

R

The number of entries in the ProxiedDevice table.

-

2.12

CollectionDeviceNumberOfEntries

unsignedInt

R

The number of entries in the CollectionDevice table.

-

2.16

IoTCapabilityNumberOfEntries

unsignedInt

R

The number of entries in the IoTCapability table.

-

2.13

NodeNumberOfEntries

unsignedInt

R

The number of entries in the Node table.

-

2.13

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.

-

2.12

Manufacturer

string(:64)

R

The manufacturer of the CPE (human readable string).

-

2.12

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 Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

-

2.12

CID

string(6)

R

Company identifier assigned and registered by the IEEE Registration Authority to the entity responsible for this Agent. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

• [0-9A-F]{6}

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

-

2.12

ModelName

string(:64)

R

Model name of the CPE (human readable string).

-

2.12

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.

-

2.12

Description

string(:256)

R

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

-

2.12

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.

-

2.12

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.

-

2.12

HardwareVersion

string(:64)

R

A string identifying the particular CPE model and version.

-

2.12

SoftwareVersion

string(:64)

R

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

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.

-

2.12

ActiveFirmwareImage

string

R

A full path reference to the row in the FirmwareImage table representing the currently running firmware image.

-

2.12

BootFirmwareImage

string

W

A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots.

This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to 'true'). Out of the factory, this parameter should be set to point to the firmware image the CPE will attempt to boot when first powered on.

The firmware image instance referenced by this parameter must also have an Available parameter value of 'true'. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPE responding with a CWMP fault (9007).

In situations where the CPE cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPE MUST NOT modify this value to point to the alternate firmware image that is currently active.

-

2.12

AdditionalHardwareVersion

string[](:64)

R

Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply.

-

2.12

AdditionalSoftwareVersion

string[](:64)

R

Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply.

-

2.12

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.

-

2.12

UpTime

unsignedInt

R

Time in seconds since the CPE was last restarted.

Value Change Notification requests for this parameter MAY be denied.

-

2.12

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.

-

2.12

HostName

string(:255)

W

The hostname of the device [Section 2 General issues/RFC1123]. This can be either a Fully Qualified Domain Name (FQDN) or just the first component of an FQDN. For example, myhgw, myhgw.home, myhgw.home.arpa, myhgw.isp.net.

-

2.16

FirmwareImageNumberOfEntries

unsignedInt

R

The number of entries in the FirmwareImage table.

-

2.12

VendorConfigFileNumberOfEntries

unsignedInt

R

The number of entries in the VendorConfigFile table.

-

2.12

ProcessorNumberOfEntries

unsignedInt

R

The number of entries in the Processor table.

-

2.12

VendorLogFileNumberOfEntries

unsignedInt

R

The number of entries in the VendorLogFile table.

-

2.12

LocationNumberOfEntries

unsignedInt

R

The number of entries in the Location table.

-

2.12

DeviceImageNumberOfEntries

unsignedInt

R

The number of entries in the DeviceImageFile table.

-

2.12

FriendlyName

string(:32)

W

The friendly name of the device.

In [TR-369] the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of [TR-369].

-

2.12

PEN

string(:10)

R

Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assinged number.

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

-

2.12

MaxNumberOfActivateTimeWindows

unsignedInt(1:5)

R

The maximum number of time windows in a FirmwareImage.{i}.Activate() Command that the Device supports.

-

2.16

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.12

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 Command input argument Restore().Input.TargetFileName used to restore this configuration file.

-

2.12

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.

-

2.12

Date

dateTime

R

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

-

2.12

Description

string(:256)

R

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

-

2.12

UseForBackupRestore

boolean

R

When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes.

Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific.

-

2.12

Total

unsignedInt

R

The total physical volatile RAM, in KiB, installed on the device.

-

2.12

Free

unsignedInt

R

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

Value Change Notification requests for this parameter MAY be denied.

-

2.12

TotalPersistent

unsignedInt

R

The sum total physical Non-Volatile Memory (NVM), in KiB, installed on the device. This memory persists across reboots and can be used by the system, applications, or users.

-

2.15

FreePersistent

unsignedInt

R

The sum total free physical Non-Volatile Memory (NVM), in KiB, currently available on the device. This memory persists across reboots and is available for use by the system, applications, or users.

Value Change Notification requests for this parameter MAY be denied.

-

2.15

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.

Value Change Notification requests for this parameter MAY be denied.

-

2.12

ProcessNumberOfEntries

unsignedInt

R

The number of entries in the Process table.

-

2.12

PID

unsignedInt

R

The Process Identifier.

-

2.12

Command

string(:256)

R

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

-

2.12

Size

unsignedInt

R

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

Value Change Notification requests for this parameter MAY be denied.

-

2.12

Priority

unsignedInt(:99)

R

The priority of the process where 0 is highest.

-

2.12

CPUTime

unsignedInt

R

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

Value Change Notification requests for this parameter MAY be denied.

-

2.12

State

string

R

The current state that the process is in.

Enumeration of:

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

Value Change Notification requests for this parameter MAY be denied.

-

2.12

TemperatureSensorNumberOfEntries

unsignedInt

R

The number of entries in the TemperatureSensor table.

-

2.12

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.12

Enable

boolean

W

Indicates whether or not the temperature sensor is enabled.

-

2.12

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)

-

2.12

ResetTime

dateTime

R

The time at which this temperature sensor was reset.

Reset can be caused by:

• Status transition from Disabled to Enabled

• Reset() command is invoked.

• An internal reset of the temperature sensor (including a reboot of the device).

The Unknown Time value, as defined in [TR-106], indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.

-

2.12

Name

string(:256)

R

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

-

2.12

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.

Value Change Notification requests for this parameter MAY be denied.

-

2.12

LastUpdate

dateTime

R

The time at which this temperature sensor's last good reading was obtained.

The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset.

Value Change Notification requests for this parameter MAY be denied.

-

2.12

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.

-

2.12

MinTime

dateTime

R

The time at which this temperature sensor's lowest value was read.

The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset.

-

2.12

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.

-

2.12

MaxTime

dateTime

R

The time at which this temperature sensor's highest value was read.

The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset.

-

2.12

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.

-

2.12

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-106], indicates that an alarm has not been encountered since the last reset.

-

2.12

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.

-

2.12

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.

-

2.12

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-106], indicates that an alarm has not been encountered since the last reset.

-

2.12

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

-

2.12

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]

-

2.12

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.12

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

-

2.12

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.12

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.

-

2.12

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.

-

2.12

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.

-

2.12

Source

string

R

Identifies the source of the location data.

Enumeration of:

• GPS
• AGPS
• Manual
• External

External

2.12

AcquiredTime

dateTime

R

The time when the location was acquired.

-

2.12

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

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

-

2.12

ExternalProtocol

string

R

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

• <Empty> (An empty string)
• CWMP
• USP (Added in 2.13)
• 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

2.12

DataObject

string(:1200)

W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP or USP.

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 or USP 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 or USP MUST exist at any given time.

-

2.12

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.12

Location

string

R

The location of the device that represents the image as the user looks at the front of the device in its typical orientation (e.g., on-end, flat).

Enumeration of:

• Front
• Back
• Left
• Right
• Top
• Bottom

-

2.12

Image

base64

R

The device image in PNG, JPEG or GIF format.

-

2.12

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.12

Name

string(:64)

R

Firmware/software image name. Descriptive text of the image or filename.

The value of Name is an empty string if Status is anything other than Active, Available, InstallationFailed, or ActivationFailed.

-

2.12

Version

string(:64)

R

A string identifying the version of the firmware image represented by this FirmwareImage. Whenever this firmware image is active (ie, the device has booted this firmware image), the value of the SoftwareVersion parameter MUST be the same as the value contained in this parameter.

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.

The value of Version is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed.

-

2.12

Available

boolean

W

Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true.

This value MUST be set to true by the device whenever a new firmware image is installed.

This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter.

Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it.

-

2.12

Status

string

R

Status of the firmware image, as determined by the Agent. Enumeration of:

• NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
• Active (This Firmware Image instance is the currently active image, added in 2.14)
• Downloading (This Firmware Image instance is being downloaded)
• Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
• Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
• DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
• ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
• InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
• ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)

-

2.12

BootFailureLog

string

R

If the Agent is unable to boot into this firmware image, when specified, the Agent can use this parameter to record some information as to why the boot failed.

If the Agent successfully boots into this firmware, the value of this parameter SHOULD be an empty string. When a new firmware image is installed into this object instance, this parameter MUST be cleared.

The length of this string is defined as implementation-specific by the Agent.

-

2.12

Enable

boolean

W

Enables or disables all the time clients and servers.

-

2.12

Status

string

R

Reflects the global time synchronisation status of the CPE. Enumeration of:

• Disabled (Indicates that the CPE's time client services are disabled)
• Unsynchronized (Indicates that the CPE's absolute time has not yet been set by any of the configured time clients)
• Synchronized (Indicates that the CPE has acquired accurate absolute time; its current time is accurate. One or more time client was able to configure the time of the CPE)
• Error_FailedToSynchronize (This enumeration was DEPRECATED in 2.16 due to the introduction of Client)
• Error (MAY be used by the CPE to indicate a locally defined error condition. None of the configured Time clients were able to synchronize the time, OPTIONAL)

-

2.12

CurrentLocalTime

dateTime

R

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

Value Change Notification requests for this parameter MAY be denied.

-

2.12

LocalTimeZone

string(:256)

W

The local time zone definition, encoded according to IEEE 1003.1 (POSIX). The following is an example value:

EST+5 EDT,M4.1.0/2,M10.5.0/2

-

2.12

ClientNumberOfEntries

unsignedInt

R

The number of entries in the Client table.

-

2.16

ServerNumberOfEntries

unsignedInt

R

The number of entries in the Server table.

-

2.16

Enable

boolean

W

Enables or disables the time client.

-

2.16

Status

string

R

Status of Time support for this client. Enumeration of:

• Disabled (Indicates that the time client service is being disabled)
• Unsynchronized (Indicates that the time client absolute time has not yet been set)
• Synchronized (Indicates that the time client has acquired accurate absolute time; its current time is accurate)
• Error (MAY be used by the time client to indicate a locally defined error condition, OPTIONAL)

-

2.16

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.16

Mode

string

W

Specifies in which mode the NTP client must be run. Enumeration of:

• Unicast (Support for the NTP client in unicast mode)
• Broadcast (Support for the NTP client in broadcast mode)
• Multicast (Support for the NTP client in multicast mode)
• Manycast (Support for the NTP client in manycast mode)

-

2.16

Port

unsignedInt(1:65535)

W

Specify the port used to send NTP packets. [Section 7.2/RFC5905]

123

2.16

Version

unsignedInt(1:4)

W

Specifies the supported NTP version. Possible versions are 1-4.

4

2.16

Servers

string[]

W

Comma-separated list of strings. Points to a CSV list of NTP servers or pools. A NTP server can either be specified as an IP address or a host name. It is expected that the NTP client resolves multiple addresses which can change over time when ResolveAddresses is enabled.

<Empty>

2.16

ResolveAddresses

boolean

W

When this option is enabled the NTP client must resolve the multiple addresses associated with the host name(s) that are specified in the Servers field.

false

2.16

ResolveMaxAddresses

unsignedInt

W

When ResolveAddresses is enabled, This parameter specifies the maxium number of IP addresses that the NTP client can resolve. 0 means that all addresses must be resolved.

6

2.16

Peer

boolean

W

Use symmetric active association mode. This device may provide synchronization to the configured NTP server.

-

2.16

MinPoll

unsignedInt

W

This is the minimum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 6 (64 seconds). [Section 7.2/RFC5905]

6

2.16

MaxPoll

unsignedInt

W

This is the maximum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 10 (1024 seconds) [Section 7.2/RFC5905]

10

2.16

IBurst

boolean

W

If the IBurst parameter is enabled, and this is the first packet sent when the server has been unreachable, the client sends a burst. This is useful to quickly reduce the synchronization distance below the distance threshold and synchronize the clock. [RFC5905].

-

2.16

Burst

unsignedInt

W

If the Burst parameter is enabled and the server is reachable and a valid source of synchronization is available, the client sends a burst of BCOUNT (8) packets at each poll interval. The interval between packets in the burst is two seconds. This is useful to accurately measure jitter with long poll intervals. [RFC5905].

8

2.16

Interface

string(:256)

W

The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Client entry.

<Empty>

2.16

BindType

string

W

Specifies how the client sockets are bound. Enumeration of:

• Address (The client sockets are bound to a local IP address)
• Device (The client sockets are bound to a network device. This can be useful when the local address is dynamic)

-

2.16

Enable

boolean

W

Enables or disables authentication of the time client.

false

2.16

Certificate

string

W

The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the certificate that must be used by the NTS-KE client.

<Empty>

2.16

NTSPort

unsignedInt(1:65535)

W

On this port the NTS Key Establishment protocol is being provided.

4460

2.16

PacketsSent

unsignedInt

R

[StatsCounter32] Specifies the number of packets that have been successfully sent from the NTP client to the NTP server.

-

2.16

PacketsSentFailed

unsignedInt

R

[StatsCounter32] Specifies the number of packets that were not successfully sent to the NTP server.

-

2.16

PacketsReceived

unsignedInt

R

[StatsCounter32] Specifies the number of packets that have been successfully received by the NTP client from the NTP server.

-

2.16

PacketsDropped

unsignedInt

R

[StatsCounter32] Specifies the number of packets that were received by the NTP client but were not successfully processed or handled due to errors or other issues.

-

2.16

Enable

boolean

W

Enables or disables the time server.

-

2.16

Status

string

R

Status of Time server instance. Enumeration of:

• Up (Indicates that the NTP server instance is enabled and working)
• Down (Indicates that the NTP server instance is disabled and thus not working)
• Error (MAY be used by the NTP server instance to indicate a locally defined error condition, OPTIONAL)

-

2.16

Alias

string(:64)

W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

• The value MUST NOT be empty.

• The value MUST start with a letter.

• If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

If the value isn't assigned by the Controller on creation, the Agent MUST choose an initial value that doesn't conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it's been assigned by the Controller or set internally by the Agent.

-

2.16

Mode

string

W

Specifies in which mode the NTP server must be ran. Enumeration of:

• Unicast (Support for the NTP server in unicast mode)
• Broadcast (Support for the NTP server in broadcast mode)
• Multicast (Support for the NTP server in multicast mode)
• Manycast (Support for the NTP server in manycast mode)

-

2.16

Version

unsignedInt(1:4)

W

Specifies the supported NTP version. Possible versions are 1-4.

4

2.16

Port

unsignedInt(1:65535)

W

Specify the port used to receive NTP packets. [Section 7.2/RFC5905]

123

2.16

Interface

string(:256)

W

The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Server entry.

<Empty>

2.16

BindType

string

W

Specifies how the client sockets must be bounded. Enumeration of:

• Address (The server sockets are bound to a local IP address)
• Device (The server sockets are bound to a network device. This can be useful when the local address is dynamic)

-

2.16

MinPoll

unsignedInt

W

This is the minimum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 6 (64 seconds). [Section 7.2/RFC5905]

6

2.16

MaxPoll

unsignedInt

W

This is the maximum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 10 (1024 seconds) [Section 7.2/RFC5905]

10

2.16

TTL

unsignedInt(1:255)

W

Specifies the time to live (TTL) for a broadcast/multicast packet. [Section 3.1/RFC5905]

255

2.16

Enable

boolean

W

Enables or disables authentication of the NTP server.

false

2.16

Certificate

string

W

The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the certificate that must be used by the NTS-KE client.

<Empty>

2.16

NTSNTPServer

string[]

W

Comma-separated list of strings. Points to a CSV list of NTP servers. A NTP server can either be specified as an IP address or a host name. When used the NTS-KE server will tell the remote NTS-KE client the NTP hostname or address of the NTP server(s) that should be used. This allows to seperate the NTP server and NTS-KE server implementation.

<Empty>

2.16

PacketsSent

unsignedInt

R

[StatsCounter32] Specifies the number of packets that have been successfully sent from the NTP server to the NTP client.

-

2.16

PacketsSentFailed

unsignedInt

R

[StatsCounter32] Specifies the number of packets that were not successfully sent to the NTP client.

-

2.16

PacketsReceived

unsignedInt

R

[StatsCounter32] Specifies the number of packets that have been successfully received by the NTP server from a NTP client.

-

2.16

PacketsDropped

unsignedInt

R

[StatsCounter32] Specifies the number of packets that were received by the NTP server but were not successfully processed or handled due to errors or other issues.

-

2.16

Enable

boolean

W

Enables and disables the CPE's user interface.

The factory default value MUST be true.

-

2.12

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.

-

2.12

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 (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword).

-

2.12

UpgradeAvailable

boolean

W

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

-

2.12

WarrantyDate

dateTime

W

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

-

2.12

ISPName

string(:64)

W

The name of the customer's ISP.

-

2.12

ISPHelpDesk

string(:32)

W

The help desk phone number of the ISP.

-

2.12

ISPHomePage

string(:2048)

W

The [URL] of the ISP's home page.

-

2.12

ISPHelpPage

string(:2048)

W

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

-

2.12

ISPLogo

base64(0:4095)

W

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

-

2.12

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.

-

2.12

ISPMailServer

string(:2048)

W

The [URL] of the ISP's mail server.

-

2.12

ISPNewsServer

string(:2048)

W

The [URL] of the ISP's news server.

-

2.12

TextColor

hexBinary(3)

W

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

-

2.12

BackgroundColor

hexBinary(3)

W

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

-

2.12

ButtonColor

hexBinary(3)

W

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

-

2.12

ButtonTextColor

hexBinary(3)

W

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

-

2.12

AutoUpdateServer

string(:256)

W

The server the CPE can check to see if an update is available for direct download to it.

-

2.12

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.

-

2.12

AvailableLanguages

string[](:256)

R

Comma-separated list (maximum number of characters 256) of strings. List items represent user-interface languages that are available, where each language is specified according to [RFC3066].

-

2.12

CurrentLanguage

string(:16)

W

Current user-interface language, specified according to [RFC3066]. The value MUST be a member of the list reported by the AvailableLanguages parameter.

-

2.12

HTTPAccessSupportedProtocols

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 [RFC9110])
• HTTPS (As defined in [RFC9110])

-

2.16

HTTPAccessNumberOfEntries

unsignedInt

R