--- name: "ndctl-monitor" section: "1" platform: "linux" package: "ndctl" version: "85-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/ndctl-monitor" --- # ndctl-monitor(1) Monitor the smart events of nvdimm objects ## NAME ndctl-monitor - Monitor the smart events of nvdimm objects ## SYNOPSIS ``` ndctl monitor [] ``` ## DESCRIPTION Ndctl monitor is used for monitoring the smart events of nvdimm objects and dumping the json format notifications to syslog, standard output or a logfile. The objects to monitor and smart events to notify can be selected by setting options and/or configuration files with .conf suffix under /etc/ndctl.conf.d Both, the values in configuration file and in options will work. If there is a conflict, the values in options will override the values in the configuration file. Any updated values in the configuration file will take effect only after the monitor process is restarted. ## EXAMPLES Run a monitor as a daemon to monitor DIMMs on bus "nfit\_test.1" ``` ndctl monitor --bus=nfit_test.1 --daemon ``` Run a monitor as a one-shot command and output the notifications to /var/log/ndctl.log ``` ndctl monitor --log=/var/log/ndctl.log ``` Run a monitor daemon as a system service ``` systemctl start ndctl-monitor.service ``` ## OPTIONS \-b, --bus= A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the operation to the specified bus(es). The keyword *all* can be specified to indicate the lack of any restriction, however this is the same as not supplying a --bus option at all. \-d, --dimm= A *nmemX* device name, or a dimm id number. Restrict the operation to the specified dimm(s). The keyword *all* can be specified to indicate the lack of any restriction, however this is the same as not supplying a --dimm option at all. \-r, --region= A *regionX* device name, or a region id number. Restrict the operation to the specified region(s). The keyword *all* can be specified to indicate the lack of any restriction, however this is the same as not supplying a --region option at all. \-n, --namespace= A *namespaceX.Y* device name, or namespace region plus id tuple *X.Y*. \-l, --log= Send log messages to the specified destination. • "\": Send log messages to specified \. When fopen() is not able to open \, log messages will be forwarded to syslog. • "syslog": Send messages to syslog. • "standard": Send messages to standard output. The default log destination is *syslog* if "--daemon" is specified, otherwise *standard*. Note that standard and relative path for \ will not work if "--daemon" is specified. \-c, --config-file= Provide the config file(s) to use. This overrides the default config typically found in /etc/ndctl.conf.d - \--daemon Run a monitor as a daemon. \-D, --dimm-event= Name of an smart health event from the following: • "dimm-spares-remaining": Spare Blocks Remaining value has gone below the pre-programmed threshold. • "dimm-media-temperature": NVDIMM Media temperature value has gone above the pre-programmed threshold. • "dimm-controller-temperature": NVDIMM Controller temperature value has gone above the pre-programmed threshold. • "dimm-health-state": NVDIMM Normal Health Status has changed • "dimm-unclean-shutdown": NVDIMM Last Shutdown Status was a unclean shutdown. The monitor will attempt to enable the alarm control bits for all specified events. \-p, --poll= Poll and report status/event every \ seconds. - \-u, --human Output monitor notification as human friendly json format instead of the default machine friendly json format. - \-v, --verbose Emit extra debug messages to log. ## COPYRIGHT Copyright (c) 2018, FUJITSU LIMITED. License GPLv2: GNU GPL version 2 \. 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-list(1)](/ndctl-list/1.md), [ndctl-inject-smart(1)](/ndctl-inject-smart/1.md)