contrib/ofed/librdmacm/man/mckey.1

   1 .TH "MCKEY" 1 "2007-05-15" "librdmacm" "librdmacm" librdmacm
   2 .SH NAME
   3 mckey \- RDMA CM multicast setup and simple data transfer test.
   4 .SH SYNOPSIS
   5 .sp
   6 .nf
   7 \fImckey\fR -m multicast_address [-s] [-b bind_address] [-c connections]
   8                 [-C message_count] [-S message_size] [-p port_space]
   9 \fImckey\fR -m multicast_address -s [-b bind_address] [-c connections]
  10                 [-C message_count] [-S message_size] [-p port_space]
  11 \fImckey\fR -M unmapped_multicast_address -b bind_address [-s] [-c connections]
  12                 [-C message_count] [-S message_size] [-p port_space]
  13 .fi
  14 .SH "DESCRIPTION"
  15 Establishes a set of RDMA multicast communication paths between nodes
  16 using the librdmacm, optionally transfers datagrams to receiving nodes,
  17 then tears down the communication.
  18 .SH "OPTIONS"
  19 .TP
  20 \-m multicast_address
  21 IP multicast address to join.
  22 .TP
  23 \-M unmapped_multicast_address
  24 RDMA transport specific multicast address to join.
  25 .TP
  26 \-s
  27 Send datagrams to the multicast group.
  28 .TP
  29 \-b bind_address
  30 The local network address to bind to.
  31 .TP
  32 \-c connections
  33 The number of QPs to join the multicast group.  (default 1)
  34 .TP
  35 \-C message_count
  36 The number of messages to transfer over each connection.  (default 10)
  37 .TP
  38 \-S message_size
  39 The size of each message transferred, in bytes.  This value must be smaller
  40 than the MTU of the underlying RDMA transport, or an error will occur.
  41 (default 100)
  42 .TP
  43 \-p port_space
  44 The port space of the datagram communication.  May be either the RDMA
  45 UDP (0x0111) or IPoIB (0x0002) port space.  (default RDMA_PS_UDP)
  46 .SH "NOTES"
  47 Basic usage is to start mckey -m multicast_address on a server system,
  48 then run mckey -m multicast_address -s on a client system.
  49 .P
  50 Unique Infiniband SA assigned multicast GIDs can be retrived by
  51 invoking mckey with a zero MGID or IP address.  (Example, -M 0 or
  52 -m 0.0.0.0).  The assigned address will be displayed to allow
  53 mckey clients to join the created group.
  54 .P
  55 Because this test maps RDMA resources to userspace, users must ensure
  56 that they have available system resources and permissions.  See the
  57 libibverbs README file for additional details.
  58 .SH "SEE ALSO"
  59 rdma_cm(7), ucmatose(1), udaddy(1), rping(1)