ndctl - Man Page

• Create an 'fsdax' mode namespace: ndctl create-namespace --mode=fsdax
• Change the mode of a namespace to 'raw': ndctl create-namespace --reconfigure=namespaceX.Y --mode=raw
• Check a sector mode namespace for consistency, and repair if needed: ndctl check-namespace --repair namespaceX.Y
• List all namespaces, regions, and buses (including disabled ones): ndctl list --namespaces --regions --buses --idle
• List a specific namespace and include lots of additional information: ndctl list -vvv --namespace=namespaceX.Y
• Run a monitor to watch for SMART health events for NVDIMMs on the 'ACPI.NFIT' bus: ndctl monitor --bus=ACPI.NFIT
• Remove a namespace (when applicable) or reset it to an initial state: ndctl destroy-namespace --force namespaceX.Y

tldr.sh

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

-v,  --version

Display ndctl version.

-h,  --help

Run ndctl help command.

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 © 2016 - 2022, Intel Corporation. License GPLv2: GNU GPL version 2 http://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

linkndctl:ndctl-create-namespace[1], linkndctl:ndctl-destroy-namespace[1], linkndctl:ndctl-check-namespace[1], linkndctl:ndctl-enable-region[1], linkndctl:ndctl-disable-region[1], linkndctl:ndctl-enable-dimm[1], linkndctl:ndctl-disable-dimm[1], linkndctl:ndctl-enable-namespace[1], linkndctl:ndctl-disable-namespace[1], linkndctl:ndctl-zero-labels[1], linkndctl:ndctl-read-labels[1], linkndctl:ndctl-inject-error[1], linkndctl:ndctl-list[1], LIBNVDIMM Overview^[1], NVDIMM Driver Writer’s Guide^[2]

1. LIBNVDIMM Overview
   https://www.kernel.org/doc/Documentation/nvdimm/nvdimm.txt
2. NVDIMM Driver Writer’s Guide
   http://pmem.io/documents/NVDIMM_Driver_Writers_Guide.pdf

daxio(1).