]> CyberLeo.Net >> Repos - FreeBSD/releng/9.2.git/blob - contrib/ofed/management/infiniband-diags/man/ibaddr.8
- Copy stable/9 to releng/9.2 as part of the 9.2-RELEASE cycle.
[FreeBSD/releng/9.2.git] / contrib / ofed / management / infiniband-diags / man / ibaddr.8
1 .TH IBADDR 8 "June 18, 2007" "OpenIB" "OpenIB Diagnostics"
2
3 .SH NAME
4 ibaddr \- query InfiniBand address(es)
5
6 .SH SYNOPSIS
7 .B ibaddr
8 [\-d(ebug)] [\-D(irect)] [\-G(uid)] [\-l(id_show)] [\-g(id_show)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-h(elp)] [<lid | dr_path | guid>]
9
10 .SH DESCRIPTION
11 .PP
12 Display the lid (and range) as well as the GID address of the
13 port specified (by DR path, lid, or GUID) or the local port by default.
14 .PP
15 Note: this utility can be used as simple address resolver.
16
17 .SH OPTIONS
18
19 .PP
20 .TP
21 \fB\-G\fR, \fB\-\-Guid\fR
22 show lid range and gid for GUID address
23 .TP
24 \fB\-l\fR, \fB\-\-lid_show\fR
25 show lid range only
26 .TP
27 \fB\-L\fR, \fB\-\-Lid_show\fR
28 show lid range (in decimal) only
29 .TP
30 \fB\-g\fR, \fB\-\-gid_show\fR
31 show gid address only
32
33 .SH COMMON OPTIONS
34
35 Most OpenIB diagnostics take the following common flags. The exact list of
36 supported flags per utility can be found in the usage message and can be shown
37 using the util_name -h syntax.
38
39 # Debugging flags
40 .PP
41 \-d      raise the IB debugging level.
42         May be used several times (-ddd or -d -d -d).
43 .PP
44 \-e      show send and receive errors (timeouts and others)
45 .PP
46 \-h      show the usage message
47 .PP
48 \-v      increase the application verbosity level.
49         May be used several times (-vv or -v -v -v)
50 .PP
51 \-V      show the version info.
52
53 # Addressing flags
54 .PP
55 \-D      use directed path address arguments. The path
56         is a comma separated list of out ports.
57         Examples:
58         "0"             # self port
59         "0,1,2,1,4"     # out via port 1, then 2, ...
60 .PP
61 \-G      use GUID address argument. In most cases, it is the Port GUID.
62         Example:
63         "0x08f1040023"
64 .PP
65 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
66
67 # Other common flags:
68 .PP
69 \-C <ca_name>    use the specified ca_name.
70 .PP
71 \-P <ca_port>    use the specified ca_port.
72 .PP
73 \-t <timeout_ms> override the default timeout for the solicited mads.
74
75 Multiple CA/Multiple Port Support
76
77 When no IB device or port is specified, the port to use is selected
78 by the following criteria:
79 .PP
80 1. the first port that is ACTIVE.
81 .PP
82 2. if not found, the first port that is UP (physical link up).
83
84 If a port and/or CA name is specified, the user request is
85 attempted to be fulfilled, and will fail if it is not possible.
86
87 .SH EXAMPLES
88
89 .PP
90 ibaddr                  # local port\'s address
91 .PP
92 ibaddr 32               # show lid range and gid of lid 32
93 .PP
94 ibaddr -G 0x8f1040023   # same but using guid address
95 .PP
96 ibaddr -l 32            # show lid range only
97 .PP
98 ibaddr -L 32            # show decimal lid range only
99 .PP
100 ibaddr -g 32            # show gid address only
101
102 .SH SEE ALSO
103 .BR ibroute (8),
104 .BR ibtracert (8)
105
106 .SH AUTHOR
107 .TP
108 Hal Rosenstock
109 .RI < halr@voltaire.com >