Whamcloud - gitweb
LU-930 doc: fix format man page sections for lctl
[fs/lustre-release.git] / lustre / doc / lctl-snapshot-destroy.8
1 .TH LCTL-SNAPSHOT_DESTROY 8 "2017-05-13" Lustre "configuration utilities"
2 .SH NAME
3 lctl-snapshot_destroy \- destroy Lustre snapshot
4 .SH SYNOPSIS
5 .TP
6 .B lctl snapshot_destroy \fR[-f | --force] {-F | --fsname fsname} [-h | --help]
7                {-n | --name ssname} [-r | --rsh remote_shell]
8 .br
9 .SH DESCRIPTION
10 Destroy the specified snapshot. The tool loads system configuration from
11 the file
12 .B /etc/ldev.conf
13 as described in the
14 .BR lctl (8)
15 .B SNAPSHOT
16 section. Then,  the snapshot pieces are destroyed on every Lustre target
17 (MGT/MDT/OST).
18 .SH OPTIONS
19 .TP
20 .BR -f ", " --force
21 Destroy the specified snapshot by force. If the snapshot is mounted (see
22 .BR snapshot_mount ),
23 it will be umounted firstly, then destroyed. Even if some pieces of the
24 snapshot are lost or broken for some reason(s), the remained parts of the
25 snapshot still can be destroyed with this option specified.
26 .TP
27 .BR  -F ", " --fsname " "\fIfsname
28 The filesystem name.
29 .TP
30 .BR  -h ", " --help
31 For help information.
32 .TP
33 .BR  -n ", " --name " "\fIssname
34 The snapshot (to be destroyed) name must be specified.
35 .TP
36 .BR  -r ", " --rsh " "\fIremote_shell
37 Specify a shell to communicate with remote targets. The default value is
38 .BR ssh .
39 It is the system admin's duty to guarantee that the specified
40 .I remote_shell
41 works well among targets without password authentication.
42
43 .SH AVAILABILITY
44 .B lctl-snapshot-destroy
45 is part of the
46 .BR lustre (7)
47 filesystem package.
48 .SH SEE ALSO
49 .BR lctl (8),
50 .BR lctl-lcfg (8),
51 .BR lctl-barrier (8),
52 .BR lctl-snapshot-create (8),
53 .BR lctl-snapshot-modify (8),
54 .BR lctl-snapshot-list (8),
55 .BR lctl-snapshot-mount (8),
56 .BR lctl-snapshot-umount (8)