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 default configuration file
18       (/etc/ndctl/monitor.conf). Both of the values in configuration file and
19       in options will work. If there is a conflict, the values in options
20       will override the values in configuration file. The changed values in
21       configuration file will work after the monitor is restarted.
22

EXAMPLES

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

OPTIONS

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

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

SEE ALSO

113       ndctl-list(1), ndctl-inject-smart(1)
114
115
116
117ndctl 62                          05/11/2019                  NDCTL-MONITOR(1)
Impressum