contrib/ofed/management/infiniband-diags/man/ibtracert.8

   1 .TH IBTRACERT 8 "April 14, 2007" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 ibtracert\- trace InfiniBand path
   5
   6 .SH SYNOPSIS
   7 .B ibtracert
   8 [\-d(ebug)] [-v(erbose)] [\-D(irect)] [\-G(uids)] [-n(o_info)] [-m mlid] [-s
   9 smlid] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)]
  10 [\-\-node\-name\-\-map <node-name-map>] [\-h(elp)] [<dest dr_path|lid|guid> [<startlid> [<endlid>]]]
  11
  12 .SH DESCRIPTION
  13 .PP
  14 ibtracert uses SMPs to trace the path from a source GID/LID to a
  15 destination GID/LID. Each hop along the path is displayed until the destination
  16 is reached or a hop does not respond. By using the -m option, multicast path
  17 tracing can be performed between source and destination nodes.
  18
  19 .SH OPTIONS
  20
  21 .PP
  22 .TP
  23 \fB\-n\fR, \fB\-\-no_info\fR
  24 simple format; don't show additional information
  25 .TP
  26 \fB\-m\fR
  27 show the multicast trace of the specified mlid
  28 .TP
  29 \fB\-\-node\-name\-map\fR <node-name-map>
  30 Specify a node name map.  The node name map file maps GUIDs to more user friendly
  31 names.  See
  32 .B ibnetdiscover(8)
  33 for node name map file format.
  34
  35 .SH COMMON OPTIONS
  36
  37 Most OpenIB diagnostics take the following common flags. The exact list of
  38 supported flags per utility can be found in the usage message and can be shown
  39 using the util_name -h syntax.
  40
  41 # Debugging flags
  42 .PP
  43 \-d      raise the IB debugging level.
  44         May be used several times (-ddd or -d -d -d).
  45 .PP
  46 \-h      show the usage message
  47 .PP
  48 \-v      increase the application verbosity level.
  49         May be used several times (-vv or -v -v -v)
  50 .PP
  51 \-V      show the version info.
  52
  53 # Addressing flags
  54 .PP
  55 \-D      use directed path address arguments. The path
  56         is a comma separated list of out ports.
  57         Examples:
  58         "0"             # self port
  59         "0,1,2,1,4"     # out via port 1, then 2, ...
  60 .PP
  61 \-G      use GUID address argument. In most cases, it is the Port GUID.
  62         Example:
  63         "0x08f1040023"
  64 .PP
  65 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  66
  67 # Other common flags:
  68 .PP
  69 \-C <ca_name>    use the specified ca_name.
  70 .PP
  71 \-P <ca_port>    use the specified ca_port.
  72 .PP
  73 \-t <timeout_ms> override the default timeout for the solicited mads.
  74
  75 Multiple CA/Multiple Port Support
  76
  77 When no IB device or port is specified, the port to use is selected
  78 by the following criteria:
  79 .PP
  80 1. the first port that is ACTIVE.
  81 .PP
  82 2. if not found, the first port that is UP (physical link up).
  83
  84 If a port and/or CA name is specified, the user request is
  85 attempted to be fulfilled, and will fail if it is not possible.
  86
  87 .SH EXAMPLES
  88
  89 .PP
  90 Unicast examples
  91 .PP
  92 ibtracert 4 16              # show path between lids 4 and 16
  93 .PP
  94 ibtracert -n 4 16           # same, but using simple output format
  95 .PP
  96 ibtracert -G 0x8f1040396522d 0x002c9000100d051  # use guid addresses
  97
  98 .PP
  99 Multicast example
 100 .PP
 101 ibtracert -m 0xc000 4 16    # show multicast path of mlid 0xc000 between lids 4 and 16
 102
 103 .SH SEE ALSO
 104 .BR ibroute (8)
 105
 106 .SH AUTHOR
 107 .TP
 108 Hal Rosenstock
 109 .RI < halr@voltaire.com >
 110 .TP
 111 Ira Weiny
 112 .RI < weiny2@llnl.gov >