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

   1 .TH IBPING 8 "August 11, 2006" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 ibping \- ping an InfiniBand address
   5
   6 .SH SYNOPSIS
   7 .B ibping
   8 [\-d(ebug)] [\-e(rr_show)] [\-v(erbose)] [\-G(uid)] [\-C ca_name] [\-P ca_port] [\-s smlid] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-c ping_count] [\-f(lood)] [\-o oui] [\-S(erver)] [\-h(elp)] <dest lid | guid>
   9
  10 .SH DESCRIPTION
  11 .PP
  12 ibping uses vendor mads to validate connectivity between IB nodes.
  13 On exit, (IP) ping like output is show. ibping is run as client/server.
  14 Default is to run as client. Note also that a default ping server is
  15 implemented within the kernel.
  16
  17 .SH OPTIONS
  18
  19 .PP
  20 .TP
  21 \fB\-c\fR
  22 stop after count packets
  23 .TP
  24 \fB\-f\fR, \fB\-\-flood\fR
  25 flood destination: send packets back to back without delay
  26 .TP
  27 \fB\-o\fR, \fB\-\-oui\fR
  28 use specified OUI number to multiplex vendor mads
  29 .TP
  30 \fB\-S\fR, \fB\-\-Server\fR
  31 start in server mode (do not return)
  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 \-G      use GUID address argument. In most cases, it is the Port GUID.
  56         Example:
  57         "0x08f1040023"
  58 .PP
  59 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  60
  61 # Other common flags:
  62 .PP
  63 \-C <ca_name>    use the specified ca_name.
  64 .PP
  65 \-P <ca_port>    use the specified ca_port.
  66 .PP
  67 \-t <timeout_ms> override the default timeout for the solicited mads.
  68
  69 Multiple CA/Multiple Port Support
  70
  71 When no IB device or port is specified, the port to use is selected
  72 by the following criteria:
  73 .PP
  74 1. the first port that is ACTIVE.
  75 .PP
  76 2. if not found, the first port that is UP (physical link up).
  77
  78 If a port and/or CA name is specified, the user request is
  79 attempted to be fulfilled, and will fail if it is not possible.
  80
  81 .SH AUTHOR
  82 .TP
  83 Hal Rosenstock
  84 .RI < halr@voltaire.com >