The operational state of the device middleware during its boot sequence.
Represents the possible milestones during the boot process, providing clear indicators
of the device's current state and readiness for communication. These stages are used both
for real-time operational state tracking and for historical boot performance analysis.
The transitions between stages provide clear triggers for internal management agents
to know exactly when the device is ready for specific operations.
E.g., the CWMP/USP agents can use these stages to determine communication readiness.
Artificial milestone marking the first recorded timestamp of the boot process.
Device has received power and hardware initialization has started.
Core operating system and kernel have been initialized and basic runtime is available.
Local networking stack (e.g., IPv4/IPv6 interfaces, DHCP) is operational.
Management protocol agent (TR-069/TR-369) has started and can accept controller sessions.
E.g., the CWMP Agent can send the ‘1 BOOT’ Inform or the USP Agent can send the
‘Boot!’ Event.
Device fully operational. All systems initialized, including services, Internet
connectivity and remote management.
Device is in the process of shutting down.
The cause of the boot.
A reboot triggered locally on the device (NOT as a result of a
{{command|.Reboot()|model}} command triggered by a remote trigger, e.g.
another remote management protocol).
A reboot triggered via the {{command|.Reboot()|model}} command or other remote
trigger, e.g. another remote management protocol.
A shutdown triggered locally on the device (NOT as a result of a
{{command|.Shutdown()|model}} command triggered by a remote trigger, e.g.
another remote management protocol).
A shutdown triggered via the {{command|.Shutdown()|model}} command or other remote
trigger, e.g. another remote management protocol.
A factory reset triggered locally on the device or remotely (as a result of a
{{command|.FactoryReset()|model}} command or other remote trigger,
e.g. another remote management protocol), which is to be used
when the Agent cannot differentiate between local and remote
A factory reset triggered locally on the device (NOT as a result of a
{{command|.FactoryReset()|model}} command triggered by a remote trigger,
e.g. another remote management protocol)
A factory reset triggered via the {{command|.FactoryReset()|model}} command or
other remote trigger, e.g. another remote management protocol
This object contains general device information.
Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"),
or the value is {{empty}} 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) {{bibref|JJ-300.00}} and
{{bibref|G.9973}}. Standard HTIP device categories are defined in
{{bibref|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.
The manufacturer of the CPE (human readable string).
Organizationally unique identifier of the device manufacturer.
Represented as a six hexadecimal-digit value using all upper-case
letters and including any leading zeros. {{pattern}}
The value MUST be a valid OUI as defined in {{bibref|OUI}}.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
Model name of the CPE (human readable string).
The model number of the device (human readable string), or {{empty}}
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) {{bibref|JJ-300.00}} and
{{bibref|G.9973}}. In this case, the maximum length of the string is
31.
A full description of the CPE device (human readable string).
Identifier of the class of product for which the serial number
applies. That is, for a given manufacturer, this parameter is used to
identify the product or class of product over which the
{{param|SerialNumber}} parameter is unique.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
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.
A string identifying the particular CPE model and version.
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''.
{{noreference}}A full path reference to the row in the
{{object|FirmwareImage}} table representing the currently running
firmware image.
{{noreference}}A full path reference to the row in the
{{object|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 {{object|FirmwareImage}} object where the
({{param|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.
{{list}} Each entry is an additional version. Represents any
additional hardware version information the vendor might wish to
supply.
{{list}} Each entry is an additional version. Represents any
additional software version information the vendor might wish to
supply.
Identifier of the primary service provider and other provisioning
information, which MAY be used by the ACS to determine service
provider-specific customization and provisioning parameters.
Time in {{units}} since the CPE was last restarted.
Date and time in UTC that the CPE first both successfully established
an IP-layer network connection and acquired an absolute time
reference using NTP or equivalent over that network connection. The
CPE MAY reset this date after a factory reset.
If NTP or equivalent is not available, this parameter, if present,
SHOULD be set to the Unknown Time value.
Date and time of when the {{param|SoftwareVersion}} last changed.
The hostname of the device {{bibref|RFC1123|Section 2 General
issues}}. 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.
The two-letter country code in accordance with {{bibref|ISO3166-1}} alpha-2. For example, 'US' for the United States.
{{numentries}}
{{numentries}}
{{numentries}}
{{deprecated|2.18|because the only contained parameter, {{param|Processor.{i}.Architecture}},
is no longer relevant for modern devices.}}
{{deleted|2.21}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Every instance of this object is a Vendor Configuration File, and
contains parameters associated with the Vendor Configuration File.
This table of Vendor Configuration Files is for information only and
does not allow the Controller to operate on these files in any way.
{{template|VENDORCONFIGFILE-DESC}}
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.
{{template|VENDORCONFIGFILE-NAME}}
A string identifying the configuration file version currently used in
the CPE.
If the CPE is able to obtain the version of the configuration file
from the file itself, then the value of this parameter MUST be set to
the obtained value.
Otherwise, the value of this parameter MUST be {{empty}}.
Date and time when the content of the current version of this vendor
configuration file was first applied by the CPE.
A description of the vendor configuration file (human-readable
string).
When {{true}}, this parameter indicates that this {{object}} instance
is to be used for backup and restoration purposes.
Note: The backup and restore operations may require the use of
multiple {{object}} instances. In this scenario the mechanism for
determining the order and combination of {{object}} instances used for
backup and restoration purposes is implementation specific.
Status of the device's physical memory.
The total physical volatile RAM, in {{units}}, installed on the
device.
The estimated total physical volatile RAM, in {{units}}, that can be allocated
without triggering out-of-memory conditions.
The free physical volatile RAM, in {{units}}, currently unallocated
and unused. This excludes memory that can be reclaimed (e.g. caches,
buffers).
Note: This definition was changed in Device:2.21. Please refer to {{param|Available}} for
a guaranteed indication of memory availability, rather than memory that is completely unused.
The sum total physical Non-Volatile Memory (NVM), in {{units}},
installed on the device. This memory persists across reboots and can
be used by the system, applications, or users.
The sum total free physical Non-Volatile Memory (NVM), in {{units}},
currently available on the device. This memory persists across
reboots and is available for use by the system, applications, or
users.
This object specifies information that the device has obtained via sampling
the memory utilization (RAM) on the device.
Indicates whether or not memory monitoring is enabled.
Memory utilization, in {{units}}, rounded to the nearest
whole {{units}}, is the percentage of memory used by the system which cannot be spontaneously
reclaimed or repurposed by the system in case it is required. This metric is collected at the
{{param|PollingInterval}}. This value is used to determine if a critical condition is
reached i.e., the memory utilization exceeds {{param|CriticalRiseThreshold}}.
The interval, measured in {{units}}, in which the device polls
the memory utilization.
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.
Memory utilization rise threshold {{units}} value. If the {{param|MemUtilization}} exceeds the rise threshold value,
and the {{param|CriticalFallTimeStamp}} is greater than {{param|CriticalRiseTimeStamp}} (indicating that critical
condition is reached), the following takes place:
* The {{param|CriticalRiseTimeStamp}} is updated to the current time.
* A log is generated into the vendor log file referenced by
{{param|VendorLogFileRef}}
indicating critical condition is reached if the {{param|EnableCriticalLog}} is {{true}}.
Memory utilization fall threshold {{units}} value. If the {{param|MemUtilization}} falls below the fall threshold value and
{{param|CriticalRiseTimeStamp}} is greater than {{param|CriticalFallTimeStamp}} (indicating that the critical condition
is no longer present), the following takes place:
* The {{param|CriticalFallTimeStamp}} is updated to current time.
* A log is generated into the vendor log file referenced by
{{object|.DeviceInfo.VendorLogFile}} indicating that the critical
condition is no longer present if the {{param|EnableCriticalLog}} is {{true}}.
Last date and time when the critical condition was reached. See {{param|CriticalRiseThreshold}} description
for more details.
Last date and time when the critical condition was no longer present. See {{param|CriticalFallThreshold}} description
for more details.
This parameter indicates whether a critical log needs to be
generated in the vendor log file.
* If the value of {{param}} is {{true}}, then a critical log is generated
in the vendor log file.
* If the value of {{param}} is {{false}}, then no critical log is generated
in the vendor log file.
The reference to {{object|.DeviceInfo.VendorLogFile}} is automatically constructed
and the {{object|.DeviceInfo.VendorLogFile}} is populated with the information based on {{param|FilePath}}.
E.g. When {{param|FilePath}} = ''file:///var/log/messages''.
The following entry is automatically added to {{object|.DeviceInfo.VendorLogFile}}: ''file:///var/log/messages''.
Destination path and filename of where to create and keep the log files
which MUST use the file URI scheme {{bibref|RFC8089|The file URI Scheme}}.
This file is related to {{param|EnableCriticalLog}}.
Status of the processes on the device.
The total amount of the CPU, in {{units}}, rounded to the nearest
whole {{units}}. In the case that multiple CPU are present, this
value represents the average of all CPU.
{{numentries}}
{{numentries}}
This object describes the utilization metrics for each CPU on the device. It also defines
the monitoring actions that are automatically triggered when specific utilization thresholds
are crossed.
Name of this CPU. This text MUST be sufficient to
distinguish this CPU from other CPUs.
Enables or disables the CPU utilization monitoring.
Time in {{units}} since the CPU was last restarted.
CPU utilization, in {{units}}, rounded to the nearest
whole {{units}}, while executing at the user level.
This includes utilization across all cores.
This value is calculated the same way as {{param|CPUUtilization}}. See
{{param|CPUUtilization}} description for more details.
CPU utilization, in {{units}}, rounded to the nearest
whole {{units}}, while executing at the system/kernel level.
Note that this includes the time spent servicing interrupts as well.
This includes utilization across all cores.
This value is calculated the same way as {{param|CPUUtilization}}. See
{{param|CPUUtilization}} description for more details.
CPU utilization, in {{units}}, rounded to the nearest
whole {{units}}, while the CPU was idle.
This value is calculated the same way as {{param|CPUUtilization}}. See
{{param|CPUUtilization}} description for more details.
CPU utilization, in {{units}}, rounded to the nearest
whole {{units}}. The CPU Utilization is calculated as
a moving window average of {{param|NumSamples}} CPU utilization samples collected at the {{param|PollInterval}}.
For example, the CPU utilization is calculated as follows:
CPU Utilization = (sample1 + sample2 + ... + sampleN)/N where N is the number of CPU usage samples as represented by {{param|NumSamples}}
and sample1, sample2, ..., sampleN are CPU usage samples collected at every {{param|PollInterval}} seconds.
This parameter, which reflects system and user mode CPU utilization, is used to determine if the CPU is in critical condition.
This value includes system mode and user mode utilization i.e.,
everything except idle mode utilization.
The interval, measured in {{units}}, over which the CPU usage is polled.
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 poll interval.
This parameter indicates the number of CPU usage samples that is needed to
calculate the average CPU utilization and populate the {{param|CPUUtilization}}
CPU utilization rise threshold {{units}} value. If the {{param|CPUUtilization}} exceeds the rise threshold value and the
{{param|CriticalFallTimeStamp}} is greater than {{param|CriticalRiseTimeStamp}} (indicating that critical condition
is reached), the following takes place:
* The {{param|CriticalRiseTimeStamp}} is updated to the current time
* A log is generated into the vendor log file referenced by {{object|###.DeviceInfo.VendorLogFile}}
indicating critical condition is reached if the {{param|EnableCriticalLog}} is {{true}}. The logs generated
should indicate the {{param|Name}} as well as the {{param|CriticalRiseTimeStamp}} of the CPU.
CPU utilization fall threshold {{units}} value. If the {{param|CPUUtilization}} falls below fall threshold value and
{{param|CriticalRiseTimeStamp}} is greater than {{param|CriticalFallTimeStamp}} (indicating that critical condition
is no longer present), the following takes place:
* The {{param|CriticalFallTimeStamp}} is updated to current time
* A log is generated into the vendor log file referenced by {{object|###.DeviceInfo.VendorLogFile}}
indicating the clearing of critical condition if the {{param|EnableCriticalLog}} is {{true}}. The logs generated
should indicate the {{param|Name}} as well as the {{param|CriticalFallTimeStamp}} of the CPU.
Last date and time when the critical condition was reached. See {{param|CriticalRiseThreshold}} description for
more details.
Last date and time when the critical condition is no longer present. See {{param|CriticalFallThreshold}} description
for more details.
This parameter indicates whether a critical log needs to be
generated in the vendor log file.
* If the value of {{param}} is {{true}}, then a critical log is generated
in the vendor log file.
* If the value of {{param}} is {{false}}, then no critical log is generated
in the vendor log file.
The reference to {{object|###.DeviceInfo.VendorLogFile}} is automatically constructed
and the {{object|###.DeviceInfo.VendorLogFile}} is populated with the information based on {{param|FilePath}}.
E.g. When {{param|FilePath}} = ''file:///var/log/messages''.
The following entry is automatically added to {{object|###.DeviceInfo.VendorLogFile}}: ''file:///var/log/messages''.
Destination path and filename of where to create and keep the log files
which MUST use the uri scheme file {{bibref|RFC8089|The file URI Scheme}}.
This file is related to {{param|EnableCriticalLog}}.
The aggregate rate of hardware interrupts (IRQs) handled by this CPU across all interrupt sources, in {{units}}.
List of all processes running on the device.
The Process Identifier.
The name of the command that has caused the process to exist.
The size in {{units}} of the memory occupied by the process.
The priority of the process where 0 is highest.
The amount of time in {{units}} that the process has spent taking up
CPU time since the process was started.
The current state that the process is in.
Status of the power consumption of the device.
{{numentries}}
Represents the power sensor parameters including voltage, current, and power measurements.
Indicates whether or not the power sensor is enabled.
The status of this power sensor.
The sensor is not currently sampling the power.
The sensor is currently sampling the power.
The sensor error currently prevents sampling the power.
Name of this power sensor. This text MUST be sufficient to
distinguish this power sensor from other power sensors.
The time at which this power sensor's last good reading was
obtained.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a
good reading has not been obtained since last reset.
The voltage measured by the sensor, in {{units}}.
The current measured by the sensor, in {{units}}.
The power measured by the sensor, in {{units}}.
Status of the temperature of the device.
{{numentries}}
This object represents information that the device has obtained via
sampling an internal temperature sensor.
Indicates whether or not the temperature sensor is enabled.
The status of this temperature sensor.
The sensor is not currently sampling the temperature.
The sensor is currently sampling the temperature.
The sensor error currently prevents sampling the temperature.
The time at which this temperature sensor was reset.
Reset can be caused by:
* {{param|Status}} transition from {{enum|Disabled|Status}} to
{{enum|Enabled|Status}}
* {{template|Reset}}.
* An internal reset of the temperature sensor (including a reboot of
the device).
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates
that this temperature sensor has never been reset, which can only
happen if it has never been enabled.
Name of this temperature sensor. This text MUST be sufficient to
distinguish this temperature sensor from other temperature sensors.
This temperature sensor's last good reading in {{units}}.
A value of -274 (which is below absolute zero) indicates a good
reading has not been obtained since last reset.
The time at which this temperature sensor's last good reading was
obtained.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a
good reading has not been obtained since last reset.
This temperature sensor's lowest value reading in {{units}} since
last reset.
A value of -274 (which is below absolute zero) indicates a good
reading has not been obtained since last reset.
The time at which this temperature sensor's lowest value was read.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a
good reading has not been obtained since last reset.
This temperature sensor's highest value reading in {{units}} since
last reset.
A value of -274 (which is below absolute zero) indicates a good
reading has not been obtained since last reset.
The time at which this temperature sensor's highest value was read.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a
good reading has not been obtained since last reset.
This temperature sensor's low alarm value in {{units}}.
A value of -274 (which is below absolute zero) indicates a non
configured value.
A change to this value will cause {{param|LowAlarmTime}} to be reset.
Initial time at which this temperature sensor's
{{param|LowAlarmValue}} was encountered.
This value is only set the first time the alarm is seen and not
changed until the next reset.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates
that an alarm has not been encountered since the last reset.
This temperature sensor's high alarm value in {{units}}.
A value of -274 (which is below absolute zero) indicates a non
configured value.
A change to this value will cause {{param|HighAlarmTime}} to be
reset.
The interval, measured in {{units}}, in which the device polls this
{{object}}.
If the value is 0 then the device selects its own polling interval.
If the value is greater than 0 then the device MUST use this value as
the polling interval.
Initial time at which this temperature sensor's
{{param|HighAlarmValue}} was encountered.
This value is only set the first time the alarm is seen and not
changed until the next reset.
The Unknown Time value, as defined in {{bibref|TR-106}}, indicates
that an alarm has not been encountered since the last reset.
This object defines the parameters that describe how the device handles
network traffic.
The maximum number of {{units}} of outstanding data a sender can send
on a particular connection prior to an acknowledgment
{{bibref|RFC793}}. Any scaling factor SHOULD be included in this
parameter {{bibref|RFC1323}}.
{{list}} Indicates the TCP congestion control mechanism(s)
implemented. {{enum}}
Tahoe, Reno, and New Reno are defined in {{bibref|RFC2582}}
Represents the base TCP implementation in {{bibref|RFC793}} and
elements of {{bibref|RFC2582}}
Represents the base TCP implementation in {{bibref|RFC793}}
with the additional algorithms defined in {{bibref|RFC2581}}
Described as a modification to the Reno algorithms in
{{bibref|RFC2582}}
An emerging TCP congestion control mechanism
Each table entry represents a hardware or virtual processor that
resides on this device.
{{deprecated|2.18|because the only contained parameter, {{param|Architecture}},
is no longer relevant for modern devices.}}
{{deleted|2.21}}
The architecture of the processor on the underlying hardware.
{{enum}}
For processor architectures not included in this list, the vendor MAY
include vendor-specific values, which MUST use the format defined in
{{bibref|TR-106|Section 3.3}}.
big-endian
little-endian
big-endian
little-endian
This Object details the available rotation settings for vendor log file rotation.
Based on {{bibref|YANGSYSLOG|A YANG Data Model for Syslog Configuration}}.
Enables or disables the log rotation functionality for this item.
Specifies the full path and filename of the log file that must be rotated.
Which MUST use the uri scheme file {{bibref|RFC8089|The file URI Scheme}}.
Specifies the maximum number of log files retained.
When during log rotation the maximum number of log files is reached,
the oldest log file will be deleted.
Specify ''1'' for implementations that only support one log file.
Specifies the maximum log file size in {{units}}.
Log events that arrive after the maximum file size is reached will cause the current log file to be closed
and a new log file to be opened.
Specifies the length of time, in {{units}}, that log events should be written to a specific log file.
Log events that arrive after the rollover period cause the current log file to be closed
and a new log file to be opened.
Specifies the length of time, in {{units}}, that completed/closed log event files
should be stored in the file system before they are removed.
Specifies the post-rotation compression method that must be applied
exclusively on the initial log file in a rotation sequence.
{{numentries}}
Each table entry represents a Log File.
This table of log files is informational only and does not allow the
Controller to operate on these files in any way.
Name of the rotated log file stored within the same directory that {{param|#.Name}} is specified.
Which MUST use the uri scheme file {{bibref|RFC8089|The file URI Scheme}}.
The size of the log file in {{units}}. If the device doesn't
know the file size then {{param}} will be 0.
Last modification date of the file specified by {{param|Name}}.
Each table entry represents a Vendor Log File.
This table of log files is informational only and does not allow the
Controller to operate on these files in any way.
Name of the log file.
Typically this will be the full file system path, but provided that
it is guaranteed to be unique across current and future log files, it
MAY be a shorter name derived from the file system path, or be
derived via another mechanism.
The maximum size of the log file in {{units}}. If the device doesn't
know the maximum file size then {{param}} will be 0.
When {{true}}, the log file contents are preserved across a device
reboot.
When {{false}}, the log file contents will be purged when the device
is rebooted.
This object contains Location information.
Identifies the source of the location data.
The time when the location was acquired.
URL, MAC address, or other identifier that identifies an "External"
source of this location.
Meaningful only if {{param|Source}} has a value of
{{enum|External|Source}}, otherwise it MUST be {{empty}}.
If {{param|ExternalProtocol}} has a value of
{{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the
Controller.
If {{param|ExternalProtocol}} has a value of
{{enum|USP|ExternalProtocol}}, this is the USP Endpoint of the
Controller.
Protocol used to acquire a location from an "External" source.
{{enum}}
Meaningful only if {{param|Source}} has a value of
{{enum|External|Source}}, otherwise it MUST be {{empty}}.
{{empty}}
The currently valid location information.
Writable only when {{param|ExternalProtocol}} has a value of
{{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}}.
If obtained through the local GPS/AGPS then the location information
is formatted according to {{bibref|RFC5491}}.
If obtained through the local Barometer then the location information
is formatted according to {{bibref|RFC8428}}.
If manually configured then location information will be
XML-formatted according to {{bibref|RFC5491}} (geographical
information) and {{bibref|RFC5139}} (civic addresses).
If manually configured then location information will be
XML-formatted according to {{bibref|RFC8428}} (barometric data).
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 {{bibref|RFC5491}} (geographical information) and
{{bibref|RFC5139}} (civic addresses).
CWMP or USP configured location information will be XML-formatted
according to {{bibref|RFC8428}} (barometric information) for Barometer.
Only zero or one Location object instance with value
{{enum|CWMP|ExternalProtocol}} MUST exist at any given time.
This object describes an image of the device.
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).
The device image in PNG, JPEG or GIF format.
Top-level object for mapping firmware images.
This is a static table – the number of object instances in this table
is defined by the firmware that is currently running.
Firmware/software image name. Descriptive text of the image or
filename.
The value of {{param}} is {{empty}} if {{param|Status}} is anything
other than {{enum|Active|Status}}, {{enum|Available|Status}},
{{enum|InstallationFailed|Status}}, or
{{enum|ActivationFailed|Status}}.
A string identifying the version of the firmware image represented by
this {{object}}. Whenever this firmware image is active (ie, the
device has booted this firmware image), the value of the
{{param|#.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 {{param}} is {{empty}} if {{param|Status}} is anything
other than {{enum|Available|Status}},
{{enum|InstallationFailed|Status}}, or
{{enum|ActivationFailed|Status}}.
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 {{param|#.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.
Status of the firmware image, as determined by the Agent. {{enum}}
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.
This Firmware Image instance is the currently active image.
This Firmware Image instance is being downloaded.
This Firmware Image instance has been downloaded, and is in the
process of being validated.
This Firmware Image instance has been downloaded, validated,
and installed, and is ready to be activated.
The Agent has attempted to download this Firmware Image
instance, but ultimately failed while retrieving it from the
source URL.
The Agent has attempted to validate a Firmware Image downloaded
to this instance, but ultimately failed while validating it.
The Agent has attempted to install a Firmware Image downloaded
and validated to this instance, but ultimately failed while
installing it.
The Agent has attempted to activate this Firmware Image instance,
but ultimately the activation failed.
Date and time of when {{param|Status}} last changed.
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 {{empty}}. 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.
A fault in the context of the Kernel refers to a situation where the kernel encounters a critical error or a bug that it cannot recover from.
When this happens, the kernel generates a "fault message" or "kernel panic", which provides information about the error,
the state of the system at the time of the error, and a stack trace of function calls leading up to the error.
Path where the Kernel faults logs must be stored.
Total number of Kernel faults which occurred since last firmware upgrade.
The number of Kernel faults which occurred during the previous boot cycle.
The number of Kernel faults which have occurred during the current boot cycle.
Minimum free space in {{units}} on the device that must be free before attempting to create a {{object|KernelFault}} instance.
This setting does not affect the counting of Kernel faults.
When enabled and once the maximum {{object|KernelFault}} entries as
indicated by {{param|MaxKernelFaultEntries}} are reached,
the oldest entry, determined by {{param|KernelFault.{i}.TimeStamp}},
is removed to make space for a new one, which is assigned a new
instance identifier and a new {{param|KernelFault.{i}.Alias}}.
This setting does not affect the counting of Kernel faults.
The maximum number of entries available in the {{object|KernelFault}} table.
Defines the maximum number of {{object|KernelFault}} instances that can be stored on the device.
When {{param|RotateKernelFaultEntries}} is {{false}} and this limit is hit, no new {{object|KernelFault}} instances will be created until sufficient Kernel fault instances are removed. When {{param|RotateKernelFaultEntries}} is {{true}} and this limit is hit, the table {{object|KernelFault}} is rotated as specified by {{param|RotateKernelFaultEntries}}.
Set this parameter to 0 to completely disable the creation of {{object|KernelFault}} instances.
Reducing the {{param}} will cause for the implementation to delete the oldest {{object|KernelFault}} instances.
This setting does not affect the counting of Kernel faults.
{{numentries}}
{{numentries}}
Each table entry represents a Kernel fault that is stored on the device.
Specifies the location of where to create and keep the logs.
Can either be a relative path or file within the {{param|#.StoragePath}} location.
The last instruction executed when the Kernel fault was triggered.
The time when the Kernel fault was registered.
The firmware version that triggered the Kernel fault.
The name of the process that was active while the kernel fault occurred.
The reason why the kernel fault occurred.
Each table entry represents statistics for a particular recorded Kernel Fault Type.
The type of the Kernel fault for which this table entry contains the statistics.
Kernel fault of unknown or unmatched type.
Memory page not present or access violation.
Illegal access to CPU-protected resource.
Invalid or unsupported instruction encountered.
Division by zero or invalid divide operation.
Floating-point or SIMD unit not available.
Second fault occurred during fault handling.
Stack overflow or invalid stack segment.
Misaligned memory access.
Hardware machine check exception.
Floating-point or SIMD arithmetic fault.
Software breakpoint or trap instruction.
Hardware single-step or watchpoint triggered.
Non-maskable interrupt received.
CPU-detected protection/security fault.
Recoverable kernel exception resulting in process termination.
Unrecoverable kernel fault causing system halt.
Total number of Kernel faults, of this type, which occurred since last firmware upgrade.
The number of Kernel faults, of this type, which occurred during the previous boot cycle.
The number of Kernel faults, of this type, which have occurred during the current boot cycle.
Monitoring process faults and configuring the operating system to generate crash dumps and core files
is essential for diagnosing and troubleshooting issues with applications and processes.
Path where the process fault logs must be stored.
Total number of process faults which occurred since last firmware upgrade.
The number of process faults which occurred during the previous boot cycle.
The number of process faults that have occurred during the current boot cycle.
Minimum free space in {{units}} on the device that must be free before attempting to create a {{object|ProcessFault}} instance.
This setting does not affect the counting of process faults.
When enabled and once the maximum {{object|ProcessFault}} entries as
indicated by {{param|MaxProcessFaultEntries}} are reached,
the oldest entry, determined by {{param|ProcessFault.{i}.TimeStamp}},
is removed to make space for a new one, which is assigned a new
instance identifier and a new {{param|ProcessFault.{i}.Alias}}.
This setting does not affect the counting of Process faults.
The maximum number of entries available in the {{object|ProcessFault}} table.
Defines the maximum number of {{object|ProcessFault}} instances that can be stored on the device.
When {{param|RotateProcessFaultEntries}} is {{false}} and this limit is hit, no new {{object|ProcessFault}} instances will be created until sufficient Process fault instances are removed. When {{param|RotateProcessFaultEntries}} is {{true}} and this limit is hit, the table {{object|ProcessFault}} is rotated as specified by {{param|RotateProcessFaultEntries}}.
Set this parameter to 0 to completely disable the creation of {{object|ProcessFault}} instances.
Reducing the {{param}} will cause for the implementation to delete the oldest {{object|ProcessFault}} instances.
This setting does not affect the counting of process faults.
{{numentries}}
{{numentries}}
Each table entry represents a process fault that is stored on the device.
Process ID of the process that crashed.
Process Name of the process that crashed.
Specifies the location of where to create and keep the process fault logs.
Can either be a relative path or file within the {{param|#.StoragePath}} location.
The time when the process fault occurred.
The firmware version that triggered the process fault.
The command arguments that were used to start to the process.
The reason why the process fault occurred.
Each table entry represents statistics for a particular recorded Process Fault Type.
The type of the process fault for which this table entry contains the statistics.
Process fault of unknown or unmatched type.
Invalid memory reference (SIGSEGV).
Invalid physical memory access (SIGBUS).
Invalid or privileged instruction (SIGILL).
Arithmetic fault such as divide by zero (SIGFPE).
Process aborted (SIGABRT).
Breakpoint or trace trap (SIGTRAP).
Invalid or blocked system call (SIGSYS).
Killed by kernel Out-Of-Memory killer (SIGKILL).
Write to a closed pipe or socket (SIGPIPE).
Terminal hangup or disconnect (SIGHUP).
Total number of process faults, of this type, which occurred since last firmware upgrade.
The number of process faults, of this type, which occurred during the previous boot cycle.
The number of process faults, of this type, which have occurred during the current boot cycle.
This parameter specifies the last known reason why the device rebooted, which contains
information about the reboot reason, cause and timestamp.
This event is triggered when the temperature sensor detects a high temperature.
If the {{param|Enable}} parameter is {{true}}, the event is triggered exactly once when the
{{param|Value}} value rises above {{param|HighAlarmValue}}.
The current temperature value that triggered the event.
This value is in {{units}}.
This event is triggered when the temperature sensor detects a low temperature.
If the {{param|Enable}} parameter is {{true}}, the event is triggered exactly once when the
{{param|Value}} value falls below {{param|LowAlarmValue}}.
The current temperature value that triggered the event.
This value is in {{units}}.
This command removes all the {{object|KernelFault.{i}.}} from the device, together with all the associated Kernel fault data stored on the device.
Remove this row from the table, together with the associated Kernel fault data stored on the device.
This command removes all the {{object|ProcessFault.{i}.}} from the device, together with all the associated faulty data stored on the device.
Remove this row from the table, together with the associated faulty data stored on the device.
The monitoring of reboot reasons is essential for diagnosing and troubleshooting
issues with applications and processes running on the Device.
The number of times the device has rebooted since the last factory reset.
The number of times the device has rebooted since the latest firmware update.
The number of times the device has rebooted by a sw/hw watchdog since the last factory reset.
The watchdog is a component within the operating system kernel or Device responsible for monitoring user-space activities.
If it detects non-responsiveness in user-space processes, it triggers a reboot of the device.
The current boot cycle of the device (e.g. Warm or Cold).
The device's boot cycle could not be determined.
The device performed a warm boot.
This typically occurs during a restart without a full power cycle (e.g. a
software-initiated restart).
The device performed a cold boot.
This indicates that power was applied to the device from a completely off state.
The number of times the device has cold rebooted since the last factory reset.
The number of times the device has warm rebooted since the last factory reset.
The maximum number of entries available in the {{object|Reboot}} table.
Defines the maximum number of {{object|Reboot}} instances that can be stored on the device.
When the maximum {{object|Reboot}} entries as indicated by {{param}} are reached,
the next boot entry overrides the object with the oldest {{param|Reboot.{i}.TimeStamp}}.
Set this parameter to 0 to completely disable the creation of {{object|Reboot}} instances.
Set this parameter to -1 to leave it open to the implementation to decide
the maximum number of {{object|Reboot}} instances that may be stored on the device.
Reducing the {{param}} will cause for the implementation to delete the oldest {{object|Reboot}} instances.
This setting does not affect the counting of reboots.
{{numentries}}
Removes all the {{object|Reboot.{i}.}} instances from the device, together with the associated data stored on the device.
Each table entry represents a reboot reason that is stored on the device.
When the maximum {{object}} entries as indicated by {{param|#.MaxRebootEntries}} are reached,
the next boot entry overrides the object with the oldest {{param|TimeStamp}}.
The time when the reboot occurred.
{{true}} if the Device was rebooted as a result of a firmware update; otherwise {{false}}.
The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web user interface, ...).
Remove this row from the table, together with the associated data stored on the device.
Boot performance metrics for monitoring and analyzing device boot time and milestones.
This object provides detailed historical timing metrics for the most recent boot cycle,
allowing for performance analysis and troubleshooting of boot-related issues.
The timestamp when the boot process started.
The timestamp of when the boot (of all systems) is complete.
Duration of the most recent boot ({{param|BootCompleteTime}} - {{param|BootStartTime}}), in {{units}}.
This value is calculated by the device as a convenience, since it can also be derived by the controller.
{{numentries}}
Each table entry represents a milestone reached during the boot process referenced by
{{param|##.LastRebootRef}}. This table is cleared and repopulated on each new boot.
The timestamp when this boot milestone was reached.
* A {{event|MemoryCriticalState!}} event is generated along with Mem stats indicating
critical condition is reached.
This event is generated indicating critical condition is reached i.e., when
{{param|MemUtilization}} exceeds the rise threshold, the event is generated.
Memory utilization, in {{units}}, rounded to the nearest
whole {{units}}, collected at the polling interval.
* A {{event|CPUCriticalState!}} event is generated along with CPU Utilization indicating
critical condition is reached.
This event is generated indicating critical condition is reached i.e., when
the rise threshold is crossed, the event is generated.
CPU utilization, in {{units}}, rounded to the nearest
whole {{units}}.
Name of this CPU. This text MUST be sufficient to
distinguish this CPU from other CPUs.
This command is issued to upload the log information specified by this
{{object}} instance.
All results of the actual upload will be contained within the
{{event|.LocalAgent.TransferComplete!}} event.
The {{datatype}} specifying the destination file location. The
HTTPS transport MUST be supported, and the HTTP transport MAY be
supported.
This argument specifies only the destination file location, and
does not indicate in any way the name or location of the local
file to be uploaded.
If the Agent receives multiple upload requests with the same URL,
the Agent MUST perform each upload as requested, and MUST NOT
assume that the content of the file to be uploaded is the same
each time.
This URL MUST NOT include the "userinfo" component, as defined in
{{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file
server. If {{param}} is not provided or is set to {{empty}}, an alternative form of
authentication (e.g., certificate-based authentication) is required.
Note: The mandatory requirement for this parameter was removed in Device:2.20.
Password to be used by the Agent to authenticate with the file
server. If {{param}} is not provided or is set to {{empty}}, an alternative form of
authentication (e.g., certificate-based authentication) is required.
Note: The mandatory requirement for this parameter was removed in Device:2.20.