diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/gluster.8 | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/gluster.8 b/doc/gluster.8 index d13cb6f6a17..eed81400cb3 100644 --- a/doc/gluster.8 +++ b/doc/gluster.8 @@ -108,12 +108,15 @@ Display help for the peer command. .SS "Snapshot Commands" .PP .TP -\fB\ snapshot create <snapname> <volname> [description <description>] [force] \fR -Creates a snapshot of a GlusterFS volume. User can provide a snap-name and a description to identify the snap. The description cannot be more than 1024 characters. To be able to take a snapshot, volume should be present and it should be in started state. +\fB\ snapshot create <snapname> <volname> [no-timestamp] [description <description>] [force] \fR +Creates a snapshot of a GlusterFS volume. User can provide a snap-name and a description to identify the snap. Snap will be created by appending timestamp in GMT. User can override this behaviour using "no-timestamp" option. The description cannot be more than 1024 characters. To be able to take a snapshot, volume should be present and it should be in started state. .TP \fB\ snapshot restore <snapname> \fR Restores an already taken snapshot of a GlusterFS volume. Snapshot restore is an offline activity therefore if the volume is online (in started state) then the restore operation will fail. Once the snapshot is restored it will not be available in the list of snapshots. .TP +\fB\ snapshot clone <clonename> <snapname> \fR +Create a clone of a snapshot volume, the resulting volume will be GlusterFS volume. User can provide a clone-name. To be able to take a clone, snapshot should be present and it should be in activated state. +.TP \fB\ snapshot delete ( all | <snapname> | volume <volname> ) \fR If snapname is specified then mentioned snapshot is deleted. If volname is specified then all snapshots belonging to that particular volume is deleted. If keyword *all* is used then all snapshots belonging to the system is deleted. .TP @@ -121,7 +124,7 @@ If snapname is specified then mentioned snapshot is deleted. If volname is speci Lists all snapshots taken. If volname is provided, then only the snapshots belonging to that particular volume is listed. .TP \fB\ snapshot info [snapname | (volume <volname>)] \fR -This command gives information such as snapshot name, snapshot UUID, time at which snapshot was created, and it lists down the snap-volume-name, number of snapshots already taken and number of snapshots still available for that particular volume, and the state of the snapshot. +This command gives information such as snapshot name, snapshot UUID, time at which snapshot was created, and it lists down the snap-volume-name, number of snapshots already taken and number of snapshots still available for that particular volume, and the state of the snapshot. If snapname is specified then info of the mentioned snapshot is displayed. If volname is specified then info of all snap-shots belonging to that volume is displayed. If both snapname and volname is not specified then info of all the snapshots present in the system are displayed. .TP \fB\ snapshot status [snapname | (volume <volname>)] \fR This command gives status of the snapshot. The details included are snapshot brick path, volume group(LVM details), status of the snapshot bricks, PID of the bricks, data percentage filled for that particular volume group to which the snapshots belong to, and total size of the logical volume. @@ -135,7 +138,7 @@ snapshot config without any keywords displays the snapshot config values of all Snapshot config command along with keywords can be used to change the existing config values. If volname is provided then config value of that volume is changed, else it will set/change the system limit. -snap-max-soft-limit and auto-delete are global options, that will be inherited by all volumes in the system and cannot be set to individual volumes. +snap-max-hard-limit, snap-max-soft-limit and auto-delete are global options, that will be inherited by all volumes in the system and cannot be set to individual volumes. The system limit takes precedence over the volume specific limit. @@ -143,7 +146,7 @@ When auto-delete feature is enabled, then upon reaching the soft-limit, with eve When auto-delete feature is disabled, then upon reaching the soft-limit, the user gets a warning with every successful snapshot creation. -Upon reaching the hard-limit, further snapshot creations will not be allowed. +When auto-delete feature is disabled, then upon reaching the hard-limit, further snapshot creations will not be allowed. activate-on-create is disabled by default. If you enable activate-on-create, then further snapshot will be activated during the time of snapshot creation. .TP @@ -154,6 +157,9 @@ Note : By default the snapshot is activated during snapshot creation. .TP \fB\ snapshot deactivate <snapname> \fR Deactivates the mentioned snapshot. +.TP +\fB\ snapshot help \fR +Display help for the snapshot commands. .SS "Other Commands" .TP \fB\ help \fR |