VBLADE/vblade-master/vblade.8

   1 .TH vblade 8
   2 .SH NAME
   3 vblade, vbladed \- export data via ATA over Ethernet
   4 .SH SYNOPSIS
   5 .nf
   6 .B vblade [ -m mac[,mac...] ] shelf slot netif filename
   7 .fi
   8 .SH DESCRIPTION
   9 The
  10 .I vblade
  11 command starts a process that uses raw sockets to perform ATA over
  12 Ethernet, acting like a virtual EtherDrive (R) blade.
  13 .PP
  14 The
  15 .I vbladed
  16 script can be used to daemonize the vblade process,
  17 detaching it from your terminal and sending its output to the system
  18 logs.
  19 .SS Arguments
  20 .TP
  21 \fBshelf\fP
  22 This should be the shelf address (major AoE address) of the AoE device
  23 to create.
  24 .TP
  25 \fBslot\fP
  26 This should be the slot address (minor AoE address) of the AoE device
  27 to create.
  28 .TP
  29 \fBnetif\fP
  30 The name of the ethernet network interface to use for AoE
  31 communications.
  32 .TP
  33 \fBfilename\fP
  34 The name of the regular file or block device to export.
  35 .SS Options
  36 .TP
  37 \fB-b\fP
  38 The \-b flag takes an argument, the advertised buffer count, specifying
  39 the maximum number of outstanding messages the server can queue for
  40 processing.
  41 .TP
  42 \fB-d\fP
  43 The \-d flag selects O_DIRECT mode for accessing the underlying block
  44 device.
  45 .TP
  46 \fB-s\fP
  47 The \-s flag selects O_SYNC mode for accessing the underlying block
  48 device, so all writes are committed to disk before returning to the
  49 client.
  50 .TP
  51 \fB-r\fP
  52 The \-r flag restricts the export of the device to be read-only.
  53 .TP
  54 \fB-m\fP
  55 The \-m flag takes an argument, a comma separated list of MAC addresses
  56 permitted access to the vblade.  A MAC address can be specified in upper
  57 or lower case, with or without colons.
  58 .TP
  59 \fB-o\fP
  60 The \-o flag takes an argument, the number of sectors at the beginning
  61 of the exported file that are excluded from AoE export (default zero).
  62 .TP
  63 \fB-l\fP
  64 The \-l flag takes an argument, the number of sectors to export.
  65 Defaults to the file size in sectors minus the offset.
  66 .SH EXAMPLE
  67 In this example, the root user on a host named
  68 .I nai
  69 exports a file named "3TB" to the LAN on eth0 using AoE shelf address 11
  70 and slot address 1.  The process runs in the foreground.  Using
  71 .I vbladed
  72 would have resulted in the process running as a daemon in the
  73 background.
  74 .IP
  75 .EX
  76 .nf
  77 nai:~# vblade 11 1 eth0 /data/3TB
  78 .fi
  79 .EE
  80 .SH NOTES AND WARNINGS
  81 Users of Jumbo frames should read the README file distributed with
  82 .I vblade
  83 to learn about a workaround for kernel buffering limitations.
  84 .PP
  85 At least one AoE initiator (WinAoE) has been found to enforce legacy
  86 CHS geometry for drives by discarding sectors. You should ensure that
  87 the underlaying regular file or block device size is a multiple of
  88 8225280 bytes (255 heads, 63 sectors/track, 512 bytes/sector) if you
  89 encounter filesystem corruption.
  90 .SH REPORTING BUGS
  91 Please report bugs to the aoetools-discuss mailing list.
  92 .SH AUTHOR
  93 Brantley Coile (brantley@coraid.com)