Whamcloud - gitweb
LU-11467 utils: add lfs mirror delete command
[fs/lustre-release.git] / lustre / doc / lfs-mirror-delete.1
1 .TH LFS-MIRROR-DELETE 1 2019-09-15 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs mirror delete \- delete a specified mirror from an existing mirrored file
4 .SH SYNOPSIS
5 .B lfs mirror delete
6 {\fB\-\-mirror\-id\fR <\fImirror_id\fR> | \fB\-\-component\-id\fR|\fB\-I\fR
7 <\fIcomp_id\fR> |\fB\-\-pool\fR <\fIpool\fR>}
8 <\fImirrored_file\fR>
9 .SH DESCRIPTION
10 This command deletes a mirror with mirror ID <\fImirror_id\fR> or containing
11 a component with <\fIcomp_id\fR> or containing a component on <\fIpool\fR>
12 out of a mirrored file specified by the path name \fImirrored_file\fR.
13 .br
14 If \fImirrored_file\fR has only one mirror existing after split, it will be
15 converted to a regular non-mirrored file.
16 .br
17 If the original \fImirrored_file\fR is not a mirrored file, then the command
18 will return an error.
19 .br
20 If the specified mirror is the last non-stale mirror, then the command will
21 return an error.
22 .SH OPTIONS
23 .TP
24 .BR \-\-mirror\-id\fR\ <\fImirror_id\fR>
25 The numerical unique identifier for a mirror. The mirror ID is unique within a
26 mirrored file and is automatically assigned at file creation or extension time.
27 It can be fetched by \fBlfs getstripe\fR command (see \fBlfs(1)\fR).
28 .TP
29 .BR \-\-comp\-id\fR\ <\fIcomp_id\fR>
30 The numerical unique identifier for a component contained within a mirror.
31 .TP
32 .BR \-\-pool\fR\ <\fIpool\fR>
33 The pool storing a component contained within a mirror.
34 .SH EXAMPLES
35 .TP
36 .B lfs mirror delete --mirror-id 2 /mnt/lustre/file1
37 Delete the mirror with ID 2 of /mnt/lustre/file1.
38 .TP
39 .B lfs mirror delete --pool ssd /mnt/lustre/file1
40 Split a mirror on pool ssd out of /mnt/lustre/file1 and destroy it.
41 .SH AUTHOR
42 The \fBlfs mirror split\fR command is part of the Lustre filesystem.
43 .SH SEE ALSO
44 .BR lfs (1),
45 .BR lfs-setstripe (1),
46 .BR lfs-mirror-create (1),
47 .BR lfs-mirror-extend (1),
48 .BR lfs-mirror-resync (1),
49 .BR lfs-mirror-split (1),
50 .BR lfs-mirror-verify (1)