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

   1 .TH IBROUTE 8 "July 25, 2006" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 ibroute \- query InfiniBand switch forwarding tables
   5
   6 .SH SYNOPSIS
   7 .B ibroute
   8 [\-d(ebug)] [-a(ll)] [-n(o_dests)] [-v(erbose)] [\-D(irect)] [\-G(uid)] [-M(ulticast)] [-s smlid] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-h(elp)] [<dest dr_path|lid|guid> [<startlid> [<endlid>]]]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 ibroute uses SMPs to display the forwarding tables (unicast
  13 (LinearForwardingTable or LFT) or multicast (MulticastForwardingTable or MFT))
  14 for the specified switch LID and the optional lid (mlid) range.
  15 The default range is all valid entries in the range 1...FDBTop.
  16
  17 .SH OPTIONS
  18
  19 .PP
  20 .TP
  21 \fB\-a\fR, \fB\-\-all\fR
  22 show all lids in range, even invalid entries
  23 .TP
  24 \fB\-n\fR, \fB\-\-no_dests\fR
  25 do not try to resolve destinations
  26 .TP
  27 \fB\-M\fR, \fB\-\-Multicast\fR
  28 show multicast forwarding tables
  29 In this case, the range parameters are specifying the mlid range.
  30
  31 .SH COMMON OPTIONS
  32
  33 Most OpenIB diagnostics take the following common flags. The exact list of
  34 supported flags per utility can be found in the usage message and can be shown
  35 using the util_name -h syntax.
  36
  37 # Debugging flags
  38 .PP
  39 \-d      raise the IB debugging level.
  40         May be used several times (-ddd or -d -d -d).
  41 .PP
  42 \-e      show send and receive errors (timeouts and others)
  43 .PP
  44 \-h      show the usage message
  45 .PP
  46 \-v      increase the application verbosity level.
  47         May be used several times (-vv or -v -v -v)
  48 .PP
  49 \-V      show the version info.
  50
  51 # Addressing flags
  52 .PP
  53 \-D      use directed path address arguments. The path
  54         is a comma separated list of out ports.
  55         Examples:
  56         "0"             # self port
  57         "0,1,2,1,4"     # out via port 1, then 2, ...
  58 .PP
  59 \-G      use GUID address argument. In most cases, it is the Port GUID.
  60         Example:
  61         "0x08f1040023"
  62 .PP
  63 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  64
  65 # Other common flags:
  66 .PP
  67 \-C <ca_name>    use the specified ca_name.
  68 .PP
  69 \-P <ca_port>    use the specified ca_port.
  70 .PP
  71 \-t <timeout_ms> override the default timeout for the solicited mads.
  72
  73 Multiple CA/Multiple Port Support
  74
  75 When no IB device or port is specified, the port to use is selected
  76 by the following criteria:
  77 .PP
  78 1. the first port that is ACTIVE.
  79 .PP
  80 2. if not found, the first port that is UP (physical link up).
  81
  82 If a port and/or CA name is specified, the user request is
  83 attempted to be fulfilled, and will fail if it is not possible.
  84
  85 .SH EXAMPLES
  86
  87 .PP
  88 Unicast examples
  89 .PP
  90 ibroute 4       # dump all lids with valid out ports of switch with lid 4
  91 .PP
  92 ibroute -a 4    # same, but dump all lids, even with invalid out ports
  93 .PP
  94 ibroute -n 4    # simple dump format - no destination resolution
  95 .PP
  96 ibroute 4 10    # dump lids starting from 10 (up to FDBTop)
  97 .PP
  98 ibroute 4 0x10 0x20     # dump lid range
  99 .PP
 100 ibroute -G 0x08f1040023 # resolve switch by GUID
 101 .PP
 102 ibroute -D 0,1  # resolve switch by direct path
 103
 104 .PP
 105 Multicast examples
 106 .PP
 107 ibroute -M 4    # dump all non empty mlids of switch with lid 4
 108 .PP
 109 ibroute -M 4 0xc010 0xc020      # same, but with range
 110 .PP
 111 ibroute -M -n 4 # simple dump format
 112
 113 .SH SEE ALSO
 114 .BR ibtracert (8)
 115
 116 .SH AUTHOR
 117 .TP
 118 Hal Rosenstock
 119 .RI < halr@voltaire.com >