NDCTL User Guide
Home
PMDK
NDCTL
Blog
Search…
v73
NDCTL User Guide
Installing NDCTL, DAXCTL, and CXL-CLI Utilities
Quick Start
Concepts
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
CXL Man Pages
Troubleshooting
Glossary
Reference Material
Powered By
GitBook
NDCTL Man Pages
This section links to the online man pages:
ndctl
- Manage “libnvdimm” subsystem devices (Non-volatile Memory)
ndctl-activate-firmware
- activate staged firmware on memory devices
ndctl-check-labels
- determine if the given dimms have a valid namespace index block
ndctl-check-namespace
- check namespace metadata consistency
ndctl-clear-errors
- clear all errors (badblocks) on the given namespace
ndctl-create-namespace
- provision or reconfigure a namespace
ndctl-destroy-namespace
- destroy the given namespace(s)
ndctl-disable-dimm
- disable one or more idle dimms
ndctl-disable-namespace
- disable the given namespace(s)
ndctl-disable-region
- disable the given region(s) and all descendant namespaces
ndctl-enable-dimm
- enable one more dimms
ndctl-enable-namespace
- enable the given namespace(s)
ndctl-enable-region
- enable the given region(s) and all descendant namespaces
ndctl-freeze-security
- Set the given DIMM(s) to reject future security operations
ndctl-init-labels
- initialize the label data area on a dimm or set of dimms
ndctl-inject-error
- inject media errors at a namespace offset
ndctl-inject-smart
- perform smart threshold/injection operations on an NVDIMM
ndctl-list
- print the platform nvdimm device topology and attributes
ndctl-load-keys
- load the master key (kek) and encrypted passphrases into the keyring
ndctl-monitor
- Monitor the SMART events from NVDIMMs
ndctl-read-infoblock
- read and optionally parse the info-block a namespace
ndctl-read-labels
- read out the label area on a NVDIMM or set of NVDIMMs
ndctl-remove-passphrase
- Stop an NVDIMM from locking at power-loss and requiring a passphrase to access media
ndctl-sanitize-dimm
- Perform a cryptographic destruction or overwrite of the contents of the given NVDIMM(s)
ndctl-setup-passphrase
- setup and enable the security passphrase for one or more NVDIMMs
ndctl-start-scrub
- start an Address Range Scrub (ARS) operation
ndctl-update-firmware
- provides for updating the firmware on an NVDIMM
ndctl-update-passphrase
- update the security passphrase for one or more NVDIMMs
ndctl-wait-overwrite
- wait for an overwrite operation to complete
ndctl-wait-scrub
- wait for an Address Range Scrub (ARS) operation to complete
ndctl-write-infoblock
- generate and write an infoblock
ndctl-write-labels
- write data to the label area on a dimm
ndctl-zero-labels
- zero out the label area on a dimm or set of dimms
Previous
Managing NVDIMM Security
Next
ndctl(1)
Last modified
3mo ago
Copy link