nvdimm.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: QI Fuli <qi.fuli@jp.fujitsu.com>
To: linux-nvdimm@lists.01.org
Cc: tokunaga.keiich@jp.fujitsu.com
Subject: [ndctl PATCH v13 4/5] ndctl, documentation: add man page for monitor
Date: Sat, 14 Jul 2018 08:33:49 +0900	[thread overview]
Message-ID: <20180713233350.7148-5-qi.fuli@jp.fujitsu.com> (raw)
In-Reply-To: <20180713233350.7148-1-qi.fuli@jp.fujitsu.com>

This patch is used to add man page for ndctl monitor command.

Signed-off-by: QI Fuli <qi.fuli@jp.fujitsu.com>
 Documentation/ndctl/Makefile.am       |   3 +-
 Documentation/ndctl/ndctl-monitor.txt | 108 ++++++++++++++++++++++++++
 2 files changed, 110 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/ndctl/ndctl-monitor.txt

diff --git a/Documentation/ndctl/Makefile.am b/Documentation/ndctl/Makefile.am
index 4fd9636..a30b139 100644
--- a/Documentation/ndctl/Makefile.am
+++ b/Documentation/ndctl/Makefile.am
@@ -46,7 +46,8 @@ man1_MANS = \
 	ndctl-inject-error.1 \
 	ndctl-inject-smart.1 \
 	ndctl-update-firmware.1 \
-	ndctl-list.1
+	ndctl-list.1 \
+	ndctl-monitor.1
diff --git a/Documentation/ndctl/ndctl-monitor.txt b/Documentation/ndctl/ndctl-monitor.txt
new file mode 100644
index 0000000..304b6e7
--- /dev/null
+++ b/Documentation/ndctl/ndctl-monitor.txt
@@ -0,0 +1,108 @@
+// SPDX-License-Identifier: GPL-2.0
+ndctl-monitor - Monitor the smart events of nvdimm objects
+'ndctl monitor' [<options>]
+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 the default configuration file
+(/etc/ndctl/monitor.conf). Both of the values in configuration file
+and in options will work. If there is a conflict, the values in
+options will override the values in configuration file. The changed
+values in configuration file will work after the monitor is restarted.
+The smart threshold evnet alarm of dimm will be turned on when the
+monitor gets started, if it is set off.
+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
+ndctl monitor -log /var/log/ndctl.log
+Run a monitor daemon as a system service
+systemctl start ndctl-monitor.service
+	Enforce that the operation only be carried on devices that are
+	attached to the given bus. Where 'bus' can be a provider name
+	or a bus id number.
+	A 'nmemX' device name, or dimm id number. Select the devices to
+	monitor reference the given dimm.
+	A 'regionX' device name, or a region id number. The keyword 'all'
+	can be specified to carry out the operation on every region in
+	the system, optionally filtered by bus id (see --bus= option).
+	A 'namespaceX.Y' device name, or namespace region plus id tuple
+	'X.Y'.
+-l <file | syslog | standard>::
+--log=<file | syslog | standard>::
+	Output notifications to <file>, syslog or standard output.
+	Run a monitor as a daemon.
+	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.
+	Output monitor notification as human friendly json format instead
+	of the default machine friendly json format.
+Copyright (c) 2018, FUJITSU LIMITED. License GPLv2: GNU GPL version 2
+<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.
+linkndctl:ndctl-list[1], linkndctl:ndctl-inject-smart[1]

Linux-nvdimm mailing list

  parent reply	other threads:[~2018-07-13 23:34 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-13 23:33 [ndctl PATCH v13 0/5] ndctl, monitor: add ndctl monitor daemon QI Fuli
2018-07-13 23:33 ` [ndctl PATCH v13 1/5] ndctl, monitor: add a new command - monitor QI Fuli
2018-07-13 23:33 ` [ndctl PATCH v13 2/5] ndctl, monitor: add main ndctl monitor configuration file QI Fuli
2018-10-16  0:23   ` Dan Williams
2018-10-16  4:09     ` qi.fuli
2018-11-05  8:05       ` qi.fuli
2018-07-13 23:33 ` [ndctl PATCH v13 3/5] ndctl, monitor: add the unit file of systemd for ndctl-monitor service QI Fuli
2018-07-13 23:33 ` QI Fuli [this message]
2018-07-13 23:33 ` [ndctl PATCH v13 5/5] ndctl, test: add a new unit test for monitor QI Fuli
2018-07-19  0:42 ` [ndctl PATCH v13 0/5] ndctl, monitor: add ndctl monitor daemon Verma, Vishal L
2018-07-19  1:02   ` Qi, Fuli

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180713233350.7148-5-qi.fuli@jp.fujitsu.com \
    --to=qi.fuli@jp.fujitsu.com \
    --cc=linux-nvdimm@lists.01.org \
    --cc=tokunaga.keiich@jp.fujitsu.com \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).