|
 |
d1681e |
From 793830be96b95daaa842ab63da66be8840e04315 Mon Sep 17 00:00:00 2001
|
|
|
d1681e |
From: Sanju Rakonde <srakonde@redhat.com>
|
|
|
d1681e |
Date: Mon, 27 Nov 2017 00:18:03 +0530
|
|
|
d1681e |
Subject: [PATCH 135/139] cli: commands are missing in man page
|
|
|
d1681e |
|
|
|
d1681e |
adding missed commands to gluster manual page.
|
|
|
d1681e |
|
|
|
d1681e |
>upstream mainline patch : https://review.gluster.org/#/c/18855
|
|
|
d1681e |
|
|
|
d1681e |
Change-Id: I2e5eb1b3929241275ee7a046c5e3d45a5aa5c4a2
|
|
|
d1681e |
BUG: 1516249
|
|
|
d1681e |
Signed-off-by: Sanju Rakonde <srakonde@redhat.com>
|
|
|
d1681e |
Reviewed-on: https://code.engineering.redhat.com/gerrit/128885
|
|
|
d1681e |
Reviewed-by: Atin Mukherjee <amukherj@redhat.com>
|
|
|
d1681e |
Tested-by: RHGS Build Bot <nigelb@redhat.com>
|
|
|
d1681e |
---
|
|
|
d1681e |
doc/gluster.8 | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
|
|
|
d1681e |
1 file changed, 47 insertions(+), 2 deletions(-)
|
|
|
d1681e |
|
|
|
d1681e |
diff --git a/doc/gluster.8 b/doc/gluster.8
|
|
|
d1681e |
index 4c20307..c13a1c2 100644
|
|
|
d1681e |
--- a/doc/gluster.8
|
|
|
d1681e |
+++ b/doc/gluster.8
|
|
|
d1681e |
@@ -35,6 +35,12 @@ The Gluster Console Manager is a command line utility for elastic volume managem
|
|
|
d1681e |
\fB\ volume info [all|<VOLNAME>] \fR
|
|
|
d1681e |
Display information about all volumes, or the specified volume.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ volume list \fR
|
|
|
d1681e |
+List all volumes in cluster
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume status [all | <VOLNAME> [nfs|shd|<BRICK>|quotad|tierd]] [detail|clients|mem|inode|fd|callpool|tasks|client-list] \fR
|
|
|
d1681e |
+Display status of all or specified volume(s)/brick
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
\fB\ volume create <NEW-VOLNAME> [stripe <COUNT>] [replica <COUNT>] [disperse [<COUNT>]] [redundancy <COUNT>] [transport <tcp|rdma|tcp,rdma>] <NEW-BRICK> ... \fR
|
|
|
d1681e |
Create a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp).
|
|
|
d1681e |
To create a volume with both transports (tcp and rdma), give 'transport tcp,rdma' as an option.
|
|
|
d1681e |
@@ -51,8 +57,17 @@ Stop the specified volume.
|
|
|
d1681e |
\fB\ volume set <VOLNAME> <OPTION> <PARAMETER> [<OPTION> <PARAMETER>] ... \fR
|
|
|
d1681e |
Set the volume options.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
-\fB\ volume get <VOLNAME> <OPTION/all>\fR
|
|
|
d1681e |
-Get the volume options.
|
|
|
d1681e |
+\fB\ volume get <VOLNAME/all> <OPTION/all> \fR
|
|
|
d1681e |
+Get the value of the all options or given option for volume <VOLNAME> or all option. gluster volume get all all is to get all global options
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume reset <VOLNAME> [option] [force] \fR
|
|
|
d1681e |
+Reset all the reconfigured options
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume barrier <VOLNAME> {enable|disable} \fR
|
|
|
d1681e |
+Barrier/unbarrier file operations on a volume
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume clear-locks <VOLNAME> <path> kind {blocked|granted|all}{inode [range]|entry [basename]|posix [range]} \fR
|
|
|
d1681e |
+Clear locks held on path
|
|
|
d1681e |
.TP
|
|
|
d1681e |
\fB\ volume help \fR
|
|
|
d1681e |
Display help for the volume command.
|
|
|
d1681e |
@@ -70,6 +85,9 @@ If you remove the brick, the data stored in that brick will not be available. Yo
|
|
|
d1681e |
.B replace-brick
|
|
|
d1681e |
option.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ volume reset-brick <VOLNAME> <SOURCE-BRICK> {{start} | {<NEW-BRICK> commit}} \fR
|
|
|
d1681e |
+Brings down or replaces the specified source brick with the new brick.
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
\fB\ volume replace-brick <VOLNAME> <SOURCE-BRICK> <NEW-BRICK> commit force \fR
|
|
|
d1681e |
Replace the specified source brick with a new brick.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
@@ -91,6 +109,15 @@ Locate the log file for corresponding volume/brick.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
\fB\ volume log rotate <VOLNAME> [BRICK] \fB
|
|
|
d1681e |
Rotate the log file for corresponding volume/brick.
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume profile <VOLNAME> {start|info [peek|incremental [peek]|cumulative|clear]|stop} [nfs] \fR
|
|
|
d1681e |
+Profile operations on the volume. Once started, volume profile <volname> info provides cumulative statistics of the FOPs performed.
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume statedump <VOLNAME> [[nfs|quotad] [all|mem|iobuf|callpool|priv|fd|inode|history]... | [client <hostname:process-id>]] \fR
|
|
|
d1681e |
+Dumps the in memory state of the specified process or the bricks of the volume.
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume sync <HOSTNAME> [all|<VOLNAME>] \fR
|
|
|
d1681e |
+Sync the volume information from a peer
|
|
|
d1681e |
.SS "Peer Commands"
|
|
|
d1681e |
.TP
|
|
|
d1681e |
\fB\ peer probe <HOSTNAME> \fR
|
|
|
d1681e |
@@ -102,6 +129,9 @@ Detach the specified peer.
|
|
|
d1681e |
\fB\ peer status \fR
|
|
|
d1681e |
Display the status of peers.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ pool list \fR
|
|
|
d1681e |
+List all the nodes in the pool (including localhost)
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
\fB\ peer help \fR
|
|
|
d1681e |
Display help for the peer command.
|
|
|
d1681e |
.SS "Tier Commands"
|
|
|
d1681e |
@@ -109,9 +139,15 @@ Display help for the peer command.
|
|
|
d1681e |
\fB\ volume tier <VOLNAME> attach [<replica COUNT>] <NEW-BRICK>... \fR
|
|
|
d1681e |
Attach to an existing volume a tier of specified type using the specified bricks.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ volume tier <VOLNAME> start [force] \fR
|
|
|
d1681e |
+Start the tier service for <VOLNAME>
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
\fB\ volume tier <VOLNAME> status \fR
|
|
|
d1681e |
Display statistics on data migration between the hot and cold tiers.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ volume tier <VOLNAME> stop [force] \fR
|
|
|
d1681e |
+Stop the tier service for <VOLNAME>
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
\fB\ volume tier <VOLNAME> detach start\fR
|
|
|
d1681e |
Begin detaching the hot tier from the volume. Data will be moved from the hot tier to the cold tier.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
@@ -164,6 +200,12 @@ Set the hard timeout for the volume. The interval in which limits are retested a
|
|
|
d1681e |
\fB\ volume quota <VOLNAME> alert-time <TIME> \fR
|
|
|
d1681e |
Set the frequency in which warning messages need to be logged (in the brick logs) once soft limit is breached.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ volume inode-quota <VOLNAME> enable/disable \fR
|
|
|
d1681e |
+Enable/disable inode-quota for <VOLNAME>
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
+\fB\ volume quota help \fR
|
|
|
d1681e |
+Display help for volume quota commands
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
NOTE: valid units of time and their symbols are : hours(h/hr), minutes(m/min), seconds(s/sec), weeks(w/wk), Days(d/days).
|
|
|
d1681e |
.SS "Geo-replication Commands"
|
|
|
d1681e |
.TP
|
|
|
d1681e |
@@ -206,6 +248,9 @@ Scrub frequency for volume <VOLNAME>
|
|
|
d1681e |
\fB\ volume bitrot <VOLNAME> scrub {pause|resume|status|ondemand} \fR
|
|
|
d1681e |
Pause/Resume scrub. Upon resume, scrubber continues where it left off. status option shows the statistics of scrubber. ondemand option starts the scrubbing immediately if the scrubber is not paused or already running.
|
|
|
d1681e |
.TP
|
|
|
d1681e |
+\fB\ volume bitrot help \fR
|
|
|
d1681e |
+Display help for volume bitrot commands
|
|
|
d1681e |
+.TP
|
|
|
d1681e |
.SS "Snapshot Commands"
|
|
|
d1681e |
.PP
|
|
|
d1681e |
.TP
|
|
|
d1681e |
--
|
|
|
d1681e |
1.8.3.1
|
|
|
d1681e |
|