.\" Copyright IBM Corp. 2024
.\" s390-tools is free software; you can redistribute it and/or modify
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.\" Macro for inserting an option description prologue.
.\" .OD <long> [<short>] [args]
.de OD
.  ds args "
.  if !'\\$3'' .as args \fI\\$3\fP
.  if !'\\$4'' .as args \\$4
.  if !'\\$5'' .as args \fI\\$5\fP
.  if !'\\$6'' .as args \\$6
.  if !'\\$7'' .as args \fI\\$7\fP
.  PD 0
.  if !'\\$2'' .IP "\fB\-\\$2\fP \\*[args]" 4
.  if !'\\$1'' .IP "\fB\-\-\\$1\fP \\*[args]" 4
.  PD
..
.\" Macro for inserting code line.
.\" .CL <text>
.de CL
.  ds pfont \fP
.  nh
.  na
.  ft CR
\\$*
.  ft \\*[pfont]
.  ad
.  hy
.  br
..
.
.TH zpcimon 8 "Oct 2024" s390-tools zpcictl
.
.SH NAME
zpcimon - Monitor health of directly attached PCI devices including NVMes and NICs.
.
.
.SH SYNOPSIS
.B "zpcimon"
.I "OPTIONS"
.
.
.SH DESCRIPTION
Use
.B zpcimon
to monitor the health of the optical modules of directly attached PCI based
NICs as well as the health of NVMe devices using their SMART data. When
executed without the \fB--monitor\fR option it will collect health data from
all available and relevant PCI devices and print a summary in JSON format. Add
the \fB--send-report\fR option to report this data to the support element.

.
.
.SH OPTIONS
.SS Operation Options
.OD monitor "m"
Run continuously and monitor all supported devices. On link state changes
optical module data is collected and NVMe SMART data is collected on hotplug.
Moreover every
.B --interval
seconds data from all adapters is collected as a whole system snapshot.
.PP
.
.OD send-report "r"
Report the optics and NVMe health data to the Support Element (SE)
.PP
.
.OD quiet "q"
Be quiet and don't print health summaries.
.PP
.
.OD interval "i" "seconds"
Interval in seconds at which to collect monitoring data in the absence of link
state changes. A value larger than 24 hours (86400 seconds) is clamped down to
24 hours.
.PP
.
.OD module-info ""
Include a base64 encoded binary dump of the module's SFF-8636/8472/8024
standard data for each netdev. This matches "ethtool --module-info <netdev> raw
on".

.B Example: Extract module information for the first adapter

.CL zpcimon --module-info | jq -r '.adapters[0].netdevs[0].optics.module_info' | base64 -d | hexdump -C
.PP
.PP
.
.OD smart-log-raw ""
Include a base64 encoded binary dump of each NVMe's SMART data. This matches
"nvme smart-log --output-format=binary /dev/nvmeX".
.PP
.
.SS Output Format Options
.OD format "" <FORMAT>
Set the output format out of json, json-seq, jsonl, pairs, and csv. Note that
only json-seq and jsonl sequence formats are supported for monitoring mode as
they handle a continuous stream of updates well. While they are not supported
in query mode.
.PP
.
.SS General Options
.OD help "h" ""
Print usage information, then exit.
.PP
.
.OD version "v" ""
Print version information, then exit.
.PP