'\" t
.\"     Title: cxl-list
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2022-04-08
.\"    Manual: cxl Manual
.\"    Source: cxl
.\"  Language: English
.\"
.TH "CXL\-LIST" "1" "2022-04-08" "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\-list \- List CXL capable memory devices, and their attributes in json.
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIcxl list\fP [<options>]
.fi
.br
.sp
Walk the CXL capable device hierarchy in the system and list all device
instances along with some of their major attributes.
.SH "EXAMPLE"
.sp
.if n .RS 4
.nf
.fam C
# cxl list \-\-memdevs
{
  "memdev":"mem0",
  "pmem_size":268435456,
  "ram_size":0,
}
.fam
.fi
.if n .RE
.SH "OPTIONS"
.sp
\-m, \-\-memdev=
.RS 4
Specify a cxl memory device name to filter the listing. For example:
.RE
.sp
.if n .RS 4
.nf
.fam C
# cxl list \-\-memdev=mem0
{
  "memdev":"mem0",
  "pmem_size":268435456,
  "ram_size":0,
}
.fam
.fi
.if n .RE
.sp
\-M, \-\-memdevs
.RS 4
Include CXL memory devices in the listing
.RE
.sp
\-i, \-\-idle
.RS 4
Include idle (not enabled / zero\-sized) devices in the listing
.RE
.sp
\-H, \-\-health
.RS 4
Include health information in the memdev listing. Example listing:
.RE
.sp
.if n .RS 4
.nf
.fam C
# cxl list \-m mem0 \-H
[
  {
    "memdev":"mem0",
    "pmem_size":268435456,
    "ram_size":268435456,
    "health":{
      "maintenance_needed":true,
      "performance_degraded":true,
      "hw_replacement_needed":true,
      "media_normal":false,
      "media_not_ready":false,
      "media_persistence_lost":false,
      "media_data_lost":true,
      "media_powerloss_persistence_loss":false,
      "media_shutdown_persistence_loss":false,
      "media_persistence_loss_imminent":false,
      "media_powerloss_data_loss":false,
      "media_shutdown_data_loss":false,
      "media_data_loss_imminent":false,
      "ext_life_used":"normal",
      "ext_temperature":"critical",
      "ext_corrected_volatile":"warning",
      "ext_corrected_persistent":"normal",
      "life_used_percent":15,
      "temperature":25,
      "dirty_shutdowns":10,
      "volatile_errors":20,
      "pmem_errors":30
    }
  }
]
.fam
.fi
.if n .RE
.sp
\-u, \-\-human
.RS 4
By default the command will output machine\-friendly raw\-integer
data. Instead, with this flag, numbers representing storage size
will be formatted as human readable strings with units, other
fields are converted to hexadecimal strings.
.RE
.sp
\-v, \-\-verbose
.RS 4
Emit more debug messages
.RE
.SH "COPYRIGHT"
.sp
Copyright \(co 2016 \- 2020, Intel Corporation. License GPLv2: GNU GPL
version 2 \c
.URL "http://gnu.org/licenses/gpl.html" "" "."
This is free software:
you are free to change and redistribute it.  There is NO WARRANTY, to
the extent permitted by law.
.SH "SEE ALSO"
.sp
ndctl\-list(1)