summaryrefslogtreecommitdiffabout
path: root/doc/eclat-lstag.1
blob: 482ea36c11a1f6fde936e4762f402bf0067d0b97 (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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
.\" 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-LSTAG 1 "January 26, 2015" "ECLAT" "Eclat User Reference"
.SH NAME
eclat-lstag, eclat-describe-tags \- list the EC2 tags 
.SH SYNOPSIS
.nh
.na
\fBeclat lstag\fR [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
 [\fB\-r\fR [\fIMAP\fR:]\fIID\fR] [\fB\-s \fIID\fR] [\fB\-v\fR \fIID\fR]\
 [\fB\-T\fR \fIFILE\fR]\
 [\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR]\
 [\fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR]\
 [\fB\-\-volume\fR \fIID\fR] [\fB\-\-snapshot\fR \fIID\fR]\
 [\fIFILTER\fR...]
.PP
\fBeclat lstag\fR \fB\-\-help\fR
.ad
.hy
.SH DESCRIPTION
This command lists the EC2 tags.  If no filter has been supplied, all
tags are listed.  
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-ami\fR \fIID\fR
Describes tags of the given image.  In resource translation mode, uses
the map \fBImageId\fR.
.TP
\fB\-i\fR, \fB\-\-instance\fR \fIID\fR
Describes tags of the given instance.  In resource translation mode, uses
the map \fBInstanceId\fR.
.TP
\fB\-r\fR, \fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR
Describes tags of the EC2 resource identified by \fIID\fR.  If optional
\fIMAP\fR prefix is supplied and resource translation mode is enabled,
this option will use the \fIMAP\fR to translate \fIID\fR into AWS
resource identifier.
.TP
\fB\-s\fR, \fB\-\-snapshot\fR \fIID\fR
Describes tags of the given snapshot.  In resource translation mode, uses
the map \fBSnapshotId\fR.
.TP
\fB\-v\fR, \fB\-\-volume\fR \fIID\fR
Describes tags of the given volume.  In resource translation mode, uses
the map \fBVolumeId\fR.
.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
.EX
eclat \-x lstag resource\-id=InstanceId:webserver
.EE
.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=\fIstring\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:
.PP
.EX
ami-1a2b3c4d	image	webserver	
ami-1a2b3c4d	image	stack	Production
i-5f4e3d2a	instance	webserver	
i-5f4e3d2a	instance	stack	Production
i-12345678	instance	database_server	
.EE
.SH EXAMPLE
.PP
.EX
eclat lstag resource-id=i-5f4e3d2a key=Name
.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-mktag (1),
.BR eclat\-rmtag (1).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <bug\-eclat@gnu.org.ua>.
.SH COPYRIGHT
Copyright \(co 2012-2015 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.