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

   1 .TH SMPDUMP 8 "July 25, 2006" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 smpdump \- dump InfiniBand subnet management attributes
   5
   6 .SH SYNOPSIS
   7 .B smpdump
   8 [\-s(ring)] [\-D(irect)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-h(elp)] <dlid|dr_path> <attr> [mod]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 smpdump is a general purpose SMP utility which gets SM attributes from a
  13 specified SMA. The result is dumped in hex by default.
  14
  15 .SH OPTIONS
  16
  17 .TP
  18 attr
  19 IBA attribute ID for SM attribute
  20 .TP
  21 mod
  22 IBA modifier for SM attribute
  23
  24 .SH COMMON OPTIONS
  25
  26 Most OpenIB diagnostics take the following common flags. The exact list of
  27 supported flags per utility can be found in the usage message and can be shown
  28 using the util_name -h syntax.
  29
  30 # Debugging flags
  31 .PP
  32 \-d      raise the IB debugging level.
  33         May be used several times (-ddd or -d -d -d).
  34 .PP
  35 \-e      show send and receive errors (timeouts and others)
  36 .PP
  37 \-h      show the usage message
  38 .PP
  39 \-v      increase the application verbosity level.
  40         May be used several times (-vv or -v -v -v)
  41 .PP
  42 \-V      show the version info.
  43
  44 # Addressing flags
  45 .PP
  46 \-D      use directed path address arguments. The path
  47         is a comma separated list of out ports.
  48         Examples:
  49         "0"             # self port
  50         "0,1,2,1,4"     # out via port 1, then 2, ...
  51 .PP
  52 \-G      use GUID address argument. In most cases, it is the Port GUID.
  53         Example:
  54         "0x08f1040023"
  55 .PP
  56 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  57
  58 # Other common flags:
  59 .PP
  60 \-C <ca_name>    use the specified ca_name.
  61 .PP
  62 \-P <ca_port>    use the specified ca_port.
  63 .PP
  64 \-t <timeout_ms> override the default timeout for the solicited mads.
  65
  66 Multiple CA/Multiple Port Support
  67
  68 When no IB device or port is specified, the port to use is selected
  69 by the following criteria:
  70 .PP
  71 1. the first port that is ACTIVE.
  72 .PP
  73 2. if not found, the first port that is UP (physical link up).
  74
  75 If a port and/or CA name is specified, the user request is
  76 attempted to be fulfilled, and will fail if it is not possible.
  77
  78 .SH EXAMPLES
  79
  80 Direct Routed Examples
  81 .PP
  82 smpdump -D 0,1,2,3,5 16 # NODE DESC
  83 .PP
  84 smpdump -D 0,1,2 0x15 2 # PORT INFO, port 2
  85
  86 LID Routed Examples
  87 .PP
  88 smpdump 3 0x15 2        # PORT INFO, lid 3 port 2
  89 .PP
  90 smpdump 0xa0 0x11       # NODE INFO, lid 0xa0
  91
  92 .SH SEE ALSO
  93 .BR smpquery (8)
  94
  95 .SH AUTHOR
  96 .TP
  97 Hal Rosenstock
  98 .RI < halr@voltaire.com >