summaryrefslogtreecommitdiffabout
path: root/doc/eclat-lsvol.1
blob: 594611df1125a53042fb00cf72c9726b8ba53b16 (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.\" This file is part of Eclat -*- nroff -*-
.\" Copyright (C) 2012-2015 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-LSVOL 1 "January 26, 2015" "ECLAT" "Eclat User Reference"
.SH NAME
eclat-lsvol, eclat-describe-volumes \- list EBS volumes
.SH SYNOPSIS
\fBeclat lsvol\fR [\fIFILTER\fR...] [\fIID\fR...]
.PP
\fBeclat lsvol\fR \fB\-\-help\fR
.SH DESCRIPTION
This command displays the EBS volumes in your account.  By default,
all volumes are shown.  To select particular volumes, give their IDs
in the command line.
.PP
If ID mapping is enabled (see the section \fBMAPS\fR
in
.BR eclat (1)),
this command treats the IDs as volume names and translates them to the
AWS IDs using the \fBVolumeId\fR map.
.SH FILTERS
Filters allow you to select only volumes matching particular
criteria.  The following filters are defined:
.TP
\fBattachment.attach\-time\fR=\fIdate\fR
The time stamp when the attachment initiated.
.TP
\fBattachment.delete\-on\-termination\fR=\fIboolean\fR
Whether the volume is deleted on instance termination.
.TP
\fBattachment.device\fR=\fBstring\fR
The device name that is exposed to the instance (for example, /dev/sda1).
.TP
\fBattachment.instance\-id\fR=\fIstring\fR
.TP
\fBattachment.status\fR=\fIvalue\fR
The attachment state.  Valid \fIvalue\fRs are:
.BR attaching ,
.BR attached ,
.BR detaching ,
.BR detached .
.TP
\fBavailability\-zone\fR=\fIstring\fR
The availability zone in which the volume was created.
.TP
\fBcreate\-time\fR=\fIdate\fR
.TP
\fBsize\fR=\fIinteger\fB
The size of the volume, in GiB.
.TP
\fBsnapshot\-id\fR=\fIstring\fR
The snapshot from which the volume was created.
.TP
\fBstatus\fR=\fIvalue\fR
The status of the volume.  Allowed \fIvalue\fR is one of:
.BR creating ,
.BR available ,
.BR in\-use ,
.BR deleting ,
.BR deleted ,
.BR error .
.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 snapshots that have the tag
\fBfoo\fR defined and all snapshots that have \fBbar\fR as a value of any
of their tags.  To request a snapshot 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 the snapshots having the specified tag \fIKEY\fR set to the value
\fIVAL\fR.  For example:
.sp
.EX
tag:Name="root partition"
.EE
.TP
\fBvolume\-id\fR=\fIID\fR
The volume ID.  This filter has the same effect as specifying \fIID\fR
as the command line argument.  It is needed mostly when you use ID
mapping but wish to identify some modules by their IDs and another by
their symbolic name, e.g.:
.sp
.EX
eclat \-x lsvol root volume\-id=vol\-1aeb5008 srv
.EE
.TP
\fBvolume\-type\fR=\fIvalue\fR
The Amazon EBS volume type.  Valid values are
.B standard
and
.BR io1 .
.SH OUTPUT
Each volume is listed on a separate line.  Output fields are separated
by horizontal tab characters.  The fields are: the volume ID, its size
in GiB, and status.  Following this, volume attachments are
described.  Each attachment consists of four fields: the volume ID,
the ID of the instance it is attached to, the device name it is known
as, and the attachment status.  For example:
.PP
.EX
vol\-4282672b 80 in\-use vol\-4282672b i\-6058a509 /dev/sdh attached
.EE
.SH "SEE ALSO"
.BR eclat (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.