root / docs / man / kamaki.rst @ 6893e31c
History | View | Annotate | Download (8.3 kB)
1 |
:orphan: |
---|---|
2 |
|
3 |
kamaki tool manual page |
4 |
======================= |
5 |
|
6 |
Synopsis |
7 |
-------- |
8 |
|
9 |
**kamaki** [*group*] [*command*] [...] [*options*] [*arguments*] |
10 |
**kamaki-shell** [*group*] [*command*] [...] [*arguments*] |
11 |
|
12 |
|
13 |
Description |
14 |
----------- |
15 |
|
16 |
:program:`kamaki` is a simple, yet intuitive, command-line tool for managing |
17 |
clouds. It can be used in three forms: as an interactive shell |
18 |
(`kamaki-shell`), as a command line tool (`kamaki`) or as a clients API for |
19 |
other applications (`kamaki.clients`). |
20 |
|
21 |
To run `kamaki` as an interactive shell, type |
22 |
|
23 |
kamaki-shell |
24 |
|
25 |
To run `kamaki` as tool type |
26 |
|
27 |
kamaki <group> <command> [...] [options] |
28 |
|
29 |
The kamaki clients API can be imported in python applications as |
30 |
`kamaki.clients` |
31 |
|
32 |
|
33 |
List of available command groups: |
34 |
|
35 |
user |
36 |
Astakos/Identity API commands |
37 |
|
38 |
project |
39 |
Astakos project API commands |
40 |
|
41 |
quota |
42 |
Astakos/Account API commands for quotas |
43 |
|
44 |
resource |
45 |
Astakos/Account API commands for resources |
46 |
|
47 |
file |
48 |
Pithos+/Storage object level API commands |
49 |
|
50 |
container |
51 |
Pithos+/Storage container level API commands |
52 |
|
53 |
group |
54 |
Pithos+/Storage user groups |
55 |
|
56 |
sharer |
57 |
Pithos+/Storage sharer accounts |
58 |
|
59 |
server |
60 |
Cyclades/Compute API server commands |
61 |
|
62 |
flavor |
63 |
Cyclades/Compute API flavor commands |
64 |
|
65 |
image |
66 |
Cyclades/Plankton API image commands |
67 |
|
68 |
imagecompute |
69 |
Cyclades/Compute API image commands |
70 |
|
71 |
network |
72 |
Networking API network commands |
73 |
|
74 |
subnet |
75 |
Networking API network commands |
76 |
|
77 |
ip |
78 |
Networking API floatingip commands |
79 |
|
80 |
port |
81 |
Networking API network Commands |
82 |
|
83 |
config |
84 |
Kamaki option and cloud configuration |
85 |
|
86 |
history |
87 |
Kamaki command history |
88 |
|
89 |
|
90 |
Hidden command groups |
91 |
--------------------- |
92 |
|
93 |
livetest |
94 |
Live tests that check kamaki against running services. To enable: |
95 |
kamaki config set livetest.cli livetest |
96 |
|
97 |
service |
98 |
Astakos API service commands |
99 |
|
100 |
endpoint |
101 |
Astakos API endpoints commands |
102 |
|
103 |
commission |
104 |
Astakos API commission commands |
105 |
|
106 |
|
107 |
Options |
108 |
------- |
109 |
|
110 |
.. code-block:: console |
111 |
|
112 |
--help, -h Show help message and exit. |
113 |
-v Use verbose output. |
114 |
-d Use debug output. |
115 |
-o KEY=VAL Override a config value (can be repeated) |
116 |
--cloud CLOUD Choose a cloud to connect to |
117 |
|
118 |
|
119 |
Commands |
120 |
-------- |
121 |
|
122 |
user |
123 |
**** |
124 |
|
125 |
* authenticate Authenticate a user, show user information |
126 |
* info Get info for (current) session user |
127 |
* uuid2name Get user name(s) from uuid(s) |
128 |
* authenticate Authenticate a user and get all authentication information |
129 |
* list List (cached) session users |
130 |
* add Authenticate a user by token and add to kamaki session (cache) |
131 |
* name2uuid Get user uuid(s) from name(s) |
132 |
* select Select a user from the (cached) list as the current session user |
133 |
* delete Delete a user (token) from the (cached) list of session users |
134 |
|
135 |
project |
136 |
******* |
137 |
|
138 |
* info Get details for a project |
139 |
* unsuspend Resume a suspended project (special privileges needed) |
140 |
* suspend Suspend a project (special privileges needed) |
141 |
* list List all projects |
142 |
* create Apply for a new project |
143 |
* modify Modify a project |
144 |
* terminate Terminate a project (special privileges needed) |
145 |
* application Application management commands |
146 |
* membership Project membership management commands |
147 |
* reinstate Reinstate a terminated project (special privileges needed) |
148 |
|
149 |
quota |
150 |
***** |
151 |
|
152 |
* list Get user quotas |
153 |
* info Get quota for a service (cyclades, pithos, astakos) |
154 |
|
155 |
resource |
156 |
******** |
157 |
|
158 |
* list List user resources |
159 |
|
160 |
file |
161 |
**** |
162 |
|
163 |
* info Get information/details about a file |
164 |
* truncate Truncate remote file up to size |
165 |
* mkdir Create a directory ( create --content-type='applcation/directory' ) |
166 |
* create Create an empty file |
167 |
* move Move objects, even between different accounts or containers |
168 |
* list List all objects in a container or a directory object |
169 |
* upload Upload a file |
170 |
* cat Fetch remote file contents |
171 |
* modify Modify the attributes of a file or directory object |
172 |
* append Append local file to (existing) remote object |
173 |
* download Download a remove file or directory object to local file system |
174 |
* copy Copy objects, even between different accounts or containers |
175 |
* overwrite Overwrite part of a remote file |
176 |
* delete Delete a file or directory object |
177 |
|
178 |
container |
179 |
********* |
180 |
|
181 |
* info Get information about a container |
182 |
* modify Modify the properties of a container |
183 |
* create Create a new container |
184 |
* list List all containers, or their contents |
185 |
* empty Empty a container |
186 |
* delete Delete a container |
187 |
|
188 |
group |
189 |
***** |
190 |
|
191 |
* create Create a group of users |
192 |
* list List all groups and group members |
193 |
* delete Delete a user group |
194 |
|
195 |
sharer |
196 |
****** |
197 |
|
198 |
* info Details on a Pithos+ sharer account (default: current account) |
199 |
* list List accounts who share file objects with current user |
200 |
|
201 |
server |
202 |
****** |
203 |
|
204 |
* info Detailed information on a Virtual Machine |
205 |
* modify Modify attributes of a virtual server |
206 |
* create Create a server (aka Virtual Machine) |
207 |
* list List virtual servers accessible by user |
208 |
* reboot Reboot a virtual server |
209 |
* start Start an existing virtual server |
210 |
* shutdown Shutdown an active virtual server |
211 |
* delete Delete a virtual server |
212 |
* wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
213 |
|
214 |
flavor |
215 |
****** |
216 |
|
217 |
* list list flavors |
218 |
* info get flavor details |
219 |
|
220 |
image |
221 |
***** |
222 |
|
223 |
* info Get image metadata |
224 |
* list List images accessible by user |
225 |
* register (Re)Register an image file to an Image service |
226 |
* modify Add / update metadata and properties for an image |
227 |
* unregister Unregister an image (does not delete the image file) |
228 |
|
229 |
imagecompute |
230 |
************ |
231 |
|
232 |
* info Get detailed information on an image |
233 |
* list List images |
234 |
* modify Modify image properties (metadata) |
235 |
* delete Delete an image (WARNING: image file is also removed) |
236 |
|
237 |
network |
238 |
******* |
239 |
|
240 |
* info: Get details about a network |
241 |
* disconnect: Disconnect a network from a device |
242 |
* modify: Modify network attributes |
243 |
* create: Create a new network |
244 |
* list: List networks |
245 |
* connect: Connect a network with a device (server or router) |
246 |
* delete: Delete a network |
247 |
|
248 |
subnet |
249 |
****** |
250 |
|
251 |
* info Get details about a subnet |
252 |
* list List subnets |
253 |
* create Create a new subnet |
254 |
* modify Modify the attributes of a subnet |
255 |
|
256 |
ip |
257 |
** |
258 |
|
259 |
* info Details for an IP |
260 |
* list List reserved floating IPs |
261 |
* attach Attach a floating IP to a server |
262 |
* pools List pools of floating IPs |
263 |
* release Release a floating IP |
264 |
* detach Detach a floating IP from a server |
265 |
* reserve Reserve a floating IP |
266 |
|
267 |
port |
268 |
**** |
269 |
|
270 |
* info Get details about a port |
271 |
* list List all ports |
272 |
* create Create a new port (== connect server to network) |
273 |
* modify Modify the attributes of a port |
274 |
* delete Delete a port (== disconnect server from network) |
275 |
* wait Wait for port to finish [ACTIVE, DOWN, BUILD, ERROR] |
276 |
|
277 |
config |
278 |
****** |
279 |
|
280 |
* list list configuration options |
281 |
* get get a configuration option |
282 |
* set set a configuration option |
283 |
* del delete a configuration option |
284 |
|
285 |
history |
286 |
******* |
287 |
|
288 |
Command user history, as stored in ~/.kamaki.history |
289 |
|
290 |
* show show intersession history |
291 |
* clean clean up history |
292 |
* run run/show previously executed command(s) |
293 |
|
294 |
|
295 |
livetest (hidden) |
296 |
***************** |
297 |
|
298 |
* all test all clients |
299 |
* args test how arguments are treated by kamaki |
300 |
* astakos test Astakos client |
301 |
* cyclades test Cyclades client |
302 |
* error Create an error message with optional message |
303 |
* image test Image client |
304 |
* pithos test Pithos client |
305 |
* prints user-test print methods for lists and dicts |
306 |
|
307 |
service (hidden) |
308 |
**************** |
309 |
|
310 |
* list List available services |
311 |
* uuid2username Get service username(s) from uuid(s) |
312 |
* quotas Get service quotas |
313 |
* username2uuid Get service uuid(s) from username(s) |
314 |
|
315 |
endpoint (hidden) |
316 |
***************** |
317 |
|
318 |
* list Get endpoints service endpoints |
319 |
|
320 |
commission (hidden) |
321 |
******************* |
322 |
|
323 |
* info Get commission info (special privileges required) |
324 |
* resolve Resolve multiple commissions (special privileges required) |
325 |
* accept Accept a pending commission (special privileges required) |
326 |
* reject Reject a pending commission (special privileges required) |
327 |
* issue Issue commissions as a json string (special privileges required) |
328 |
* pending List pending commissions (special privileges required) |
329 |
|
330 |
|
331 |
Author |
332 |
------ |
333 |
|
334 |
Synnefo development team <synnefo-devel@googlegroups.com>. |
335 |
|