ibnd_show_progress(3) [centos man page]

IBND_DISCOVER_FABRIC(3) 				    OpenIB Programmer's Manual					   IBND_DISCOVER_FABRIC(3)

NAME

       ibnd_discover_fabric, ibnd_destroy_fabric, ibnd_debug ibnd_show_progress - initialize ibnetdiscover library.

SYNOPSIS

       #include <infiniband/ibnetdisc.h>

       void ibnd_destroy_fabric(ibnd_fabric_t *fabric)
       void ibnd_debug(int i)
       void ibnd_show_progress(int i)
       int ibnd_set_max_smps_on_wire(int i)

DESCRIPTION

       ibnd_discover_fabric() Discover the fabric connected to the port specified by ibmad_port, using a timeout specified.  The "from" and "hops"
       parameters are optional and allow one to scan part of a fabric by specifying a node "from" and a number of hops	away  from  that  node	to
       scan, "hops".  This gives the user a "sub-fabric" which is "centered" anywhere they chose.

       ibmad_port must be opened with at least IB_SMI_CLASS and IB_SMI_DIRECT_CLASS classes for ibnd_discover_fabric to work.

       ibnd_destroy_fabric() free all memory and resources associated with the fabric.

       ibnd_debug() Set the debug level to be printed as library operations take place.

       ibnd_show_progress() Indicate that the library should print debug output which shows it's progress through the fabric.

       ibnd_set_max_smps_on_wire() Set the number of SMP's which will be issued on the wire simultaneously.

RETURN VALUE

       ibnd_discover_fabric() return NULL on failure, otherwise a valid ibnd_fabric_t object.

       ibnd_destory_fabric(), ibnd_debug() NONE

       ibnd_set_max_smps_on_wire() The previous value is returned

EXAMPLES

       Discover the entire fabric connected to device mthca0 , port 1.

	    int  mgmt_classes[2]  =  {IB_SMI_CLASS,  IB_SMI_DIRECT_CLASS};	 struct  ibmad_port  *ibmad_port  = mad_rpc_open_port(ca, ca_port,
       mgmt_classes, 2);      ibnd_fabric_t *fabric = ibnd_discover_fabric(ibmad_port, 100, NULL, 0);	   ...	      ibnd_destroy_fabric(fabric);
	    mad_rpc_close_port(ibmad_port);

       Discover only a single node and those nodes connected to it.

	    ...       str2drpath(&(port_id.drpath), from, 0, 0);      ...	ibnd_discover_fabric(ibmad_port, 100, &port_id, 1);	 ...

SEE ALSO

	    libibmad, mad_rpc_open_port

AUTHORS

       Ira Weiny <weiny2@llnl.gov>

OpenIB								   July 25, 2008					   IBND_DISCOVER_FABRIC(3)

IBDIAGPATH(1)						       IB DIAGNOSTIC PACKAGE						     IBDIAGPATH(1)

NAME

       ibdiagpath - IB diagnostic path

SYNOPSYS

       ibdiagpath
	    {-n <[src-name,]dst-name>|-l <[src-lid,]dst-lid>|-d <p1,p2,p3,...>}
	    [-c <count>] [-v] [-t <topo-file>] [-s <sys-name>] [-i <dev-index>]
	    [-p <port-num>] [-o <out-dir>] [-lw <1x|4x|12x>] [-ls <2.5|5|10>] [-pm]
	    [-pc] [-P <<PM counter>=<Trash Limit>>]

DESCRIPTION

       ibdiagpath traces a path between two end-points and provides information regarding the nodes and ports traversed along the path. It uti-
       lizes device specific health queries for the different devices along the traversed path.  The way ibdiagpath operates depends on the
       addressing mode used on the command line. If directed route adressing is used, the local node is the source node and the route to the des-
       tination port is known apriori.	On the other hand, if LID route (or by-name) addressing is imployed, then the source and destination ports
       of a route are specified by their LIDs (or by the names defined in the topology file). In this case, the actual path from the local port to
       the source port, and from the source port to the destination port, is defined by means of Subnet Management Linear Forwarding Table queries
       of the switch nodes along those paths. Therefore, the path cannot be predicted as it may change.  The tool allows omitting the source node,
       in which case the local port on the machine running the tool is assumed to be the source.  Note: When ibdiagpath queries for the perfor-
       mance counters along the path between the source and destination ports, it always traverses the LID route, even if a directed route is
       specified. If along the LID route one or more links are not in the ACTIVE state, ibdiagpath reports an error.  Checks for path validity
       from partitions, IPoIB and QoS perspectives are also provided.

       ibdiagpath.log -
	   A dump of all the application reports generate according to the provided flags

       ibdiagnet.pm -
	   A dump of the pm Counters values, of the fabric links

OPTIONS

       -n <[src-name,]dst-name> :
	   Names of the source and destination ports (as defined in the topology file; source may be omitted -> local port is assumed to be the
	   source)
       -l <[src-lid,]dst-lid> :
	   Source and destination LIDs (source may be omitted -> local port is assumed to be the source)
       -d <p1,p2,p3,...> :
	   directed route from the local node (which is the source) and the destination node
       -c <count> :
	   The minimal number of packets to be sent across each link (default = 100)
       -v :
	   Enable verbose mode
       -t <topo-file> :
	   Specifies the topology file name
       -s <sys-name> :
	   Specifies the local system name. Meaningful only if a topology file is specified
       -i <dev-index> :
	   Specifies the index of the device of the port used to connect to the IB fabric (in case of multiple devices on the local system)
       -p <port-num> :
	   Specifies the local device's port number used to connect to the IB fabric
       -o <out-dir> :
	   Specifies the directory where the output files will be placed (default = /tmp)
       -lw <1x|4x|12x> :
	   Specifies the expected link width
       -ls <2.5|5|10>  :
	   Specifies the expected link speed
       -pm	       :
	   Dump all the fabric links, pm Counters into ibdiagnet.pm
       -pc	       :
	   Reset all the fabric links pmCounters
       -P <PM=<Trash>> :
	   If any of the provided pm is greater then its provided value, print it to screen
       -h|--help       :
	   Prints the help page information
       -V|--version :
	   Prints the version of the tool
       --vars :
	   Prints the tool's environment variables and their values

ERROR CODES

       1 - The path traced is un-healthy
       2 - Failed to parse command line options
       3 - More then 64 hops are required for traversing the local port to the "Source" port and then to the "Destination" port.
       4 - Unable to traverse the LFT data from source to destination
       5 - Failed to use Topology File
       6 - Failed to load required Package

IBDIAG 1.0							    2009-01-08							     IBDIAGPATH(1)