Revision cf49aa14 docs/man/kamaki.rst
| b/docs/man/kamaki.rst | ||
|---|---|---|
| 6 | 6 |
Synopsis |
| 7 | 7 |
-------- |
| 8 | 8 |
|
| 9 |
**kamaki** <*group*> <*command*> [*options*]
|
|
| 9 |
**kamaki** [*group*] [*command*] [...] [*options*]
|
|
| 10 | 10 |
|
| 11 | 11 |
|
| 12 | 12 |
Description |
| 13 | 13 |
----------- |
| 14 | 14 |
|
| 15 | 15 |
:program:`kamaki` is a simple, yet intuitive, command-line tool for managing |
| 16 |
clouds. |
|
| 16 |
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.
|
|
| 17 | 17 |
|
| 18 |
List of available groups: |
|
| 18 |
To run kamaki as an interactive shell, type |
|
| 19 |
|
|
| 20 |
kamaki |
|
| 21 |
|
|
| 22 |
To run kamaki as tool type |
|
| 23 |
|
|
| 24 |
kamaki <group> <command> [...] [options] |
|
| 25 |
|
|
| 26 |
The kamaki clients API can be imported in python applications as kamaki.clients |
|
| 27 |
|
|
| 28 |
|
|
| 29 |
List of available command groups: |
|
| 19 | 30 |
|
| 20 | 31 |
config |
| 21 | 32 |
|
| 22 | 33 |
Edit configuration options. Config options are stored in ~/.kamakirc file. |
| 23 | 34 |
|
| 35 |
history |
|
| 36 |
|
|
| 37 |
Access kamaki user history, which is stored in ~/.kamaki.history file. |
|
| 38 |
|
|
| 24 | 39 |
server |
| 25 | 40 |
|
| 26 | 41 |
Manage compute API virtual machines. |
| ... | ... | |
| 29 | 44 |
|
| 30 | 45 |
Manage compute API flavors. |
| 31 | 46 |
|
| 32 |
image |
|
| 33 |
|
|
| 34 |
Manage compute API images. |
|
| 35 |
|
|
| 36 | 47 |
network |
| 37 | 48 |
|
| 38 | 49 |
Manage compute API networks. |
| 39 | 50 |
|
| 40 |
glance
|
|
| 51 |
image
|
|
| 41 | 52 |
|
| 42 |
Manage Glance API images.
|
|
| 53 |
Manage compute API and glance images.
|
|
| 43 | 54 |
|
| 44 | 55 |
store |
| 45 | 56 |
|
| ... | ... | |
| 49 | 60 |
Options |
| 50 | 61 |
------- |
| 51 | 62 |
|
| 52 |
--help Show help message and exit.
|
|
| 63 |
--help, -h Show help message and exit.
|
|
| 53 | 64 |
-v Use verbose output. |
| 54 | 65 |
-d Use debug output. |
| 55 | 66 |
-o KEY=VAL Override a config value (can be used multiple times) |
| ... | ... | |
| 67 | 78 |
* del delete a configuration option |
| 68 | 79 |
|
| 69 | 80 |
|
| 81 |
history commands |
|
| 82 |
**************** |
|
| 83 |
|
|
| 84 |
Show command user history, as stored in ~/.kamaki.history |
|
| 85 |
|
|
| 86 |
* clean clean up history |
|
| 87 |
|
|
| 70 | 88 |
|
| 71 | 89 |
server commands |
| 72 | 90 |
*************** |
| ... | ... | |
| 99 | 117 |
image commands and options |
| 100 | 118 |
************************** |
| 101 | 119 |
|
| 102 |
* list list images |
|
| 103 |
* info get image details |
|
| 104 |
* delete delete image |
|
| 105 |
* meta get image metadata |
|
| 106 |
* addmeta add image metadata |
|
| 107 |
* setmeta update image metadata |
|
| 108 |
* delmeta delete image metadata |
|
| 109 |
|
|
| 120 |
* list list images |
|
| 121 |
* info get image details |
|
| 122 |
* public list public images |
|
| 123 |
* shared list shared images |
|
| 124 |
* delete delete image |
|
| 125 |
* register register an image |
|
| 126 |
* meta get image metadata |
|
| 127 |
* members get image members |
|
| 128 |
* addmember add a member to an image |
|
| 129 |
* delmember remove a member from an image |
|
| 130 |
* setmembers set the members of an image |
|
| 131 |
* properties get image properties |
|
| 132 |
* setproperty update an image property |
|
| 133 |
* addproperty add an image property |
|
| 134 |
* delproperty delete an image property |
|
| 110 | 135 |
|
| 111 | 136 |
network commands |
| 112 | 137 |
**************** |
| ... | ... | |
| 120 | 145 |
* disconnect disconnect a server from a network |
| 121 | 146 |
|
| 122 | 147 |
|
| 123 |
glance commands |
|
| 124 |
*************** |
|
| 125 |
|
|
| 126 |
* list list images |
|
| 127 |
* meta get image metadata |
|
| 128 |
* register register an image |
|
| 129 |
* members get image members |
|
| 130 |
* shared list shared images |
|
| 131 |
* addmember add a member to an image |
|
| 132 |
* delmember remove a member from an image |
|
| 133 |
* setmembers set the members of an image |
|
| 134 |
|
|
| 135 |
|
|
| 136 | 148 |
store commands |
| 137 | 149 |
************** |
| 138 | 150 |
|
Also available in: Unified diff