nbd

Documentation

Overview

nbd provides methods for working with Network Block Devices. This relies on the nbd kernel module which can be checked for using the Ready() function.

Index

• Variables
• func ConnectImage(image string) (string, error)
• func DisconnectDevice(dev string) error
• func GetDevice() (string, error)
• func Modprobe() error
• func Ready() error

Variables

var (
	ErrNoDeviceAvailable = errors.New("no available nbds found")
)

var ExternalDependencies = []string{
	"lsmod",
	"modprobe",
	"qemu-nbd",
}

Functions

func ConnectImage

func ConnectImage(image string) (string, error)

ConnectImage exports a image using the NBD protocol using the qemu-nbd. If successful, returns the NBD device.

func DisconnectDevice

func DisconnectDevice(dev string) error

DisconnectDevice disconnects a given NBD using qemu-nbd.

func GetDevice

func GetDevice() (string, error)

GetDevice returns the first available NBD. If there are no devices available, returns ErrNoDeviceAvailable.

func Modprobe

func Modprobe() error

func Ready

func Ready() error

Ready checks to see if the NBD kernel module has been loaded. If it does not find the module, it returns an error. NBD functions should only be used after this function returns no error.