Package ndctl

Manage "libnvdimm" subsystem devices (Non-volatile Memory)

https://github.com/pmem/ndctl

Utility library for managing the "libnvdimm" subsystem. The "libnvdimm"
subsystem defines a kernel device model and control message interface for
platform NVDIMM resources like those defined by the ACPI 6+ NFIT (NVDIMM
Firmware Interface Table).

Version: 80

General Commands

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 a DIMM
ndctl-list dump the platform nvdimm device topology and attributes in json
ndctl-load-keys load the kek and encrypted passphrases into the keyring
ndctl-monitor Monitor the smart events of nvdimm objects
ndctl-read-infoblock read and optionally parse the info-block a namespace
ndctl-read-labels read out the label area on a dimm or set of dimms
ndctl-remove-passphrase Stop a DIMM 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 an NVDIMM
ndctl-start-scrub start an Address Range Scrub (ARS) operation
ndctl-update-firmware update the firmware the given device
ndctl-update-passphrase update the security passphrase for an NVDIMM
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