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

   1 .TH SAQUERY 8 "October 19, 2008" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 saquery \- query InfiniBand subnet administration attributes
   5
   6 .SH SYNOPSIS
   7 .B saquery
   8 [\-h] [\-d] [\-p] [\-N] [\-\-list | \-D] [\-S] [\-I] [\-L] [\-l] [\-G] [\-O]
   9 [\-U] [\-c] [\-s] [\-g] [\-m] [\-x]
  10 [\-C ca_name] [\-P ca_port] [\-\-smkey val] [\-t(imeout) <msec>]
  11 [\-\-src\-to\-dst <src:dst>]
  12 [\-\-sgid\-to\-dgid <sgid\-dgid>]
  13 [\-\-node\-name\-map <node\-name\-map>]
  14 [<name> | <lid> | <guid>]
  15
  16 .SH DESCRIPTION
  17 .PP
  18 saquery issues the selected SA query. Node records are queried by default.
  19
  20 .SH OPTIONS
  21
  22 .PP
  23 .TP
  24 \fB\-p\fR
  25 get PathRecord info
  26 .TP
  27 \fB\-N\fR
  28 get NodeRecord info
  29 .TP
  30 \fB\-\-list | \-D\fR
  31 get NodeDescriptions of CAs only
  32 .TP
  33 \fB\-S\fR
  34 get ServiceRecord info
  35 .TP
  36 \fB\-I\fR
  37 get InformInfoRecord (subscription) info
  38 .TP
  39 \fB\-L\fR
  40 return the Lids of the name specified
  41 .TP
  42 \fB\-l\fR
  43 return the unique Lid of the name specified
  44 .TP
  45 \fB\-G\fR
  46 return the Guids of the name specified
  47 .TP
  48 \fB\-O\fR
  49 return the name for the Lid specified
  50 .TP
  51 \fB\-U\fR
  52 return the name for the Guid specified
  53 .TP
  54 \fB\-c\fR
  55 get the SA's class port info
  56 .TP
  57 \fB\-s\fR
  58 return the PortInfoRecords with isSM or isSMdisabled capability mask bit on
  59 .TP
  60 \fB\-g\fR
  61 get multicast group info
  62 .TP
  63 \fB\-m\fR
  64 get multicast member info.  If a group is specified, limit the output to the
  65 group specified and print one line containing only the GUID and node
  66 description for each entry. Example: saquery -m 0xc000
  67 .TP
  68 \fB\-x\fR
  69 get LinkRecord info
  70 .TP
  71 \fB\-\-src-to-dst\fR
  72 get a PathRecord for <src:dst>
  73 where src and dst are either node names or LIDs
  74 .TP
  75 .B \-\-sgid\-to\-dgid
  76 get a PathRecord for
  77 .I sgid
  78 to
  79 .I dgid
  80 where both GIDs are in an IPv6 format acceptable to
  81 .BR inet_pton (3).
  82 .TP
  83 \fB\-C\fR <ca_name>
  84 use the specified ca_name.
  85 .TP
  86 \fB\-P\fR <ca_port>
  87 use the specified ca_port.
  88 .TP
  89 \fB\-\-smkey\fR <val>
  90 use SM_Key value for the query. Will be used only with "trusted" queries.
  91 If non-numeric value (like 'x') is specified then saquery will prompt for
  92 a value.
  93 .TP
  94 \fB\-t\fR, \fB\-timeout\fR <msec>
  95 Specify SA query response timeout in milliseconds.
  96 Default is 100 milliseconds. You may want to use
  97 this option if IB_TIMEOUT is indicated.
  98 .TP
  99 \fB\-\-node\-name\-map\fR <node-name-map>
 100 Specify a node name map.  The node name map file maps GUIDs to more user friendly
 101 names.  See
 102 .B ibnetdiscover(8)
 103 for node name map file format.  Only used with the \fB\-O\fR and \fB\-U\fR options.
 104 .TP
 105 Supported query names (and aliases):
 106  ClassPortInfo (CPI)
 107  NodeRecord (NR)
 108  PortInfoRecord (PIR) [[lid]/[port]]
 109  SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]
 110  PKeyTableRecord (PKTR) [[lid]/[port]/[block]]
 111  VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]
 112  InformInfoRecord (IIR)
 113  LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]
 114  ServiceRecord (SR)
 115  PathRecord (PR)
 116  MCMemberRecord (MCMR)
 117  LFTRecord (LFTR) [[lid]/[block]]
 118  MFTRecord (MFTR) [[mlid]/[position]/[block]]
 119 .TP
 120 \fB\-d\fR
 121 enable debugging
 122 .TP
 123 \fB\-h\fR
 124 show help
 125
 126 .SH AUTHORS
 127 .TP
 128 Ira Weiny
 129 .RI < weiny2@llnl.gov >
 130 .TP
 131 Hal Rosenstock
 132 .RI < halr@voltaire.com >