LinuxCommandLibrary

ndctl

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

TLDR

Create an 'fsdax' mode namespace

$ ndctl create-namespace --mode=[fsdax]
copy


Change the mode of a namespace to 'raw'
$ ndctl create-namespace --reconfigure=[namespaceX.Y] --mode=[raw]
copy


Check a sector mode namespace for consistency, and repair if needed
$ ndctl check-namespace --repair [namespaceX.Y]
copy


List all namespaces, regions, and buses (including disabled ones)
$ ndctl list --namespaces --regions --buses --idle
copy


List a specific namespace and include lots of additional information
$ ndctl list -vvv --namespace=[namespaceX.Y]
copy


Run a monitor to watch for SMART health events for NVDIMMs on the 'ACPI.NFIT' bus
$ ndctl monitor --bus=[ACPI.NFIT]
copy


Remove a namespace (when applicable) or reset it to an initial state
$ ndctl destroy-namespace --force [namespaceX.Y]
copy

SYNOPSIS

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


OPTIONS

-v, --version

Display ndctl version.

-h, --help

Run ndctl help command.

DESCRIPTION

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

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.

SEE ALSO

ndctl-create-namespace(1), ndctl-destroy-namespace(1), ndctl-check-namespace(1), ndctl-enable-region(1), ndctl-disable-region(1), ndctl-enable-dimm(1), ndctl-disable-dimm(1), ndctl-enable-namespace(1), ndctl-disable-namespace(1), ndctl-zero-labels(1), ndctl-read-labels(1), ndctl-inject-error(1), ndctl-list(1), "LIBNVDIMM <https://www.kernel.org/doc/Documentation/nvdimm/nvdimm.txt> Overview" , "NVDIMM <http://pmem.io/documents/NVDIMM_Driver_Writers_Guide.pdf>Driver Writer’s Guide"

Copied to clipboard