contrib/ofed/management/infiniband-diags/man/ibportstate.8

   1 .TH IBPORTSTATE 8 "October 19, 2006" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 ibportstate \- handle port (physical) state and link speed of an InfiniBand port
   5
   6 .SH SYNOPSIS
   7 .B ibportstate
   8 [\-d(ebug)] [\-e(rr_show)] [\-v(erbose)] [\-D(irect)] [\-G(uid)] [\-s smlid] [\-V(ersion)] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-h(elp)] <dest dr_path|lid|guid> <portnum> [<op>]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 ibportstate allows the port state and port physical state of an IB port
  13 to be queried (in addition to link width and speed being validated
  14 relative to the peer port when the port queried is a switch port),
  15 or a switch port to be disabled, enabled, or reset. It
  16 also allows the link speed enabled on any IB port to be adjusted.
  17
  18 .SH OPTIONS
  19
  20 .PP
  21 .TP
  22 op
  23 Port operations allowed
  24  supported ops: enable, disable, reset, speed, query
  25  Default is query
  26 .PP
  27  ops enable, disable, and reset are only allowed on switch ports
  28  (An error is indicated if attempted on CA or router ports)
  29  speed op is allowed on any port
  30  speed values are legal values for PortInfo:LinkSpeedEnabled
  31  (An error is indicated if PortInfo:LinkSpeedSupported does not support
  32   this setting)
  33  (NOTE: Speed changes are not effected until the port goes through
  34   link renegotiation)
  35  query also validates port characteristics (link width and speed)
  36   based on the peer port. This checking is done when the port
  37   queried is a switch port as it relies on combined routing
  38   (an initial LID route with directed routing to the peer) which
  39   can only be done on a switch. This peer port validation feature
  40   of query op requires LID routing to be functioning in the subnet.
  41
  42
  43 .SH COMMON OPTIONS
  44
  45 Most OpenIB diagnostics take the following common flags. The exact list of
  46 supported flags per utility can be found in the usage message and can be shown
  47 using the util_name -h syntax.
  48
  49 # Debugging flags
  50 .PP
  51 \-d      raise the IB debugging level.
  52         May be used several times (-ddd or -d -d -d).
  53 .PP
  54 \-e      show send and receive errors (timeouts and others)
  55 .PP
  56 \-h      show the usage message
  57 .PP
  58 \-v      increase the application verbosity level.
  59         May be used several times (-vv or -v -v -v)
  60 .PP
  61 \-V      show the version info.
  62
  63 # Addressing flags
  64 .PP
  65 \-D      use directed path address arguments. The path
  66         is a comma separated list of out ports.
  67         Examples:
  68         "0"             # self port
  69         "0,1,2,1,4"     # out via port 1, then 2, ...
  70 .PP
  71 \-G      use GUID address argument. In most cases, it is the Port GUID.
  72         Example:
  73         "0x08f1040023"
  74 .PP
  75 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  76
  77 # Other common flags:
  78 .PP
  79 \-C <ca_name>    use the specified ca_name.
  80 .PP
  81 \-P <ca_port>    use the specified ca_port.
  82 .PP
  83 \-t <timeout_ms> override the default timeout for the solicited mads.
  84
  85 Multiple CA/Multiple Port Support
  86
  87 When no IB device or port is specified, the port to use is selected
  88 by the following criteria:
  89 .PP
  90 1. the first port that is ACTIVE.
  91 .PP
  92 2. if not found, the first port that is UP (physical link up).
  93
  94 If a port and/or CA name is specified, the user request is
  95 attempted to be fulfilled, and will fail if it is not possible.
  96
  97 .SH EXAMPLES
  98
  99 .PP
 100 ibportstate 3 1 disable                 # by lid
 101 .PP
 102 ibportstate -G 0x2C9000100D051 1 enable # by guid
 103 .PP
 104 ibportstate -D 0 1                      # (query) by direct route
 105 .PP
 106 ibportstate 3 1 reset                           # by lid
 107 .PP
 108 ibportstate 3 1 speed 1                         # by lid
 109
 110 .SH AUTHOR
 111 .TP
 112 Hal Rosenstock
 113 .RI < halr@voltaire.com >