NDCTL User Guide
HomePMDKNDCTLBlog
v71
v71
  • NDCTL User Guide
  • Installing NDCTL & DAXCTL
    • Installing NDCTL and DAXCTL Packages on Linux
    • Installing NDCTL and DAXCTL 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)
  • Troubleshooting
  • Glossary
  • Reference Material
Powered by GitBook
On this page

Was this helpful?

NDCTL Man Pages

PreviousManaging NVDIMM SecurityNextndctl(1)

Last updated 4 years ago

Was this helpful?

This section links to the online man pages:

  • - Manage “libnvdimm” subsystem devices (Non-volatile Memory)

  • ndctl-activate-firmware - activate staged firmware on memory devices

  • - determine if the given dimms have a valid namespace index block

  • - check namespace metadata consistency

  • - clear all errors (badblocks) on the given namespace

  • - provision or reconfigure a namespace

  • - destroy the given namespace(s)

  • - disable one or more idle dimms

  • - disable the given namespace(s)

  • - disable the given region(s) and all descendant namespaces

  • - enable one more dimms

  • - enable the given namespace(s)

  • - enable the given region(s) and all descendant namespaces

  • - Set the given DIMM(s) to reject future security operations

  • - initialize the label data area on a dimm or set of dimms

  • - inject media errors at a namespace offset

  • - perform smart threshold/injection operations on an NVDIMM

  • - print the platform nvdimm device topology and attributes

  • - load the master key (kek) and encrypted passphrases into the keyring

  • - Monitor the SMART events from NVDIMMs

  • - read and optionally parse the info-block a namespace

  • - read out the label area on a NVDIMM or set of NVDIMMs

  • - Stop an NVDIMM from locking at power-loss and requiring a passphrase to access media

  • - Perform a cryptographic destruction or overwrite of the contents of the given NVDIMM(s)

  • - setup and enable the security passphrase for one or more NVDIMMs

  • - start an Address Range Scrub (ARS) operation

  • - provides for updating the firmware on an NVDIMM

  • - update the security passphrase for one or more NVDIMMs

  • - wait for an overwrite operation to complete

  • - wait for an Address Range Scrub (ARS) operation to complete

  • - generate and write an infoblock

  • - write data to the label area on a dimm

  • - zero out the label area on a dimm or set of dimms

ndctl
ndctl-check-labels
ndctl-check-namespace
ndctl-clear-errors
ndctl-create-namespace
ndctl-destroy-namespace
ndctl-disable-dimm
ndctl-disable-namespace
ndctl-disable-region
ndctl-enable-dimm
ndctl-enable-namespace
ndctl-enable-region
ndctl-freeze-security
ndctl-init-labels
ndctl-inject-error
ndctl-inject-smart
ndctl-list
ndctl-load-keys
ndctl-monitor
ndctl-read-infoblock
ndctl-read-labels
ndctl-remove-passphrase
ndctl-sanitize-dimm
ndctl-setup-passphrase
ndctl-start-scrub
ndctl-update-firmware
ndctl-update-passphrase
ndctl-wait-overwrite
ndctl-wait-scrub
ndctl-write-infoblock
ndctl-write-labels
ndctl-zero-labels