nbd-cli man page

nbd-cli

Description

nbd-cli is a cli utility, which aims at making backstore creation/deletion/mapping/unmaping/listing.

Synopsis

nbd-cli [OPTION] [COMMAND [OPTIONS]]

Nbd-CLI Options

gluster help

Display help for gluster commands

azblk help

Display help for azblk commands

ceph help [TODO]

Display help for ceph commands

global help [TODO]

Display help for global commands

version

Display the version of nbd-cli

Nbd-CLI Gluster Commands

gluster help

Display help for gluster commands

gluster create <VOLUME/FILEPATH> [prealloc] <size SIZE> [host RUNNER_HOST]

Create FILEPATH in the VOLUME, prealloc is false as default, and the SIZE is valid with B, K(iB), M(iB), G(iB), T(iB), P(iB), E(iB), Z(iB), Y(iB), RUNNER_HOST will be 'localhost' as default

gluster delete <VOLUME/FILEPATH> [host RUNNER_HOST]

Delete FILEPATH from the VOLUME, RUNNER_HOST will be 'localhost' as default

gluster map <VOLUME/FILEPATH> [nbd-device] [timeout TIME] [readonly] [host RUNNER_HOST]

Map FILEPATH to the nbd device, as default the timeout 0, none readonly, RUNNER_HOST will be 'localhost' as default

gluster unmap <nbd-device|VOLUME/FILEPATH> [host RUNNER_HOST]

Unmap the nbd device or VOLUME/FILEPATH, RUNNER_HOST will be 'localhost' as default

gluster list [inuse|free|create|dead|live|all] [host RUNNER_HOST]

List the inuseded|free NBD devices or the backstores which are in created state or which the connections are in dead|live state, 'all' as default. 'create' means the backstores are just created or unmapped. 'dead' means the socket connection is lost, which mainly dues to the nbd-runner service was restart without unmapping. 'live' means everything is okay for both mapping and socket connection, RUNNER_HOST will be 'localhost' as default

Nbd-CLI Azblk Commands

azblk help

Display help for azblk commands

azblk create <'account.blob.core.windows.net/container/vhd[;option1][;option2']> [prealloc] <size SIZE> [host RUNNER_HOST]

Create the vhd file in your storage account container, prealloc is false as default, and the SIZE is valid with B, K(iB), M(iB), G(iB), T(iB), RUNNER_HOST will be 'localhost' as default

Valid options: sas=SAS_STRING lease=LEASE_ID http https is the default

azblk delete <account.blob.core.windows.net/container/vhd> [host RUNNER_HOST]

Delete the vhd file from your storage account container, RUNNER_HOST will be 'localhost' as default

azblk map <account.blob.core.windows.net/container/vhd> [nbd-device] [timeout TIME] [readonly] [host RUNNER_HOST]

Map the vhd to the nbd device, as default the socket connection timeout is 30 seconds, none readonly, RUNNER_HOST will be 'localhost' as default

azblk unmap <nbd-device|<account.blob.core.windows.net/container/vhd> [host RUNNER_HOST]

Unmap the nbd device or account/container/vhd, RUNNER_HOST will be 'localhost' as default

azblk list [inuse|free|create|dead|live|all] [host RUNNER_HOST]

List the inused|free NBD devices or the backstores which are in created state or which the connections are in dead|live state, 'all' as default. 'create' means the backstores are just created or unmapped. 'dead' means the socket connection is lost, which mainly dues to the nbd-runner service was restart without unmapping. 'live' means everything is okay for both mapping and socket connection, RUNNER_HOST will be 'localhost' as default

See Also

nbd-runner(8), nbd-clid(8),

Author

Xiubo Li <xiubli@redhat.com>

Reporting Bugs

Report bugs via gluster-devel <gluster-devel@gluster.org>
or <https://github.com/gluster/nbd-runner/issues>

Referenced By

nbd-clid(8), nbd-runner(8).