X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qemu-nbd.texi;h=9a84e81eed9c82a7bc62451151659366f79c20db;hb=b4053c64833762f1249b2d704d2da30b5b10c8ff;hp=a56ebc34337a85c62f0f3377f0ea49161abf3376;hpb=0ab3b3375b362e4ea53714e8448eaf60d311daac;p=mirror_qemu.git diff --git a/qemu-nbd.texi b/qemu-nbd.texi index a56ebc3433..9a84e81eed 100644 --- a/qemu-nbd.texi +++ b/qemu-nbd.texi @@ -13,7 +13,8 @@ Export a QEMU disk image using the NBD protocol. @c man end @c man begin OPTIONS -@var{filename} is a disk image filename. +@var{filename} is a disk image filename, or a set of block +driver options if @var{--image-opts} is specified. @var{dev} is an NBD device. @@ -21,9 +22,10 @@ Export a QEMU disk image using the NBD protocol. @item --object type,id=@var{id},...props... Define a new instance of the @var{type} object class identified by @var{id}. See the @code{qemu(1)} manual page for full details of the properties -supported. The common object type that it makes sense to define is the +supported. The common object types that it makes sense to define are the @code{secret} object, which is used to supply passwords and/or encryption -keys. +keys, and the @code{tls-creds} object, which is used to supply TLS +credentials for the qemu-nbd server. @item -p, --port=@var{port} The TCP port to listen on (default @samp{10809}) @item -o, --offset=@var{offset} @@ -32,6 +34,10 @@ The offset into the image The interface to bind to (default @samp{0.0.0.0}) @item -k, --socket=@var{path} Use a unix socket with path @var{path} +@item --image-opts +Treat @var{filename} as a set of image options, instead of a plain +filename. If this flag is specified, the @var{-f} flag should +not be used, instead the '@code{format=}' option should be set. @item -f, --format=@var{fmt} Force the use of the block driver for format @var{fmt} instead of auto-detecting @@ -73,12 +79,27 @@ Disconnect the device @var{dev} Allow up to @var{num} clients to share the device (default @samp{1}) @item -t, --persistent Don't exit on the last connection +@item -x, --export-name=@var{name} +Set the NBD volume export name. This switches the server to use +the new style NBD protocol negotiation +@item -D, --description=@var{description} +Set the NBD volume export description, as a human-readable +string. Requires the use of @option{-x} +@item --tls-creds=ID +Enable mandatory TLS encryption for the server by setting the ID +of the TLS credentials object previously created with the --object +option. +@item --fork +Fork off the server process and exit the parent once the server is running. @item -v, --verbose Display extra debugging information @item -h, --help Display this help and exit @item -V, --version Display version information and exit +@item -T, --trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}] +@findex --trace +@include qemu-option-trace.texi @end table @c man end