aboutsummaryrefslogtreecommitdiff
path: root/doc/eclat-lschvol.1
blob: a08a5c4139be7b31a02ac2b7a07e4d3a251a49e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
.\" This file is part of Eclat -*- nroff -*-
.\" Copyright (C) 2012-2023 Sergey Poznyakoff
.\"
.\" Eclat is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3, or (at your option)
.\" any later version.
.\"
.\" Eclat is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with Eclat.  If not, see <http://www.gnu.org/licenses/>.
.TH ECLAT-LSCHVOL 1 "December 15, 2018" "ECLAT" "Eclat User Reference"
.SH NAME
eclat-lschvol \- reports the current modification status of EBS volumes
.SH SYNOPSIS
.nh
.na
\fBeclat lschvol\fR [\fIFILTER\fR...] [\fIVOL-ID\fR...]
.PP
\fBeclat lschvol\fR \fB\-\-help\fR
.ad
.hy
.SH DESCRIPTION
Reports the current modification status of EBS volumes. Volumes can be
specified either by their volume IDs or by filters. In the latter
case, all volumes matching filters will be reported.
.SH FILTERS
.TP
\fBvolume\-id\fR=\fIID\fR
The volume ID.  This filter has the same effect as specifying \fIID\fR
as the command line argument. 
.TP
\fBmodification\-state=\fISTATE\fR
Modules with this modification state. \fISTATE\fR is one of
.BR modifying ,
.BR optimizing ,
.BR completed ,
or
.B failed .
.TP
\fBtarget\-size=\fISIZE\fR
Target size of the volume.
.TP
\fBtarget\-iops=\fINUM\fR
Target IOPS of the volume.
.TP
\fBtarget\-volume\-type=\fITYPE\fR
Target volume type (one of:
.BR standard ,
.BR io1 ,
.BR gp2 ,
.BR sc1 ,
.BR st1 ).
.TP
\fBoriginal\-size=\fISIZE\fR
Original size of the volume.
.TP
\fBoriginal\-iops=\fINUM\fR
Original IOPS of the volume.
.TP
\fBoriginal\-volume\-type=\fITYPE\fR
Original type of the volume.
.TP
\fBstart\-time=\fITIME\fR
Time when the recent \fBModifyVolume\fR operation (see
.BR eclat\-chvol (1))
was initialized.
.SH OUTPUT
Default output format is similar to that of \fBeclat chvol\fR
subcommand: report for each volume begins in the column 0 with
the volume ID, followed by the modification status and progress
percentage. Lines that follow are indented by one tab stop. Each
line lists a parameter name, its original and target value. For
example:
.sp
.EX
vol-deadbeef optimizing 80%
        size: 16 => 32
        type: standard => standard
.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat-chvol (1).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <bug\-eclat@gnu.org.ua>.
.SH COPYRIGHT
Copyright \(co 2012-2018 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end:

Return to:

Send suggestions and report system problems to the System administrator.