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

   1 .TH SMPQUERY 8 "March 14, 2007" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 smpquery \- query InfiniBand subnet management attributes
   5
   6 .SH SYNOPSIS
   7 .B smpquery
   8 [\-d(ebug)] [\-e(rr_show)] [\-v(erbose)] [\-D(irect)] [\-G(uid)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [--node-name-map node-name-map] [\-V(ersion)] [\-h(elp)] <op> <dest dr_path|lid|guid> [op params]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 smpquery allows a basic subset of standard SMP queries including the following:
  13 node info, node description, switch info, port info. Fields are displayed in
  14 human readable format.
  15
  16 .SH OPTIONS
  17
  18 .PP
  19 .TP
  20 Current supported operations and their parameters:
  21         nodeinfo <addr>
  22         nodedesc <addr>
  23         portinfo <addr> [<portnum>]     # default port is zero
  24         switchinfo <addr>
  25         pkeys <addr> [<portnum>]
  26         sl2vl <addr> [<portnum>]
  27         vlarb <addr> [<portnum>]
  28         guids <addr>
  29
  30 .TP
  31 \fB\-\-node\-name\-map\fR <node-name-map>
  32 Specify a node name map.  The node name map file maps GUIDs to more user friendly
  33 names.  See
  34 .B ibnetdiscover(8)
  35 for node name map file format.
  36
  37 .SH COMMON OPTIONS
  38
  39 Most OpenIB diagnostics take the following common flags. The exact list of
  40 supported flags per utility can be found in the usage message and can be shown
  41 using the util_name -h syntax.
  42
  43 # Debugging flags
  44 .PP
  45 \-d      raise the IB debugging level.
  46         May be used several times (-ddd or -d -d -d).
  47 .PP
  48 \-e      show send and receive errors (timeouts and others)
  49 .PP
  50 \-h      show the usage message
  51 .PP
  52 \-v      increase the application verbosity level.
  53         May be used several times (-vv or -v -v -v)
  54 .PP
  55 \-V      show the version info.
  56
  57 # Addressing flags
  58 .PP
  59 \-D      use directed path address arguments. The path
  60         is a comma separated list of out ports.
  61         Examples:
  62         "0"             # self port
  63         "0,1,2,1,4"     # out via port 1, then 2, ...
  64 .PP
  65 \-c      use combined route address arguments. The
  66         address is a combination of a LID and a direct route path.
  67         The LID specified is the DLID and the local LID is used
  68         as the DrSLID.
  69 .PP
  70 \-G      use GUID address argument. In most cases, it is the Port GUID.
  71         Example:
  72         "0x08f1040023"
  73 .PP
  74 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  75
  76 # Other common flags:
  77 .PP
  78 \-C <ca_name>    use the specified ca_name.
  79 .PP
  80 \-P <ca_port>    use the specified ca_port.
  81 .PP
  82 \-t <timeout_ms> override the default timeout for the solicited mads.
  83
  84 Multiple CA/Multiple Port Support
  85
  86 When no IB device or port is specified, the port to use is selected
  87 by the following criteria:
  88 .PP
  89 1. the first port that is ACTIVE.
  90 .PP
  91 2. if not found, the first port that is UP (physical link up).
  92
  93 If a port and/or CA name is specified, the user request is
  94 attempted to be fulfilled, and will fail if it is not possible.
  95
  96 .SH EXAMPLES
  97
  98 .PP
  99 smpquery portinfo 3 1        # portinfo by lid, with port modifier
 100 .PP
 101 smpquery -G switchinfo 0x2C9000100D051 1        # switchinfo by guid
 102 .PP
 103 smpquery -D nodeinfo 0       # nodeinfo by direct route
 104 .PP
 105 smpquery -c nodeinfo 6 0,12  # nodeinfo by combined route
 106
 107 .SH SEE ALSO
 108 .BR smpdump (8)
 109
 110 .SH AUTHOR
 111 .TP
 112 Hal Rosenstock
 113 .RI < halr@voltaire.com >