'\" t
.\"     Title: cxl-set-alert-config
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.23
.\"      Date: 2024-07-18
.\"    Manual: cxl Manual
.\"    Source: cxl
.\"  Language: English
.\"
.TH "CXL\-SET\-ALERT\-CONFIG" "1" "2024-07-18" "cxl" "cxl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
cxl-set-alert-config \- set the warning alert threshold on a CXL memdev
.SH "SYNOPSIS"
.sp
.nf
\fIcxl set\-alert\-config <mem0> [<mem1>..<memN>] [<options>]\fP
.fi
.br
.SH "DESCRIPTION"
.sp
CXL device raises an alert when its health status is changed. Critical alert
shall automatically be configured by the device after a device reset.
If supported, programmable warning thresholds also be initialized to vendor
recommended defaults, then could be configured by the user.
.sp
Use this command to configure warning alert thresholds of a device.
Having issued this command, the newly requested warning thresholds would
override the previously programmed warning thresholds.
.sp
To enable warning alert, set both \fIthreshold=value\fP and \fIalert=on\fP. To disable
warning alert, set only \fIalert=off\fP. Other cases would cause errors.
.sp
Use "cxl list \-m <memdev> \-A" to examine the programming warning threshold
capabilities of a device.
.SH "EXAMPLES"
.sp
Set warning threshold to 30 and enable alert for life used.
.sp
.if n .RS 4
.nf
.fam C
# cxl set\-alert\-config mem0 \-\-life\-used\-threshold=30 \-\-life\-used\-alert=on
{
  "memdev":"mem0",
  "ram_size":"1024.00 MiB (1073.74 MB)",
  "alert_config":{
    "life_used_prog_warn_threshold_valid":true,
    "dev_over_temperature_prog_warn_threshold_valid":false,
    "dev_under_temperature_prog_warn_threshold_valid":false,
    "corrected_volatile_mem_err_prog_warn_threshold_valid":false,
    "corrected_pmem_err_prog_warn_threshold_valid":false,
    "life_used_prog_warn_threshold_writable":true,
    "dev_over_temperature_prog_warn_threshold_writable":true,
    "dev_under_temperature_prog_warn_threshold_writable":true,
    "corrected_volatile_mem_err_prog_warn_threshold_writable":true,
    "corrected_pmem_err_prog_warn_threshold_writable":true,
    "life_used_crit_alert_threshold":75,
    "life_used_prog_warn_threshold":30,
    "dev_over_temperature_crit_alert_threshold":0,
    "dev_under_temperature_crit_alert_threshold":0,
    "dev_over_temperature_prog_warn_threshold":0,
    "dev_under_temperature_prog_warn_threshold":0,
    "corrected_volatile_mem_err_prog_warn_threshold":0,
    "corrected_pmem_err_prog_warn_threshold":0
  },
  "serial":"0",
  "host":"0000:0d:00.0"
}
cxl memdev: cmd_set_alert_config: set alert configuration 1 mem
.fam
.fi
.if n .RE
.sp
Disable warning alert for life_used.
.sp
.if n .RS 4
.nf
.fam C
# cxl set\-alert\-config mem0 \-\-life\-used\-alert=off
{
  "memdev":"mem0",
  "ram_size":"1024.00 MiB (1073.74 MB)",
  "alert_config":{
    "life_used_prog_warn_threshold_valid":false,
    "dev_over_temperature_prog_warn_threshold_valid":false,
    "dev_under_temperature_prog_warn_threshold_valid":false,
    "corrected_volatile_mem_err_prog_warn_threshold_valid":false,
    "corrected_pmem_err_prog_warn_threshold_valid":false,
    "life_used_prog_warn_threshold_writable":true,
    "dev_over_temperature_prog_warn_threshold_writable":true,
    "dev_under_temperature_prog_warn_threshold_writable":true,
    "corrected_volatile_mem_err_prog_warn_threshold_writable":true,
    "corrected_pmem_err_prog_warn_threshold_writable":true,
    "life_used_crit_alert_threshold":75,
    "life_used_prog_warn_threshold":30,
    "dev_over_temperature_crit_alert_threshold":0,
    "dev_under_temperature_crit_alert_threshold":0,
    "dev_over_temperature_prog_warn_threshold":0,
    "dev_under_temperature_prog_warn_threshold":0,
    "corrected_volatile_mem_err_prog_warn_threshold":0,
    "corrected_pmem_err_prog_warn_threshold":0
  },
  "serial":"0",
  "host":"0000:0d:00.0"
}
cxl memdev: cmd_set_alert_config: set alert configuration 1 mem
.fam
.fi
.if n .RE
.SH "OPTIONS"
.sp
<memory device(s)>
.RS 4
A \fImemX\fP device name, or a memdev id number. Restrict the operation to
the specified memdev(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction.
.RE
.sp
\-S, \-\-serial
.RS 4
Rather an a memdev id number, interpret the <memdev> argument(s)
as a list of serial numbers.
.RE
.sp
\-L, \-\-life\-used\-threshold=
.RS 4
Set <value> for the life used warning alert threshold.
.RE
.sp
\-\-life\-used\-alert=
.RS 4
Enable or disable the life used warning alert.
Options are \fIon\fP or \fIoff\fP.
.RE
.sp
\-O, \-\-over\-temperature\-threshold=
.RS 4
Set <value> for the device over temperature warning alert threshold.
.RE
.sp
\-\-over\-temperature\-alert=
.RS 4
Enable or disable the device over temperature warning alert.
Options are \fIon\fP or \fIoff\fP.
.RE
.sp
\-U, \-\-under\-temperature\-threshold=
.RS 4
Set <value> for the device under temperature warning alert threshold.
.RE
.sp
\-\-under\-temperature\-alert=
.RS 4
Enable or disable the device under temperature warning alert.
Options are \fIon\fP or \fIoff\fP.
.RE
.sp
\-V, \-\-volatile\-mem\-err\-threshold=
.RS 4
Set <value> for the corrected volatile memory error warning alert
threshold.
.RE
.sp
\-\-volatile\-mem\-err\-alert=
.RS 4
Enable or disable the corrected volatile memory error warning alert.
Options are \fIon\fP or \fIoff\fP.
.RE
.sp
\-P, \-\-pmem\-err\-threshold=
.RS 4
Set <value> for the corrected persistent memory error warning alert
threshold.
.RE
.sp
\-\-pmem\-err\-alert=
.RS 4
Enable or disable the corrected persistent memory error warning alert.
Options are \fIon\fP or \fIoff\fP.
.RE
.sp
\-v, \-\-verbose
.RS 4
Turn on verbose debug messages in the library (if libcxl was built with
logging and debug enabled).
.RE
.SH "SEE ALSO"
.sp
CXL\-3.0 8.2.9.8.3.3