1IBPORTSTATE(8)                Open IB Diagnostics               IBPORTSTATE(8)
2
3
4

NAME

6       IBPORTSTATE - handle port (physical) state and link speed of an Infini‐
7       Band port
8

SYNOPSIS

10       ibportstate [options] <dest dr_path|lid|guid> <portnum> [<op>]
11

DESCRIPTION

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. It also allows the link
17       speed/width enabled on any IB port to be adjusted.
18

OPTIONS

20       <op>
21
22              Supported ops: enable, disable,  reset,  speed,  espeed,  fdr10,
23              width, query,
24                     on,  off,  down,  arm, active, vls, mtu, lid, smlid, lmc,
25                     mkey, mkeylease, mkeyprot (Default is query)
26
27              enable, disable, and reset are only allowed on switch ports  (An
28              error is indicated if attempted on CA or router ports)
29
30              off change the port state to disable.
31
32              on  change  the port state to enable(only when the current state
33              is disable).
34
35              speed and width are allowed on any port
36
37              speed values are the legal values for  PortInfo:LinkSpeedEnabled
38              (An  error  is indicated if PortInfo:LinkSpeedSupported does not
39              support this setting)
40
41              espeed is allowed on any port supporting extended link speeds
42
43              fdr10 is allowed on any port supporting fdr10 (An error is indi‐
44              cated  if  port's capability mask indicates extended link speeds
45              are not supported or if PortInfo:LinkSpeedExtSupported does  not
46              support this setting)
47
48              width  values are legal values for PortInfo:LinkWidthEnabled (An
49              error is indicated if PortInfo:LinkWidthSupported does not  sup‐
50              port  this  setting)  (NOTE:  Speed  and  width  changes are not
51              effected until the port goes through link renegotiation)
52
53              query also validates port characteristics  (link  width,  speed,
54              espeed, and fdr10) based on the peer port. This checking is done
55              when the port queried is a switch port as it relies on  combined
56              routing (an initial LID route with directed routing to the peer)
57              which can only be done on a switch. This  peer  port  validation
58              feature  of  query  op requires LID routing to be functioning in
59              the subnet.
60
61              mkey, mkeylease, and mkeyprot are only allowed on CAs,  routers,
62              or switch port 0 (An error is generated if attempted on external
63              switch ports).  Hexadecimal and octal mkeys may be specified  by
64              prepending  the  key  with  '0x'  or  '0',  respectively.   If a
65              non-numeric value (like 'x') is specified  for  the  mkey,  then
66              ibportstate will prompt for a value.
67
68   Addressing Flags
69       -L, --Lid   The address specified is a LID
70
71       -G, --Guid     The address specified is a Port GUID
72
73       -D, --Direct     The address specified is a directed route
74
75          Examples:
76             [options] -D [options] "0"          # self port
77             [options] -D [options] "0,1,2,1,4"  # out via port 1, then 2, ...
78
79             (Note the second number in the path specified must match the port being
80             used.  This can be specified using the port selection flag '-P' or the
81             port found through the automatic selection process.)
82
83       -s, --sm_port <smlid>     use 'smlid' as the target lid for SA queries.
84
85   Port Selection flags
86       -C, --Ca <ca_name>    use the specified ca_name.
87
88       -P, --Port <ca_port>    use the specified ca_port.
89
90   Local port Selection
91       Multiple  port/Multiple CA support: when no IB device or port is speci‐
92       fied (see the "local umad parameters"  below),  the  libibumad  library
93       selects the port to use by the following criteria:
94
95          1. the first port that is ACTIVE.
96
97          2. if not found, the first port that is UP (physical link up).
98
99          If  a  port  and/or  CA  name  is  specified,  the libibumad library
100          attempts to fulfill the user request, and will fail  if  it  is  not
101          possible.
102
103          For example:
104
105              ibaddr                 # use the first port (criteria #1 above)
106              ibaddr -C mthca1       # pick the best port from "mthca1" only.
107              ibaddr -P 2            # use the second (active/up) port from the first available IB device.
108              ibaddr -C mthca0 -P 2  # use the specified port only.
109
110   Configuration flags
111       --config, -z  <config_file> Specify alternate config file.
112          Default: /etc/infiniband-diags/ibdiag.conf
113
114       -t,  --timeout  <timeout_ms>  override  the  default  timeout  for  the
115       solicited mads.
116
117       -y, --m_key <key>
118              use the specified M_key for requests. If non-numeric value (like
119              'x') is specified then a value will be prompted for.
120
121   Debugging flags
122       -h, --help      show the usage message
123
124       -d     raise  the  IB debugging level.  May be used several times (-ddd
125              or -d -d -d).
126
127       -e     show send and receive errors (timeouts and others)
128
129       -K, --show_keys
130              show security keys  (mkey,  smkey,  etc.)  associated  with  the
131              request.
132
133       -v, --verbose
134              increase  the  application verbosity level.  May be used several
135              times (-vv or -v -v -v)
136
137       -V, --version     show the version info.
138

FILES

140   CONFIG FILE
141       /etc/infiniband-diags/ibdiag.conf
142
143       A global config file is provided to set some of the common options  for
144       all tools.  See supplied config file for details.
145

EXAMPLES

147       ::     ibportstate 3 1 disable                  # by lid ibportstate -G
148              0x2C9000100D051  1  enable   #  by  guid  ibportstate  -D  0   1
149              #    (query)   by   direct   route   ibportstate   3   1   reset
150              # by lid ibportstate 3  1  speed  1                   #  by  lid
151              ibportstate 3 1 width 1                  # by lid ibportstate -D
152              0 1 lid 0x1234 arm        # by direct route
153

AUTHOR

155       Hal Rosenstock
156              < hal.rosenstock@gmail.com >
157
158
159
160
161                                                                IBPORTSTATE(8)
Impressum