1IBPORTSTATE(8) Open IB Diagnostics IBPORTSTATE(8)
2
6 IBPORTSTATE - handle port (physical) state and link speed of an Infini‐
7 Band port
8
10 ibportstate [options] <dest dr_path|lid|guid> <portnum> [<op>]
11
13 ibportstate allows the port state and port physical state of an IB port
14 to be queried (in addition to link width and speed being validated rel‐
15 ative to the peer port when the port queried is a switch port), or a
16 switch port to be disabled, enabled, or reset. InfiniBand HCA port
17 state may be changed locally without the knowledge of the Subnet Man‐
18 ager. It also allows the link speed/width enabled on any IB port to be
19 adjusted.
20
22 <op>
23 Supported ops: enable, disable, reset, speed, espeed, fdr10,
25 width, query,
26 on, off, down, arm, active, vls, mtu, lid, smlid, lmc,
27 mkey, mkeylease, mkeyprot (Default is query)
28 enable, disable, and reset change or reset a switch or HCA port
30 state (You must specify the CA name and Port number when locally
31 change CA port state.)
32 off change the port state to disable.
34 on change the port state to enable(only when the current state
36 is disable).
37 speed and width are allowed on any port
39 speed values are the legal values for PortInfo:LinkSpeedEnabled
41 (An error is indicated if PortInfo:LinkSpeedSupported does not
42 support this setting)
43 espeed is allowed on any port supporting extended link speeds
45 fdr10 is allowed on any port supporting fdr10 (An error is indi‐
47 cated if port's capability mask indicates extended link speeds
48 are not supported or if PortInfo:LinkSpeedExtSupported does not
49 support this setting)
50 width values are legal values for PortInfo:LinkWidthEnabled (An
52 error is indicated if PortInfo:LinkWidthSupported does not sup‐
53 port this setting) (NOTE: Speed and width changes are not
54 effected until the port goes through link renegotiation)
55 query also validates port characteristics (link width, speed,
57 espeed, and fdr10) based on the peer port. This checking is done
58 when the port queried is a switch port as it relies on combined
59 routing (an initial LID route with directed routing to the peer)
60 which can only be done on a switch. This peer port validation
61 feature of query op requires LID routing to be functioning in
62 the subnet.
63 mkey, mkeylease, and mkeyprot are only allowed on CAs, routers,
65 or switch port 0 (An error is generated if attempted on external
66 switch ports). Hexadecimal and octal mkeys may be specified by
67 prepending the key with '0x' or '0', respectively. If a
68 non-numeric value (like 'x') is specified for the mkey, then
69 ibportstate will prompt for a value.
70 Addressing Flags
72 -L, --Lid The address specified is a LID
73 -G, --Guid The address specified is a Port GUID
75 -D, --Direct The address specified is a directed route
77 Examples:
79 [options] -D [options] "0" # self port
80 [options] -D [options] "0,1,2,1,4" # out via port 1, then 2, ...
81 (Note the second number in the path specified must match the port being
83 used. This can be specified using the port selection flag '-P' or the
84 port found through the automatic selection process.)
85 -s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.
87 Port Selection flags
89 -C, --Ca <ca_name> use the specified ca_name.
90 -P, --Port <ca_port> use the specified ca_port.
92 Local port Selection
94 Multiple port/Multiple CA support: when no IB device or port is speci‐
95 fied (see the "local umad parameters" below), the libibumad library
96 selects the port to use by the following criteria:
97 1. the first port that is ACTIVE.
99 2. if not found, the first port that is UP (physical link up).
101 If a port and/or CA name is specified, the libibumad library
103 attempts to fulfill the user request, and will fail if it is not
104 possible.
105 For example:
107 ibaddr # use the first port (criteria #1 above)
109 ibaddr -C mthca1 # pick the best port from "mthca1" only.
110 ibaddr -P 2 # use the second (active/up) port from the first available IB device.
111 ibaddr -C mthca0 -P 2 # use the specified port only.
112 Configuration flags
114 --config, -z <config_file> Specify alternate config file.
115 Default: /etc/infiniband-diags/ibdiag.conf
116 -t, --timeout <timeout_ms> override the default timeout for the
118 solicited mads.
119 -y, --m_key <key>
121 use the specified M_key for requests. If non-numeric value (like
122 'x') is specified then a value will be prompted for.
123 Debugging flags
125 -h, --help show the usage message
126 -d raise the IB debugging level. May be used several times (-ddd
128 or -d -d -d).
129 -e show send and receive errors (timeouts and others)
131 -K, --show_keys
133 show security keys (mkey, smkey, etc.) associated with the
134 request.
135 -v, --verbose
137 increase the application verbosity level. May be used several
138 times (-vv or -v -v -v)
139 -V, --version show the version info.
141
143 CONFIG FILE
144 /etc/infiniband-diags/ibdiag.conf
145 A global config file is provided to set some of the common options for
147 all tools. See supplied config file for details.
148
150 :: ibportstate -C qib0 -P 1 3 1 disable # by CA name, CA Port
151 Number, lid, physical port number ibportstate -C qib0 -P 1 3 1
152 enable # by CA name, CA Port Number, lid, physical port
153 number ibportstate -D 0 1 # (query) by
154 direct route ibportstate 3 1 reset # by lid
155 ibportstate 3 1 speed 1 # by lid ibportstate 3
156 1 width 1 # by lid ibportstate -D 0 1 lid
157 0x1234 arm # by direct route
158
160 Hal Rosenstock
161 < hal.rosenstock@gmail.com >
162 2013-03-26 IBPORTSTATE(8)