1nbd-cli(8) System Manager's Manual nbd-cli(8)
2
6 nbd-cli
7
9 nbd-cli is a cli utility, which aims at making backstore creation/dele‐
10 tion/mapping/unmaping/listing.
11
14 nbd-cli [OPTION] [COMMAND [OPTIONS]]
15
18 gluster help
19 Display help for gluster commands
20 azblk help
23 Display help for azblk commands
24 ceph help [TODO]
27 Display help for ceph commands
28 global help [TODO]
31 Display help for global commands
32 version
35 Display the version of nbd-cli
36
40 gluster help
41 Display help for gluster commands
42 gluster create <VOLUME/FILEPATH> [prealloc] <size SIZE> [host RUN‐
45 NER_HOST]
46 Create FILEPATH in the VOLUME, prealloc is false as default, and
47 the SIZE is valid with B, K(iB), M(iB), G(iB), T(iB), P(iB),
48 E(iB), Z(iB), Y(iB), RUNNER_HOST will be 'localhost' as default
49 gluster delete <VOLUME/FILEPATH> [host RUNNER_HOST]
52 Delete FILEPATH from the VOLUME, RUNNER_HOST will be 'localhost'
53 as default
54 gluster map <VOLUME/FILEPATH> [nbd-device] [timeout TIME] [readonly]
57 [host RUNNER_HOST]
58 Map FILEPATH to the nbd device, as default the timeout 0, none
59 readonly, RUNNER_HOST will be 'localhost' as default
60 gluster unmap <nbd-device|VOLUME/FILEPATH> [host RUNNER_HOST]
63 Unmap the nbd device or VOLUME/FILEPATH, RUNNER_HOST will be
64 'localhost' as default
65 gluster list [inuse|free|create|dead|live|all] [host RUNNER_HOST]
68 List the inuseded|free NBD devices or the backstores which are
69 in created state or which the connections are in dead|live
70 state, 'all' as default. 'create' means the backstores are just
71 created or unmapped. 'dead' means the socket connection is lost,
72 which mainly dues to the nbd-runner service was restart without
73 unmapping. 'live' means everything is okay for both mapping and
74 socket connection, RUNNER_HOST will be 'localhost' as default
75
78 azblk help
79 Display help for azblk commands
80 azblk create <'account.blob.core.windows.net/con‐
83 tainer/vhd[;option1][;option2']> [prealloc] <size SIZE> [host RUN‐
84 NER_HOST]
85 Create the vhd file in your storage account container, prealloc
86 is false as default, and the SIZE is valid with B, K(iB), M(iB),
87 G(iB), T(iB), RUNNER_HOST will be 'localhost' as default
88 Valid options: sas=SAS_STRING lease=LEASE_ID http https is the
90 default
91 azblk delete <account.blob.core.windows.net/container/vhd> [host RUN‐
94 NER_HOST]
95 Delete the vhd file from your storage account container, RUN‐
96 NER_HOST will be 'localhost' as default
97 azblk map <account.blob.core.windows.net/container/vhd> [nbd-device]
100 [timeout TIME] [readonly] [host RUNNER_HOST]
101 Map the vhd to the nbd device, as default the socket connection
102 timeout is 30 seconds, none readonly, RUNNER_HOST will be
103 'localhost' as default
104 azblk unmap <nbd-device|<account.blob.core.windows.net/container/vhd>
107 [host RUNNER_HOST]
108 Unmap the nbd device or account/container/vhd, RUNNER_HOST will
109 be 'localhost' as default
110 azblk list [inuse|free|create|dead|live|all] [host RUNNER_HOST]
113 List the inused|free NBD devices or the backstores which are in
114 created state or which the connections are in dead|live state,
115 'all' as default. 'create' means the backstores are just created
116 or unmapped. 'dead' means the socket connection is lost, which
117 mainly dues to the nbd-runner service was restart without unmap‐
118 ping. 'live' means everything is okay for both mapping and
119 socket connection, RUNNER_HOST will be 'localhost' as default
120
123 nbd-runner(8), nbd-clid(8),
124
127 Xiubo Li <xiubli@redhat.com>
128
130 Report bugs via gluster-devel <gluster-devel@gluster.org>
131 or <https://github.com/gluster/nbd-runner/issues>
132 nbd-cli(8)