aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--TODO6
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/eclat-create-tags.196
-rw-r--r--doc/eclat-delete-tags.196
-rw-r--r--doc/eclat-describe-tags.1103
5 files changed, 301 insertions, 3 deletions
diff --git a/TODO b/TODO
index 7c3b518..95655de 100644
--- a/TODO
+++ b/TODO
@@ -42,7 +42,7 @@ CreateSecurityGroup CRESECGRP [ ] [ ]
CreateSnapshot CRESNAP [X] [X]
CreateSpotDatafeedSubscription CRESPOTDFSSCR [ ] [ ]
CreateSubnet CRESUB [ ] [ ]
-CreateTags CRETAGS [X] [ ]
+CreateTags CRETAGS [X] [X]
CreateVolume CREVOL [ ] [ ]
CreateVpc CREVPC [ ] [ ]
CreateVpnConnection CREVPNCNCT [ ] [ ]
@@ -62,7 +62,7 @@ DeleteSecurityGroup DELSECGRP [ ] [ ]
DeleteSnapshot DELSNAP [X] [X]
DeleteSpotDatafeedSubscription DELSPOTDFSSCR [ ] [ ]
DeleteSubnet DELSUB [ ] [ ]
-DeleteTags DELTAGS [X] [ ]
+DeleteTags DELTAGS [X] [X]
DeleteVolume DELVOL [ ] [ ]
DeleteVpc DELVPC [ ] [ ]
DeleteVpnConnection DELVPNCNCT [ ] [ ]
@@ -99,7 +99,7 @@ DescribeSpotDatafeedSubscription DSCRSPOTDFSSCR [ ] [ ]
DescribeSpotInstanceRequests DSCRSPOTINSTREQS [ ] [ ]
DescribeSpotPriceHistory DSCRSPOTPRICHIST [ ] [ ]
DescribeSubnets DSCRSUBS [ ] [ ]
-DescribeTags DSCRTAGS [X] [ ]
+DescribeTags DSCRTAGS [X] [X]
DescribeVolumes DSCRVOLS [X] [ ]
DescribeVolumeAttribute DSCRVOLATTR [ ] [ ]
DescribeVolumeStatus DSCRVOLSTAT [ ] [ ]
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 476f810..eff235d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -18,8 +18,11 @@ dist_man_MANS=\
eclat.1\
eclat-associate-address.1\
eclat-create-snapshot.1\
+ eclat-create-tags.1\
eclat-delete-snapshot.1\
+ eclat-delete-tags.1\
eclat-describe-snapshots.1\
+ eclat-describe-tags.1\
eclat-disassociate-address.1\
eclat-get-console-output.1\
eclat-start-instances.1\
diff --git a/doc/eclat-create-tags.1 b/doc/eclat-create-tags.1
new file mode 100644
index 0000000..b9f90da
--- /dev/null
+++ b/doc/eclat-create-tags.1
@@ -0,0 +1,96 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012 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 CREATE\-TAGS 1 "October 15, 2012" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat eclat\-create\-tags \- create or replace tags for a resource
+.SH SYNOPSIS
+eclat eclat\-create\-tags [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
+ [\fB\-r\fR \fIID\fR] [\fB\-v\fR \fIID\fR]
+ [\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR] [\fB\-\-resource\-id\fR \fIID\fR]
+ [\fB\-\-volume\fR \fIID\fR] \fITAG\fR[=\fIVAL\fR]...
+
+eclat eclat\-create\-tags \fB\-\-help\fR
+.SH DESCRIPTION
+This command creates or replaces one or more tags for a given
+resource. Tags are specified by their names. If a tag name is
+followed by an equals sign, the characters following that sign are
+stored in this tag's value. Otherwise an empty value is assigned to
+it.
+.PP
+The resource to create the tags for is supplied with one of the
+options. The resource designation must be present.
+.PP
+If ID mapping is enabled (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+all options except \fB\-r\fR (\fB\-\-resource\-id\fR) translate their
+arguments using corresponding maps.
+.SH OPTIONS
+.TP
+\fB\-a\fR, \fB\-\-ami\fR \fIID\fR
+Creates tags for the given image. In resource translation mode, uses
+the map \fBImageId\fR.
+.TP
+\fB\-i\fR, \fB\-\-instance\fR \fIID\fR
+Creates tags for the given instance. In resource translation mode, uses
+the map \fBInstanceId\fR.
+.TP
+\fB\-r\fR, \fB\-\-resource\-id\fR \fIID\fR
+Creates tags for the EC2 resource identified by \fIID\fR.
+.TP
+\fB\-v\fR, \fB\-\-volume\fR \fIID\fR
+Creates tags for the given volume. In resource translation mode, uses
+the map \fBVolumeId\fR.
+.SH OUTPUT
+By default the command does not output anything, unless an error
+occurs in which case the error diagnostics is printed on the standard
+error.
+.SH EXAMPLE
+.sp
+.nf
+.in +2
+eclat create\-tags \-i i\-12345678 Name=Webserver test
+.in
+.fi
+.sp
+This command creates two tags for instance \fBi\-12345678\fR: the tag
+\fBName\fR with the value \fBWebserver\fR and tag \fBtest\fR with
+empty value.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-delete\-tags (1),
+.BR eclat\-describe\-tags (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012 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-delete-tags.1 b/doc/eclat-delete-tags.1
new file mode 100644
index 0000000..e255bde
--- /dev/null
+++ b/doc/eclat-delete-tags.1
@@ -0,0 +1,96 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012 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 DELETE\-TAGS 1 "October 15, 2012" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat eclat\-delete\-tags \- delete or replace tags for a resource
+.SH SYNOPSIS
+eclat eclat\-delete\-tags [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
+ [\fB\-r\fR \fIID\fR] [\fB\-v\fR \fIID\fR]
+ [\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR] [\fB\-\-resource\-id\fR \fIID\fR]
+ [\fB\-\-volume\fR \fIID\fR] \fITAG\fR[=\fIVAL\fR]...
+
+eclat eclat\-delete\-tags \fB\-\-help\fR
+.SH DESCRIPTION
+This command deletes more tags for a given resource. Tags are
+specified by their names. If a tag name is followed by an equals
+sign and a value, it will be deleted only if both its name and value
+are the same as the supplied ones. Otherwise, the tag will be deleted
+regardless of its value.
+.PP
+The resource to delete tags from is supplied with one of the
+options. The resource designation must be present.
+.PP
+If ID mapping is enabled (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+all options except \fB\-r\fR (\fB\-\-resource\-id\fR) translate their
+arguments using corresponding maps.
+.SH OPTIONS
+.TP
+\fB\-a\fR, \fB\-\-ami\fR \fIID\fR
+Deletes tags from the given image. In resource translation mode, uses
+the map \fBImageId\fR.
+.TP
+\fB\-i\fR, \fB\-\-instance\fR \fIID\fR
+Deletes tags from the given instance. In resource translation mode, uses
+the map \fBInstanceId\fR.
+.TP
+\fB\-r\fR, \fB\-\-resource\-id\fR \fIID\fR
+Deletes tags from the EC2 resource identified by \fIID\fR.
+.TP
+\fB\-v\fR, \fB\-\-volume\fR \fIID\fR
+Deletes tags from the given volume. In resource translation mode, uses
+the map \fBVolumeId\fR.
+.SH OUTPUT
+By default the command does not output anything, unless an error
+occurs in which case the error diagnostics is printed on the standard
+error.
+.SH EXAMPLE
+.sp
+.nf
+.in +2
+eclat delete\-tags \-i i\-12345678 Name=Webserver test
+.in
+.fi
+.sp
+This command deletes two tags from the instance \fBi\-12345678\fR: the tag
+\fBName\fR, if it has the value \fBWebserver\fR and tag \fBtest\fR,
+no matter what its value is.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-create\-tags (1),
+.BR eclat\-describe\-tags (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012 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-tags.1 b/doc/eclat-describe-tags.1
new file mode 100644
index 0000000..93a9dd1
--- /dev/null
+++ b/doc/eclat-describe-tags.1
@@ -0,0 +1,103 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012 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\-TAGS 1 "October 15, 2012" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat eclat\-describe\-tags \- list the EC2 tags
+.SH SYNOPSIS
+eclat eclat\-describe\-tags [\fBFILTER\fR...]
+
+eclat eclat\-describe\-tags \fB\-\-help\fR
+.SH DESCRIPTION
+This command lists the EC2 tags. If no filter has been supplied, all
+tags are listed.
+.SH FILTERS
+Available filters are:
+.TP
+\fBkey\fR=\fIstring\fR
+Lists tags with the given key.
+.TP
+\fBresource\-id\fR=\fIstring\fR[,\fIstring\fR...]
+Lists tags pertaining to the given resorce ID or IDs. Multiple IDs
+are allowed, provided that they are separated by commas. If ID
+mapping is requested (see the
+.B MAPS
+section in
+.BR eclat (1)),
+each ID can be prefixed with the map name and a colon in order to
+request its translation using this map. For example:
+.sp
+.nf
+.in +2
+eclat \-x describe\-tags resource\-id=InstanceId:webserver
+.in
+.fi
+.sp
+.TP
+\fBresource\-type\fR=\fItype\fR.
+List only tags pertaining to resources of the given \fItype\fR. Valid
+\fItype\fRs are: \fBcustomer-gateway\fR, \fBdhcp-options\fR,
+\fBimage\fR, \fBinstance\fR, \fBinternet-gateway\fR, \fBnetwork-acl\fR,
+\fBreserved-instances\fR, \fBroute-table\fR, \fBsecurity-group\fR,
+\fBsnapshot\fR, \fBspot-instances-request\fR, \fBsubnet\fR,
+\fBvolume\fR, \fBvpc\fR, \fBvpn-connection\fR, and \fBvpn-gateway\fR.
+.TP
+\fBvalue\fR
+Lists tags with the given value.
+.SH OUTPUT
+The default output format lists on each line the resource ID, its
+type, the tag name and its value. For example:
+.sp
+.nf
+.in +2
+ami-1a2b3c4d image webserver
+ami-1a2b3c4d image stack Production
+i-5f4e3d2a instance webserver
+i-5f4e3d2a instance stack Production
+i-12345678 instance database_server
+.in
+.fi
+.SH EXAMPLE
+.sp
+.nf
+.in +2
+eclat describe\-tags resource-id=i-5f4e3d2a key=Name
+.in
+.fi
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-create\-tags (1),
+.BR eclat\-delete\-tags (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012 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.