root / debian / kamaki.1 @ e78f2082
History | View | Annotate | Download (10.6 kB)
1 |
.TH "KAMAKI" "1" "December 16, 2013" "0.12" "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 reStructeredText. |
32 |
. |
33 |
.SH SYNOPSIS |
34 |
.sp |
35 |
\fBkamaki\fP [\fIgroup\fP] [\fIcommand\fP] [...] [\fIoptions\fP] [\fIarguments\fP] |
36 |
\fBkamaki\-shell\fP [\fIgroup\fP] [\fIcommand\fP] [...] [\fIarguments\fP] |
37 |
.SH DESCRIPTION |
38 |
.sp |
39 |
\fBkamaki\fP is a simple, yet intuitive, command\-line tool for managing |
40 |
clouds. It can be used in three forms: as an interactive shell |
41 |
(\fIkamaki\-shell\fP), as a command line tool (\fIkamaki\fP) or as a clients API for |
42 |
other applications (\fIkamaki.clients\fP). |
43 |
.sp |
44 |
To run \fIkamaki\fP as an interactive shell, type |
45 |
.INDENT 0.0 |
46 |
.INDENT 3.5 |
47 |
kamaki\-shell |
48 |
.UNINDENT |
49 |
.UNINDENT |
50 |
.sp |
51 |
To run \fIkamaki\fP as tool type |
52 |
.INDENT 0.0 |
53 |
.INDENT 3.5 |
54 |
kamaki <group> <command> [...] [options] |
55 |
.UNINDENT |
56 |
.UNINDENT |
57 |
.sp |
58 |
The kamaki clients API can be imported in python applications as |
59 |
\fIkamaki.clients\fP |
60 |
.sp |
61 |
List of available command groups: |
62 |
.INDENT 0.0 |
63 |
.TP |
64 |
.B user |
65 |
Astakos/Identity API commands |
66 |
.TP |
67 |
.B project |
68 |
Astakos project API commands |
69 |
.TP |
70 |
.B quota |
71 |
Astakos/Account API commands for quotas |
72 |
.TP |
73 |
.B resource |
74 |
Astakos/Account API commands for resources |
75 |
.TP |
76 |
.B file |
77 |
Pithos+/Storage object level API commands |
78 |
.TP |
79 |
.B container |
80 |
Pithos+/Storage container level API commands |
81 |
.TP |
82 |
.B group |
83 |
Pithos+/Storage user groups |
84 |
.TP |
85 |
.B sharer |
86 |
Pithos+/Storage sharer accounts |
87 |
.TP |
88 |
.B server |
89 |
Cyclades/Compute API server commands |
90 |
.TP |
91 |
.B flavor |
92 |
Cyclades/Compute API flavor commands |
93 |
.TP |
94 |
.B image |
95 |
Cyclades/Plankton API image commands |
96 |
.TP |
97 |
.B imagecompute |
98 |
Cyclades/Compute API image commands |
99 |
.TP |
100 |
.B network |
101 |
Networking API network commands |
102 |
.TP |
103 |
.B subnet |
104 |
Networking API network commands |
105 |
.TP |
106 |
.B ip |
107 |
Networking API floatingip commands |
108 |
.TP |
109 |
.B port |
110 |
Networking API network Commands |
111 |
.TP |
112 |
.B config |
113 |
Kamaki option and cloud configuration |
114 |
.TP |
115 |
.B history |
116 |
Kamaki command history |
117 |
.UNINDENT |
118 |
.SH HIDDEN COMMAND GROUPS |
119 |
.INDENT 0.0 |
120 |
.TP |
121 |
.B livetest |
122 |
Live tests that check kamaki against running services. To enable: |
123 |
kamaki config set livetest.cli livetest |
124 |
.TP |
125 |
.B service |
126 |
Astakos API service commands |
127 |
.TP |
128 |
.B endpoint |
129 |
Astakos API endpoints commands |
130 |
.TP |
131 |
.B commission |
132 |
Astakos API commission commands |
133 |
.UNINDENT |
134 |
.SH OPTIONS |
135 |
.sp |
136 |
.nf |
137 |
.ft C |
138 |
\-\-help, \-h Show help message and exit. |
139 |
\-v Use verbose output. |
140 |
\-d Use debug output. |
141 |
\-o KEY=VAL Override a config value (can be repeated) |
142 |
\-\-cloud CLOUD Choose a cloud to connect to |
143 |
.ft P |
144 |
.fi |
145 |
.SH COMMANDS |
146 |
.SS user |
147 |
.INDENT 0.0 |
148 |
.IP \(bu 2 |
149 |
authenticate Authenticate a user, show user information |
150 |
.IP \(bu 2 |
151 |
info Get info for (current) session user |
152 |
.IP \(bu 2 |
153 |
uuid2name Get user name(s) from uuid(s) |
154 |
.IP \(bu 2 |
155 |
authenticate Authenticate a user and get all authentication information |
156 |
.IP \(bu 2 |
157 |
list List (cached) session users |
158 |
.IP \(bu 2 |
159 |
add Authenticate a user by token and add to kamaki session (cache) |
160 |
.IP \(bu 2 |
161 |
name2uuid Get user uuid(s) from name(s) |
162 |
.IP \(bu 2 |
163 |
select Select a user from the (cached) list as the current session user |
164 |
.IP \(bu 2 |
165 |
delete Delete a user (token) from the (cached) list of session users |
166 |
.UNINDENT |
167 |
.SS project |
168 |
.INDENT 0.0 |
169 |
.IP \(bu 2 |
170 |
info Get details for a project |
171 |
.IP \(bu 2 |
172 |
unsuspend Resume a suspended project (special privileges needed) |
173 |
.IP \(bu 2 |
174 |
suspend Suspend a project (special privileges needed) |
175 |
.IP \(bu 2 |
176 |
list List all projects |
177 |
.IP \(bu 2 |
178 |
create Apply for a new project |
179 |
.IP \(bu 2 |
180 |
modify Modify a project |
181 |
.IP \(bu 2 |
182 |
terminate Terminate a project (special privileges needed) |
183 |
.IP \(bu 2 |
184 |
application Application management commands |
185 |
.IP \(bu 2 |
186 |
membership Project membership management commands |
187 |
.IP \(bu 2 |
188 |
reinstate Reinstate a terminated project (special privileges needed) |
189 |
.UNINDENT |
190 |
.SS quota |
191 |
.INDENT 0.0 |
192 |
.IP \(bu 2 |
193 |
list Get user quotas |
194 |
.IP \(bu 2 |
195 |
info Get quota for a service (cyclades, pithos, astakos) |
196 |
.UNINDENT |
197 |
.SS resource |
198 |
.INDENT 0.0 |
199 |
.IP \(bu 2 |
200 |
list List user resources |
201 |
.UNINDENT |
202 |
.SS file |
203 |
.INDENT 0.0 |
204 |
.IP \(bu 2 |
205 |
info Get information/details about a file |
206 |
.IP \(bu 2 |
207 |
truncate Truncate remote file up to size |
208 |
.IP \(bu 2 |
209 |
mkdir Create a directory ( create \-\-content\-type=\(aqapplcation/directory\(aq ) |
210 |
.IP \(bu 2 |
211 |
create Create an empty file |
212 |
.IP \(bu 2 |
213 |
move Move objects, even between different accounts or containers |
214 |
.IP \(bu 2 |
215 |
list List all objects in a container or a directory object |
216 |
.IP \(bu 2 |
217 |
upload Upload a file |
218 |
.IP \(bu 2 |
219 |
cat Fetch remote file contents |
220 |
.IP \(bu 2 |
221 |
modify Modify the attributes of a file or directory object |
222 |
.IP \(bu 2 |
223 |
append Append local file to (existing) remote object |
224 |
.IP \(bu 2 |
225 |
download Download a remove file or directory object to local file system |
226 |
.IP \(bu 2 |
227 |
copy Copy objects, even between different accounts or containers |
228 |
.IP \(bu 2 |
229 |
overwrite Overwrite part of a remote file |
230 |
.IP \(bu 2 |
231 |
delete Delete a file or directory object |
232 |
.UNINDENT |
233 |
.SS container |
234 |
.INDENT 0.0 |
235 |
.IP \(bu 2 |
236 |
info Get information about a container |
237 |
.IP \(bu 2 |
238 |
modify Modify the properties of a container |
239 |
.IP \(bu 2 |
240 |
create Create a new container |
241 |
.IP \(bu 2 |
242 |
list List all containers, or their contents |
243 |
.IP \(bu 2 |
244 |
empty Empty a container |
245 |
.IP \(bu 2 |
246 |
delete Delete a container |
247 |
.UNINDENT |
248 |
.SS group |
249 |
.INDENT 0.0 |
250 |
.IP \(bu 2 |
251 |
create Create a group of users |
252 |
.IP \(bu 2 |
253 |
list List all groups and group members |
254 |
.IP \(bu 2 |
255 |
delete Delete a user group |
256 |
.UNINDENT |
257 |
.SS sharer |
258 |
.INDENT 0.0 |
259 |
.IP \(bu 2 |
260 |
info Details on a Pithos+ sharer account (default: current account) |
261 |
.IP \(bu 2 |
262 |
list List accounts who share file objects with current user |
263 |
.UNINDENT |
264 |
.SS server |
265 |
.INDENT 0.0 |
266 |
.IP \(bu 2 |
267 |
info Detailed information on a Virtual Machine |
268 |
.IP \(bu 2 |
269 |
modify Modify attributes of a virtual server |
270 |
.IP \(bu 2 |
271 |
create Create a server (aka Virtual Machine) |
272 |
.IP \(bu 2 |
273 |
list List virtual servers accessible by user |
274 |
.IP \(bu 2 |
275 |
reboot Reboot a virtual server |
276 |
.IP \(bu 2 |
277 |
start Start an existing virtual server |
278 |
.IP \(bu 2 |
279 |
shutdown Shutdown an active virtual server |
280 |
.IP \(bu 2 |
281 |
delete Delete a virtual server |
282 |
.IP \(bu 2 |
283 |
wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
284 |
.UNINDENT |
285 |
.SS flavor |
286 |
.INDENT 0.0 |
287 |
.IP \(bu 2 |
288 |
list list flavors |
289 |
.IP \(bu 2 |
290 |
info get flavor details |
291 |
.UNINDENT |
292 |
.SS image |
293 |
.INDENT 0.0 |
294 |
.IP \(bu 2 |
295 |
info Get image metadata |
296 |
.IP \(bu 2 |
297 |
list List images accessible by user |
298 |
.IP \(bu 2 |
299 |
register (Re)Register an image file to an Image service |
300 |
.IP \(bu 2 |
301 |
modify Add / update metadata and properties for an image |
302 |
.IP \(bu 2 |
303 |
unregister Unregister an image (does not delete the image file) |
304 |
.UNINDENT |
305 |
.SS imagecompute |
306 |
.INDENT 0.0 |
307 |
.IP \(bu 2 |
308 |
info Get detailed information on an image |
309 |
.IP \(bu 2 |
310 |
list List images |
311 |
.IP \(bu 2 |
312 |
modify Modify image properties (metadata) |
313 |
.IP \(bu 2 |
314 |
delete Delete an image (WARNING: image file is also removed) |
315 |
.UNINDENT |
316 |
.SS network |
317 |
.INDENT 0.0 |
318 |
.IP \(bu 2 |
319 |
info: Get details about a network |
320 |
.IP \(bu 2 |
321 |
disconnect: Disconnect a network from a device |
322 |
.IP \(bu 2 |
323 |
modify: Modify network attributes |
324 |
.IP \(bu 2 |
325 |
create: Create a new network |
326 |
.IP \(bu 2 |
327 |
list: List networks |
328 |
.IP \(bu 2 |
329 |
connect: Connect a network with a device (server or router) |
330 |
.IP \(bu 2 |
331 |
delete: Delete a network |
332 |
.UNINDENT |
333 |
.SS subnet |
334 |
.INDENT 0.0 |
335 |
.IP \(bu 2 |
336 |
info Get details about a subnet |
337 |
.IP \(bu 2 |
338 |
list List subnets |
339 |
.IP \(bu 2 |
340 |
create Create a new subnet |
341 |
.IP \(bu 2 |
342 |
modify Modify the attributes of a subnet |
343 |
.UNINDENT |
344 |
.SS ip |
345 |
.INDENT 0.0 |
346 |
.IP \(bu 2 |
347 |
info Details for an IP |
348 |
.IP \(bu 2 |
349 |
list List reserved floating IPs |
350 |
.IP \(bu 2 |
351 |
attach Attach a floating IP to a server |
352 |
.IP \(bu 2 |
353 |
pools List pools of floating IPs |
354 |
.IP \(bu 2 |
355 |
release Release a floating IP |
356 |
.IP \(bu 2 |
357 |
detach Detach a floating IP from a server |
358 |
.IP \(bu 2 |
359 |
reserve Reserve a floating IP |
360 |
.UNINDENT |
361 |
.SS port |
362 |
.INDENT 0.0 |
363 |
.IP \(bu 2 |
364 |
info Get details about a port |
365 |
.IP \(bu 2 |
366 |
list List all ports |
367 |
.IP \(bu 2 |
368 |
create Create a new port (== connect server to network) |
369 |
.IP \(bu 2 |
370 |
modify Modify the attributes of a port |
371 |
.IP \(bu 2 |
372 |
delete Delete a port (== disconnect server from network) |
373 |
.IP \(bu 2 |
374 |
wait Wait for port to finish [ACTIVE, DOWN, BUILD, ERROR] |
375 |
.UNINDENT |
376 |
.SS config |
377 |
.INDENT 0.0 |
378 |
.IP \(bu 2 |
379 |
list list configuration options |
380 |
.IP \(bu 2 |
381 |
get get a configuration option |
382 |
.IP \(bu 2 |
383 |
set set a configuration option |
384 |
.IP \(bu 2 |
385 |
del delete a configuration option |
386 |
.UNINDENT |
387 |
.SS history |
388 |
.sp |
389 |
Command user history, as stored in ~/.kamaki.history |
390 |
.INDENT 0.0 |
391 |
.IP \(bu 2 |
392 |
show show intersession history |
393 |
.IP \(bu 2 |
394 |
clean clean up history |
395 |
.IP \(bu 2 |
396 |
run run/show previously executed command(s) |
397 |
.UNINDENT |
398 |
.SS livetest (hidden) |
399 |
.INDENT 0.0 |
400 |
.IP \(bu 2 |
401 |
all test all clients |
402 |
.IP \(bu 2 |
403 |
args test how arguments are treated by kamaki |
404 |
.IP \(bu 2 |
405 |
astakos test Astakos client |
406 |
.IP \(bu 2 |
407 |
cyclades test Cyclades client |
408 |
.IP \(bu 2 |
409 |
error Create an error message with optional message |
410 |
.IP \(bu 2 |
411 |
image test Image client |
412 |
.IP \(bu 2 |
413 |
pithos test Pithos client |
414 |
.IP \(bu 2 |
415 |
prints user\-test print methods for lists and dicts |
416 |
.UNINDENT |
417 |
.SS service (hidden) |
418 |
.INDENT 0.0 |
419 |
.IP \(bu 2 |
420 |
list List available services |
421 |
.IP \(bu 2 |
422 |
uuid2username Get service username(s) from uuid(s) |
423 |
.IP \(bu 2 |
424 |
quotas Get service quotas |
425 |
.IP \(bu 2 |
426 |
username2uuid Get service uuid(s) from username(s) |
427 |
.UNINDENT |
428 |
.SS endpoint (hidden) |
429 |
.INDENT 0.0 |
430 |
.IP \(bu 2 |
431 |
list Get endpoints service endpoints |
432 |
.UNINDENT |
433 |
.SS commission (hidden) |
434 |
.INDENT 0.0 |
435 |
.IP \(bu 2 |
436 |
info Get commission info (special privileges required) |
437 |
.IP \(bu 2 |
438 |
resolve Resolve multiple commissions (special privileges required) |
439 |
.IP \(bu 2 |
440 |
accept Accept a pending commission (special privileges required) |
441 |
.IP \(bu 2 |
442 |
reject Reject a pending commission (special privileges required) |
443 |
.IP \(bu 2 |
444 |
issue Issue commissions as a json string (special privileges required) |
445 |
.IP \(bu 2 |
446 |
pending List pending commissions (special privileges required) |
447 |
.UNINDENT |
448 |
.SH AUTHOR |
449 |
.sp |
450 |
Synnefo development team <\fI\%synnefo-devel@googlegroups.com\fP>. |
451 |
.SH COPYRIGHT |
452 |
2013, GRNET |
453 |
.\" Generated by docutils manpage writer. |
454 |
.\" |
455 |
. |