contrib/ofed/management/doc/diagtools-proposal.txt

   1 Diagnostic Tools
   2 11/29/04
   3
   4 user space applications (also library support)
   5 two categories: host and network
   6
   7 Host Oriented Diagnostic Tools
   8
   9 1. ibstatus
  10
  11 Description:
  12 ibstatus displays basic information obtained from the local IB driver.
  13 -v enables verbose mode. Normal output includes LID, SMLID, port state,
  14 link width active, and port physical state. Verbose includes all sysfs
  15 supported parameters for that interface and port.
  16
  17 Syntax:
  18 ibstatus [-v] [-I mthca0] [-p port]
  19
  20 Dependencies:
  21 sysfs support in mthca
  22
  23 2. ibroute
  24
  25 Description:
  26 ibroute uses SMPs to display the forwarding tables (unicast
  27 (LinearForwardingTable or LFT) or multicast (MulticastForwardingTable or MFT))
  28 for the specified LID.
  29
  30 Syntax:
  31 ibroute [-multi] [-m mkey] [-pa path] [-I mthca0] [-p port] LID
  32
  33 Dependencies:
  34 user MAD access, SMA
  35
  36 3. ibtracert
  37
  38 Description:
  39 ibtracert uses SMPs to trace the path from a source GID/LID to a
  40 destination GID/LID. The source GID/LID must be local to the node.
  41 Each hop along the path is displayed until the destination is reached or
  42 a hop does not respond. By using -mg and/or -ml options, multicast path
  43 tracing can be performed between source and destination nodes.
  44
  45 Syntax:
  46 ibtracert [-m mkey] [-pa path] [-sg SGID] [-sl SLID] [-dg DGID] [-dl DLID] \
  47                 [-mg MGID] [-ml MLID] [-I mthca0] [-p port]
  48
  49 Dependencies:
  50 user MAD access, SMA
  51
  52 4. smpquery
  53
  54 Description:
  55 smpquery allows a basic subset of standard SMP queries including the following:
  56 local information (LID, GID, etc.), node information (from NodeDescription,
  57 NodeInfo, and possibly SwitchInfo if node is a switch), port information
  58 (port address and state), and port parameters (SLtoVLMappingTable,
  59 VLArbitrationTable, HOQLife, ...).
  60
  61 Syntax:
  62 smpquery [-m mkey] [-l LID] [-pa path] [-I mthca0] [-p port] \
  63                 [-l] [-n] [-pi] [-pp]
  64
  65 Dependencies:
  66 User MAD access
  67
  68 5. smpdump
  69
  70 Description:
  71 smpdump is a general purpose SMP utility which gets SM attributes from a
  72 specified SMA. The result is dumped as hex (-x) or string (-s), with hex
  73 as the default.
  74
  75 Syntax:
  76 smpdump [-m mkey] [-l LID] [-p path]  [-I mthca0] [-p port] \
  77                 [-a attributeID] [-am attributeModifier] [-s] [-x]
  78
  79 Dependencies:
  80 User MAD access, MAD snooping support
  81
  82 6. perfquery
  83
  84 Description:
  85 perfquery uses PerfMgt GMPs to obtain the PortCounters (basic performance
  86 and error counters) from the PMA at the node specified. -r resets these
  87 counters after obtaining them.
  88
  89 Syntax:
  90 perfquery [-I mthca0] [-p port] [-r] [-g GID] LID
  91
  92 Dependencies:
  93 User MAD access, PMA
  94
  95 7. ibping
  96
  97 Description:
  98 ibping uses UD transport to validate connectivity between IB nodes.
  99 It is run as client/server (daemon). -v option uses vendor MADs rather than
 100 normal UD transport.
 101
 102 Syntax:
 103 ibping [-d] [-v] [-c count] [-i interval] [-s packetsize] \
 104                 [-I mthca0] [-p port] [-q qkey] [-g DGID] [-qp dqp] [-dl DLID]
 105
 106 -d: run as daemon (server)
 107
 108 Dependencies:
 109 user MAD access
 110
 111
 112 Network Oriented Diagnostics
 113
 114 8. ibnetdiscover
 115
 116 Description:
 117 ibnetdiscover performs IB subnet discovery and outputs a human readable
 118 topology file. GUIDs, node types, and port numbers are displayed
 119 as well as port LIDs and NodeDescriptions. All nodes (and links) are displayed
 120 (full topology).
 121
 122 Syntax:
 123 ibnetdiscover [-I mthca0] [-p port] [-o topology-filename]
 124
 125 Dependencies:
 126 user MAD access
 127
 128 Future versions of this file will be annotated with additional information
 129 including system guid, system type, internal to physical mapping, and physical
 130 location information (blade or ASIC number, etc.).
 131
 132 9. ibhosts
 133
 134 Description:
 135 ibhosts either walks the IB subnet topology or uses an already saved topology
 136 file and extracts the HCA nodes.
 137
 138 Syntax:
 139 ibhosts [-I mthca0] [-p port] [-i topology-filename] [-o ibhosts-filename]
 140
 141 Dependencies:
 142 user MAD access, ibnetdiscover
 143
 144 10. ibswitches
 145
 146 Description:
 147 ibswitches either walks the IB subnet topology or uses an already saved
 148 topology file and extracts the IB switches.
 149
 150 Syntax:
 151 ibswitches [-I mthca0] [-p port] \
 152                 [-i topology-filename] [-o ibswitches-filename]
 153
 154 Dependencies:
 155 user MAD access, ibnetdiscover
 156
 157 11. ibnetverify
 158
 159 Description:
 160 ibnetverify uses a full topology file that was created by ibnetdiscover,
 161 scans the network to see if the current topology matches or not displaying
 162 any discrepancies, and validates the connectivity and reports errors
 163 (from port counters).
 164
 165 Syntax:
 166 ibnetverify -f filename [-I mthca0] [-p port]
 167
 168 Dependencies:
 169 user MAD access, ibnetdiscover