1NDCTL-MONITOR(1)                 ndctl Manual                 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 the configuration file at
18       /etc/ndctl/monitor.conf
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
29       ndctl monitor --bus=nfit_test.1 --daemon
30
31       Run a monitor as a one-shot command and output the notifications to
32       /var/log/ndctl.log
33
34
35       ndctl monitor --log=/var/log/ndctl.log
36
37       Run a monitor daemon as a system service
38
39
40       systemctl start ndctl-monitor.service
41

OPTIONS

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

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

SEE ALSO

116       ndctl-list(1), ndctl-inject-smart(1)
117
118
119
120ndctl                             2020-03-24                  NDCTL-MONITOR(1)
Impressum