Blame doc/rst/iblinkinfo.8.in.rst

Packit db064d
==========
Packit db064d
IBLINKINFO
Packit db064d
==========
Packit db064d
Packit db064d
--------------------------------------------
Packit db064d
report link info for all links in the fabric
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
iblinkinfo <options>
Packit db064d
Packit db064d
DESCRIPTION
Packit db064d
===========
Packit db064d
Packit db064d
iblinkinfo reports link info for each port in an IB fabric, node by node.
Packit db064d
Optionally, iblinkinfo can do partial scans and limit its output to parts of a
Packit db064d
fabric.
Packit db064d
Packit db064d
OPTIONS
Packit db064d
=======
Packit db064d
Packit db064d
**--down, -d**
Packit db064d
Print only nodes which have a port in the "Down" state.
Packit db064d
Packit db064d
**--line, -l**
Packit db064d
Print all information for each link on one line. Default is to print a header
Packit db064d
with the node information and then a list for each port (useful for
Packit db064d
grep'ing output).
Packit db064d
Packit db064d
Packit db064d
**--additional, -p**
Packit db064d
Print additional port settings (<LifeTime>,<HoqLife>,<VLStallCount>)
Packit db064d
Packit db064d
**--switches-only**
Packit db064d
Show only switches in output.
Packit db064d
Packit db064d
**--cas-only**
Packit db064d
Show only CAs in output.
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
**--switch, -S <port_guid>** same as "-G". (provided only for backward compatibility)
Packit db064d
Packit db064d
How much of the scan to be printed can be controlled with the following.
Packit db064d
Packit db064d
**--all, -a**
Packit db064d
Print all nodes found in a partial fabric scan.  Normally a
Packit db064d
partial fabric scan will return only the node specified.  This option will
Packit db064d
print the other nodes found as well.
Packit db064d
Packit db064d
**--hops, -n <hops>**
Packit db064d
Specify the number of hops away from a specified node to scan.  This is useful
Packit db064d
to expand a partial fabric scan beyond the node specified.
Packit db064d
Packit db064d
Packit db064d
Cache File flags
Packit db064d
----------------
Packit db064d
Packit db064d
.. include:: common/opt_load-cache.rst
Packit db064d
.. include:: common/opt_diff.rst
Packit db064d
Packit db064d
**--diffcheck <key(s)>**
Packit db064d
Specify what diff checks should be done in the **--diff** option above.  Comma
Packit db064d
separate multiple diff check key(s).  The available diff checks are: **port** =
Packit db064d
port connections, **state** = port state, **lid** = lids, **nodedesc** = node
Packit db064d
descriptions.  Note that **port**, **lid**, and **nodedesc** are checked only
Packit db064d
for the node types that are specified (e.g.  **switches-only**, **cas-only**).
Packit db064d
If **port** is specified alongside **lid** or **nodedesc**, remote port lids
Packit db064d
and node descriptions will also be compared.
Packit db064d
Packit db064d
Packit db064d
**--filterdownports <filename>**
Packit db064d
Filter downports indicated in a ibnetdiscover cache.  If a port was previously
Packit db064d
indicated as down in the specified cache, and is still down, do not output it in the
Packit db064d
resulting output.  This option may be particularly useful for environments
Packit db064d
where switches are not fully populated, thus much of the default iblinkinfo
Packit db064d
info is considered useless.  See **ibnetdiscover** for information on caching
Packit db064d
ibnetdiscover output.
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_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
EXIT STATUS
Packit db064d
===========
Packit db064d
Packit db064d
0 on success, -1 on failure to scan the fabric, 1 if check mode is used and
Packit db064d
inconsistencies are found.
Packit db064d
Packit db064d
FILES
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
Packit db064d
AUTHOR
Packit db064d
======
Packit db064d
Packit db064d
Ira Weiny
Packit db064d
        < ira.weiny@intel.com >