1gluster-block(8)                 Red Hat, Inc.                gluster-block(8)
2
3
4

NAME

6       gluster-block  -  Gluster  Block  Storage Console Manager (command line
7       utility)
8

SYNOPSIS

10       gluster-block <create|list|info|delete> <volname[/blockname]>  [<args>]
11       [--json*]
12

DESCRIPTION

14       The Gluster Block Storage Console Manager(gluster-block) is a CLI util‐
15       ity, which aims at making gluster backed  block  storage  creation  and
16       maintenance as simple as possible.
17
18       Note  that  the  gluster-blockd daemon is responsible for block manage‐
19       ment, hence the daemon must be running on all servers.
20

COMMANDS

22   create <VOLNAME/NEW-BLOCKNAME> [ha <COUNT>] [auth <enable|disable>] [preal‐
23       loc <full|no>] <HOST1[,HOST2,..]> <BYTES>
24       create block device.
25
26       [ha <COUNT>]
27              multipath requirement for high availability (default: 1)
28
29       [auth <enable|disable>]
30              authentication setting (default: disable)
31
32       [prealloc <full|no>]
33              "full"  mode  preallocates  space  by  writing zeros to storage.
34              (default: no)
35
36       <HOST1,[HOST2....]>
37              servers in the pool where targets will be exported.
38
39       <BYTES>
40              size in B|KiB|MiB|GiB|TiB|PiB ... (default: bytes)
41
42   list <VOLNAME>
43       list available block devices.
44
45   info <VOLNAME/BLOCKNAME>
46       details about block device.
47
48   delete <VOLNAME/BLOCKNAME> [force]
49       delete block device.
50
51   modify <VOLNAME/BLOCKNAME> <auth enable|disable>
52       modify block device.
53
54   help
55       show help message and exit.
56
57   version
58       show version info and exit.
59

SUPPORTED JSON-FORMATS

61       --json | --json-plain | --json-spaced | --json-pretty
62
63

EXAMPLES

65       To create a block device of size 1GiB
66       # gluster-block create blockVol/sampleBlock ${HOST} 1GiB
67
68       To create a block device of size 1GiB with auth enable
69       # gluster-block create blockVol/sampleBlock auth enable ${HOST} 1GiB
70
71       To create a block device of size 1GiB, by preallocating storage with zero fill
72       # gluster-block create blockVol/sampleBlock prealloc full ${HOST} 1GiB
73
74       To create a block device of size 1GiB with multi-path(replica) 3
75       # gluster-block create blockVol/sampleBlock ha 3 ${HOST1},${HOST2},${HOST3} 1GiB
76
77       To create a block device of size 1GiB and expect response in json format
78       # gluster-block create blockVol/sampleBlock ${HOST} 1GiB --json
79
80       You can pass more no. of nodes than ha count, this will actually help create in recovering from
81       failures, incase creation of block fails on any of scheduled(always first in list) ha count nodes.
82       # gluster-block create blockVol/sampleBlock ha 3 ${HOST1},${HOST2},${HOST3},${HOST4},${HOST5} 1GiB
83
84       To disable auth on a block device
85       # gluster-block modify blockVol/sampleBlock auth disable
86
87       To enable auth on a block device
88       # gluster-block modify blockVol/sampleBlock auth enable
89
90       To list available block devices
91       # gluster-block list blockVol
92
93       To get details of a block device
94       # gluster-block info blockVol/sampleBlock
95
96       To delete a block device
97       # gluster-block delete blockVol/sampleBlock
98

FILES

100       /var/log/gluster-block/*
101       /var/run/gluster-block.socket
102       /var/run/gluster-block.lock
103       /etc/sysconfig/gluster-blockd-config
104

REPORTING BUGS

106       Report bugs via gluster-devel <gluster-devel@gluster.org
107       or <https://github.com/gluster/gluster-block/issues>
108
109
110

AUTHOR

112       Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
113
114

THANKS

116       Vijay Bellur <vbellur@redhat.com>
117       Pranith Kumar Karampuri <pkarampu@redhat.com>
118
119
120
121

SEE ALSO

123       gluster-blockd(8), targetcli(8), tcmu-runner(8), glusterfs(8), glusterd(8), gluster(8)
124

126       Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
127
128 26 Feb 2017                 command line utility             gluster-block(8)
Impressum