'\" t
.\"     Title: ndctl-monitor
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2022-04-08
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-MONITOR" "1" "2022-04-08" "ndctl" "ndctl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ndctl\-monitor \- Monitor the smart events of nvdimm objects
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIndctl monitor\fP [<options>]
.fi
.br
.SH "DESCRIPTION"
.sp
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.
.sp
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
.sp
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.
.SH "EXAMPLES"
.sp
Run a monitor as a daemon to monitor DIMMs on bus "nfit_test.1"
.sp
.sp
.nf
ndctl monitor \-\-bus=nfit_test.1 \-\-daemon
.fi
.br
.sp
Run a monitor as a one\-shot command and output the notifications to
/var/log/ndctl.log
.sp
.sp
.nf
ndctl monitor \-\-log=/var/log/ndctl.log
.fi
.br
.sp
Run a monitor daemon as a system service
.sp
.sp
.nf
systemctl start ndctl\-monitor.service
.fi
.br
.SH "OPTIONS"
.sp
\-b, \-\-bus=
.RS 4
A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the
operation to the specified bus(es). The keyword \fIall\fP can be specified
to indicate the lack of any restriction, however this is the same as
not supplying a \-\-bus option at all.
.RE
.sp
\-d, \-\-dimm=
.RS 4
A \fInmemX\fP device name, or a dimm id number. Restrict the operation to
the specified dimm(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction, however this is the same as not supplying
a \-\-dimm option at all.
.RE
.sp
\-r, \-\-region=
.RS 4
A \fIregionX\fP device name, or a region id number. Restrict the operation to
the specified region(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction, however this is the same as not supplying a
\-\-region option at all.
.RE
.sp
\-n, \-\-namespace=
.RS 4
A \fInamespaceX.Y\fP device name, or namespace region plus id tuple
\fIX.Y\fP.
.RE
.sp
\-l, \-\-log=
.RS 4
Send log messages to the specified destination.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"<file>":
Send log messages to specified <file>. When fopen() is not able
to open <file>, log messages will be forwarded to syslog.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"syslog":
Send messages to syslog.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"standard":
Send messages to standard output.
.RE
.RE
.sp
The default log destination is \fIsyslog\fP if "\-\-daemon" is specified,
otherwise \fIstandard\fP. Note that standard and relative path for <file>
will not work if "\-\-daemon" is specified.
.sp
\-c, \-\-config\-file=
.RS 4
Provide the config file(s) to use. This overrides the default config
typically found in /etc/ndctl.conf.d
.RE
.sp
\-\-daemon
.RS 4
Run a monitor as a daemon.
.RE
.sp
\-D, \-\-dimm\-event=
.RS 4
Name of an smart health event from the following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"dimm\-spares\-remaining": Spare Blocks Remaining value has gone
below the pre\-programmed threshold.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"dimm\-media\-temperature": NVDIMM Media temperature value has
gone above the pre\-programmed threshold.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"dimm\-controller\-temperature": NVDIMM Controller temperature
value has gone above the pre\-programmed threshold.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"dimm\-health\-state": NVDIMM Normal Health Status has changed
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"dimm\-unclean\-shutdown": NVDIMM Last Shutdown Status was a
unclean shutdown.
.RE
.RE
.sp
The monitor will attempt to enable the alarm control bits for all
specified events.
.sp
\-p, \-\-poll=
.RS 4
Poll and report status/event every <n> seconds.
.RE
.sp
\-u, \-\-human
.RS 4
Output monitor notification as human friendly json format instead
of the default machine friendly json format.
.RE
.sp
\-v, \-\-verbose
.RS 4
Emit extra debug messages to log.
.RE
.SH "COPYRIGHT"
.sp
Copyright (c) 2018, FUJITSU LIMITED. License GPLv2: GNU GPL version 2
.URL "http://gnu.org/licenses/gpl.html" "" "."
This is free software: you are
free to change and redistribute it. There is NO WARRANTY, to the
extent permitted by law.
.SH "SEE ALSO"
.sp
ndctl\-list(1), ndctl\-inject\-smart(1)