NDCTL User Guide
HomePMDKNDCTLBlog
v72.1
v72.1
  • NDCTL User Guide
  • Installing NDCTL, DAXCTL, and CXL-CLI Utilities
    • Installing NDCTL and DAXCTL Packages on Linux
    • Installing the CXL-CLI Package on Linux
    • Installing NDCTL, DAXCTL, and CXL-CLI from Source on Linux
  • Quick Start
  • Concepts
    • NVDIMM Devices
    • PMEM and BLK Modes
    • Regions
      • Regions, Atomic Sectors, and DAX
    • Label Storage Area (LSA)
    • Namespaces
  • Managing NVDIMMs
  • Managing Regions
  • Managing Label Storage Areas (LSA)
  • Managing Namespaces
  • Managing NVDIMM Security
  • NDCTL Man Pages
    • ndctl(1)
    • ndctl-activate-firmware(1)
    • ndctl−check−labels(1)
    • ndctl−check−namespace(1)
    • ndctl−clear−errors(1)
    • ndctl−create−namespace(1)
    • ndctl−destroy−namespace(1)
    • ndctl−disable−dimm(1)
    • ndctl−disable−namespace(1)
    • ndctl−disable−region(1)
    • ndctl−enable−dimm(1)
    • ndctl-enable−namespace(1)
    • ndctl−enable−region(1)
    • ndctl−freeze−security(1)
    • ndctl−init−labels(1)
    • ndctl−inject−error(1)
    • ndctl−inject−smart(1)
    • ndct-list(1)
    • ndctl−load−keys(1)
    • ndctl−monitor(1)
    • ndctl-read-infoblock(1)
    • ndctl−read−labels(1)
    • ndctl−remove−passphrase(1)
    • ndctl−sanitize−dimm(1)
    • ndctl−setup−passphrase(1)
    • ndctl−start−scrub(1)
    • ndctl-update-firmware(1)
    • ndctl-update-passphrase(1)
    • ndctl−wait−overwrite(1)
    • ndctl−wait−scrub(1)
    • ndctl-write-infoblock(1)
    • ndctl−write−labels(1)
    • ndctl−zero−labels(1)
  • DAXCTL Man Pages
    • daxctl(1)
    • daxctl-create-device (1)
    • daxctl-destroy-device (1)
    • daxctl-disable-device (1)
    • daxctl-enable-device (1)
    • daxctl-list(1)
    • daxctl−migrate−device−model(1)
    • daxctl−offline−memory(1)
    • daxctl−online−memory(1)
    • daxctl−reconfigure−device(1)
  • CXL Man Pages
    • cxl(1)
    • cxl-list(1)
    • cxl-read-labels(1)
    • cxl-write-labels(1)
    • cxl-zero-labels(1)
  • Troubleshooting
  • Glossary
  • Reference Material
Powered by GitBook
On this page
  • NAME
  • SYNOPSIS
  • EXAMPLE
  • OPTIONS
  • COPYRIGHT

Was this helpful?

  1. DAXCTL Man Pages

daxctl-list(1)

Previousdaxctl-enable-device (1)Nextdaxctl−migrate−device−model(1)

Last updated 3 years ago

Was this helpful?

NAME

daxctl−list − dump the platform Device−DAX regions, devices, and attributes in json.

SYNOPSIS

daxctl list [<options>]

Walk all the device−dax−regions in the system and list all device instances along with some of their major attributes.

Options can be specified to limit the output to objects of a certain class. Where the classes are regions or devices. By default, daxctl list with no options is equivalent to:

daxctl list −−devices

EXAMPLE

# daxctl list --regions --devices

{
 "id":1,
 "devices":[
   {
	 "chardev":"dax1.0",
	 "size":3233808384
   }
 ]
}

OPTIONS

−r, −−region=

A device−dax region is a contiguous range of memory that hosts one or more /dev/daxX.Y devices, where X is the region id and Y is the device instance id. The keyword all can be specified to carry out the operation on every region in the system.

−d, −−dev=

Specify a dax device name, . tuple, or keyword all to filter the listing. For example to list the first device instance in region1:

# daxctl list --dev=1.0

{
 "chardev":"dax1.0",
 "size":3233808384
}

−D, −−devices

Include device−dax instance info in the listing (default)

−R, −−regions

Include region info in the listing

−i, −−idle

Include idle (not enabled / zero−sized) devices in the listing

−u, −−human

By default daxctl list 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. Example:

# daxctl list
{
 "chardev":"dax1.0",
 "size":32828817408
}

# daxctl list --human
{
 "chardev":"dax1.0",
 "size":"30.57 GiB (32.83 GB)"
}

COPYRIGHT

Copyright (c) 2016 − 2019, Intel Corporation. License GPLv2: GNU GPL version 2 . This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

http://gnu.org/licenses/gpl.html
NAME
SYNOPSIS
EXAMPLE
OPTIONS
COPYRIGHT