📦 ndctl-doc

C

• cxl(1)Provides enumeration and provisioning commands for CXL platforms✨
• cxl-create-region(1)Assemble a CXL region by setting up attributes of its constituent CXL memdevs.✨
• cxl-destroy-region(1)destroy specified region(s).✨
• cxl-disable-bus(1)Shutdown an entire tree of CXL devices✨
• cxl-disable-memdev(1)deactivate / hot-remove a given CXL memdev✨
• cxl-disable-port(1)disable / hot-remove a given CXL port and descendants✨
• cxl-disable-region(1)disable specified region(s).✨
• cxl-enable-memdev(1)activate / hot-add a given CXL memdev✨
• cxl-enable-port(1)activate / hot-add a given CXL port✨
• cxl-enable-region(1)enable specified region(s).✨
• cxl-free-dpa(1)release device-physical address space✨
• cxl-list(1)List platform CXL objects, and their attributes, in json.✨
• cxl-monitor(1)Monitor the CXL trace events✨
• cxl-read-labels(1)read out the label area on a CXL memdev✨
• cxl-reserve-dpa(1)allocate device-physical address space✨
• cxl-set-alert-config(1)set the warning alert threshold on a CXL memdev✨
• cxl-set-partition(1)set the partitioning between volatile and persistent capacity on a CXL memdev✨
• cxl-update-firmware(1)update the firmware on a CXL memdev✨
• cxl-wait-sanitize(1)wait for a sanitize operation to complete✨
• cxl-write-labels(1)write data to the label area on a memdev✨
• cxl-zero-labels(1)zero out the label area on a set of memdevs✨
• cxl_new(3)Create a new library context object that acts as a handle for all library operations✨

D

• daxctl(1)Provides enumeration and provisioning commands for the Linux kernel Device-DAX facility✨
• daxctl-create-device(1)Create a devdax device✨
• daxctl-destroy-device(1)Destroy a devdax device✨
• daxctl-disable-device(1)Disables a devdax device✨
• daxctl-enable-device(1)Enable a devdax device✨
• daxctl-list(1)dump the platform Device-DAX regions, devices, and attributes in json.✨
• daxctl-migrate-device-model(1)Opt-in to the /sys/bus/dax device-model, allow for alternative Device-DAX instance drivers.✨
• daxctl-offline-memory(1)Offline the memory for a device that is in system-ram mode✨
• daxctl-online-memory(1)Online the memory for a device that is in system-ram mode✨
• daxctl-reconfigure-device(1)Reconfigure a dax device into a different mode✨

L

• libcxl(3)A library to interact with CXL devices through sysfs(5) and ioctl(2) interfaces✨

N

• ndctl(1)Manage "libnvdimm" subsystem devices (Non-volatile Memory)✨
• ndctl-activate-firmware(1)activate staged firmware on memory devices✨
• ndctl-check-labels(1)determine if the given dimms have a valid namespace index block✨
• ndctl-check-namespace(1)check namespace metadata consistency✨
• ndctl-clear-errors(1)clear all errors (badblocks) on the given namespace✨
• ndctl-create-namespace(1)provision or reconfigure a namespace✨
• ndctl-destroy-namespace(1)destroy the given namespace(s)✨
• ndctl-disable-dimm(1)disable one or more idle dimms✨
• ndctl-disable-namespace(1)disable the given namespace(s)✨
• ndctl-disable-region(1)disable the given region(s) and all descendant namespaces✨
• ndctl-enable-dimm(1)enable one more dimms✨
• ndctl-enable-namespace(1)enable the given namespace(s)✨
• ndctl-enable-region(1)enable the given region(s) and all descendant namespaces✨
• ndctl-freeze-security(1)Set the given DIMM(s) to reject future security operations✨
• ndctl-init-labels(1)initialize the label data area on a dimm or set of dimms✨
• ndctl-inject-error(1)inject media errors at a namespace offset✨
• ndctl-inject-smart(1)perform smart threshold/injection operations on a DIMM✨
• ndctl-list(1)dump the platform nvdimm device topology and attributes in json✨
• ndctl-load-keys(1)load the kek and encrypted passphrases into the keyring✨
• ndctl-monitor(1)Monitor the smart events of nvdimm objects✨
• ndctl-read-infoblock(1)read and optionally parse the info-block a namespace✨
• ndctl-read-labels(1)read out the label area on a dimm or set of dimms✨
• ndctl-remove-passphrase(1)Stop a DIMM from locking at power-loss and requiring a passphrase to access media✨
• ndctl-sanitize-dimm(1)Perform a cryptographic destruction or overwrite of the contents of the given NVDIMM(s)✨
• ndctl-setup-passphrase(1)setup and enable the security passphrase for an NVDIMM✨
• ndctl-start-scrub(1)start an Address Range Scrub (ARS) operation✨
• ndctl-update-firmware(1)update the firmware the given device✨
• ndctl-update-passphrase(1)update the security passphrase for an NVDIMM✨
• ndctl-wait-overwrite(1)wait for an overwrite operation to complete✨
• ndctl-wait-scrub(1)wait for an Address Range Scrub (ARS) operation to complete✨
• ndctl-write-infoblock(1)generate and write an infoblock✨
• ndctl-write-labels(1)write data to the label area on a dimm✨
• ndctl-zero-labels(1)zero out the label area on a dimm or set of dimms✨