Blame doc/rst/ibqueryerrors.8.in.rst

Packit db064d
=============
Packit db064d
IBQUERYERRORS
Packit db064d
=============
Packit db064d
Packit db064d
---------------------------------
Packit db064d
query and report IB port counters
Packit db064d
---------------------------------
Packit db064d
Packit db064d
:Date: @BUILD_DATE@
Packit db064d
:Manual section: 8
Packit db064d
:Manual group: OpenIB Diagnostics
Packit db064d
Packit db064d
Packit db064d
SYNOPSIS
Packit db064d
========
Packit db064d
Packit db064d
ibqueryerrors [options]
Packit db064d
Packit db064d
DESCRIPTION
Packit db064d
===========
Packit db064d
Packit db064d
The default behavior is to report the port error counters which exceed a
Packit db064d
threshold for each port in the fabric.  The default threshold is zero (0).
Packit db064d
Error fields can also be suppressed entirely.
Packit db064d
Packit db064d
In addition to reporting errors on every port.  ibqueryerrors can report the
Packit db064d
port transmit and receive data as well as report full link information to the
Packit db064d
remote port if available.
Packit db064d
Packit db064d
OPTIONS
Packit db064d
=======
Packit db064d
Packit db064d
**-s, --suppress <err1,err2,...>**
Packit db064d
Suppress the errors listed in the comma separated list provided.
Packit db064d
Packit db064d
**-c, --suppress-common**
Packit db064d
Suppress some of the common "side effect" counters.  These counters usually do
Packit db064d
not indicate an error condition and can be usually be safely ignored.
Packit db064d
Packit db064d
**-r, --report-port**
Packit db064d
Report the port information.  This includes LID, port, external port (if
Packit db064d
applicable), link speed setting, remote GUID, remote port, remote external port
Packit db064d
(if applicable), and remote node description information.
Packit db064d
Packit db064d
**--data**
Packit db064d
Include the optional transmit and receive data counters.
Packit db064d
Packit db064d
**--threshold-file <filename>**
Packit db064d
Specify an alternate threshold file.  The default is @IBDIAG_CONFIG_PATH@/error_thresholds
Packit db064d
Packit db064d
**--switch**  print data for switch's only
Packit db064d
Packit db064d
**--ca**  print data for CA's only
Packit db064d
Packit db064d
**--skip-sl**  Use the default sl for queries. This is not recommended when
Packit db064d
using a QoS aware routing engine as it can cause a credit deadlock.
Packit db064d
Packit db064d
**--router**  print data for routers only
Packit db064d
Packit db064d
**--clear-errors -k** Clear error counters after read.
Packit db064d
Packit db064d
**--clear-counts -K** Clear data counters after read.
Packit db064d
Packit db064d
**CAUTION** clearing data or error counters will occur regardless of if they
Packit db064d
are printed or not.  See **--counters** and **--data** for details on
Packit db064d
controlling which counters are printed.
Packit db064d
Packit db064d
**--details** include receive error and transmit discard details
Packit db064d
Packit db064d
**--counters** print data counters only
Packit db064d
Packit db064d
Packit db064d
Partial Scan flags
Packit db064d
------------------
Packit db064d
Packit db064d
The node to start a partial scan can be specified with the following addresses.
Packit db064d
Packit db064d
.. include:: common/opt_G_with_param.rst
Packit db064d
.. include:: common/opt_D_with_param.rst
Packit db064d
Packit db064d
**Note:** For switches results are printed for all ports not just switch port 0.
Packit db064d
Packit db064d
**-S <port_guid>** same as "-G". (provided only for backward compatibility)
Packit db064d
Packit db064d
Packit db064d
Cache File flags
Packit db064d
----------------
Packit db064d
Packit db064d
.. include:: common/opt_load-cache.rst
Packit db064d
Packit db064d
Packit db064d
Packit db064d
Packit db064d
Port Selection flags
Packit db064d
--------------------
Packit db064d
Packit db064d
.. include:: common/opt_C.rst
Packit db064d
.. include:: common/opt_P.rst
Packit db064d
.. include:: common/sec_portselection.rst
Packit db064d
Packit db064d
Configuration flags
Packit db064d
-------------------
Packit db064d
Packit db064d
.. include:: common/opt_z-config.rst
Packit db064d
.. include:: common/opt_o-outstanding_smps.rst
Packit db064d
.. include:: common/opt_node_name_map.rst
Packit db064d
.. include:: common/opt_t.rst
Packit db064d
.. include:: common/opt_y.rst
Packit db064d
Packit db064d
Debugging flags
Packit db064d
---------------
Packit db064d
Packit db064d
.. include:: common/opt_d.rst
Packit db064d
.. include:: common/opt_e.rst
Packit db064d
.. include:: common/opt_h.rst
Packit db064d
.. include:: common/opt_v.rst
Packit db064d
.. include:: common/opt_V.rst
Packit db064d
Packit db064d
**-R**  (This option is obsolete and does nothing)
Packit db064d
Packit db064d
EXIT STATUS
Packit db064d
===========
Packit db064d
Packit db064d
**-1** if scan fails.
Packit db064d
Packit db064d
**0** if scan succeeds without errors beyond thresholds
Packit db064d
Packit db064d
**1** if errors are found beyond thresholds or inconsistencies are found in check mode.
Packit db064d
Packit db064d
FILES
Packit db064d
=====
Packit db064d
Packit db064d
ERROR THRESHOLD
Packit db064d
---------------
Packit db064d
Packit db064d
@IBDIAG_CONFIG_PATH@/error_thresholds
Packit db064d
Packit db064d
Define threshold values for errors.  File format is simple "name=val".
Packit db064d
Comments begin with '#'
Packit db064d
Packit db064d
**Example:**
Packit db064d
Packit db064d
::
Packit db064d
Packit db064d
	# Define thresholds for error counters
Packit db064d
	SymbolErrorCounter=10
Packit db064d
	LinkErrorRecoveryCounter=10
Packit db064d
	VL15Dropped=100
Packit db064d
Packit db064d
Packit db064d
.. include:: common/sec_config-file.rst
Packit db064d
Packit db064d
.. include:: common/sec_node-name-map.rst
Packit db064d
Packit db064d
AUTHOR
Packit db064d
======
Packit db064d
Packit db064d
Ira Weiny
Packit db064d
        < ira.weiny@intel.com >