nbdkit-nfs-plugin(1)

📦
version 1.48.1 · 4 versions
, in fedora 44

✨ nbdkit-nfs-plugin 💅

okay bestie, so this is a page from the nbdkit manual, and it's all about nbdkit-nfs-plugin — the plugin that lets you vibe with a disk image living on a Network File Server. NFS girlies, this one's for you 🫶

🌸 NAME 🌸

nbdkit-nfs-plugin — use disk image on Network File Server

🎀 SYNOPSIS 🎀

nbdkit nfs [uri=]URI [readonly=true]

nbdkit nfs --dump-plugin

💖 DESCRIPTION 💖

so nbdkit-nfs-plugin is a plugin for nbdkit(1) and what it does is mount a disk image that lives on a Network File Server (NFS) and then expose it for read and write over the NBD protocol. it uses libnfs under the hood. iconic behaviour tbh ✨

the only required parameter is the RFC-2224 NFS URI. here's a lil example for you:

nbdkit nfs 'nfs://server/mnt/disk.img?version=4'
⚠️ real talk: when you use this plugin, you may have to run nbdkit as root if the NFS server requires the NFS client to be using a privileged port — that's the so-called "secure" option in /etc/exports. no cap, check your exports file first 🙈

🦋 PARAMETERS 🦋

  • readonly=true — open the NFS file read-only. simple as that 💅
  • [uri=]URI — the RFC 2224-compliant URI of the NFS server, mountpoint and filename. you can add other query parameters to control features like timeouts and reconnections. for the deets, go look at https://github.com/sahlberg/libnfs 👑

also, the uri= prefix may be omitted in most cases. see "Magic parameters" in nbdkit(1). iykyk ✨

🌈 DUMP PLUGIN OUTPUT 🌈

nbdkit nfs --dump-plugin

this shows you:

🔥 DEBUGGING 🔥

want libnfs debugging? say less. you can either use the nbdkit debugging flag -D nfs.debug=9 or add debug=9 to the end of the URI. two paths, same destiny:

nbdkit -f -v nfs 'nfs://...' -D nfs.debug=9

nbdkit -f -v nfs 'nfs://...&debug=9'

🍓 FILES 🍓

  • $plugindir/nbdkit-nfs-plugin.so — the plugin. that's the one. 🎀

use nbdkit --dump-config to find the location of $plugindir. go find it bestie, it's out there somewhere 🧚

⭐ VERSION ⭐

nbdkit-nfs-plugin first appeared in nbdkit 1.44. baby plugin, but she's growing 🌱

👑 SEE ALSO 👑

nbdkit(1), nbdkit-plugin(3), nbdkit-curl-plugin(1), nbdkit-file-plugin(1), nbdkit-ssh-plugin(1), exports(5), nfs(5), https://github.com/sahlberg/libnfs.

💜 AUTHORS 💜

Richard W.M. Jones

Copyright Red Hat

💅 LICENSE 💅

okay so redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met — periodt:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. ✅
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. ✅
  • Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. ✅
😭 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the whole page, bestie!! 🌈✨ this lil slice of the nbdkit manual is from nbdkit-1.48.1, dated 2026-08-29, and it's the nbdkit-nfs-plugin(1) page 💖 go mount something iconic 🦋💅

📦 where this page comes from