vblade.8 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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-m\fP
  38. The -m flag takes an argument, a comma separated list of MAC addresses
  39. permitted access to the vblade. A MAC address can be specified in upper
  40. or lower case, with or without colons.
  41. .SH EXAMPLE
  42. In this example, the root user on a host named
  43. .I nai
  44. exports a file named "3TB" to the LAN on eth0 using AoE shelf address 11
  45. and slot address 1. The process runs in the foreground. Using
  46. .I vbladed
  47. would have resulted in the process running as a daemon in the
  48. background.
  49. .IP
  50. .EX
  51. .nf
  52. nai:~# vblade 11 1 eth0 /data/3TB
  53. .fi
  54. .EE
  55. .SH BUGS
  56. Users of Jumbo frames should read the README file distributed with
  57. vblade to learn about a workaround for kernel buffering limitations.
  58. .SH AUTHOR
  59. Brantley Coile (brantley@coraid.com)