6801fc385d
BUG: 805138 Change-Id: Ifbceb329ba9039e6617d377c6b7fdb67d2383ddd Signed-off-by: M. Mohan Kumar <mohan@in.ibm.com> Reviewed-on: http://review.gluster.org/4274 Reviewed-by: Anand Avati <avati@redhat.com> Tested-by: Anand Avati <avati@redhat.com>
145 lines
5.0 KiB
Groff
145 lines
5.0 KiB
Groff
|
|
.\" Copyright (c) 2006-2012 Red Hat, Inc. <http://www.redhat.com>
|
|
.\" This file is part of GlusterFS.
|
|
.\"
|
|
.\" This file is licensed to you under your choice of the GNU Lesser
|
|
.\" General Public License, version 3 or any later version (LGPLv3 or
|
|
.\" later), or the GNU General Public License, version 2 (GPLv2), in all
|
|
.\" cases as published by the Free Software Foundation.
|
|
.\"
|
|
.\"
|
|
.TH Gluster 8 "Gluster command line utility" "22 November 2012" "Gluster Inc."
|
|
.SH NAME
|
|
gluster - Gluster Console Manager (command line utility)
|
|
.SH SYNOPSIS
|
|
.B gluster
|
|
.PP
|
|
To run the program and display gluster prompt:
|
|
.PP
|
|
.B gluster
|
|
.PP
|
|
(or)
|
|
.PP
|
|
To specify a command directly:
|
|
.PP
|
|
.B gluster
|
|
.I [commands] [options]
|
|
|
|
.SH DESCRIPTION
|
|
The Gluster Console Manager is a command line utility for elastic volume management. You can run the gluster command on any export server. The command enables administrators to perform cloud operations, such as creating, expanding, shrinking, rebalancing, and migrating volumes without needing to schedule server downtime.
|
|
.SH COMMANDS
|
|
|
|
.SS "Volume Commands"
|
|
.PP
|
|
.TP
|
|
|
|
\fB\ volume info [all|<VOLNAME>] \fR
|
|
Display information about all volumes, or the specified volume.
|
|
.TP
|
|
\fB\ volume create <NEW-VOLNAME> [device vg] [stripe <COUNT>] [replica <COUNT>] [transport <tcp|rdma|tcp,rdma>] <NEW-BRICK> ... \fR
|
|
Create a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp).
|
|
To create a volume with both transports (tcp and rdma), give 'transport tcp,rdma' as an option.
|
|
device vg parameter specifies volume should use block backend instead of regular posix backend. In this case NEW-BRICK should specify an existing Volume Group and there can be only one brick for Block backend volumes. \fR
|
|
Refer Block backend section for more details
|
|
.TP
|
|
\fB\ volume delete <VOLNAME> \fR
|
|
Delete the specified volume.
|
|
.TP
|
|
\fB\ volume start <VOLNAME> \fR
|
|
Start the specified volume.
|
|
.TP
|
|
\fB\ volume stop <VOLNAME> [force] \fR
|
|
Stop the specified volume.
|
|
.TP
|
|
\fB\ volume rename <VOLNAME> <NEW-VOLNAME> \fR
|
|
Rename the specified volume.
|
|
.TP
|
|
\fB\ volume set <VOLNAME> <OPTION> <PARAMETER> [<OPTION> <PARAMETER>] ... \fR
|
|
Set the volume options.
|
|
.TP
|
|
\fB\ volume help \fR
|
|
Display help for the volume command.
|
|
.SS "Block backend"
|
|
.TP
|
|
By specifying "device vg" in volume create, a volume capable of exporting block devices(ie Volume Groups (VG)) is created. As of now exporting only VG is supported. While creating block backend volume the "VG" (mentioned in NEW-BRICK) must exist (ie created with vgcreate). VG is exported as a directory and all LVs under that VG will be exported as files. Please refer BD commands section for Block backend related commands
|
|
.SS "Brick Commands"
|
|
.PP
|
|
.TP
|
|
\fB\ volume add-brick <VOLNAME> <NEW-BRICK> ... \fR
|
|
Add the specified brick to the specified volume.
|
|
.TP
|
|
\fB\ volume remove-brick <VOLNAME> <BRICK> ... \fR
|
|
Remove the specified brick from the specified volume.
|
|
.IP
|
|
.B Note:
|
|
If you remove the brick, the data stored in that brick will not be available. You can migrate data from one brick to another using
|
|
.B replace-brick
|
|
option.
|
|
.TP
|
|
\fB\ volume rebalance-brick <VOLNAME>(<BRICK> <NEW-BRICK>) start \fR
|
|
Start rebalancing the specified volume.
|
|
.TP
|
|
\fB\ volume rebalance <VOLNAME> stop \fR
|
|
Stop rebalancing the specified volume.
|
|
.TP
|
|
\fB\ volume rebalance <VOLNAME> status \fR
|
|
Display the rebalance status of the specified volume.
|
|
.TP
|
|
\fB\ volume replace-brick <VOLNAME> (<BRICK> <NEW-BRICK>) start|pause|abort|status|commit \fR
|
|
Replace the specified brick.
|
|
.SS "Log Commands"
|
|
.TP
|
|
\fB\ volume log filename <VOLNAME> [BRICK] <DIRECTORY> \fB
|
|
Set the log directory for the corresponding volume/brick.
|
|
.TP
|
|
\fB\ volume log locate <VOLNAME> [BRICK] \fB
|
|
Locate the log file for corresponding volume/brick.
|
|
.TP
|
|
\fB\ volume log rotate <VOLNAME> [BRICK] \fB
|
|
Rotate the log file for corresponding volume/brick.
|
|
.SS "Peer Commands"
|
|
.TP
|
|
\fB\ peer probe <HOSTNAME> \fR
|
|
Probe the specified peer.
|
|
.TP
|
|
\fB\ peer detach <HOSTNAME> \fR
|
|
Detach the specified peer.
|
|
.TP
|
|
\fB\ peer status \fR
|
|
Display the status of peers.
|
|
.TP
|
|
\fB\ peer help \fR
|
|
Display help for the peer command.
|
|
.SS "BD commands"
|
|
.TP
|
|
\fB\ bd create <VOLNAME:/path-to-image> <size> \fR
|
|
Creates a new image of given size in the volume. Size can be suffixed with MB, GB etc, if nothing specified MB is taken as default.
|
|
.TP
|
|
\fB\ bd delete <VOLNAME:/path-to-image> \fR
|
|
Deletes a image in the volume
|
|
.TP
|
|
\fB\ bd clone <VOLNAME:/path-to-image> <new-image> \fR
|
|
Clones an existing image (full clone)
|
|
.TP
|
|
\fB\ bd snapshot <VOLNAME:/path-to-image> <new-image> <size> \fR
|
|
Creates a linked clone of an existing image with given size. Size can be suffixed with MB, GB etc, if nothing specified MB is taken as default.
|
|
|
|
.SS "Other Commands"
|
|
.TP
|
|
\fB\ help \fR
|
|
Display the command options.
|
|
.TP
|
|
\fB\ quit \fR
|
|
Exit the gluster command line interface.
|
|
|
|
.SH FILES
|
|
/var/lib/glusterd/*
|
|
.SH SEE ALSO
|
|
.nf
|
|
\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8)
|
|
\fR
|
|
.fi
|
|
.SH COPYRIGHT
|
|
.nf
|
|
Copyright(c) 2006-2011 Gluster, Inc. <http://www.gluster.com>
|