debian man page for ibdmchk

IBDMCHK(1)						       IB DATA MODEL PACKAGE							IBDMCHK(1)

NAME
       IBDM - Network Checker and Attributes Analyzer

SYNOPSYS
       ibdmchk has two operation modes: design and verification.

       DESIGN:

       ibdmchk [-v][-h][-u][-a <roots file>] -t <topology file> -n <SM Node>
	 -p <SM Port> [-e] [-l <lmc>]

       VERIFICATION:

       ibdmchk [-v][-h][-r <roots file>] [-s <subnet file>] [-f <fdb file>]
	 [-l <lmc>]

DESIGN MODE DESCRIPTION
       The Design mode is intended to be used before the cluster is built. It provides basic checks of the specified network as described by a
       topology file. After simulating the SM LID assignment and routing algorithms it provides reports of the (H)CA to (H)CA paths depth his-
       togram and credit deadlock potential in the resulting routing scheme.

ARGUMENTS
:
       -t|--topo <topo file>
	      The topology file specifying the network. See man ibdm-topology-file

       -n|--node <SM Node>
	      The name of the Subnet Manager node (syntax: <Topo-File-System>/U1)

       -p|--port <SM Port>
	      The port number by which the SM nodes is attached to the fabric.

OPTIONS
       -v|--verbose
	      Verbsoe mode

       -h|--help
	      Provides this help message

       -l|--lmc <lmc>
	      LMC value > 0 means assigning 2^lmc lids to each port.

       -e|--enh
	      Use enhanced routing algorithm when LMC > 0 and report the resulting paths correlation (using same system/node) histogram

       -u|--updn
	      Use up/down routing algorithm instead of OpenSM min-hop.

       -r|--roots <roots file> A file with all the roots node names (one on each line).

VERIFICATION MODE DESCRIPTION
       After the cluster is built and OpenSM is run (using flag -D 0x43) it reports the subnet and FDB tables into the files osm-subnet.lst,
       osm.fdbs and osm.fdbs in /var/log/ (or subnet.lst, osm.fdbs and osm.mcfdbs into /tmp in older OpenSM versions).	Based on these files the
       utility checks all CA to CA connectivity. Further analysis for credit deadlock potential is performed and reported.  In case of an LMC > 0
       it reports histograms for how many systems and nodes are common between the different paths for the same port pairs.

ARGUMENTS
       -l|--lmc <lmc>
	      The LMC value used while running OpenSM. Mandatory if not the default 0.

OPTIONS
       -v|--verbose
	      Verbsoe mode

       -h|--help
	      Provides this help message

       -s|--subnet <file>
	      OpenSM subnet.lst file (default is /var/log/osm-subnet.lst or /tmp/subnet.lst)

       -f|--fdb <file>
	      OpenSM dump of Ucast LFDB. Use -D 0x41 to generate it (default is /var/log/osm.fdbs or /tmp/osm.fdbs).

       -m|--mcfdb <file>
	      OpenSM dump of Multicast LFDB. Use -D 0x41 to generate it (default is /var/log/osm.mcfdbs or /tmp/osm.mcfdbs).

       -r|--roots <roots file>
	      A file holding all root nodes guids (one per line).

AUTHOR
       Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il

IBDM 1.0							    2008-06-16								IBDMCHK(1)