'\" t
.\"     Title: ndctl-list
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-02-22
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-LIST" "1" "2024-02-22" "ndctl" "ndctl 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"
ndctl-list \- dump the platform nvdimm device topology and attributes in json
.SH "SYNOPSIS"
.sp
.nf
\fIndctl list\fP [<options>]
.fi
.br
.sp
Walk all the nvdimm buses in the system and list all attached devices
along with some of their major attributes.
.sp
Options can be specified to limit the output to devices of a certain
class.  Where the classes are buses, dimms, regions, and namespaces.  By
default, \fIndctl list\fP with no options is equivalent to:
.sp
.nf
ndctl list \-\-namespaces \-\-bus=all \-\-region=all
.fi
.br
.SH "EXAMPLE"
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-buses \-\-namespaces

{
  "provider":"nfit_test.1",
  "dev":"ndbus2",
  "namespaces":[
    {
      "dev":"namespace9.0",
      "mode":"raw",
      "size":33554432,
      "blockdev":"pmem9"
    }
  ]
}
{
  "provider":"nfit_test.0",
  "dev":"ndbus1"
}
{
  "provider":"e820",
  "dev":"ndbus0",
  "namespaces":[
    {
      "dev":"namespace0.0",
      "mode":"fsdax",
      "size":8589934592,
      "blockdev":"pmem0"
    }
  ]
}
.fam
.fi
.if n .RE
.SH "OPTIONS"
.sp
\-r, \-\-region=
.RS 4
A \fIregionX\fP device name, or a region id number. Restrict the operation to
the specified region(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction, however this is the same as not supplying a
\-\-region option at all.
.RE
.sp
\-b, \-\-bus=
.RS 4
A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the
operation to the specified bus(es). The keyword \fIall\fP can be specified
to indicate the lack of any restriction, however this is the same as
not supplying a \-\-bus option at all.
.RE
.sp
\-d, \-\-dimm=
.RS 4
An \fInmemX\fP device name, or dimm id number. The dimm id number
here is X in \fInmemX\fP. Filter listing by devices that reference
the given dimm. For example to see all namespaces comprised
of storage capacity on nmem0:
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-dimm=nmem0 \-\-namespaces
.fam
.fi
.if n .RE
.sp
\-n, \-\-namespace=
.RS 4
An \fInamespaceX.Y\fP device name, or namespace region plus id tuple
\fIX.Y\fP. Limit the namespace list to the single identified device
if present.
.RE
.sp
\-m, \-\-mode=
.RS 4
Filter listing by the mode (\fIraw\fP, \fIfsdax\fP, \fIsector\fP or \fIdevdax\fP)
of the namespace(s).
.RE
.sp
\-U, \-\-numa\-node=
.RS 4
Filter listing by numa node
.RE
.sp
\-B, \-\-buses
.RS 4
Include bus info in the listing
.RE
.sp
\-D, \-\-dimms
.RS 4
Include dimm info in the listing
.RE
.sp
.nf
{
  "dev":"nmem0",
  "id":"cdab\-0a\-07e0\-ffffffff",
  "handle":0,
  "phys_id":0,
  "security:":"disabled"
}
.fi
.br
.sp
\-H, \-\-health
.RS 4
Include dimm health info in the listing.  For example:
.RE
.sp
.nf
{
  "dev":"nmem0",
  "health":{
    "health_state":"non\-critical",
    "temperature_celsius":23,
    "spares_percentage":75,
    "alarm_temperature":true,
    "alarm_spares":true,
    "temperature_threshold":40,
    "spares_threshold":5,
    "life_used_percentage":5,
    "shutdown_state":"clean"
  }
}
.fi
.br
.sp
\-F, \-\-firmware
.RS 4
Include firmware info in the listing, including the state and
capability of runtime firmware activation:
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-BDF
[
  {
    "provider":"nfit_test.0",
    "dev":"ndbus2",
    "scrub_state":"idle",
    "firmware":{
      "activate_method":"suspend",
      "activate_state":"idle"
    },
    "dimms":[
      {
        "dev":"nmem1",
        "id":"cdab\-0a\-07e0\-ffffffff",
        "handle":0,
        "phys_id":0,
        "security":"disabled",
        "firmware":{
          "current_version":0,
          "can_update":true
        }
      },
\&...
]
.fam
.fi
.if n .RE
.sp
\-X, \-\-device\-dax
.RS 4
Include device\-dax ("daxregion") details when a namespace is in
"devdax" mode.
.RE
.sp
.nf
{
  "dev":"namespace0.0",
  "mode":"devdax",
  "size":4225761280,
  "uuid":"18ae1bbb\-bb62\-4efc\-86df\-4a5caacb5dcc",
  "daxregion":{
    "id":0,
    "size":4225761280,
    "align":2097152,
    "devices":[
      {
        "chardev":"dax0.0",
        "size":4225761280
      }
    ]
  }
}
.fi
.br
.sp
\-R, \-\-regions
.RS 4
Include region info in the listing
.RE
.sp
\-N, \-\-namespaces
.RS 4
Include namespace info in the listing.  Namespace info is
listed by default if no other options are specified to the command.
.RE
.sp
\-i, \-\-idle
.RS 4
Include idle (not enabled) devices in the listing
.RE
.sp
\-c, \-\-configured
.RS 4
Include configured devices (non\-zero sized namespaces)
regardless of whether they are enabled, or not. Other devices
besides namespaces are always considered "configured".
.RE
.sp
\-C, \-\-capabilities
.RS 4
Include region capabilities in the listing, i.e. supported
namespace modes and variable properties like sector sizes and
alignments.
.RE
.sp
\-M, \-\-media\-errors
.RS 4
Include media errors (badblocks) in the listing. Note that the
\fIbadblock_count\fP property is included in the listing by default
when the count is non\-zero, otherwise it is hidden. Also, if the
namespace is in \fIsector\fP mode the \fIbadblocks\fP listing is not
included and \fIbadblock_count\fP property may include blocks that are
located in metadata, or unused capacity in the namespace. Convert
a \fIsector\fP namespace into \fIraw\fP mode to list precise \fIbadblocks\fP
offsets.
.RE
.sp
.nf
{
  "dev":"namespace7.0",
  "mode":"raw",
  "size":33554432,
  "blockdev":"pmem7",
  "badblock_count":17,
  "badblocks":[
    {
      "offset":4,
      "length":1
    },
    {
      "offset":32768,
      "length":8
    },
    {
      "offset":65528,
      "length":8
    }
  ]
}
.fi
.br
.sp
\-v, \-\-verbose
.RS 4
Increase verbosity of the output. This can be specified
multiple times to be even more verbose on the informational and
miscellaneous output, and can be used to override omitted flags
for showing specific information.
.br
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\fB\-v\fP
In addition to the enabled namespaces default output, show the
numa_node, raw_uuid, and bad block media errors.
.br
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\fB\-vv\fP
Everything \fI\-v\fP provides, plus automatically enable \-\-dimms,
\-\-buses, and \-\-regions.
.br
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\fB\-vvv\fP
Everything \fI\-vv\fP provides, plus \-\-health, \-\-capabilities,
\-\-idle, and \-\-firmware.
::
The verbosity can also be scoped by the object type. For example
to just list regions with capabilities and media error info.
.RE
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-Ru \-vvv \-r 0
{
  "dev":"region0",
  "size":"4.00 GiB (4.29 GB)",
  "available_size":0,
  "max_available_extent":0,
  "type":"pmem",
  "numa_node":0,
  "target_node":2,
  "capabilities":[
    {
      "mode":"sector",
      "sector_sizes":[
        512,
        520,
        528,
        4096,
        4104,
        4160,
        4224
      ]
    },
    {
      "mode":"fsdax",
      "alignments":[
        4096,
        2097152,
        1073741824
      ]
    },
    {
      "mode":"devdax",
      "alignments":[
        4096,
        2097152,
        1073741824
      ]
    }
  ],
  "persistence_domain":"unknown"
}
.fam
.fi
.if n .RE
.sp
\-u, \-\-human
.RS 4
Format numbers representing storage sizes, or offsets as human
readable strings with units instead of the default machine\-friendly
raw\-integer data. Convert other numeric fields into hexadecimal strings.
.RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-region=7
{
  "dev":"region7",
  "size":67108864,
  "available_size":67108864,
  "type":"pmem",
  "iset_id":\-6382611090938810793,
  "badblock_count":8
}
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
# ndctl list \-\-human \-\-region=7
{
  "dev":"region7",
  "size":"64.00 MiB (67.11 MB)",
  "available_size":"64.00 MiB (67.11 MB)",
  "type":"pmem",
  "iset_id":"0xa76c6907811fae57",
  "badblock_count":8
}
.fam
.fi
.if n .RE
.SH "ENVIRONMENT VARIABLES"
.sp
\fINDCTL_LIST_LINT\fP
.RS 4
A bug in the "ndctl list" output needs to be fixed with care for
other tooling that may have developed a dependency on the buggy
behavior. The NDCTL_LIST_LINT variable is an opt\-in to apply
fixes, and not regress previously shipped behavior by default.
This environment variable applies the following fixups:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Fix "ndctl list \-Rv" to only show region objects and not include
namespace objects.
::
.RE
.RE
.SH "COPYRIGHT"
.sp
Copyright \(co 2016 \- 2022, 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\-create\-namespace(1)