1NDCTL-MONITOR(1)                                              NDCTL-MONITOR(1)
2
3
4

NAME

6       ndctl-monitor - Monitor the smart events of nvdimm objects
7

SYNOPSIS

9       ndctl monitor [<options>]
10

DESCRIPTION

12       Ndctl monitor is used for monitoring the smart events of nvdimm objects
13       and dumping the json format notifications to syslog, standard output or
14       a logfile.
15
16       The objects to monitor and smart events to notify can be selected by
17       setting options and/or configuration files with .conf suffix under
18       /etc/ndctl.conf.d
19
20       Both, the values in configuration file and in options will work. If
21       there is a conflict, the values in options will override the values in
22       the configuration file. Any updated values in the configuration file
23       will take effect only after the monitor process is restarted.
24

EXAMPLES

26       Run a monitor as a daemon to monitor DIMMs on bus "nfit_test.1"
27
28           ndctl monitor --bus=nfit_test.1 --daemon
29
30       Run a monitor as a one-shot command and output the notifications to
31       /var/log/ndctl.log
32
33           ndctl monitor --log=/var/log/ndctl.log
34
35       Run a monitor daemon as a system service
36
37           systemctl start ndctl-monitor.service
38

OPTIONS

40       -b, --bus=
41           A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict
42           the operation to the specified bus(es). The keyword all can be
43           specified to indicate the lack of any restriction, however this is
44           the same as not supplying a --bus option at all.
45
46       -d, --dimm=
47           A nmemX device name, or a dimm id number. Restrict the operation to
48           the specified dimm(s). The keyword all can be specified to indicate
49           the lack of any restriction, however this is the same as not
50           supplying a --dimm option at all.
51
52       -r, --region=
53           A regionX device name, or a region id number. Restrict the
54           operation to the specified region(s). The keyword all can be
55           specified to indicate the lack of any restriction, however this is
56           the same as not supplying a --region option at all.
57
58       -n, --namespace=
59           A namespaceX.Y device name, or namespace region plus id tuple X.Y.
60
61       -l, --log=
62           Send log messages to the specified destination.
63
64           •   "<file>": Send log messages to specified <file>. When fopen()
65               is not able to open <file>, log messages will be forwarded to
66               syslog.
67
68           •   "syslog": Send messages to syslog.
69
70           •   "standard": Send messages to standard output.
71
72       The default log destination is syslog if "--daemon" is specified,
73       otherwise standard. Note that standard and relative path for <file>
74       will not work if "--daemon" is specified.
75
76       -c, --config-file=
77           Provide the config file(s) to use. This overrides the default
78           config typically found in /etc/ndctl.conf.d
79
80       --daemon
81           Run a monitor as a daemon.
82
83       -D, --dimm-event=
84           Name of an smart health event from the following:
85
86           •   "dimm-spares-remaining": Spare Blocks Remaining value has gone
87               below the pre-programmed threshold.
88
89           •   "dimm-media-temperature": NVDIMM Media temperature value has
90               gone above the pre-programmed threshold.
91
92           •   "dimm-controller-temperature": NVDIMM Controller temperature
93               value has gone above the pre-programmed threshold.
94
95           •   "dimm-health-state": NVDIMM Normal Health Status has changed
96
97           •   "dimm-unclean-shutdown": NVDIMM Last Shutdown Status was a
98               unclean shutdown.
99
100       The monitor will attempt to enable the alarm control bits for all
101       specified events.
102
103       -p, --poll=
104           Poll and report status/event every <n> seconds.
105
106       -u, --human
107           Output monitor notification as human friendly json format instead
108           of the default machine friendly json format.
109
110       -v, --verbose
111           Emit extra debug messages to log.
112

114       Copyright (c) 2018, FUJITSU LIMITED. License GPLv2: GNU GPL version 2
115       http://gnu.org/licenses/gpl.html. This is free software: you are free
116       to change and redistribute it. There is NO WARRANTY, to the extent
117       permitted by law.
118

SEE ALSO

120       linkndctl:ndctl-list[1], linkndctl:ndctl-inject-smart[1]
121
122
123
124                                  01/13/2023                  NDCTL-MONITOR(1)
Impressum