summaryrefslogtreecommitdiffstats
path: root/contrib/ofed/management/infiniband-diags/man/smpdump.8
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/ofed/management/infiniband-diags/man/smpdump.8')
-rw-r--r--contrib/ofed/management/infiniband-diags/man/smpdump.898
1 files changed, 98 insertions, 0 deletions
diff --git a/contrib/ofed/management/infiniband-diags/man/smpdump.8 b/contrib/ofed/management/infiniband-diags/man/smpdump.8
new file mode 100644
index 0000000..2a08753
--- /dev/null
+++ b/contrib/ofed/management/infiniband-diags/man/smpdump.8
@@ -0,0 +1,98 @@
+.TH SMPDUMP 8 "July 25, 2006" "OpenIB" "OpenIB Diagnostics"
+
+.SH NAME
+smpdump \- dump InfiniBand subnet management attributes
+
+.SH SYNOPSIS
+.B smpdump
+[\-s(ring)] [\-D(irect)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-h(elp)] <dlid|dr_path> <attr> [mod]
+
+.SH DESCRIPTION
+.PP
+smpdump is a general purpose SMP utility which gets SM attributes from a
+specified SMA. The result is dumped in hex by default.
+
+.SH OPTIONS
+
+.TP
+attr
+IBA attribute ID for SM attribute
+.TP
+mod
+IBA modifier for SM attribute
+
+.SH COMMON OPTIONS
+
+Most OpenIB diagnostics take the following common flags. The exact list of
+supported flags per utility can be found in the usage message and can be shown
+using the util_name -h syntax.
+
+# Debugging flags
+.PP
+\-d raise the IB debugging level.
+ May be used several times (-ddd or -d -d -d).
+.PP
+\-e show send and receive errors (timeouts and others)
+.PP
+\-h show the usage message
+.PP
+\-v increase the application verbosity level.
+ May be used several times (-vv or -v -v -v)
+.PP
+\-V show the version info.
+
+# Addressing flags
+.PP
+\-D use directed path address arguments. The path
+ is a comma separated list of out ports.
+ Examples:
+ "0" # self port
+ "0,1,2,1,4" # out via port 1, then 2, ...
+.PP
+\-G use GUID address argument. In most cases, it is the Port GUID.
+ Example:
+ "0x08f1040023"
+.PP
+\-s <smlid> use 'smlid' as the target lid for SM/SA queries.
+
+# Other common flags:
+.PP
+\-C <ca_name> use the specified ca_name.
+.PP
+\-P <ca_port> use the specified ca_port.
+.PP
+\-t <timeout_ms> override the default timeout for the solicited mads.
+
+Multiple CA/Multiple Port Support
+
+When no IB device or port is specified, the port to use is selected
+by the following criteria:
+.PP
+1. the first port that is ACTIVE.
+.PP
+2. if not found, the first port that is UP (physical link up).
+
+If a port and/or CA name is specified, the user request is
+attempted to be fulfilled, and will fail if it is not possible.
+
+.SH EXAMPLES
+
+Direct Routed Examples
+.PP
+smpdump -D 0,1,2,3,5 16 # NODE DESC
+.PP
+smpdump -D 0,1,2 0x15 2 # PORT INFO, port 2
+
+LID Routed Examples
+.PP
+smpdump 3 0x15 2 # PORT INFO, lid 3 port 2
+.PP
+smpdump 0xa0 0x11 # NODE INFO, lid 0xa0
+
+.SH SEE ALSO
+.BR smpquery (8)
+
+.SH AUTHOR
+.TP
+Hal Rosenstock
+.RI < halr@voltaire.com >
OpenPOWER on IntegriCloud