NDCTL User Guide
HomePMDKNDCTLBlog
v66
v66
  • NDCTL User Guide
  • Installing NDCTL
    • Installing NDCTL Packages on Linux
    • Installing NDCTL 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−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)
    • ndctl−list(1)
    • ndctl−load−keys(1)
    • ndctl−monitor(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−labels(1)
    • ndctl−zero−labels(1)
  • DAXCTL Man Pages
    • daxctl(1)
    • daxctl-list(1)
    • daxctl−migrate−device−model(1)
    • daxctl−offline−memory(1)
    • daxctl−online−memory(1)
    • daxctl−reconfigure−device(1)
  • Troubleshooting
  • Glossary
  • Reference Material
Powered by GitBook
On this page
  • NAME
  • SYNOPSIS
  • OPTIONS
  • DESCRIPTION
  • COPYRIGHT
  • SEE ALSO

Was this helpful?

  1. NDCTL Man Pages

ndctl(1)

PreviousNDCTL Man PagesNextndctl−check−labels(1)

Last updated 5 years ago

Was this helpful?

NAME

ndctl − Manage "libnvdimm" subsystem devices (Non−volatile Memory)

SYNOPSIS

ndctl [−−version] [−−help] [OPTIONS] COMMAND [ARGS]

OPTIONS

−v, −−version

Display ndctl version.

−h, −−help

Run ndctl help command.

DESCRIPTION

ndctl is utility for managing the "libnvdimm" kernel subsystem. The "libnvdimm" subsystem defines a kernel device model and control message interface for platform NVDIMM resources like those defined by the ACPI 6.0 NFIT (NVDIMM Firmware Interface Table). Operations supported by the tool include, provisioning capacity (namespaces), as well as enumerating/enabling/disabling the devices (dimms, regions, namespaces) associated with an NVDIMM bus.

COPYRIGHT

SEE ALSO

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.

, , , , , , , , , , , , , LIBNVDIMM Overview" , NVDIMM Driver Writer’s Guide"

http://gnu.org/licenses/gpl.html
ndctl−create−namespace(1)
ndctl−destroy−namespace(1)
ndctl−check−namespace(1)
ndctl−enable−region(1)
ndctl−disable−region(1)
ndctl−enable−dimm(1)
ndctl−disable−dimm(1)
ndctl−enable−namespace(1)
ndctl−disable−namespace(1)
ndctl−zero−labels(1)
ndctl−read−labels(1)
ndctl−inject−error(1)
ndctl−list(1)
https://www.kernel.org/doc/Documentation/nvdimm/nvdimm.txt
http://pmem.io/documents/NVDIMM_Driver_Writers_Guide.pdf
NAME
SYNOPSIS
OPTIONS
DESCRIPTION
COPYRIGHT
SEE ALSO