summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org>2018-12-15 09:57:44 (GMT)
committer Sergey Poznyakoff <gray@gnu.org>2018-12-15 09:57:44 (GMT)
commita2c6cdd2c14c3c1d54436b2329b1c11c759eed31 (patch) (side-by-side diff)
treef05fdd70a388805964369c5faf604c1078318059
parent2116e1ef1cd5597e23f785e84d67d8fea5537475 (diff)
downloadeclat-a2c6cdd2c14c3c1d54436b2329b1c11c759eed31.tar.gz
eclat-a2c6cdd2c14c3c1d54436b2329b1c11c759eed31.tar.bz2
Document chvol and lschvol commands.
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--TODO4
-rw-r--r--doc/Makefile.inc2
-rw-r--r--doc/eclat-chvol.193
-rw-r--r--doc/eclat-lschvol.1108
4 files changed, 205 insertions, 2 deletions
diff --git a/TODO b/TODO
index f0b5579..65034a0 100644
--- a/TODO
+++ b/TODO
@@ -104,7 +104,7 @@ DescribeSpotPriceHistory - [ ] [ ]
DescribeSubnets lssubnet [X] [ ]
DescribeTags lstag [X] [X]
DescribeVolumes lsvol [X] [X]
-DescribeVolumesModifications lschvol [X] [ ]
+DescribeVolumesModifications lschvol [X] [X]
DescribeVolumeAttribute - [ ] [ ]
DescribeVolumeStatus - [ ] [ ]
DescribeVpcAttribute lsvpcattr [X] [ ]
@@ -130,7 +130,7 @@ ModifyInstanceAttribute setiattr [X] [X]
ModifyNetworkInterfaceAttribute - [ ] [ ]
ModifySnapshotAttribute setsattr [X] [X]
ModifySubnetAttribute setsubnetattr [X] [ ]
-ModifyVolume chvol [X] [ ]
+ModifyVolume chvol [X] [X]
ModifyVolumeAttribute - [ ] [ ]
ModifyVpcAttribute setvpcattr [X] [ ]
MonitorInstances - [ ] [ ]
diff --git a/doc/Makefile.inc b/doc/Makefile.inc
index 43b62b3..e55c607 100644
--- a/doc/Makefile.inc
+++ b/doc/Makefile.inc
@@ -22,6 +22,7 @@ MANPAGES1=\
eclat.1\
eclat-assocaddr.1\
eclat-atvol.1\
+ eclat-chvol.1\
eclat-clrsattr.1\
eclat-dmesg.1\
eclat-cpimg.1\
@@ -31,6 +32,7 @@ MANPAGES1=\
eclat-disasaddr.1\
eclat-lsaddr.1\
eclat-lsaattr.1\
+ eclat-lschvol.1\
eclat-lsiattr.1\
eclat-lsimg.1\
eclat-lsinst.1\
diff --git a/doc/eclat-chvol.1 b/doc/eclat-chvol.1
new file mode 100644
index 0000000..7093b8b
--- a/dev/null
+++ b/doc/eclat-chvol.1
@@ -0,0 +1,93 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2018 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-CHVOL 1 "December 15, 2018" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat-chvol \- modify size, type and iops of a volume
+.SH SYNOPSIS
+.nh
+.na
+\fBeclat chvol\fR\
+ [\fBiops=\fIRATE\fR]\
+ [\fBsize=\fINUM\fR]\
+ [\fBtype=\fISTRING\fR]
+.PP
+\fBeclat chvol\fR \fB\-\-help\fR
+.ad
+.hy
+.SH DESCRIPTION
+Modifies parameters of an existing EBS volume.
+.TP
+\fBiops=\fIRATE\fR
+The IOPS rate of the volume. This is only valid for Provisioned IOPS
+SSD (io1) volumes.
+.TP
+\fBsize=\fINUM\fR]
+Size of the volume in gigabytes.
+.TP
+\fBtype=\fISTRING\fR
+Type of the volume. Valid values for \fISTRING\fR are:
+.BR standard ,
+.BR io1 ,
+.BR gp2 ,
+.BR sc1 ,
+.BR st1 .
+.PP
+Use \fBeclat lschvol\fR to check the modification status.
+.SH OUTPUT
+The default output format lists the volume ID, modification status
+(one of:
+.BR modifying ,
+.BR optimizing ,
+.BR completed ,
+or
+.BR failed ),
+and the completion percentage. This line is followed by at most three
+indented lines, each listing a parameter name, its original and
+modified value. E.g.:
+.sp
+.EX
+vol-deadbeef optimizing 80%
+ size: 16 => 32
+ type: standard => standard
+.EE
+.SH EXAMPLE
+.EX
+eclat chvol vol-deadbeef size=32
+.EE
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat-lschvol (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:
+
diff --git a/doc/eclat-lschvol.1 b/doc/eclat-lschvol.1
new file mode 100644
index 0000000..4bccc25
--- a/dev/null
+++ b/doc/eclat-lschvol.1
@@ -0,0 +1,108 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012-2018 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.