summaryrefslogtreecommitdiffabout
path: root/doc/eclat-lsistat.1
blob: ce04a907ca51771d59edb3a6c19876d54ce2a77b (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
.\" 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-LSISTAT 1 "January 26, 2015" "ECLAT" "Eclat User Reference"
.SH NAME
eclat-lsistat, eclat-describe-instance\-status \- describe status of EC2 instances
.SH SYNOPSIS
\fBeclat\fR\
 \fBlsistat\fR
 [\fB\-ar\fR]\
 [\fB\-\-all\fR]\
 [\fB\-\-running\fR]\
 [\fIFILTER\fR...]
.PP
\fBeclat lsistat\fR \fB\-\-help\fR
.SH DESCRIPTION
Describes the status of selected EC2 instances including any scheduled
events.  This information includes:
.nr step 1 1
.IP \n[step].
.B Instance state

This describes the current state of the instance: \fBrunning\fR,
\fBstopped\fR, etc.
.IP \n+[step].
.B System status

The system status refers to the functionality depending on the systems
that support the instance, such as the underlying hardware, network
devices, etc.
.IP \n+[step].
.B Instance status

The instance status describes those aspects of the functionality that
depend on the instance itself (e.g. on its operating system, the
services it runs, etc.)
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-all\fR
Return the status for all instances.  This is the default.
.TP
\fB\-r\fR, \fB\-\-running\fR
Show only running instances.
.SH FILTERS
The following filters are defined:
.TP
\fBavailability\-zone\fR=\fIstring\fR
The Availability Zone of the instance.
.TP
\fBevent.code\fR=\fIvalue\fR
The code identifying the type of event.  Valid \fIvalue\fRs are: 
.BR instance\-reboot ,
.BR system\-reboot ,
.BR system\-maintenance ,
.BR instance\-retirement .
.TP
\fBevent.description\fR=\fIstring\fR
A description of the event.
.TP
\fBevent.not\-after\fR=\fIdate\fR
The latest end time for the scheduled event.
.TP
\fBevent.not\-before\fR=\fIdate\fR
The earliest start time for the scheduled event.
.TP
\fBinstance\-state\-name\fR=\fIvalue\fR
The state of the instance.  The valid \fIvalue\fRs are:
.BR pending ,
.BR running ,
.BR shutting\-down ,
.BR terminated ,
.BR stopping ,
.BR stopped .

Note that unless \fIvalue\fR is \fBrunning\fR you have to use the
\fB\-a\fR (\fB\-\-all\fR) option for this filter to take effect.
.TP
\fBinstance\-state\-code\fR=\fIcode\fR
A code representing the state of the instance.
Valid values are:
.RS
.TP
.B 0
pending
.TP
.B 16
running
.TP
.B 32
shutting\-down
.TP
.B 48
terminated
.TP
.B 64
stopping
.TP
.B 80
stopped
.RE
.sp
Note that unless \fIcode\fR is \fB0\fR you have to use the
\fB\-a\fR (\fB\-\-all\fR) option for this filter to take effect.
.TP
\fBsystem\-status.status\fR=\fIvalue\fR
The system status of the instance.  Valid values are:
.BR ok ,
.BR impaired ,
.BR initializing ,
.BR insufficient\-data ,
.BR not\-applicable .
.TP
\fBsystem\-status.reachability\fR=\fIstring\fR
System reachability status, one of:
.BR passed ,
.BR failed ,
.BR initializing ,
.BR insufficient\-data .
.TP
\fBinstance\-status.status\fR=\fIstring\fR
The status of the instance.  One of:
.BR ok ,
.BR impaired ,
.BR initializing ,
.BR insufficient\-data ,
.BR not\-applicable .
.TP
\fBinstance\-status.reachability\fR=\fIstring\fR
The instance reachability status.  One of:
.BR passed ,
.BR failed ,
.BR initializing ,
.BR insufficient\-data .
.SH OUTPUT
Each instance is described on a separate line.  The fields are
separated by single \fBTAB\fR characters.  The fields displayed are
(from left to right): instance ID, region, and instance state.  If the
instance is running, system and instance status are also displayed.
If any events are reported, they are output on the standard error.
.SH EXAMPLE
In the example below the long lines are split for readability:
.PP
.EX
$ eclat lsistat \-a
i\-283f9f47 us\-east\-1d running impaired\
 Sys.reachability=failed Inst.reachability=failed
i\-283f9f47	Event: "The instance is running on degraded hardware"
i\-d2e36dbd us\-east\-1d running ok\
  Sys.reachability=passed	Inst.reachability=passed
.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-lsinst (1),
.BR eclat\-lsiattr (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.