> For the complete documentation index, see [llms.txt](https://docs.pmem.io/ndctl-user-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pmem.io/ndctl-user-guide/v72.0/master.md). # NDCTL User Guide ## Introduction `ndctl` is a utility for managing the Linux LIBNVDIMM Kernel subsystem. It is designed to work with various non-volatile memory devices (NVDIMMs) from different vendors. The LIBNVDIMM subsystem defines a kernel device model and control message interface for platform NVDIMM resources like those defined by the [ACPI v6.0](http://www.uefi.org/sites/default/files/resources/ACPI_6_0_Errata_A.PDF) NFIT (**N**VDIMM **F**irmware **I**nterface **T**able). The latest [ACPI ](http://www.uefi.org/specifications)and [UEFI ](http://www.uefi.org/specifications)specifications can be found at [uefi.org](http://www.uefi.org). Operations supported by `ndctl` include: * Provisioning capacity (namespaces) * Enumerating Devices * Enabling and Disabling NVDIMMs, Regions, and Namespaces * Managing NVDIMM Labels ## What's new in v72.0 This release incorporates functionality up to the 5.16 kernel. Highlights include a new utility and library for interfacing with the 'CXL' drivers and devices, a policy based configuration mechanism for ndctl and daxctl, fixes, test updates, and general additions for the PAPR family of NVDIMMs, more seed device accounting fixes, misc unit test and documentation updates, and fixes to NVDIMM bus scrubbing. Commands: * cxl-cli: new utility providing list, {read,write,zero}-label commands * daxctl-reconfigure-device: new --check-config option * ndctl-monitor: add support for a new unified config file format * ndctl-\*-namespace: seed namespace accounting fixes Tests: * Fix device-dax mremap() test * Exercise soft\_offline\_page() corner cases * Fix btt expect table compile warning * monitor.sh: add checking the presence of jq command ahead of time APIs: * ndctl\_bus\_nfit\_translate\_spa * ndctl\_dimm\_sizeof\_namespace\_index * ndctl\_get\_config\_path * ndctl\_set\_config\_path * daxctl\_dev\_has\_online\_memory * daxctl\_dev\_will\_auto\_online\_memory * daxctl\_get\_config\_path * daxctl\_set\_config\_path * cxl\_cmd\_get\_devname * cxl\_cmd\_get\_mbox\_status * cxl\_cmd\_get\_out\_size * cxl\_cmd\_health\_info\_get\_dirty\_shutdowns * cxl\_cmd\_health\_info\_get\_ext\_corrected\_persistent\_normal * cxl\_cmd\_health\_info\_get\_ext\_corrected\_persistent\_warning * cxl\_cmd\_health\_info\_get\_ext\_corrected\_volatile\_normal * cxl\_cmd\_health\_info\_get\_ext\_corrected\_volatile\_warning * cxl\_cmd\_health\_info\_get\_ext\_life\_used\_critical * cxl\_cmd\_health\_info\_get\_ext\_life\_used\_normal * cxl\_cmd\_health\_info\_get\_ext\_life\_used\_warning * cxl\_cmd\_health\_info\_get\_ext\_temperature\_critical * cxl\_cmd\_health\_info\_get\_ext\_temperature\_normal * cxl\_cmd\_health\_info\_get\_ext\_temperature\_warning * cxl\_cmd\_health\_info\_get\_hw\_replacement\_needed * cxl\_cmd\_health\_info\_get\_life\_used * cxl\_cmd\_health\_info\_get\_maintenance\_needed * cxl\_cmd\_health\_info\_get\_media\_data\_loss\_imminent * cxl\_cmd\_health\_info\_get\_media\_data\_lost * cxl\_cmd\_health\_info\_get\_media\_normal * cxl\_cmd\_health\_info\_get\_media\_not\_ready * cxl\_cmd\_health\_info\_get\_media\_persistence\_loss\_imminent * cxl\_cmd\_health\_info\_get\_media\_persistence\_lost * cxl\_cmd\_health\_info\_get\_media\_powerloss\_data\_loss * cxl\_cmd\_health\_info\_get\_media\_powerloss\_persistence\_loss * cxl\_cmd\_health\_info\_get\_media\_shutdown\_data\_loss * cxl\_cmd\_health\_info\_get\_media\_shutdown\_persistence\_loss * cxl\_cmd\_health\_info\_get\_performance\_degraded * cxl\_cmd\_health\_info\_get\_pmem\_errors * cxl\_cmd\_health\_info\_get\_temperature * cxl\_cmd\_health\_info\_get\_volatile\_errors * cxl\_cmd\_identify\_get\_fw\_rev * cxl\_cmd\_identify\_get\_label\_size * cxl\_cmd\_identify\_get\_partition\_align * cxl\_cmd\_new\_get\_health\_info * cxl\_cmd\_new\_identify * cxl\_cmd\_new\_raw * cxl\_cmd\_new\_read\_label cxl\_cmd\_new\_write\_label * cxl\_cmd\_read\_label\_get\_payload * cxl\_cmd\_ref cxl\_cmd\_set\_input\_payload * cxl\_cmd\_set\_output\_payload cxl\_cmd\_submit * cxl\_cmd\_unref cxl\_get\_log\_priority * cxl\_get\_private\_data * cxl\_get\_userdata * cxl\_memdev\_get\_ctx * cxl\_memdev\_get\_devname * cxl\_memdev\_get\_firmware\_verison * cxl\_memdev\_get\_first * cxl\_memdev\_get\_id * cxl\_memdev\_get\_label\_size * cxl\_memdev\_get\_major * cxl\_memdev\_get\_minor * cxl\_memdev\_get\_next * cxl\_memdev\_get\_pmem\_size * cxl\_memdev\_get\_ram\_size * cxl\_memdev\_nvdimm\_bridge\_active * cxl\_memdev\_read\_label * cxl\_memdev\_write\_label * cxl\_memdev\_zero\_label * cxl\_new cxl\_ref * cxl\_set\_log\_fn * cxl\_set\_log\_priority * cxl\_set\_private\_data * cxl\_set\_userdata cxl\_unref