summaryrefslogtreecommitdiffabout
path: root/doc/eclat-setiattr.1
blob: aa9fc5a41c9bbd94208b2e45c06eb0d878061027 (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
.\" This file is part of Eclat -*- nroff -*-
.\" Copyright (C) 2012-2014 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 SETIATTR 1 "April 20, 2013" "ECLAT" "Eclat User Reference"
.SH NAME
eclat setiattr, modify\-instance\-attribute \- modifies attribute of an instance
.SH SYNOPSIS
\fBeclat setiattr\fR \fIINSTANCE-ID\fR \fIATTR\fR\
 \fIVALUE\fR [\fIVALUE\fR...]

\fBeclat setiattr\fR \fB\-\-help\fR
.SH DESCRIPTION
Modifies the specified attribute of an instance.  Only one attribute
can be modified at a time.
.PP
If ID translation is enabled (see the section \fBMAPS\fR
in
.BR eclat (1)),
this command uses the \fBInstanceId\fR map to translate \fIINSTANCE-ID\fR to
the corresponding identifier.
.SH ATTRIBUTES
The \fIATTR\fR argument can be one of the following:
.TP
.BR InstanceType
Changes the instance type to the specified value.
.TP
.BR Kernel
Changes the instance kernel to the specified value.
.TP
.BR Ramdisk
Changes the instance RAM disk.
.TP
.BR UserData
Changes the instance user-specified data.
.TP
.BR DisableApiTermination
Changes the instance termination status.  The \fIVALUE\fR of
\fBtrue\fR means that the instance cannot be terminated using the API.
The \fIVALUE\fR of \fBfalse\fR means the instance can be terminated
via the API.
.TP
.BR InstanceInitiatedShutdownBehavior
Changes the instance initiated shutdown behavior.  Allowed values are
\fBstop\fR (instance will be stopped instead of terminated), and
\fBterminate\fR (instance will be terminated).
.TP
.BR BlockDeviceMapping
Change DeleteOnTermination flag for one or more modules that are
currently attached.  When this attribute is used, multiple
\fIVALUE\fRs are allowed.  Each of them must have the form
\fIDEVICE\fR=\fIBOOL\fR, where \fIDEVICE\fR is the name of the device
the volume is attached to, and \fIBOOL\fR is either \fBtrue\fR (the
volume is deleted when the instance is terminated) or \fBfalse\fR (the
volume remains intact on instance termination).
.TP
.BR sourceDestCheck
Controls Network Address Translation in a VPC.  The instance is able
to perform NAT if \fIVALUE\fR is \fBfalse\fR, and cannot do so if it
is \fBtrue\fR.
.TP
.BR groupId
Changes the security groups this instance is in.  This attribute is
valid only for instances running in a VPC.  One or more \fIVALUE\fRs
can be given.
.TP
.BR ebsOptimized
Controls whether the instance is optimized for EBS I/O.  Allowed
values are \fBtrue\fR or \fBfalse\fR.
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat-lsiattr (1),
.BR eclat-lsistat (1),
.BR eclat-lsinst (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.