root / debian / kamaki.1 @ 11835f12
History | View | Annotate | Download (8.9 kB)
1 |
.TH "KAMAKI" "1" "April 17, 2013" "0.7" "Kamaki" |
---|---|
2 |
.SH NAME |
3 |
kamaki \- Command-line tool for managing clouds |
4 |
. |
5 |
.nr rst2man-indent-level 0 |
6 |
. |
7 |
.de1 rstReportMargin |
8 |
\\$1 \\n[an-margin] |
9 |
level \\n[rst2man-indent-level] |
10 |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
11 |
- |
12 |
\\n[rst2man-indent0] |
13 |
\\n[rst2man-indent1] |
14 |
\\n[rst2man-indent2] |
15 |
.. |
16 |
.de1 INDENT |
17 |
.\" .rstReportMargin pre: |
18 |
. RS \\$1 |
19 |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
20 |
. nr rst2man-indent-level +1 |
21 |
.\" .rstReportMargin post: |
22 |
.. |
23 |
.de UNINDENT |
24 |
. RE |
25 |
.\" indent \\n[an-margin] |
26 |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
27 |
.nr rst2man-indent-level -1 |
28 |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
29 |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
30 |
.. |
31 |
.\" Man page generated from reStructuredText. |
32 |
. |
33 |
.SH SYNOPSIS |
34 |
.sp |
35 |
\fBkamaki\fP [\fIgroup\fP] [\fIcommand\fP] [...] [\fIoptions\fP] |
36 |
.SH DESCRIPTION |
37 |
.sp |
38 |
\fBkamaki\fP is a simple, yet intuitive, command\-line tool for managing |
39 |
clouds. It can be used in three forms: as an interactive shell, as a command line tool or as a clients API for other applications. |
40 |
.sp |
41 |
To run kamaki as an interactive shell, type |
42 |
.INDENT 0.0 |
43 |
.INDENT 3.5 |
44 |
kamaki |
45 |
.UNINDENT |
46 |
.UNINDENT |
47 |
.sp |
48 |
To run kamaki as tool type |
49 |
.INDENT 0.0 |
50 |
.INDENT 3.5 |
51 |
kamaki <group> <command> [...] [options] |
52 |
.UNINDENT |
53 |
.UNINDENT |
54 |
.sp |
55 |
The kamaki clients API can be imported in python applications as kamaki.clients |
56 |
.sp |
57 |
List of available command groups: |
58 |
.sp |
59 |
config |
60 |
.INDENT 0.0 |
61 |
.INDENT 3.5 |
62 |
Edit configuration options. Config options are stored in ~/.kamakirc file. |
63 |
.UNINDENT |
64 |
.UNINDENT |
65 |
.sp |
66 |
history |
67 |
.INDENT 0.0 |
68 |
.INDENT 3.5 |
69 |
Access kamaki user history, which is stored in ~/.kamaki.history file. |
70 |
.UNINDENT |
71 |
.UNINDENT |
72 |
.sp |
73 |
user |
74 |
.INDENT 0.0 |
75 |
.INDENT 3.5 |
76 |
Get information from Astakos API |
77 |
.UNINDENT |
78 |
.UNINDENT |
79 |
.sp |
80 |
server |
81 |
.INDENT 0.0 |
82 |
.INDENT 3.5 |
83 |
Manage compute API virtual machines. |
84 |
.UNINDENT |
85 |
.UNINDENT |
86 |
.sp |
87 |
flavor |
88 |
.INDENT 0.0 |
89 |
.INDENT 3.5 |
90 |
Manage compute API flavors. |
91 |
.UNINDENT |
92 |
.UNINDENT |
93 |
.sp |
94 |
network |
95 |
.INDENT 0.0 |
96 |
.INDENT 3.5 |
97 |
Manage compute API networks. |
98 |
.UNINDENT |
99 |
.UNINDENT |
100 |
.sp |
101 |
image |
102 |
.INDENT 0.0 |
103 |
.INDENT 3.5 |
104 |
Manage images on Plankton (and Compute). |
105 |
.UNINDENT |
106 |
.UNINDENT |
107 |
.sp |
108 |
file |
109 |
.INDENT 0.0 |
110 |
.INDENT 3.5 |
111 |
Manage Pithos+ API. |
112 |
.UNINDENT |
113 |
.UNINDENT |
114 |
.SH HIDDEN COMMAND GROUPS |
115 |
.sp |
116 |
livetest |
117 |
.INDENT 0.0 |
118 |
.INDENT 3.5 |
119 |
LIve tests that check kamaki against running services. To enable: |
120 |
kamaki config set livetest.cli livetest |
121 |
.UNINDENT |
122 |
.UNINDENT |
123 |
.SH OPTIONS |
124 |
.INDENT 0.0 |
125 |
.INDENT 3.5 |
126 |
.sp |
127 |
.nf |
128 |
.ft C |
129 |
\-\-help, \-h Show help message and exit. |
130 |
\-v Use verbose output. |
131 |
\-d Use debug output. |
132 |
\-o KEY=VAL Override a config value (can be used multiple times) |
133 |
.ft P |
134 |
.fi |
135 |
.UNINDENT |
136 |
.UNINDENT |
137 |
.SH COMMANDS |
138 |
.SS config commands |
139 |
.INDENT 0.0 |
140 |
.IP \(bu 2 |
141 |
list list configuration options |
142 |
.IP \(bu 2 |
143 |
get get a configuration option |
144 |
.IP \(bu 2 |
145 |
set set a configuration option |
146 |
.IP \(bu 2 |
147 |
del delete a configuration option |
148 |
.UNINDENT |
149 |
.SS history commands |
150 |
.sp |
151 |
Command user history, as stored in ~/.kamaki.history |
152 |
.INDENT 0.0 |
153 |
.IP \(bu 2 |
154 |
show show intersession history |
155 |
.IP \(bu 2 |
156 |
clean clean up history |
157 |
.IP \(bu 2 |
158 |
run run/show previously executed command(s) |
159 |
.UNINDENT |
160 |
.SS user commands |
161 |
.INDENT 0.0 |
162 |
.IP \(bu 2 |
163 |
authenticate Authenticate a user, show user information |
164 |
.UNINDENT |
165 |
.SS server commands |
166 |
.INDENT 0.0 |
167 |
.IP \(bu 2 |
168 |
addr List the addresses of all network interfaces on a server (VM) |
169 |
.IP \(bu 2 |
170 |
console Get a VNC console to access an existing server (VM) |
171 |
.IP \(bu 2 |
172 |
create Create a server (aka Virtual Machine) |
173 |
.IP \(bu 2 |
174 |
delete Delete a server (VM) |
175 |
.IP \(bu 2 |
176 |
delmeta Delete server (VM) metadata |
177 |
.IP \(bu 2 |
178 |
firewall Set the server (VM) firewall profile on VMs public network |
179 |
.IP \(bu 2 |
180 |
info Detailed information on a Virtual Machine |
181 |
.IP \(bu 2 |
182 |
list List Virtual Machines accessible by user |
183 |
.IP \(bu 2 |
184 |
meta Get a server\(aqs metadatum |
185 |
.IP \(bu 2 |
186 |
reboot Reboot a server (VM) |
187 |
.IP \(bu 2 |
188 |
rename Set/update a server (VM) name |
189 |
.IP \(bu 2 |
190 |
setmeta set server (VM) metadata |
191 |
.IP \(bu 2 |
192 |
shutdown Shutdown an active server (VM) |
193 |
.IP \(bu 2 |
194 |
start Start an existing server (VM) |
195 |
.IP \(bu 2 |
196 |
stats Get server (VM) statistics |
197 |
.IP \(bu 2 |
198 |
wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
199 |
.UNINDENT |
200 |
.SS flavor commands |
201 |
.INDENT 0.0 |
202 |
.IP \(bu 2 |
203 |
list list flavors |
204 |
.IP \(bu 2 |
205 |
info get flavor details |
206 |
.UNINDENT |
207 |
.SS image commands |
208 |
.INDENT 0.0 |
209 |
.IP \(bu 2 |
210 |
addmember Add a member to an image |
211 |
.IP \(bu 2 |
212 |
addproperty Add an OS\-related property to an image |
213 |
.IP \(bu 2 |
214 |
delete Delete an image (image file remains intact) |
215 |
.IP \(bu 2 |
216 |
delmember Remove a member from an image |
217 |
.IP \(bu 2 |
218 |
delproperty Delete a property of an image |
219 |
.IP \(bu 2 |
220 |
info Get detailed information on an image |
221 |
.IP \(bu 2 |
222 |
members Get image members |
223 |
.IP \(bu 2 |
224 |
meta Get image metadata |
225 |
.IP \(bu 2 |
226 |
properties Get properties related to OS installation in an image |
227 |
.IP \(bu 2 |
228 |
list List images accessible by user |
229 |
.IP \(bu 2 |
230 |
register (Re)Register an image |
231 |
.IP \(bu 2 |
232 |
setmembers Set the members of an image |
233 |
.IP \(bu 2 |
234 |
setproperty Update an existing property in an image |
235 |
.IP \(bu 2 |
236 |
shared List images shared by a member |
237 |
.IP \(bu 2 |
238 |
.INDENT 2.0 |
239 |
.TP |
240 |
.B compute Compute Image API commands |
241 |
.INDENT 7.0 |
242 |
.IP \(bu 2 |
243 |
list List images |
244 |
.IP \(bu 2 |
245 |
delete Delete image |
246 |
.IP \(bu 2 |
247 |
info Get image details |
248 |
.IP \(bu 2 |
249 |
properties Get image properties |
250 |
.IP \(bu 2 |
251 |
delproperty Delete an image property |
252 |
.IP \(bu 2 |
253 |
setproperty Update an image property |
254 |
.UNINDENT |
255 |
.UNINDENT |
256 |
.UNINDENT |
257 |
.SS network commands |
258 |
.INDENT 0.0 |
259 |
.IP \(bu 2 |
260 |
connect Connect a server to a network |
261 |
.IP \(bu 2 |
262 |
create Create an (unconnected) network |
263 |
.IP \(bu 2 |
264 |
delete Delete a network |
265 |
.IP \(bu 2 |
266 |
disconnect Disconnect a nic that connects a server to a network |
267 |
.IP \(bu 2 |
268 |
info Detailed information on a network |
269 |
.IP \(bu 2 |
270 |
list List networks |
271 |
.IP \(bu 2 |
272 |
rename Set the name of a network |
273 |
.UNINDENT |
274 |
.SS file commands |
275 |
.INDENT 0.0 |
276 |
.IP \(bu 2 |
277 |
append Append local file to (existing) remote object |
278 |
.IP \(bu 2 |
279 |
cat Print remote file contents to console |
280 |
.IP \(bu 2 |
281 |
copy Copy an object from container to (another) container |
282 |
.IP \(bu 2 |
283 |
create Create a container |
284 |
.IP \(bu 2 |
285 |
delete Delete a container [or an object] |
286 |
.IP \(bu 2 |
287 |
delgroup Delete a user group |
288 |
.IP \(bu 2 |
289 |
delmeta Delete metadata from account, container or object |
290 |
.IP \(bu 2 |
291 |
delpermissions Delete all permissions set on object |
292 |
.IP \(bu 2 |
293 |
download Download remote object(s) as local file(s) |
294 |
.IP \(bu 2 |
295 |
group Get groups and group members |
296 |
.IP \(bu 2 |
297 |
hashmap Get the hash\-map of an object |
298 |
.IP \(bu 2 |
299 |
info Get detailed info for account, containers or objects |
300 |
.IP \(bu 2 |
301 |
list List containers, object trees or objects in a directory |
302 |
.IP \(bu 2 |
303 |
manifest Create a remote file of uploaded parts by manifestation |
304 |
.IP \(bu 2 |
305 |
meta Get metadata for account, containers or objects |
306 |
.IP \(bu 2 |
307 |
mkdir Create a directory |
308 |
.IP \(bu 2 |
309 |
move Copy an object |
310 |
.IP \(bu 2 |
311 |
overwrite Overwrite part (from start to end) of a remote file |
312 |
.IP \(bu 2 |
313 |
permissions Get read and write permissions of an object |
314 |
.IP \(bu 2 |
315 |
publish Publish the object and print the public url |
316 |
.IP \(bu 2 |
317 |
purge Delete a container and release related data blocks |
318 |
.IP \(bu 2 |
319 |
quota Get quota (in KB) for account or container |
320 |
.IP \(bu 2 |
321 |
setgroup Set a user group |
322 |
.IP \(bu 2 |
323 |
setmeta Set a piece of metadata for account, container or object |
324 |
.IP \(bu 2 |
325 |
setpermissions Set permissions for an object |
326 |
.IP \(bu 2 |
327 |
containerlimit set Set new limit for container |
328 |
.IP \(bu 2 |
329 |
containerlimit get Get container limit |
330 |
.IP \(bu 2 |
331 |
setversioning Set versioning mode (auto, none) for account or container |
332 |
.IP \(bu 2 |
333 |
sharers List the accounts that share objects with current user |
334 |
.IP \(bu 2 |
335 |
touch Create an empty object (file) |
336 |
.IP \(bu 2 |
337 |
truncate Truncate remote file up to a size |
338 |
.IP \(bu 2 |
339 |
unpublish Unpublish an object |
340 |
.IP \(bu 2 |
341 |
upload Upload a file or directory |
342 |
.IP \(bu 2 |
343 |
versioning Get versioning for account or container |
344 |
.IP \(bu 2 |
345 |
versions Get the list of object versions |
346 |
.UNINDENT |
347 |
.SS test commands (hidden) |
348 |
.INDENT 0.0 |
349 |
.IP \(bu 2 |
350 |
all test all clients |
351 |
.IP \(bu 2 |
352 |
args test how arguments are treated by kamaki |
353 |
.IP \(bu 2 |
354 |
astakos test Astakos client |
355 |
.IP \(bu 2 |
356 |
cyclades test Cyclades client |
357 |
.IP \(bu 2 |
358 |
error Create an error message with optional message |
359 |
.IP \(bu 2 |
360 |
image test Image client |
361 |
.IP \(bu 2 |
362 |
pithos test Pithos client |
363 |
.IP \(bu 2 |
364 |
prints user\-test print methods for lists and dicts |
365 |
.UNINDENT |
366 |
.SH AUTHOR |
367 |
.sp |
368 |
Synnefo development team <\fI\%synnefo-devel@googlegroups.com\fP>. |
369 |
.SH COPYRIGHT |
370 |
2012, GRNET |
371 |
.\" Generated by docutils manpage writer. |
372 |
. |