vblade(8)

๐Ÿ“ฆ
version 25 ยท 2 versions
, in alpine 3.24, debian bookworm, ubuntu jammy, ubuntu noble

๐Ÿ’– vblade(8) โ€” bestie's guide to ATA over Ethernet ๐Ÿ’–

okay so. you're in the System Manager's Manual section of the man pages, page vblade(8), and you're about to learn how to make a whole entire disk just... appear on your network like magic. no cap. let's go. ๐Ÿฆ‹


โœจ NAME โœจ

vblade, vbladed โ€” export data via ATA over Ethernet

๐ŸŒธ SYNOPSIS ๐ŸŒธ

vblade [ -m mac[,mac...] ] shelf slot netif filename

๐Ÿ’… DESCRIPTION ๐Ÿ’…

So vblade starts up a process that uses raw sockets to do ATA over Ethernet, which is giving virtual EtherDrive (R) blade energy. it literally pretends to be a hardware drive. iconic behavior honestly. ๐Ÿ‘‘

and then there's vbladed, which is the little script that daemonizes the vblade process for you โ€” it detaches from your terminal and sends all its output to the system logs. so your drive just chills in the background doing its thing. main character energy but make it quiet. ๐Ÿคซ


๐ŸŽ€ Arguments ๐ŸŽ€

  • shelf โ€” this is the shelf address (the major AoE address) of the AoE device you're creating. it's like the shelf your lil drive sits on.
  • slot โ€” this is the slot address (the minor AoE address) of the AoE device you're creating. the specific lil cubby on that shelf.
  • netif โ€” the name of the ethernet network interface you want to use for AoE communications.
  • filename โ€” the name of the regular file or block device you're exporting. this is the actual thing being shared, bestie.

๐ŸŒˆ Options ๐ŸŒˆ

  • -b โ€” takes an argument, the advertised buffer count, which specifies the max number of outstanding messages the server can queue up for processing. queue management fr fr.
  • -d โ€” selects O_DIRECT mode for accessing the underlying block device.
  • -s โ€” selects O_SYNC mode for accessing the underlying block device, so every single write is committed to disk before returning to the client. no take-backsies.
  • -r โ€” restricts the export of the device to be read-only. look, don't touch. ๐Ÿ™ˆ
  • -m โ€” takes an argument: a comma separated list of MAC addresses permitted access to the vblade. a MAC address can be given in upper or lower case, with or without colons. picky? no, flexible. ๐Ÿ’…
  • -o โ€” takes an argument: the number of sectors at the beginning of the exported file that are excluded from AoE export. default is zero.
  • -l โ€” takes an argument: the number of sectors to export. defaults to the file size in sectors minus the offset.

๐Ÿ”ฅ EXAMPLE ๐Ÿ”ฅ

in this example, the root user on a host named nai exports a file named "3TB" to the LAN on eth0 using AoE shelf address 11 and slot address 1. the process runs in the foreground. if you'd used vbladed instead, the process would have been running as a daemon in the background. โœจ

nai:~# vblade 11 1 eth0 /data/3TB

๐Ÿ’€ NOTES AND WARNINGS ๐Ÿ’€

if you're a Jumbo frames user, go read the README file that ships with vblade to learn about a workaround for kernel buffering limitations. it's important, bestie, don't skip it. ๐Ÿ“–
at least one AoE initiator (WinAoE) has been found to enforce legacy CHS geometry for drives by discarding sectors. so if you encounter filesystem corruption, you should make sure the underlying regular file or block device size is a multiple of 8225280 bytes โ€” that's 255 heads, 63 sectors/track, 512 bytes/sector. do the math, protect your data. ๐Ÿงฎ

๐Ÿ˜ญ REPORTING BUGS ๐Ÿ˜ญ

please report bugs to the aoetools-discuss mailing list. they wanna hear from you, fr fr.


๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Brantley Coile (brantley@coraid.com)


and that's the whole page, bestie โ€” vblade(8), from the System Manager's Manual, wrapped up like the little bow it is. ๐ŸŽ€ go forth and export some blocks. slay. ๐Ÿ’–

๐Ÿ“ฆ where this page comes from