aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-04-18 18:40:02 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-04-18 18:40:02 +0300
commit347387193da605922ed98742dbc7fa3f67a908f4 (patch)
treeae259156e262763323e5adb0f717fc84c6f7618a /doc
parentdf64ed48764e5083eb6b1d02459b54112e6a1c8f (diff)
downloadeclat-347387193da605922ed98742dbc7fa3f67a908f4.tar.gz
eclat-347387193da605922ed98742dbc7fa3f67a908f4.tar.bz2
Document describe-images and describe-snapshot-attribute.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/eclat-describe-images.1206
-rw-r--r--doc/eclat-describe-snapshot-attribute.166
3 files changed, 274 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 0eadcbe..a736b48 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -28,11 +28,13 @@ MANPAGES1=\
eclat-deregister-image.1\
eclat-describe-addresses.1\
eclat-describe-availability-zones.1\
+ eclat-describe-images.1\
eclat-describe-instance-attribute.1\
eclat-describe-instance-status.1\
eclat-describe-instances.1\
eclat-describe-regions.1\
eclat-describe-security-groups.1\
+ eclat-describe-snapshot-attribute.1\
eclat-describe-snapshots.1\
eclat-describe-tags.1\
eclat-describe-volumes.1\
diff --git a/doc/eclat-describe-images.1 b/doc/eclat-describe-images.1
new file mode 100644
index 0000000..b939cc7
--- /dev/null
+++ b/doc/eclat-describe-images.1
@@ -0,0 +1,206 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012, 2013 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 DESCRIBE\-IMAGES 1 "April 18, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat describe\-images \- describe available Amazon images
+.SH SYNOPSIS
+\fBeclat describe\-images\fB\
+ [\fB\-a\fR] [\fB\-u\fR \fIID\fR]\
+ [\fB\-x\fR \fIID\fR] [\fB\-\-owner\fR=\fIID\fR]
+ [\fB\-\-executable\-by\fR=\fIID\fR]\
+ [\fIFILTER\fR...] [\fIAMI\fR...]
+
+\fBeclat describe\-images\fB \fB\-\-help\fR
+.SH DESCRIPTION
+This command lists available Amazon images.
+.PP
+The list of returned images can be abridged using command line options,
+filters and arguments.
+.PP
+Filters are any arguments that have the \fBkey\fR=\fBvalue\fR structure.
+When filters are supplied, only those images that match them are returned.
+Multiple filters are joined using logical \fBAND\fR. Multiple values
+separated by commas can be specified for a given \fBkey\fR, in which case
+a logical \fBOR\fR is implied. See the section
+.BR FILTERS
+below for a list of available filters.
+.PP
+Any command line argument that is not an option or filter is treated as
+image ID (or image name, if ID mapping is enabled) to return. Any
+number of IDs can be specified. If ID mapping is enabled (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+this command uses the \fBImageId\fR map to translate image names to
+the corresponding identifiers.
+.PP
+Image IDs, filters and options can be used in conjunction.
+.SH OPTIONS
+.TP
+\fB\-u\fR, \fB\-\-owner\fR \fIID\fR
+Filters the images owned by the specified owner. The argument is either
+the ID of the owner, or one of the following reserved words:
+.RS 4
+.TP
+.B self
+Returns the images you own.
+.TP
+.B amazon
+Returns the public Amazon images.
+.TP
+.B all
+Returns all available images.
+.TP
+.B aws\-marketplace
+Returns images from the AWS marketplace.
+.RE
+.TP
+\fB\-x\fR, \fB\-\-executable\-by\fR=\fIID\fR
+Returns AMIs for which the specified user \fIID\fR has explicit
+launch permissions. The \fIID\fR is either an AWS user ID or
+one of the following reserved words:
+.RS 4
+.TP
+.B self
+Returns the images which you can launch.
+.TP
+.B all
+Returns all images.
+.RE
+.SH FILTERS
+.TP
+\fBarchitecture\fR=\fBi386\fR | \fBx86_64\fR
+Selects images by architecture.
+.TP
+\fBblock\-device\-mapping.delete\-on\-termination\fR=\fIBOOL\fR
+Selects images based on whether their Amazon EBS volume is deleted on
+instance termination.
+.TP
+\fBblock\-device\-mapping.device\-name\fR=\fINAME\fR
+The device name for the volume.
+.TP
+\fBblock\-device\-mapping.snapshot\-id\fR=\fIID\fR
+The ID of the snapshot used for the volume.
+.TP
+\fBblock\-device\-mapping.volume\-size\fR=\fINUMBER\fR
+The volume size in GB.
+.TP
+\fBblock\-device\-mapping.volume\-type\fR=\fBstandard\fR | \fBio1\fR
+The type of the volume.
+.TP
+\fBdescription\fR=\fISTRING\fR
+The textual description of the AMI.
+.TP
+\fBimage\-id\fR=\fIID\fR
+The ID of the image.
+.TP
+\fBimage\-type\fR=\fBmachine\fR | \fBkernel\fR | \fBramdisk\fR
+The type of the image.
+.TP
+\fBis\-public\fR=\fIBOOL\fR
+Whether the image is public.
+.TP
+\fBkernel\-id\fR=\fISTRING\fR
+The kernel ID.
+.TP
+\fBmanifest\-location\fR=\fISTRING\fR
+The location of the AMI manifest.
+.TP
+\fBname\fR=\fISTRING\fR
+The name of the AMI.
+.TP
+\fBowner\-alias\fR=\fISTRING\fR
+The account alias.
+.TP
+\fBowner\-id\fR=\fISTRING\fR
+The ID of the image owner.
+.TP
+\fBplatform=windows\fR
+Selects Windows-based AMIs.
+.TP
+\fBproduct\-code\fR=\fISTRING\fR
+.TP
+\fBproduct\-code.type\fR=\fBdevpay\fR | \fBmarketplace\fR
+.TP
+\fBramdisk\-id\fR=\fISTRING\fR
+The RAM disk ID.
+.TP
+\fBroot\-device\-name\fR=\fISTRING\fR
+The name of the root volume.
+.TP
+\fBroot\-device\-type\fR=\fBebs\fR | \fBinstance\-store\fR
+The name of the root device volume.
+.TP
+\fBstate\fR=\fBavailable\fR | \fBpending\fR | \fBfailed\fR
+State of the AMI.
+.TP
+\fBstate\-reason\-code\fR=\fISTRING\fR
+The reason code of the latest state change.
+.TP
+\fBstate\-reason\-message\fR=\fISTRING\fR
+Message describing the reason of the latest state change.
+.TP
+\fBtag\-key\fR=\fISTRING\fR
+The key of a tag assigned to the resource, regardless of its value. Note,
+that this filter works independently of the \fBtag\-value\fR filter, i.e.
+\fBtag\-key=foo tag\-value=bar\fR will return all images that have the tag
+\fBfoo\fR defined and all images that have \fBbar\fR as a value of any
+of their tags. To request the image that has the tag \fBfoo\fR set to the
+value \fBbar\fR see the \fBtag\fR:\fIKEY\fR filter below.
+.TP
+\fBtag\-value\fR=\fISTRING\fR
+The value of a tag assigned to the resource, regardless of the tag's key.
+See the comment above.
+.TP
+\fBtag\fR:\fIKEY\fR=\fIVAL\fR
+Selects images having the specified tag \fIKEY\fR set to the value
+\fIVAL\fR. For example:
+.sp
+.nf
+.in +2
+tag:Name="db server"
+.in
+.fi
+.TP
+\fBvirtualization\-type\fR=\fBparavirtual\fR | \fBhvm\fR
+.TP
+\fBhypervisor\fR=\fBovm\fR | \fBxen\fR
+.SH OUTPUT
+.SH EXAMPLE
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-create\-image (1),
+.BR eclat\-deregister\-image (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012, 2013 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-describe-snapshot-attribute.1 b/doc/eclat-describe-snapshot-attribute.1
new file mode 100644
index 0000000..fdc26a2
--- /dev/null
+++ b/doc/eclat-describe-snapshot-attribute.1
@@ -0,0 +1,66 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012, 2013 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 DESCRIBE\-SNAPSHOT\-ATTRIBUTE 1 "April 18, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat describe\-snapshot\-attribute \- lists the attribute of a EBS snapshot
+.SH SYNOPSIS
+\fBeclat describe\-snapshot\-attribute\fB \fBSNAP\-ID\fR [\fBATTR\fR]
+
+\fBeclat describe\-snapshot\-attribute\fB \fB\-\-help\fR
+.SH DESCRIPTION
+Thic command outputs the value of the attribute \fBATTR\fR of the EBS
+snapshot \fBSNAP\-ID\fR. The latter is either the snapshot
+identifier, or, if ID mapping is enabled (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+its symbolic name, which will be translated using
+the \fBSnapshotId\fR map.
+.PP
+The \fBATTR\fR must be one of the following:
+.TP
+.B createVolumePermission
+Describes the create volume permissions of the snapshot.
+.TP
+.B productCodes
+Describes the product codes associated with the snapshot.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-create\-snapshot (1),
+.BR eclat\-delete\-snapshot (1),
+.BR eclat\-describe\-snapshots (1),
+.BR eclat\-modify\-snapshot\-attribute (1),
+.BR eclat\-reset\-snapshot\-attribute (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012, 2013 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.