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