diff options
Diffstat (limited to 'contrib/ofed/infiniband-diags/man')
29 files changed, 6431 insertions, 0 deletions
diff --git a/contrib/ofed/infiniband-diags/man/check_lft_balance.8 b/contrib/ofed/infiniband-diags/man/check_lft_balance.8 new file mode 100644 index 000000000000..af0580f3665e --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/check_lft_balance.8 @@ -0,0 +1,68 @@ +.\" Man page generated from reStructuredText. +. +.TH CHECK_LFT_BALANCE 8 "" "" "Open IB Diagnostics" +.SH NAME +CHECK_LFT_BALANCE \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH CHECK INFINIBAND UNICAST FORWARDING TABLES BALANCE +.SS SYNOPSIS +.sp +check_lft_balance.sh [\-hRv] +.SS DESCRIPTION +.sp +check_lft_balance.sh is a script which checks for balancing in Infiniband +unicast forwarding tables. It analyzes the output of +\fBdump_lfts(8)\fP and \fBiblinkinfo(8)\fP +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP +show help +.TP +.B \fB\-R\fP +Recalculate dump_lfts information, ie do not use the cached +information. This option is slower but should be used if the diag +tools have not been used for some time or if there are other reasons to +believe that the fabric has changed. +.TP +.B \fB\-v\fP +verbose output +.UNINDENT +.SS SEE ALSO +.sp +\fBdump_lfts(8)\fP +\fBiblinkinfo(8)\fP +.SS AUTHORS +.INDENT 0.0 +.TP +.B Albert Chu +< \fI\%chu11@llnl.gov\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/dump_fts.8 b/contrib/ofed/infiniband-diags/man/dump_fts.8 new file mode 100644 index 000000000000..ef77502e3696 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/dump_fts.8 @@ -0,0 +1,235 @@ +.\" Man page generated from reStructuredText. +. +.TH DUMP_FTS 8 "" "" "OpenIB Diagnostics" +.SH NAME +DUMP_FTS \- dump InfiniBand forwarding tables +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +dump_fts [options] [<startlid> [<endlid>]] +.SH DESCRIPTION +.sp +dump_fts is similar to ibroute but dumps tables for every switch found in an +ibnetdiscover scan of the subnet. +.sp +The dump file format is compatible with loading into OpenSM using +the \-R file \-U /path/to/dump\-file syntax. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-a, \-\-all\fP +show all lids in range, even invalid entries +.TP +.B \fB\-n, \-\-no_dests\fP +do not try to resolve destinations +.TP +.B \fB\-M, \-\-Multicast\fP +show multicast forwarding tables +In this case, the range parameters are specifying the mlid range. +.UNINDENT +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +\fBdump_lfts(8), dump_mfts(8), ibroute(8), ibswitches(8), opensm(8)\fP +.SH AUTHORS +.INDENT 0.0 +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibaddr.8 b/contrib/ofed/infiniband-diags/man/ibaddr.8 new file mode 100644 index 000000000000..2b476da33d9b --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibaddr.8 @@ -0,0 +1,214 @@ +.\" Man page generated from reStructuredText. +. +.TH IBADDR 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBADDR \- query InfiniBand address(es) +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibaddr [options] +.SH DESCRIPTION +.sp +Display the lid (and range) as well as the GID address of the +port specified (by DR path, lid, or GUID) or the local port by default. +.sp +Note: this utility can be used as simple address resolver. +.SH OPTIONS +.sp +\fB\-\-gid_show, \-g\fP +show gid address only +.sp +\fB\-\-lid_show, \-l\fP +show lid range only +.sp +\fB\-\-Lid_show, \-L\fP +show lid range (in decimal) only +.SS Addressing Flags +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SH EXAMPLES +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # local port\e\(aqs address +ibaddr 32 # show lid range and gid of lid 32 +ibaddr \-G 0x8f1040023 # same but using guid address +ibaddr \-l 32 # show lid range only +ibaddr \-L 32 # show decimal lid range only +ibaddr \-g 32 # show gid address only +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +\fBibroute (8), ibtracert (8)\fP +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibcacheedit.8 b/contrib/ofed/infiniband-diags/man/ibcacheedit.8 new file mode 100644 index 000000000000..7e3830ad288f --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibcacheedit.8 @@ -0,0 +1,80 @@ +.\" Man page generated from reStructuredText. +. +.TH IBCACHEEDIT 8 "" "" "Open IB Diagnostics" +.SH NAME +IBCACHEEDIT \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH EDIT AN IBNETDISCOVER CACHE +.SS SYNOPSIS +.sp +ibcacheedit [options] <orig.cache> <new.cache> +.SS DESCRIPTION +.sp +ibcacheedit allows users to edit an ibnetdiscover cache created through the +\fB\-\-cache\fP option in \fBibnetdiscover(8)\fP . +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-\-switchguid BEFOREGUID:AFTERGUID\fP +Specify a switchguid that should be changed. The before and after guid +should be separated by a colon. On switches, port guids are identical +to the switch guid, so port guids will be adjusted as well on switches. +.TP +.B \fB\-\-caguid BEFOREGUID:AFTERGUID\fP +Specify a caguid that should be changed. The before and after guid +should be separated by a colon. +.TP +.B \fB\-\-sysimgguid BEFOREGUID:AFTERGUID\fP +Specify a sysimgguid that should be changed. The before and after guid +should be spearated by a colon. +.TP +.B \fB\-\-portguid NODEGUID:BEFOREGUID:AFTERGUID\fP +Specify a portguid that should be changed. The nodeguid of the port +(e.g. switchguid or caguid) should be specified first, followed by a +colon, the before port guid, another colon, then the after port guid. +On switches, port guids are identical to the switch guid, so the switch +guid will be adjusted as well on switches. +.UNINDENT +.SS Debugging flags +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS AUTHORS +.INDENT 0.0 +.TP +.B Albert Chu +< \fI\%chu11@llnl.gov\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibccconfig.8 b/contrib/ofed/infiniband-diags/man/ibccconfig.8 new file mode 100644 index 000000000000..9d244f2fe95f --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibccconfig.8 @@ -0,0 +1,198 @@ +.\" Man page generated from reStructuredText. +. +.TH IBCCCONFIG 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBCCCONFIG \- configure congestion control settings +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibccconfig [common_options] [\-c cckey] [\-\-dgid gid] <op> <lid|guid> [port] +.SH DESCRIPTION +.sp +\fBibccconfig\fP +supports the configuration of congestion control settings on switches +and HCAs. +.sp +\fBWARNING \-\- You should understand what you are doing before using this tool. +Misuse of this tool could result in a broken fabric.\fP +.SH OPTIONS +.INDENT 0.0 +.TP +.B Current supported operations and their parameters: +CongestionKeyInfo (CK) <lid|guid> <cckey> <cckeyprotectbit> <cckeyleaseperiod> <cckeyviolations> +SwitchCongestionSetting (SS) <lid|guid> <controlmap> <victimmask> <creditmask> <threshold> <packetsize> <csthreshold> <csreturndelay> <markingrate> +SwitchPortCongestionSetting (SP) <lid|guid> <portnum> <valid> <control_type> <threshold> <packet_size> <cong_parm_marking_rate> +CACongestionSetting (CS) <lid|guid> <port_control> <control_map> <ccti_timer> <ccti_increase> <trigger_threshold> <ccti_min> +CongestionControlTable (CT) <lid|guid> <cctilimit> <index> <cctentry> <cctentry> ... +.UNINDENT +.sp +\fB\-\-cckey, \-c, <cckey>\fP +Specify a congestion control (CC) key. If none is specified, a key of 0 is used. +.sp +\fB\-\-dgid <dgid>\fP +destination GID: use when GRH is required in packets (IPv6 format) +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Addressing Flags +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SH EXAMPLES +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibccconfig SwitchCongestionSetting 2 0x1F 0x1FFFFFFFFF 0x0 0xF 8 0 0:0 1 # Configure Switch Congestion Settings +ibccconfig CACongestionSetting 1 0 0x3 150 1 0 0 # Configure CA Congestion Settings to SL 0 and SL 1 +ibccconfig CACongestionSetting 1 0 0x4 200 1 0 0 # Configure CA Congestion Settings to SL 2 +ibccconfig CongestionControlTable 1 63 0 0:0 0:1 ... # Configure first block of Congestion Control Table +ibccconfig CongestionControlTable 1 127 0 0:64 0:65 ... # Configure second block of Congestion Control Table +.ft P +.fi +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SH AUTHOR +.INDENT 0.0 +.TP +.B Albert Chu +< \fI\%chu11@llnl.gov\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibccquery.8 b/contrib/ofed/infiniband-diags/man/ibccquery.8 new file mode 100644 index 000000000000..cae3f33a39e2 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibccquery.8 @@ -0,0 +1,194 @@ +.\" Man page generated from reStructuredText. +. +.TH IBCCQUERY 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBCCQUERY \- query congestion control settings/info +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibccquery [common_options] [\-c cckey] [\-\-dgid gid] <op> <lid|guid> [port] +.SH DESCRIPTION +.sp +ibccquery support the querying of settings and other information related +to congestion control. +.SH OPTIONS +.INDENT 0.0 +.TP +.B Current supported operations and their parameters: +CongestionInfo (CI) <addr> +CongestionKeyInfo (CK) <addr> +CongestionLog (CL) <addr> +SwitchCongestionSetting (SS) <addr> +SwitchPortCongestionSetting (SP) <addr> [<portnum>] +CACongestionSetting (CS) <addr> +CongestionControlTable (CT) <addr> +Timestamp (TI) <addr> +.UNINDENT +.sp +\fB\-\-cckey, \-c <cckey>\fP +Specify a congestion control (CC) key. If none is specified, a key of 0 is used. +\fB\-\-dgid <gid>\fP +destination GID: use when GRH is required in packets (IPv6 format) +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Addressing Flags +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SH EXAMPLES +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibccquery CongestionInfo 3 # Congestion Info by lid +ibccquery SwitchPortCongestionSetting 3 # Query all Switch Port Congestion Settings +ibccquery SwitchPortCongestionSetting 3 1 # Query Switch Port Congestion Setting for port 1 +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +.INDENT 0.0 +.TP +.B Albert Chu +< \fI\%chu11@llnl.gov\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibfindnodesusing.8 b/contrib/ofed/infiniband-diags/man/ibfindnodesusing.8 new file mode 100644 index 000000000000..9ff6db8a8347 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibfindnodesusing.8 @@ -0,0 +1,127 @@ +.\" Man page generated from reStructuredText. +. +.TH IBFINDNODESUSING 8 "" "" "Open IB Diagnostics" +.SH NAME +IBFINDNODESUSING \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH FIND A LIST OF END NODES WHICH ARE ROUTED THROUGH THE SPECIFIED SWITCH AND PORT +.SS SYNOPSIS +.sp +ibfindnodesusing.pl [options] <switch_guid|switch_name> <port> +.SS DESCRIPTION +.sp +ibfindnodesusing.pl uses ibroute and detects the current nodes which are routed +through both directions of the link specified. The link is specified by one +switch port end; the script finds the remote end automatically. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-h\fP +show help +.TP +.B \fB\-R\fP +Recalculate the ibnetdiscover information, ie do not use the cached +information. This option is slower but should be used if the diag +tools have not been used for some time or if there are other reasons to +believe that the fabric has changed. +.UNINDENT +.sp +\fB\-C <ca_name>\fP use the specified ca_name. +.sp +\fB\-P <ca_port>\fP use the specified ca_port. +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SS AUTHOR +.INDENT 0.0 +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibhosts.8 b/contrib/ofed/infiniband-diags/man/ibhosts.8 new file mode 100644 index 000000000000..067c36394c37 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibhosts.8 @@ -0,0 +1,184 @@ +.\" Man page generated from reStructuredText. +. +.TH IBHOSTS 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBHOSTS \- show InfiniBand host nodes in topology +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibhosts [options] [<topology\-file>] +.SH DESCRIPTION +.sp +ibhosts is a script which either walks the IB subnet topology or uses an +already saved topology file and extracts the CA nodes. +.SH OPTIONS +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +ibnetdiscover(8) +.SH DEPENDENCIES +.sp +ibnetdiscover, ibnetdiscover format +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibidsverify.8 b/contrib/ofed/infiniband-diags/man/ibidsverify.8 new file mode 100644 index 000000000000..1df287b77d5f --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibidsverify.8 @@ -0,0 +1,80 @@ +.\" Man page generated from reStructuredText. +. +.TH IBIDSVERIFY 8 "" "" "Open IB Diagnostics" +.SH NAME +IBIDSVERIFY \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH VALIDATE IB IDENTIFIERS IN SUBNET AND REPORT ERRORS +.SS SYNOPSIS +.sp +ibidsverify.pl [\-h] [\-R] +.SS DESCRIPTION +.sp +ibidsverify.pl is a perl script which uses a full topology file that was +created by ibnetdiscover, scans the network to validate the LIDs and GUIDs +in the subnet. The validation consists of checking that there are no zero +or duplicate identifiers. +.sp +Finally, ibidsverify.pl will also reuse the cached ibnetdiscover output from +some of the other diag tools which makes it a bit faster than running +ibnetdiscover from scratch. +.SS OPTIONS +.sp +\fB\-R\fP +Recalculate the ibnetdiscover information, ie do not use the cached +information. This option is slower but should be used if the diag tools have +not been used for some time or if there are other reasons to believe the +fabric has changed. +.sp +\fB\-C <ca_name>\fP use the specified ca_name. +.sp +\fB\-P <ca_port>\fP use the specified ca_port. +.SS EXIT STATUS +.sp +Exit status is 1 if errors are found, 0 otherwise. +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SS SEE ALSO +.sp +\fBibnetdiscover(8)\fP +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/iblinkinfo.8 b/contrib/ofed/infiniband-diags/man/iblinkinfo.8 new file mode 100644 index 000000000000..2a571e353273 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/iblinkinfo.8 @@ -0,0 +1,319 @@ +.\" Man page generated from reStructuredText. +. +.TH IBLINKINFO 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBLINKINFO \- report link info for all links in the fabric +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +iblinkinfo <options> +.SH DESCRIPTION +.sp +iblinkinfo reports link info for each port in an IB fabric, node by node. +Optionally, iblinkinfo can do partial scans and limit its output to parts of a +fabric. +.SH OPTIONS +.sp +\fB\-\-down, \-d\fP +Print only nodes which have a port in the "Down" state. +.sp +\fB\-\-line, \-l\fP +Print all information for each link on one line. Default is to print a header +with the node information and then a list for each port (useful for +grep\(aqing output). +.sp +\fB\-\-additional, \-p\fP +Print additional port settings (<LifeTime>,<HoqLife>,<VLStallCount>) +.sp +\fB\-\-switches\-only\fP +Show only switches in output. +.sp +\fB\-\-cas\-only\fP +Show only CAs in output. +.SS Partial Scan flags +.sp +The node to start a partial scan can be specified with the following addresses. +.\" Define the common option -G +. +.sp +\fB\-\-port\-guid, \-G <port_guid>\fP Specify a port_guid +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct <dr_path>\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + \-D "0" # self port + \-D "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBNote:\fP For switches results are printed for all ports not just switch port 0. +.sp +\fB\-\-switch, \-S <port_guid>\fP same as "\-G". (provided only for backward compatibility) +.sp +How much of the scan to be printed can be controled with the following. +.sp +\fB\-\-all, \-a\fP +Print all nodes found in a partial fabric scan. Normally a +partial fabric scan will return only the node specified. This option will +print the other nodes found as well. +.sp +\fB\-\-hops, \-n <hops>\fP +Specify the number of hops away from a specified node to scan. This is useful +to expand a partial fabric scan beyond the node specified. +.SS Cache File flags +.\" Define the common option load-cache +. +.sp +\fB\-\-load\-cache <filename>\fP +Load and use the cached ibnetdiscover data stored in the specified +filename. May be useful for outputting and learning about other +fabrics or a previous state of a fabric. +.\" Define the common option diff +. +.sp +\fB\-\-diff <filename>\fP +Load cached ibnetdiscover data and do a diff comparison to the current +network or another cache. A special diff output for ibnetdiscover +output will be displayed showing differences between the old and current +fabric. By default, the following are compared for differences: switches, +channel adapters, routers, and port connections. +.\" Define the common option diffcheck +. +.sp +\fB\-\-diffcheck <key(s)>\fP +Specify what diff checks should be done in the \fB\-\-diff\fP option above. +Comma separate multiple diff check key(s). The available diff checks +are: \fBsw = switches\fP, \fBca = channel adapters\fP, \fBrouter\fP = routers, +\fBport\fP = port connections, \fBlid\fP = lids, \fBnodedesc\fP = node +descriptions. Note that \fBport\fP, \fBlid\fP, and \fBnodedesc\fP are +checked only for the node types that are specified (e.g. \fBsw\fP, +\fBca\fP, \fBrouter\fP). If \fBport\fP is specified alongside \fBlid\fP +or \fBnodedesc\fP, remote port lids and node descriptions will also be compared. +.sp +\fB\-\-filterdownports <filename>\fP +Filter downports indicated in a ibnetdiscover cache. If a port was previously +indicated as down in the specified cache, and is still down, do not output it in the +resulting output. This option may be particularly useful for environments +where switches are not fully populated, thus much of the default iblinkinfo +info is considered unuseful. See \fBibnetdiscover\fP for information on caching +ibnetdiscover output. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.INDENT 0.0 +.TP +.B \fB\-\-outstanding_smps, \-o <val>\fP +Specify the number of outstanding SMP\(aqs which should be issued during the scan +.sp +Default: 2 +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.SS Debugging flags +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SH EXIT STATUS +.sp +0 on success, \-1 on failure to scan the fabric, 1 if check mode is used and +inconsistencies are found. +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +.INDENT 0.0 +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibnetdiscover.8 b/contrib/ofed/infiniband-diags/man/ibnetdiscover.8 new file mode 100644 index 000000000000..4a4d54cf1100 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibnetdiscover.8 @@ -0,0 +1,399 @@ +.\" Man page generated from reStructuredText. +. +.TH IBNETDISCOVER 8 "" "" "Open IB Diagnostics" +.SH NAME +IBNETDISCOVER \- discover InfiniBand topology +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibnetdiscover [options] [<topology\-file>] +.SH DESCRIPTION +.sp +ibnetdiscover performs IB subnet discovery and outputs a human readable +topology file. GUIDs, node types, and port numbers are displayed +as well as port LIDs and NodeDescriptions. All nodes (and links) are displayed +(full topology). Optionally, this utility can be used to list the current +connected nodes by nodetype. The output is printed to standard output +unless a topology file is specified. +.SH OPTIONS +.sp +\fB\-l, \-\-list\fP +List of connected nodes +.sp +\fB\-g, \-\-grouping\fP +Show grouping. Grouping correlates IB nodes by different vendor specific +schemes. It may also show the switch external ports correspondence. +.sp +\fB\-H, \-\-Hca_list\fP +List of connected CAs +.sp +\fB\-S, \-\-Switch_list\fP +List of connected switches +.sp +\fB\-R, \-\-Router_list\fP +List of connected routers +.sp +\fB\-s, \-\-show\fP +Show progress information during discovery. +.sp +\fB\-f, \-\-full\fP +Show full information (ports\(aq speed and width, vlcap) +.sp +\fB\-p, \-\-ports\fP +Obtain a ports report which is a +list of connected ports with relevant information (like LID, portnum, +GUID, width, speed, and NodeDescription). +.sp +\fB\-m, \-\-max_hops\fP +Report max hops discovered. +.\" Define the common option -z +. +.INDENT 0.0 +.TP +.B \fB\-\-outstanding_smps, \-o <val>\fP +Specify the number of outstanding SMP\(aqs which should be issued during the scan +.sp +Default: 2 +.UNINDENT +.SS Cache File flags +.\" Define the common option cache +. +.sp +\fB\-\-cache <filename>\fP +Cache the ibnetdiscover network data in the specified filename. This +cache may be used by other tools for later analysis. +.\" Define the common option load-cache +. +.sp +\fB\-\-load\-cache <filename>\fP +Load and use the cached ibnetdiscover data stored in the specified +filename. May be useful for outputting and learning about other +fabrics or a previous state of a fabric. +.\" Define the common option diff +. +.sp +\fB\-\-diff <filename>\fP +Load cached ibnetdiscover data and do a diff comparison to the current +network or another cache. A special diff output for ibnetdiscover +output will be displayed showing differences between the old and current +fabric. By default, the following are compared for differences: switches, +channel adapters, routers, and port connections. +.\" Define the common option diffcheck +. +.sp +\fB\-\-diffcheck <key(s)>\fP +Specify what diff checks should be done in the \fB\-\-diff\fP option above. +Comma separate multiple diff check key(s). The available diff checks +are: \fBsw = switches\fP, \fBca = channel adapters\fP, \fBrouter\fP = routers, +\fBport\fP = port connections, \fBlid\fP = lids, \fBnodedesc\fP = node +descriptions. Note that \fBport\fP, \fBlid\fP, and \fBnodedesc\fP are +checked only for the node types that are specified (e.g. \fBsw\fP, +\fBca\fP, \fBrouter\fP). If \fBport\fP is specified alongside \fBlid\fP +or \fBnodedesc\fP, remote port lids and node descriptions will also be compared. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.INDENT 0.0 +.TP +.B \fB\-\-outstanding_smps, \-o <val>\fP +Specify the number of outstanding SMP\(aqs which should be issued during the scan +.sp +Default: 2 +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Common text to describe the Topology file. +. +.SS TOPOLOGY FILE FORMAT +.sp +The topology file format is human readable and largely intuitive. +Most identifiers are given textual names like vendor ID (vendid), device ID +(device ID), GUIDs of various types (sysimgguid, caguid, switchguid, etc.). +PortGUIDs are shown in parentheses (). For switches, this is shown on the +switchguid line. For CA and router ports, it is shown on the connectivity +lines. The IB node is identified followed by the number of ports and a quoted +the node GUID. On the right of this line is a comment (#) followed by the +NodeDescription in quotes. If the node is a switch, this line also contains +whether switch port 0 is base or enhanced, and the LID and LMC of port 0. +Subsequent lines pertaining to this node show the connectivity. On the +left is the port number of the current node. On the right is the peer node +(node at other end of link). It is identified in quotes with nodetype +followed by \- followed by NodeGUID with the port number in square brackets. +Further on the right is a comment (#). What follows the comment is +dependent on the node type. If it it a switch node, it is followed by +the NodeDescription in quotes and the LID of the peer node. If it is a +CA or router node, it is followed by the local LID and LMC and then +followed by the NodeDescription in quotes and the LID of the peer node. +The active link width and speed are then appended to the end of this +output line. +.sp +An example of this is: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# +# Topology file: generated on Tue Jun 5 14:15:10 2007 +# +# Max of 3 hops discovered +# Initiated from node 0008f10403960558 port 0008f10403960559 + +Non\-Chassis Nodes + +vendid=0x8f1 +devid=0x5a06 +sysimgguid=0x5442ba00003000 +switchguid=0x5442ba00003080(5442ba00003080) +Switch 24 "S\-005442ba00003080" # "ISR9024 Voltaire" base port 0 lid 6 lmc 0 +[22] "H\-0008f10403961354"[1](8f10403961355) # "MT23108 InfiniHost Mellanox Technologies" lid 4 4xSDR +[10] "S\-0008f10400410015"[1] # "SW\-6IB4 Voltaire" lid 3 4xSDR +[8] "H\-0008f10403960558"[2](8f1040396055a) # "MT23108 InfiniHost Mellanox Technologies" lid 14 4xSDR +[6] "S\-0008f10400410015"[3] # "SW\-6IB4 Voltaire" lid 3 4xSDR +[12] "H\-0008f10403960558"[1](8f10403960559) # "MT23108 InfiniHost Mellanox Technologies" lid 10 4xSDR + +vendid=0x8f1 +devid=0x5a05 +switchguid=0x8f10400410015(8f10400410015) +Switch 8 "S\-0008f10400410015" # "SW\-6IB4 Voltaire" base port 0 lid 3 lmc 0 +[6] "H\-0008f10403960984"[1](8f10403960985) # "MT23108 InfiniHost Mellanox Technologies" lid 16 4xSDR +[4] "H\-005442b100004900"[1](5442b100004901) # "MT23108 InfiniHost Mellanox Technologies" lid 12 4xSDR +[1] "S\-005442ba00003080"[10] # "ISR9024 Voltaire" lid 6 1xSDR +[3] "S\-005442ba00003080"[6] # "ISR9024 Voltaire" lid 6 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x8f10403960984 +Ca 2 "H\-0008f10403960984" # "MT23108 InfiniHost Mellanox Technologies" +[1](8f10403960985) "S\-0008f10400410015"[6] # lid 16 lmc 1 "SW\-6IB4 Voltaire" lid 3 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x5442b100004900 +Ca 2 "H\-005442b100004900" # "MT23108 InfiniHost Mellanox Technologies" +[1](5442b100004901) "S\-0008f10400410015"[4] # lid 12 lmc 1 "SW\-6IB4 Voltaire" lid 3 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x8f10403961354 +Ca 2 "H\-0008f10403961354" # "MT23108 InfiniHost Mellanox Technologies" +[1](8f10403961355) "S\-005442ba00003080"[22] # lid 4 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x8f10403960558 +Ca 2 "H\-0008f10403960558" # "MT23108 InfiniHost Mellanox Technologies" +[2](8f1040396055a) "S\-005442ba00003080"[8] # lid 14 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR +[1](8f10403960559) "S\-005442ba00003080"[12] # lid 10 lmc 1 "ISR9024 Voltaire" lid 6 1xSDR +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +When grouping is used, IB nodes are organized into chassis which are +numbered. Nodes which cannot be determined to be in a chassis are +displayed as "Non\-Chassis Nodes". External ports are also shown on the +connectivity lines. +.SH AUTHORS +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibnodes.8 b/contrib/ofed/infiniband-diags/man/ibnodes.8 new file mode 100644 index 000000000000..03f8c14ed0fe --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibnodes.8 @@ -0,0 +1,176 @@ +.\" Man page generated from reStructuredText. +. +.TH IBNODES 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBNODES \- show InfiniBand nodes in topology +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibnodes [options] [<topology\-file>] +.SH DESCRIPTION +.sp +ibnodes is a script which either walks the IB subnet topology or uses an +already saved topology file and extracts the IB nodes (CAs and switches). +.SH OPTIONS +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +ibnetdiscover(8) +.SH DEPENDENCIES +.sp +ibnetdiscover, ibnetdiscover format +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibping.8 b/contrib/ofed/infiniband-diags/man/ibping.8 new file mode 100644 index 000000000000..1fa53ad9464f --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibping.8 @@ -0,0 +1,177 @@ +.\" Man page generated from reStructuredText. +. +.TH IBPING 8 "" "" "Open IB Diagnostics" +.SH NAME +IBPING \- ping an InfiniBand address +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibping [options] <dest lid | guid> +.SH DESCRIPTION +.sp +ibping uses vendor mads to validate connectivity between IB nodes. +On exit, (IP) ping like output is show. ibping is run as client/server. +Default is to run as client. Note also that a default ping server is +implemented within the kernel. +.SH OPTIONS +.sp +\fB\-c, \-\-count\fP +stop after count packets +.sp +\fB\-f, \-\-flood\fP +flood destination: send packets back to back without delay +.sp +\fB\-o, \-\-oui\fP +use specified OUI number to multiplex vendor mads +.sp +\fB\-S, \-\-Server\fP +start in server mode (do not return) +.sp +\fB\-\-dgid <gid>\fP +destination GID: use when GRH is required in packets (IPv6 format) +.SS Addressing Flags +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.SS Debugging flags +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibportstate.8 b/contrib/ofed/infiniband-diags/man/ibportstate.8 new file mode 100644 index 000000000000..2d7c85ff0be9 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibportstate.8 @@ -0,0 +1,259 @@ +.\" Man page generated from reStructuredText. +. +.TH IBPORTSTATE 8 "" "" "Open IB Diagnostics" +.SH NAME +IBPORTSTATE \- handle port (physical) state and link speed of an InfiniBand port +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibportstate [options] <dest dr_path|lid|guid> <portnum> [<op>] +.SH DESCRIPTION +.sp +ibportstate allows the port state and port physical state of an IB port +to be queried (in addition to link width and speed being validated +relative to the peer port when the port queried is a switch port), +or a switch port to be disabled, enabled, or reset. It +also allows the link speed/width enabled on any IB port to be adjusted. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB<op>\fP +.INDENT 7.0 +.TP +.B Supported ops: enable, disable, reset, speed, espeed, fdr10, width, query, +on, off, down, arm, active, vls, mtu, lid, smlid, lmc, +mkey, mkeylease, mkeyprot +(Default is query) +.UNINDENT +.sp +\fBenable, disable, and reset\fP are only allowed on switch ports (An +error is indicated if attempted on CA or router ports) +.sp +\fBoff\fP change the port state to disable. +.sp +\fBon\fP change the port state to enable(only when the current state is disable). +.sp +\fBspeed and width\fP are allowed on any port +.sp +\fBspeed\fP values are the legal values for PortInfo:LinkSpeedEnabled (An +error is indicated if PortInfo:LinkSpeedSupported does not support this +setting) +.sp +\fBespeed\fP is allowed on any port supporting extended link speeds +.sp +\fBfdr10\fP is allowed on any port supporting fdr10 (An error is +indicated if port\(aqs capability mask indicates extended link speeds are +not supported or if PortInfo:LinkSpeedExtSupported does not support +this setting) +.sp +\fBwidth\fP values are legal values for PortInfo:LinkWidthEnabled (An +error is indicated if PortInfo:LinkWidthSupported does not support this +setting) (NOTE: Speed and width changes are not effected until the port +goes through link renegotiation) +.sp +\fBquery\fP also validates port characteristics (link width, speed, +espeed, and fdr10) based on the peer port. This checking is done when +the port queried is a switch port as it relies on combined routing (an +initial LID route with directed routing to the peer) which can only be +done on a switch. This peer port validation feature of query op +requires LID routing to be functioning in the subnet. +.sp +\fBmkey, mkeylease, and mkeyprot\fP are only allowed on CAs, routers, or +switch port 0 (An error is generated if attempted on external switch +ports). Hexadecimal and octal mkeys may be specified by prepending the +key with \(aq0x\(aq or \(aq0\(aq, respectively. If a non\-numeric value (like \(aqx\(aq) +is specified for the mkey, then ibportstate will prompt for a value. +.UNINDENT +.SS Addressing Flags +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.SS Debugging flags +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -K +. +.INDENT 0.0 +.TP +.B \fB\-K, \-\-show_keys\fP +show security keys (mkey, smkey, etc.) associated with the request. +.UNINDENT +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SH EXAMPLES +.INDENT 0.0 +.TP +.B :: +ibportstate 3 1 disable # by lid +ibportstate \-G 0x2C9000100D051 1 enable # by guid +ibportstate \-D 0 1 # (query) by direct route +ibportstate 3 1 reset # by lid +ibportstate 3 1 speed 1 # by lid +ibportstate 3 1 width 1 # by lid +ibportstate \-D 0 1 lid 0x1234 arm # by direct route +.UNINDENT +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%hal.rosenstock@gmail.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibqueryerrors.8 b/contrib/ofed/infiniband-diags/man/ibqueryerrors.8 new file mode 100644 index 000000000000..be9f3c086115 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibqueryerrors.8 @@ -0,0 +1,339 @@ +.\" Man page generated from reStructuredText. +. +.TH IBQUERYERRORS 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBQUERYERRORS \- query and report IB port counters +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibqueryerrors [options] +.SH DESCRIPTION +.sp +The default behavior is to report the port error counters which exceed a +threshold for each port in the fabric. The default threshold is zero (0). +Error fields can also be suppressed entirely. +.sp +In addition to reporting errors on every port. ibqueryerrors can report the +port transmit and receive data as well as report full link information to the +remote port if available. +.SH OPTIONS +.sp +\fB\-s, \-\-suppress <err1,err2,...>\fP +Suppress the errors listed in the comma separated list provided. +.sp +\fB\-c, \-\-suppress\-common\fP +Suppress some of the common "side effect" counters. These counters usually do +not indicate an error condition and can be usually be safely ignored. +.sp +\fB\-r, \-\-report\-port\fP +Report the port information. This includes LID, port, external port (if +applicable), link speed setting, remote GUID, remote port, remote external port +(if applicable), and remote node description information. +.sp +\fB\-\-data\fP +Include the optional transmit and receive data counters. +.sp +\fB\-\-threshold\-file <filename>\fP +Specify an alternate threshold file. The default is /etc/infiniband-diags/error_thresholds +.sp +\fB\-\-switch\fP print data for switch\(aqs only +.sp +\fB\-\-ca\fP print data for CA\(aqs only +.sp +\fB\-\-skip\-sl\fP Use the default sl for queries. This is not recommended when +using a QoS aware routing engine as it can cause a credit deadlock. +.sp +\fB\-\-router\fP print data for routers only +.sp +\fB\-\-clear\-errors \-k\fP Clear error counters after read. +.sp +\fB\-\-clear\-counts \-K\fP Clear data counters after read. +.sp +\fBCAUTION\fP clearing data or error counters will occur regardless of if they +are printed or not. See \fB\-\-counters\fP and \fB\-\-data\fP for details on +controling which counters are printed. +.sp +\fB\-\-details\fP include receive error and transmit discard details +.sp +\fB\-\-counters\fP print data counters only +.SS Partial Scan flags +.sp +The node to start a partial scan can be specified with the following addresses. +.\" Define the common option -G +. +.sp +\fB\-\-port\-guid, \-G <port_guid>\fP Specify a port_guid +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct <dr_path>\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + \-D "0" # self port + \-D "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBNote:\fP For switches results are printed for all ports not just switch port 0. +.sp +\fB\-S <port_guid>\fP same as "\-G". (provided only for backward compatibility) +.SS Cache File flags +.\" Define the common option load-cache +. +.sp +\fB\-\-load\-cache <filename>\fP +Load and use the cached ibnetdiscover data stored in the specified +filename. May be useful for outputting and learning about other +fabrics or a previous state of a fabric. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Configuration flags +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.INDENT 0.0 +.TP +.B \fB\-\-outstanding_smps, \-o <val>\fP +Specify the number of outstanding SMP\(aqs which should be issued during the scan +.sp +Default: 2 +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.sp +\fB\-R\fP (This option is obsolete and does nothing) +.SH EXIT STATUS +.sp +\fB\-1\fP if scan fails. +.sp +\fB0\fP if scan succeeds without errors beyond thresholds +.sp +\fB1\fP if errors are found beyond thresholds or inconsistencies are found in check mode. +.SH FILES +.SS ERROR THRESHOLD +.sp +/etc/infiniband-diags/error_thresholds +.sp +Define threshold values for errors. File format is simple "name=val". +Comments begin with \(aq#\(aq +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# Define thresholds for error counters +SymbolErrorCounter=10 +LinkErrorRecoveryCounter=10 +VL15Dropped=100 +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +.INDENT 0.0 +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibroute.8 b/contrib/ofed/infiniband-diags/man/ibroute.8 new file mode 100644 index 000000000000..7c03c1295005 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibroute.8 @@ -0,0 +1,291 @@ +.\" Man page generated from reStructuredText. +. +.TH IBROUTE 8 "" "" "Open IB Diagnostics" +.SH NAME +IBROUTE \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY INFINIBAND SWITCH FORWARDING TABLES +.SS SYNOPSIS +.sp +ibroute [options] [<dest dr_path|lid|guid> [<startlid> [<endlid>]]] +.SS DESCRIPTION +.sp +ibroute uses SMPs to display the forwarding tables (unicast +(LinearForwardingTable or LFT) or multicast (MulticastForwardingTable or MFT)) +for the specified switch LID and the optional lid (mlid) range. +The default range is all valid entries in the range 1...FDBTop. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-a, \-\-all\fP +show all lids in range, even invalid entries +.TP +.B \fB\-n, \-\-no_dests\fP +do not try to resolve destinations +.TP +.B \fB\-M, \-\-Multicast\fP +show multicast forwarding tables +In this case, the range parameters are specifying the mlid range. +.UNINDENT +.SS Addressing Flags +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SS EXAMPLES +.sp +Unicast examples +.INDENT 0.0 +.TP +.B :: +ibroute 4 # dump all lids with valid out ports of switch with lid 4 +ibroute \-a 4 # same, but dump all lids, even with invalid out ports +ibroute \-n 4 # simple dump format \- no destination resolution +ibroute 4 10 # dump lids starting from 10 (up to FDBTop) +ibroute 4 0x10 0x20 # dump lid range +ibroute \-G 0x08f1040023 # resolve switch by GUID +ibroute \-D 0,1 # resolve switch by direct path +.UNINDENT +.sp +Multicast examples +.INDENT 0.0 +.TP +.B :: +ibroute \-M 4 # dump all non empty mlids of switch with lid 4 +ibroute \-M 4 0xc010 0xc020 # same, but with range +ibroute \-M \-n 4 # simple dump format +.UNINDENT +.SS SEE ALSO +.sp +ibtracert (8) +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibrouters.8 b/contrib/ofed/infiniband-diags/man/ibrouters.8 new file mode 100644 index 000000000000..80530c6ee396 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibrouters.8 @@ -0,0 +1,184 @@ +.\" Man page generated from reStructuredText. +. +.TH IBROUTERS 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBROUTERS \- show InfiniBand router nodes in topology +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibrouters [options] [<topology\-file>] +.SH DESCRIPTION +.sp +ibrouters is a script which either walks the IB subnet topology or uses an +already saved topology file and extracts the router nodes. +.SH OPTIONS +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +ibnetdiscover(8) +.SH DEPENDENCIES +.sp +ibnetdiscover, ibnetdiscover format +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibstat.8 b/contrib/ofed/infiniband-diags/man/ibstat.8 new file mode 100644 index 000000000000..4ce3cc8a5221 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibstat.8 @@ -0,0 +1,118 @@ +.\" Man page generated from reStructuredText. +. +.TH IBSTAT 8 "" "" "Open IB Diagnostics" +.SH NAME +IBSTAT \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY BASIC STATUS OF INFINIBAND DEVICE(S) +.SS SYNOPSIS +.sp +ibstat [options] <ca_name> [portnum] +.SS DESCRIPTION +.sp +ibstat is a binary which displays basic information obtained from the local +IB driver. Output includes LID, SMLID, port state, link width active, and port +physical state. +.sp +It is similar to the ibstatus utility but implemented as a binary rather +than a script. It has options to list CAs and/or ports and displays more +information than ibstatus. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-l, \-\-list_of_cas\fP +list all IB devices +.TP +.B \fB\-s, \-\-short\fP +short output +.TP +.B \fB\-p, \-\-port_list\fP +show port list +.TP +.B \fBca_name\fP +InfiniBand device name +.TP +.B \fBportnum\fP +port number of InfiniBand device +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS EXAMPLES +.INDENT 0.0 +.TP +.B :: +ibstat # display status of all ports on all IB devices +ibstat \-l # list all IB devices +ibstat \-p # show port guids +ibstat mthca0 2 # show status of port 2 of \(aqmthca0\(aq +.UNINDENT +.SS SEE ALSO +.sp +ibstatus (8) +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibstatus.8 b/contrib/ofed/infiniband-diags/man/ibstatus.8 new file mode 100644 index 000000000000..dcfd2691e6d8 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibstatus.8 @@ -0,0 +1,73 @@ +.\" Man page generated from reStructuredText. +. +.TH IBSTATUS 8 "" "" "Open IB Diagnostics" +.SH NAME +IBSTATUS \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY BASIC STATUS OF INFINIBAND DEVICE(S) +.SS SYNOPSIS +.sp +ibstatus [\-h] [devname[:port]]... +.SS DESCRIPTION +.sp +ibstatus is a script which displays basic information obtained from the local +IB driver. Output includes LID, SMLID, port state, link width active, and port +physical state. +.SS OPTIONS +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.INDENT 0.0 +.TP +.B \fBdevname\fP +InfiniBand device name +.TP +.B \fBportnum\fP +port number of InfiniBand device +.UNINDENT +.SS EXAMPLES +.INDENT 0.0 +.TP +.B :: +ibstatus # display status of all IB ports +ibstatus mthca1 # status of mthca1 ports +ibstatus mthca1:1 mthca0:2 # show status of specified ports +.UNINDENT +.SS SEE ALSO +.sp +\fBibstat (8)\fP +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibswitches.8 b/contrib/ofed/infiniband-diags/man/ibswitches.8 new file mode 100644 index 000000000000..39f3041abc85 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibswitches.8 @@ -0,0 +1,184 @@ +.\" Man page generated from reStructuredText. +. +.TH IBSWITCHES 8 "" "" "OpenIB Diagnostics" +.SH NAME +IBSWITCHES \- show InfiniBand switch nodes in topology +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +ibswitches [options] [<topology\-file>] +.SH DESCRIPTION +.sp +ibswitches is a script which either walks the IB subnet topology or uses an +already saved topology file and extracts the switch nodes. +.SH OPTIONS +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SH FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +ibnetdiscover(8) +.SH DEPENDENCIES +.sp +ibnetdiscover, ibnetdiscover format +.SH AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibsysstat.8 b/contrib/ofed/infiniband-diags/man/ibsysstat.8 new file mode 100644 index 000000000000..126be4ec9dde --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibsysstat.8 @@ -0,0 +1,188 @@ +.\" Man page generated from reStructuredText. +. +.TH IBSYSSTAT 8 "" "" "Open IB Diagnostics" +.SH NAME +IBSYSSTAT \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYSTEM STATUS ON AN INFINIBAND ADDRESS +.SS SYNOPSIS +.sp +ibsysstat [options] <dest lid | guid> [<op>] +.SS DESCRIPTION +.sp +ibsysstat uses vendor mads to validate connectivity between IB nodes +and obtain other information about the IB node. ibsysstat is run as +client/server. Default is to run as client. +.SS OPTIONS +.sp +Current supported operations: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ping \e\- verify connectivity to server (default) +host \e\- obtain host information from server +cpu \e\- obtain cpu information from server +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \fB\-o, \-\-oui\fP +use specified OUI number to multiplex vendor mads +.TP +.B \fB\-S, \-\-Server\fP +start in server mode (do not return) +.TP +.B .sp +\fB\-\-dgid <gid>\fP +destination GID: use when GRH is required in packets (IPv6 format) +.UNINDENT +.SS Addressing Flags +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/ibtracert.8 b/contrib/ofed/infiniband-diags/man/ibtracert.8 new file mode 100644 index 000000000000..21ad34054078 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/ibtracert.8 @@ -0,0 +1,268 @@ +.\" Man page generated from reStructuredText. +. +.TH IBTRACERT 8 "" "" "Open IB Diagnostics" +.SH NAME +IBTRACERT \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH TRACE INFINIBAND PATH +.SS SYNOPSIS +.sp +ibtracert [options] [<lid|guid> [<startlid> [<endlid>]]] +.SS DESCRIPTION +.sp +ibtracert uses SMPs to trace the path from a source GID/LID to a +destination GID/LID. Each hop along the path is displayed until +the destination is reached or a hop does not respond. By using +the \-m option, multicast path tracing can be performed between source +and destination nodes. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-n, \-\-no_info\fP +simple format; don\(aqt show additional information +.TP +.B \fB\-m\fP +show the multicast trace of the specified mlid +.TP +.B \fB\-f, \-\-force\fP +force route to destination port +.UNINDENT +.SS Addressing Flags +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SS EXAMPLES +.sp +Unicast examples +.INDENT 0.0 +.TP +.B :: +ibtracert 4 16 # show path between lids 4 and 16 +ibtracert \-n 4 16 # same, but using simple output format +ibtracert \-G 0x8f1040396522d 0x002c9000100d051 # use guid addresses +.UNINDENT +.sp +Multicast example +.INDENT 0.0 +.TP +.B :: +ibtracert \-m 0xc000 4 16 # show multicast path of mlid 0xc000 between lids 4 and 16 +.UNINDENT +.SS SEE ALSO +.sp +ibroute (8) +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +<\fI\%hal.rosenstock@gmail.com\fP> +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/infiniband-diags.8 b/contrib/ofed/infiniband-diags/man/infiniband-diags.8 new file mode 100644 index 000000000000..d2d95c6d08ac --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/infiniband-diags.8 @@ -0,0 +1,452 @@ +.\" Man page generated from reStructuredText. +. +.TH INFINIBAND-DIAGS 8 "" "" "Open IB Diagnostics" +.SH NAME +INFINIBAND-DIAGS \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH DIAGNOSTICS FOR INFINIBAND FABRICS +.SS DESCRIPTION +.sp +infiniband\-diags is a set of utilities designed to help configure, debug, and +maintain infiniband fabrics. Many tools and utilities are provided. Some with +similar functionality. +.sp +The base utilities use directed route MAD\(aqs to perform their operations. They +may therefore work even in unconfigured subnets. Other, higher level +utilities, require LID routed MAD\(aqs and to some extent SA/SM access. +.SS THE USE OF SMPs (QP0) +.sp +Many of the tools in this package rely on the use of SMPs via QP0 to acquire +data directly from the SMA. While this mode of operation is not technically in +compliance with the InfiniBand specification, practical experience has found +that this level of diagnostics is valuable when working with a fabric which is +broken or only partially configured. For this reason many of these tools may +require the use of an MKey or operation from Virtual Machines may be restricted +for security reasons. +.SS COMMON OPTIONS +.sp +Most OpenIB diagnostics take some of the following common flags. The exact list +of supported flags per utility can be found in the documentation for those +commands. +.SS Addressing Flags +.sp +The \-D and \-G option have two forms: +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct <dr_path>\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + \-D "0" # self port + \-D "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -G +. +.sp +\fB\-\-port\-guid, \-G <port_guid>\fP Specify a port_guid +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -z +. +.INDENT 0.0 +.TP +.B \fB\-\-outstanding_smps, \-o <val>\fP +Specify the number of outstanding SMP\(aqs which should be issued during the scan +.sp +Default: 2 +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS COMMON FILES +.sp +The following config files are common amongst many of the utilities. +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Common text to describe the Topology file. +. +.SS TOPOLOGY FILE FORMAT +.sp +The topology file format is human readable and largely intuitive. +Most identifiers are given textual names like vendor ID (vendid), device ID +(device ID), GUIDs of various types (sysimgguid, caguid, switchguid, etc.). +PortGUIDs are shown in parentheses (). For switches, this is shown on the +switchguid line. For CA and router ports, it is shown on the connectivity +lines. The IB node is identified followed by the number of ports and a quoted +the node GUID. On the right of this line is a comment (#) followed by the +NodeDescription in quotes. If the node is a switch, this line also contains +whether switch port 0 is base or enhanced, and the LID and LMC of port 0. +Subsequent lines pertaining to this node show the connectivity. On the +left is the port number of the current node. On the right is the peer node +(node at other end of link). It is identified in quotes with nodetype +followed by \- followed by NodeGUID with the port number in square brackets. +Further on the right is a comment (#). What follows the comment is +dependent on the node type. If it it a switch node, it is followed by +the NodeDescription in quotes and the LID of the peer node. If it is a +CA or router node, it is followed by the local LID and LMC and then +followed by the NodeDescription in quotes and the LID of the peer node. +The active link width and speed are then appended to the end of this +output line. +.sp +An example of this is: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# +# Topology file: generated on Tue Jun 5 14:15:10 2007 +# +# Max of 3 hops discovered +# Initiated from node 0008f10403960558 port 0008f10403960559 + +Non\-Chassis Nodes + +vendid=0x8f1 +devid=0x5a06 +sysimgguid=0x5442ba00003000 +switchguid=0x5442ba00003080(5442ba00003080) +Switch 24 "S\-005442ba00003080" # "ISR9024 Voltaire" base port 0 lid 6 lmc 0 +[22] "H\-0008f10403961354"[1](8f10403961355) # "MT23108 InfiniHost Mellanox Technologies" lid 4 4xSDR +[10] "S\-0008f10400410015"[1] # "SW\-6IB4 Voltaire" lid 3 4xSDR +[8] "H\-0008f10403960558"[2](8f1040396055a) # "MT23108 InfiniHost Mellanox Technologies" lid 14 4xSDR +[6] "S\-0008f10400410015"[3] # "SW\-6IB4 Voltaire" lid 3 4xSDR +[12] "H\-0008f10403960558"[1](8f10403960559) # "MT23108 InfiniHost Mellanox Technologies" lid 10 4xSDR + +vendid=0x8f1 +devid=0x5a05 +switchguid=0x8f10400410015(8f10400410015) +Switch 8 "S\-0008f10400410015" # "SW\-6IB4 Voltaire" base port 0 lid 3 lmc 0 +[6] "H\-0008f10403960984"[1](8f10403960985) # "MT23108 InfiniHost Mellanox Technologies" lid 16 4xSDR +[4] "H\-005442b100004900"[1](5442b100004901) # "MT23108 InfiniHost Mellanox Technologies" lid 12 4xSDR +[1] "S\-005442ba00003080"[10] # "ISR9024 Voltaire" lid 6 1xSDR +[3] "S\-005442ba00003080"[6] # "ISR9024 Voltaire" lid 6 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x8f10403960984 +Ca 2 "H\-0008f10403960984" # "MT23108 InfiniHost Mellanox Technologies" +[1](8f10403960985) "S\-0008f10400410015"[6] # lid 16 lmc 1 "SW\-6IB4 Voltaire" lid 3 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x5442b100004900 +Ca 2 "H\-005442b100004900" # "MT23108 InfiniHost Mellanox Technologies" +[1](5442b100004901) "S\-0008f10400410015"[4] # lid 12 lmc 1 "SW\-6IB4 Voltaire" lid 3 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x8f10403961354 +Ca 2 "H\-0008f10403961354" # "MT23108 InfiniHost Mellanox Technologies" +[1](8f10403961355) "S\-005442ba00003080"[22] # lid 4 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR + +vendid=0x2c9 +devid=0x5a44 +caguid=0x8f10403960558 +Ca 2 "H\-0008f10403960558" # "MT23108 InfiniHost Mellanox Technologies" +[2](8f1040396055a) "S\-005442ba00003080"[8] # lid 14 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR +[1](8f10403960559) "S\-005442ba00003080"[12] # lid 10 lmc 1 "ISR9024 Voltaire" lid 6 1xSDR +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +When grouping is used, IB nodes are organized into chassis which are +numbered. Nodes which cannot be determined to be in a chassis are +displayed as "Non\-Chassis Nodes". External ports are also shown on the +connectivity lines. +.SS Utilities list +.SS Basic fabric conectivity +.INDENT 0.0 +.INDENT 3.5 +See: ibnetdiscover, iblinkinfo +.UNINDENT +.UNINDENT +.SS Node information +.INDENT 0.0 +.INDENT 3.5 +See: ibnodes, ibswitches, ibhosts, ibrouters +.UNINDENT +.UNINDENT +.SS Port information +.INDENT 0.0 +.INDENT 3.5 +See: ibportstate, ibaddr +.UNINDENT +.UNINDENT +.SS Switch Forwarding Table info +.INDENT 0.0 +.INDENT 3.5 +See: ibtracert, ibroute, dump_lfts, dump_mfts, check_lft_balance, ibfindnodesusing +.UNINDENT +.UNINDENT +.SS Peformance counters +.INDENT 0.0 +.INDENT 3.5 +See: ibqueryerrors, perfquery +.UNINDENT +.UNINDENT +.SS Local HCA info +.INDENT 0.0 +.INDENT 3.5 +See: ibstat, ibstatus +.UNINDENT +.UNINDENT +.SS Connectivity check +.INDENT 0.0 +.INDENT 3.5 +See: ibping, ibsysstat +.UNINDENT +.UNINDENT +.SS Low level query tools +.INDENT 0.0 +.INDENT 3.5 +See: smpquery, smpdump, saquery, sminfo +.UNINDENT +.UNINDENT +.SS Fabric verification tools +.INDENT 0.0 +.INDENT 3.5 +See: ibidsverify +.UNINDENT +.UNINDENT +.SS Backwards compatibility scripts +.sp +The following scripts have been identified as redundant and/or lower performing +as compared to the above scripts. They are provided as legacy scripts when +\-\-enable\-compat\-utils is specified at build time. +.sp +ibcheckerrors, ibclearcounters, ibclearerrors, ibdatacounters +ibchecknet, ibchecknode, ibcheckport, ibcheckportstate, +ibcheckportwidth, ibcheckstate, ibcheckwidth, ibswportwatch, +ibprintca, ibprintrt, ibprintswitch, set_nodedesc.sh +.SS AUTHORS +.INDENT 0.0 +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/perfquery.8 b/contrib/ofed/infiniband-diags/man/perfquery.8 new file mode 100644 index 000000000000..236ad73174f2 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/perfquery.8 @@ -0,0 +1,291 @@ +.\" Man page generated from reStructuredText. +. +.TH PERFQUERY 8 "" "" "Open IB Diagnostics" +.SH NAME +PERFQUERY \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY INFINIBAND PORT COUNTERS ON A SINGLE PORT +.SS SYNOPSIS +.sp +perfquery [options] [<lid|guid> [[port(s)] [reset_mask]]] +.SS DESCRIPTION +.sp +perfquery uses PerfMgt GMPs to obtain the PortCounters (basic performance and +error counters), PortExtendedCounters, PortXmitDataSL, PortRcvDataSL, +PortRcvErrorDetails, PortXmitDiscardDetails, PortExtendedSpeedsCounters, or +PortSamplesControl from the PMA at the node/port specified. Optionally shows +aggregated counters for all ports of node. Finally it can, reset after read, +or just reset the counters. +.sp +Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortRcvDataSL, +components that represent Data (e.g. PortXmitData and PortRcvData) indicate +octets divided by 4 rather than just octets. +.sp +Note: Inputting a port of 255 indicates an operation be performed on all ports. +.sp +Note: For PortCounters, ExtendedCounters, and resets, multiple ports can be +specified by either a comma separated list or a port range. See examples below. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-x, \-\-extended\fP +show extended port counters rather than (basic) port counters. +Note that extended port counters attribute is optional. +.TP +.B \fB\-X, \-\-xmtsl\fP +show transmit data SL counter. This is an optional counter for QoS. +.TP +.B \fB\-S, \-\-rcvsl\fP +show receive data SL counter. This is an optional counter for QoS. +.TP +.B \fB\-D, \-\-xmtdisc\fP +show transmit discard details. This is an optional counter. +.TP +.B \fB\-E, \-\-rcverr\fP +show receive error details. This is an optional counter. +.TP +.B \fB\-D, \-\-xmtdisc\fP +show transmit discard details. This is an optional counter. +.TP +.B \fB\-T, \-\-extended_speeds\fP +show extended speeds port counters. This is an optional counter. +.TP +.B \fB\-\-oprcvcounters\fP +show Rcv Counters per Op code. This is an optional counter. +.TP +.B \fB\-\-flowctlcounters\fP +show flow control counters. This is an optional counter. +.TP +.B \fB\-\-vloppackets\fP +show packets received per Op code per VL. This is an optional counter. +.TP +.B \fB\-\-vlopdata\fP +show data received per Op code per VL. This is an optional counter. +.TP +.B \fB\-\-vlxmitflowctlerrors\fP +show flow control update errors per VL. This is an optional counter. +.TP +.B \fB\-\-vlxmitcounters\fP +show ticks waiting to transmit counters per VL. This is an optional counter. +.TP +.B \fB\-\-swportvlcong\fP +show sw port VL congestion. This is an optional counter. +.TP +.B \fB\-\-rcvcc\fP +show Rcv congestion control counters. This is an optional counter. +.TP +.B \fB\-\-slrcvfecn\fP +show SL Rcv FECN counters. This is an optional counter. +.TP +.B \fB\-\-slrcvbecn\fP +show SL Rcv BECN counters. This is an optional counter. +.TP +.B \fB\-\-xmitcc\fP +show Xmit congestion control counters. This is an optional counter. +.TP +.B \fB\-\-vlxmittimecc\fP +show VL Xmit Time congestion control counters. This is an optional counter. +.TP +.B \fB\-c, \-\-smplctl\fP +show port samples control. +.TP +.B \fB\-a, \-\-all_ports\fP +show aggregated counters for all ports of the destination lid, reset +all counters for all ports, or if multiple ports are specified, aggregate +the counters of the specified ports. If the destination lid does not support +the AllPortSelect flag, all ports will be iterated through to emulate +AllPortSelect behavior. +.TP +.B \fB\-l, \-\-loop_ports\fP +If all ports are selected by the user (either through the \fB\-a\fP option +or port 255) or multiple ports are specified iterate through each port rather +than doing than aggregate operation. +.TP +.B \fB\-r, \-\-reset_after_read\fP +reset counters after read +.TP +.B \fB\-R, \-\-Reset_only\fP +only reset counters +.TP +.B \fB\-\-dgid <gid>\fP +destination GID: use when GRH is required in packets (IPv6 format) +.UNINDENT +.SS Addressing Flags +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SS EXAMPLES +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +perfquery # read local port performance counters +perfquery 32 1 # read performance counters from lid 32, port 1 +perfquery \-x 32 1 # read extended performance counters from lid 32, port 1 +perfquery \-a 32 # read perf counters from lid 32, all ports +perfquery \-r 32 1 # read performance counters and reset +perfquery \-x \-r 32 1 # read extended performance counters and reset +perfquery \-R 0x20 1 # reset performance counters of port 1 only +perfquery \-x \-R 0x20 1 # reset extended performance counters of port 1 only +perfquery \-R \-a 32 # reset performance counters of all ports +perfquery \-R 32 2 0x0fff # reset only error counters of port 2 +perfquery \-R 32 2 0xf000 # reset only non\-error counters of port 2 +perfquery \-a 32 1\-10 # read performance counters from lid 32, port 1\-10, aggregate output +perfquery \-l 32 1\-10 # read performance counters from lid 32, port 1\-10, output each port +perfquery \-a 32 1,4,8 # read performance counters from lid 32, port 1, 4, and 8, aggregate output +perfquery \-l 32 1,4,8 # read performance counters from lid 32, port 1, 4, and 8, output each port +.ft P +.fi +.UNINDENT +.UNINDENT +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%hal.rosenstock@gmail.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/saquery.8 b/contrib/ofed/infiniband-diags/man/saquery.8 new file mode 100644 index 000000000000..82f20f7ddbc1 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/saquery.8 @@ -0,0 +1,380 @@ +.\" Man page generated from reStructuredText. +. +.TH SAQUERY 8 "" "" "Open IB Diagnostics" +.SH NAME +SAQUERY \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY INFINIBAND SUBNET ADMINISTRATION ATTRIBUTES +.SS SYNOPSIS +.sp +saquery [options] [<name> | <lid> | <guid>] +.SS DESCRIPTION +.sp +saquery issues the selected SA query. Node records are queried by default. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-p\fP +get PathRecord info +.TP +.B \fB\-N\fP +get NodeRecord info +.TP +.B \fB\-D, \-\-list\fP +get NodeDescriptions of CAs only +.TP +.B \fB\-S\fP +get ServiceRecord info +.TP +.B \fB\-I\fP +get InformInfoRecord (subscription) info +.TP +.B \fB\-L\fP +return the Lids of the name specified +.TP +.B \fB\-l\fP +return the unique Lid of the name specified +.TP +.B \fB\-G\fP +return the Guids of the name specified +.TP +.B \fB\-O\fP +return the name for the Lid specified +.TP +.B \fB\-U\fP +return the name for the Guid specified +.TP +.B \fB\-c\fP +get the SA\(aqs class port info +.TP +.B \fB\-s\fP +return the PortInfoRecords with isSM or isSMdisabled capability mask bit on +.TP +.B \fB\-g\fP +get multicast group info +.TP +.B \fB\-m\fP +get multicast member info. If a group is specified, limit the output +to the group specified and print one line containing only the GUID and +node description for each entry. Example: saquery \-m 0xc000 +.TP +.B \fB\-x\fP +get LinkRecord info +.TP +.B \fB\-\-src\-to\-dst <src:dst>\fP +get a PathRecord for <src:dst> +where src and dst are either node names or LIDs +.TP +.B \fB\-\-sgid\-to\-dgid <sgid:dgid>\fP +get a PathRecord for \fBsgid\fP to \fBdgid\fP +where both GIDs are in an IPv6 format acceptable to \fBinet_pton (3)\fP +.TP +.B \fB\-\-smkey <val>\fP +use SM_Key value for the query. Will be used only with "trusted" +queries. If non\-numeric value (like \(aqx\(aq) is specified then saquery +will prompt for a value. +Default (when not specified here or in +/etc/infiniband-diags/ibdiag.conf) is to use SM_Key == 0 (or +"untrusted") +.TP +.B \fB\-\-sa-dgid <gid>\fP +Set the destination GID (in IPv6 format) of the SA in the GRH of the request. +Either the actual SM GID or the SA well known GID (0::2) can be used to include +in the GRH of the SA queries. +.UNINDENT +.\" Define the common option -K +. +.INDENT 0.0 +.TP +.B \fB\-K, \-\-show_keys\fP +show security keys (mkey, smkey, etc.) associated with the request. +.UNINDENT +.sp +\fB\-\-slid <lid>\fP Source LID (PathRecord) +.sp +\fB\-\-dlid <lid>\fP Destination LID (PathRecord) +.sp +\fB\-\-mlid <lid>\fP Multicast LID (MCMemberRecord) +.sp +\fB\-\-sgid <gid>\fP Source GID (IPv6 format) (PathRecord) +.sp +\fB\-\-dgid <gid>\fP Destination GID (IPv6 format) (PathRecord) +.sp +\fB\-\-gid <gid>\fP Port GID (MCMemberRecord) +.sp +\fB\-\-mgid <gid>\fP Multicast GID (MCMemberRecord) +.sp +\fB\-\-reversible\fP Reversible path (PathRecord) +.sp +\fB\-\-numb_path\fP Number of paths (PathRecord) +.INDENT 0.0 +.TP +.B \fB\-\-pkey\fP P_Key (PathRecord, MCMemberRecord). If non\-numeric value (like \(aqx\(aq) +is specified then saquery will prompt for a value +.UNINDENT +.sp +\fB\-\-qos_class\fP QoS Class (PathRecord) +.sp +\fB\-\-sl\fP Service level (PathRecord, MCMemberRecord) +.sp +\fB\-\-mtu\fP MTU and selector (PathRecord, MCMemberRecord) +.sp +\fB\-\-rate\fP Rate and selector (PathRecord, MCMemberRecord) +.sp +\fB\-\-pkt_lifetime\fP Packet lifetime and selector (PathRecord, MCMemberRecord) +.INDENT 0.0 +.TP +.B \fB\-\-qkey\fP Q_Key (MCMemberRecord). If non\-numeric value (like \(aqx\(aq) is specified +then saquery will prompt for a value +.UNINDENT +.sp +\fB\-\-tclass\fP Traffic Class (PathRecord, MCMemberRecord) +.sp +\fB\-\-flow_label\fP Flow Label (PathRecord, MCMemberRecord) +.sp +\fB\-\-hop_limit\fP Hop limit (PathRecord, MCMemberRecord) +.sp +\fB\-\-scope\fP Scope (MCMemberRecord) +.sp +\fB\-\-join_state\fP Join state (MCMemberRecord) +.sp +\fB\-\-proxy_join\fP Proxy join (MCMemberRecord) +.sp +\fB\-\-service_id\fP ServiceID (PathRecord) +.sp +Supported query names (and aliases): +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ClassPortInfo (CPI) +NodeRecord (NR) [lid] +PortInfoRecord (PIR) [[lid]/[port]/[options]] +SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]] +PKeyTableRecord (PKTR) [[lid]/[port]/[block]] +VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]] +InformInfoRecord (IIR) +LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]] +ServiceRecord (SR) +PathRecord (PR) +MCMemberRecord (MCMR) +LFTRecord (LFTR) [[lid]/[block]] +MFTRecord (MFTR) [[mlid]/[position]/[block]] +GUIDInfoRecord (GIR) [[lid]/[block]] +SwitchInfoRecord (SWIR) [lid] +SMInfoRecord (SMIR) [lid] +.ft P +.fi +.UNINDENT +.UNINDENT +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -z +. +.INDENT 0.0 +.TP +.B \fB\-\-outstanding_smps, \-o <val>\fP +Specify the number of outstanding SMP\(aqs which should be issued during the scan +.sp +Default: 2 +.UNINDENT +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS COMMON FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SS DEPENDENCIES +.sp +OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad +.SS AUTHORS +.INDENT 0.0 +.TP +.B Ira Weiny +< \fI\%ira.weiny@intel.com\fP > +.TP +.B Hal Rosenstock +< \fI\%halr@mellanox.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/sminfo.8 b/contrib/ofed/infiniband-diags/man/sminfo.8 new file mode 100644 index 000000000000..1ab235ef8785 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/sminfo.8 @@ -0,0 +1,215 @@ +.\" Man page generated from reStructuredText. +. +.TH SMINFO 8 "" "" "Open IB Diagnostics" +.SH NAME +SMINFO \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY INFINIBAND SMINFO ATTRIBUTE +.SS SYNOPSIS +.sp +sminfo [options] sm_lid | sm_dr_path [modifier] +.SS DESCRIPTION +.sp +Optionally set and display the output of a sminfo query in human readable +format. The target SM is the one listed in the local port info, or the SM +specified by the optional SM lid or by the SM direct routed path. +.sp +Note: using sminfo for any purposes other then simple query may be very +dangerous, and may result in a malfunction of the target SM. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-s, \-\-state <state>\fP set SM state +0 not active +.sp +1 discovering +.sp +2 standby +.sp +3 master +.UNINDENT +.sp +\fB\-p, \-\-priority <priority>\fP set priority (0\-15) +.sp +\fB\-a, \-\-activity <val>\fP set activity count +.SS Addressing Flags +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SS EXAMPLES +.INDENT 0.0 +.TP +.B :: +sminfo # local port\(aqs sminfo +sminfo 32 # show sminfo of lid 32 +sminfo \-G 0x8f1040023 # same but using guid address +.UNINDENT +.SS SEE ALSO +.sp +smpdump (8) +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/smpdump.8 b/contrib/ofed/infiniband-diags/man/smpdump.8 new file mode 100644 index 000000000000..8225f6356592 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/smpdump.8 @@ -0,0 +1,207 @@ +.\" Man page generated from reStructuredText. +. +.TH SMPDUMP 8 "" "" "Open IB Diagnostics" +.SH NAME +SMPDUMP \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH DUMP INFINIBAND SUBNET MANAGEMENT ATTRIBUTES +.SS SYNOPSIS +.sp +smpdump [options] <dlid|dr_path> <attribute> [attribute_modifier] +.SS DESCRIPTION +.sp +smpdump is a general purpose SMP utility which gets SM attributes from a +specified SMA. The result is dumped in hex by default. +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fBdlid|drpath\fP +LID or DR path to SMA +.TP +.B \fBattribute\fP +IBA attribute ID for SM attribute +.TP +.B \fBattribute_modifier\fP +IBA modifier for SM attribute +.TP +.B \fB\-s, \-\-string\fP +Print strings in packet if possible +.UNINDENT +.SS Addressing Flags +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SS EXAMPLES +.sp +Direct Routed Examples +.INDENT 0.0 +.TP +.B :: +smpdump \-D 0,1,2,3,5 16 # NODE DESC +smpdump \-D 0,1,2 0x15 2 # PORT INFO, port 2 +.UNINDENT +.sp +LID Routed Examples +.INDENT 0.0 +.TP +.B :: +smpdump 3 0x15 2 # PORT INFO, lid 3 port 2 +smpdump 0xa0 0x11 # NODE INFO, lid 0xa0 +.UNINDENT +.SS SEE ALSO +.sp +smpquery (8) +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%halr@voltaire.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/smpquery.8 b/contrib/ofed/infiniband-diags/man/smpquery.8 new file mode 100644 index 000000000000..c4dd24fa2555 --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/smpquery.8 @@ -0,0 +1,310 @@ +.\" Man page generated from reStructuredText. +. +.TH SMPQUERY 8 "" "" "Open IB Diagnostics" +.SH NAME +SMPQUERY \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY INFINIBAND SUBNET MANAGEMENT ATTRIBUTES +.SS SYNOPSIS +.sp +smpquery [options] <op> <dest dr_path|lid|guid> [op params] +.SS DESCRIPTION +.sp +smpquery allows a basic subset of standard SMP queries including the following: +node info, node description, switch info, port info. Fields are displayed in +human readable format. +.SS OPTIONS +.sp +Current supported operations (case insensitive) and their parameters: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Nodeinfo (NI) <addr> + +Nodedesc (ND) <addr> + +Portinfo (PI) <addr> [<portnum>] # default port is zero + +PortInfoExtended (PIE) <addr> [<portnum>] + +Switchinfo (SI) <addr> + +PKeyTable (PKeys) <addr> [<portnum>] + +SL2VLTable (SL2VL) <addr> [<portnum>] + +VLArbitration (VLArb) <addr> [<portnum>] + +GUIDInfo (GI) <addr> + +MlnxExtPortInfo (MEPI) <addr> [<portnum>] # default port is zero +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \fB\-c, \-\-combined\fP +Use Combined route address argument \fB<lid> <DR_Path>\fP +.TP +.B \fB\-x, \-\-extended\fP +Set SMSupportsExtendedSpeeds bit 31 in AttributeModifier +(only impacts PortInfo queries). +.UNINDENT +.\" Define the common option -K +. +.INDENT 0.0 +.TP +.B \fB\-K, \-\-show_keys\fP +show security keys (mkey, smkey, etc.) associated with the request. +.UNINDENT +.SS Addressing Flags +.\" Define the common option -D for Directed routes +. +.sp +\fB\-D, \-\-Direct\fP The address specified is a directed route +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Examples: + [options] \-D [options] "0" # self port + [options] \-D [options] "0,1,2,1,4" # out via port 1, then 2, ... + + (Note the second number in the path specified must match the port being + used. This can be specified using the port selection flag \(aq\-P\(aq or the + port found through the automatic selection process.) +.ft P +.fi +.UNINDENT +.UNINDENT +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option --node-name-map +. +.sp +\fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map. +.INDENT 0.0 +.INDENT 3.5 +This file maps GUIDs to more user friendly names. See FILES section. +.UNINDENT +.UNINDENT +.\" Define the common option -y +. +.INDENT 0.0 +.TP +.B \fB\-y, \-\-m_key <key>\fP +use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq) +is specified then a value will be prompted for. +.UNINDENT +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.\" Common text to describe the node name map file. +. +.SS NODE NAME MAP FILE FORMAT +.sp +The node name map is used to specify user friendly names for nodes in the +output. GUIDs are used to perform the lookup. +.sp +This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP +for the file location for your installation. +.sp +\fBGenerically:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# comment +<guid> "<name>" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample:\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# IB1 +# Line cards +0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB\-24D" +0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB\-24D" + +# Spines +0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" +0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB\-12D" + +# GUID Node Name +0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D" +0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D" +.ft P +.fi +.UNINDENT +.UNINDENT +.SS EXAMPLES +.INDENT 0.0 +.TP +.B :: +smpquery portinfo 3 1 # portinfo by lid, with port modifier +smpquery \-G switchinfo 0x2C9000100D051 1 # switchinfo by guid +smpquery \-D nodeinfo 0 # nodeinfo by direct route +smpquery \-c nodeinfo 6 0,12 # nodeinfo by combined route +.UNINDENT +.SS SEE ALSO +.sp +smpdump (8) +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%hal@mellanox.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. diff --git a/contrib/ofed/infiniband-diags/man/vendstat.8 b/contrib/ofed/infiniband-diags/man/vendstat.8 new file mode 100644 index 000000000000..a9ede4d0eddd --- /dev/null +++ b/contrib/ofed/infiniband-diags/man/vendstat.8 @@ -0,0 +1,221 @@ +.\" Man page generated from reStructuredText. +. +.TH VENDSTAT 8 "" "" "Open IB Diagnostics" +.SH NAME +VENDSTAT \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH QUERY INFINIBAND VENDOR SPECIFIC FUNCTIONS +.SS SYNOPSIS +.sp +vendstat [options] <lid|guid> +.SS DESCRIPTION +.sp +vendstat uses vendor specific MADs to access beyond the IB spec +vendor specific functionality. Currently, there is support for +Mellanox InfiniSwitch\-III (IS3) and InfiniSwitch\-IV (IS4). +.SS OPTIONS +.INDENT 0.0 +.TP +.B \fB\-N\fP +show IS3 or IS4 general information. +.TP +.B \fB\-w\fP +show IS3 port xmit wait counters. +.TP +.B \fB\-i\fP +show IS4 counter group info. +.TP +.B \fB\-c <num,num>\fP +configure IS4 counter groups. +.sp +Configure IS4 counter groups 0 and 1. Such configuration is not +persistent across IS4 reboot. First number is for counter group 0 and +second is for counter group 1. +.sp +Group 0 counter config values: +.UNINDENT +.INDENT 0.0 +.TP +.B :: +.INDENT 7.0 +.INDENT 3.5 +0 \- PortXmitDataSL0\-7 +1 \- PortXmitDataSL8\-15 +2 \- PortRcvDataSL0\-7 +.UNINDENT +.UNINDENT +.sp +Group 1 counter config values: +.UNINDENT +.INDENT 0.0 +.TP +.B :: +1 \- PortXmitDataSL8\-15 +2 \- PortRcvDataSL0\-7 +8 \- PortRcvDataSL8\-15 +.TP +.B \fB\-R, \-\-Read <addr,mask>\fP +Read configuration space record at addr +.TP +.B \fB\-W, \-\-Write <addr,val,mask>\fP +Write configuration space record at addr +.TP +.B \fB\-\-dgid <gid>\fP +destination GID: use when GRH is required in packets (IPv6 format) +.UNINDENT +.SS Addressing Flags +.\" Define the common option -G +. +.sp +\fB\-G, \-\-Guid\fP The address specified is a Port GUID +.\" Define the common option -L +. +.sp +\fB\-L, \-\-Lid\fP The address specified is a LID +.\" Define the common option -s +. +.sp +\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries. +.SS Port Selection flags +.\" Define the common option -C +. +.sp +\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name. +.\" Define the common option -P +. +.sp +\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port. +.\" Explanation of local port selection +. +.SS Local port Selection +.sp +Multiple port/Multiple CA support: when no IB device or port is specified +(see the "local umad parameters" below), the libibumad library +selects the port to use by the following criteria: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +the first port that is ACTIVE. +.IP 2. 3 +if not found, the first port that is UP (physical link up). +.UNINDENT +.sp +If a port and/or CA name is specified, the libibumad library attempts +to fulfill the user request, and will fail if it is not possible. +.sp +For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ibaddr # use the first port (criteria #1 above) +ibaddr \-C mthca1 # pick the best port from "mthca1" only. +ibaddr \-P 2 # use the second (active/up) port from the first available IB device. +ibaddr \-C mthca0 \-P 2 # use the specified port only. +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Debugging flags +.\" Define the common option -d +. +.INDENT 0.0 +.TP +.B \-d +raise the IB debugging level. +May be used several times (\-ddd or \-d \-d \-d). +.UNINDENT +.\" Define the common option -e +. +.INDENT 0.0 +.TP +.B \-e +show send and receive errors (timeouts and others) +.UNINDENT +.\" Define the common option -h +. +.sp +\fB\-h, \-\-help\fP show the usage message +.\" Define the common option -v +. +.INDENT 0.0 +.TP +.B \fB\-v, \-\-verbose\fP +increase the application verbosity level. +May be used several times (\-vv or \-v \-v \-v) +.UNINDENT +.\" Define the common option -V +. +.sp +\fB\-V, \-\-version\fP show the version info. +.SS Configuration flags +.\" Define the common option -t +. +.sp +\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads. +.\" Define the common option -z +. +.sp +\fB\-\-config, \-z <config_file>\fP Specify alternate config file. +.INDENT 0.0 +.INDENT 3.5 +Default: /etc/infiniband-diags/ibdiag.conf +.UNINDENT +.UNINDENT +.SS FILES +.\" Common text for the config file +. +.SS CONFIG FILE +.sp +/etc/infiniband-diags/ibdiag.conf +.sp +A global config file is provided to set some of the common options for all +tools. See supplied config file for details. +.SS EXAMPLES +.INDENT 0.0 +.TP +.B :: +vendstat \-N 6 # read IS3 or IS4 general information +vendstat \-w 6 # read IS3 port xmit wait counters +vendstat \-i 6 12 # read IS4 port 12 counter group info +vendstat \-c 0,1 6 12 # configure IS4 port 12 counter groups for PortXmitDataSL +vendstat \-c 2,8 6 12 # configure IS4 port 12 counter groups for PortRcvDataSL +.UNINDENT +.SS AUTHOR +.INDENT 0.0 +.TP +.B Hal Rosenstock +< \fI\%hal.rosenstock@gmail.com\fP > +.UNINDENT +.\" Generated by docutils manpage writer. +. |