root / docs / man / kamaki.rst @ f5d9bc54
History | View | Annotate | Download (6.5 kB)
1 |
:orphan: |
---|---|
2 |
|
3 |
kamaki tool manual page |
4 |
======================= |
5 |
|
6 |
Synopsis |
7 |
-------- |
8 |
|
9 |
**kamaki** [*group*] [*command*] [...] [*options*] |
10 |
|
11 |
|
12 |
Description |
13 |
----------- |
14 |
|
15 |
:program:`kamaki` is a simple, yet intuitive, command-line tool for managing |
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 |
|
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: |
30 |
|
31 |
config |
32 |
|
33 |
Edit configuration options. Config options are stored in ~/.kamakirc file. |
34 |
|
35 |
history |
36 |
|
37 |
Access kamaki user history, which is stored in ~/.kamaki.history file. |
38 |
|
39 |
server |
40 |
|
41 |
Manage compute API virtual machines. |
42 |
|
43 |
flavor |
44 |
|
45 |
Manage compute API flavors. |
46 |
|
47 |
network |
48 |
|
49 |
Manage compute API networks. |
50 |
|
51 |
image |
52 |
|
53 |
Manage compute API and Plankton images. |
54 |
|
55 |
store |
56 |
|
57 |
Manage store API. |
58 |
|
59 |
|
60 |
Hidden command groups |
61 |
--------------------- |
62 |
|
63 |
quotaholder |
64 |
|
65 |
A client for quotaholder API. to enable: |
66 |
kamaki config set quotaholder.cli hotaholder_cli |
67 |
kamaki config set quotaholder.url <quotaholder server url> |
68 |
|
69 |
test |
70 |
|
71 |
Prepared unit-tests for developers (experimental). To enable: |
72 |
kamaki config set test.cli test_cli |
73 |
|
74 |
|
75 |
Options |
76 |
------- |
77 |
|
78 |
.. code-block:: console |
79 |
|
80 |
--help, -h Show help message and exit. |
81 |
-v Use verbose output. |
82 |
-d Use debug output. |
83 |
-o KEY=VAL Override a config value (can be used multiple times) |
84 |
|
85 |
|
86 |
Commands |
87 |
-------- |
88 |
|
89 |
config commands |
90 |
*************** |
91 |
|
92 |
* list list configuration options |
93 |
* get get a configuration option |
94 |
* set set a configuration option |
95 |
* del delete a configuration option |
96 |
|
97 |
|
98 |
history commands |
99 |
**************** |
100 |
|
101 |
Command user history, as stored in ~/.kamaki.history |
102 |
|
103 |
* show show intersession history |
104 |
* clean clean up history |
105 |
* run run/show previously executed command(s) |
106 |
|
107 |
|
108 |
server commands |
109 |
*************** |
110 |
|
111 |
* addr List the addresses of all network interfaces on a server (VM) |
112 |
* console Get a VNC console to access an existing server (VM) |
113 |
* create Create a server (aka Virtual Machine) |
114 |
* delete Delete a server (VM) |
115 |
* delmeta Delete server (VM) metadata |
116 |
* firewall Set the server (VM) firewall profile on VMs public network |
117 |
* info Detailed information on a Virtual Machine |
118 |
* list List Virtual Machines accessible by user |
119 |
* meta Get a server's metadatum |
120 |
* reboot Reboot a server (VM) |
121 |
* rename Set/update a server (VM) name |
122 |
* setmeta set server (VM) metadata |
123 |
* shutdown Shutdown an active server (VM) |
124 |
* start Start an existing server (VM) |
125 |
* stats Get server (VM) statistics |
126 |
* wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
127 |
|
128 |
|
129 |
flavor commands |
130 |
*************** |
131 |
|
132 |
* list list flavors |
133 |
* info get flavor details |
134 |
|
135 |
|
136 |
image commands and options |
137 |
************************** |
138 |
|
139 |
* addmember Add a member to an image |
140 |
* addproperty Add an OS-related property to an image |
141 |
* delete Delete an image (image file remains intact) |
142 |
* delmember Remove a member from an image |
143 |
* delproperty Delete a property of an image |
144 |
* info Get detailed information on an image |
145 |
* list List images |
146 |
* members Get image members |
147 |
* meta Get image metadata |
148 |
* properties Get properties related to OS installation in an image |
149 |
* public List public images |
150 |
* register (Re)Register an image |
151 |
* setmembers Set the members of an image |
152 |
* setproperty Update an existing property in an image |
153 |
* shared List images shared by a member |
154 |
|
155 |
|
156 |
network commands |
157 |
**************** |
158 |
|
159 |
* connect Connect a server to a network |
160 |
* create Create an (unconnected) network |
161 |
* delete Delete a network |
162 |
* disconnect Disconnect a nic that connects a server to a network |
163 |
* info Detailed information on a network |
164 |
* list List networks |
165 |
* rename Set the name of a network |
166 |
|
167 |
|
168 |
store commands |
169 |
************** |
170 |
|
171 |
* append Append local file to (existing) remote object |
172 |
* cat Print remote file contents to console |
173 |
* copy Copy an object from container to (another) container |
174 |
* create Create a container |
175 |
* delete Delete a container [or an object] |
176 |
* delgroup Delete a user group |
177 |
* delmeta Delete metadata from account, container or object |
178 |
* delpermissions Delete all permissions set on object |
179 |
* download Download remote object as local file |
180 |
* group Get groups and group members |
181 |
* hashmap Get the hash-map of an object |
182 |
* info Get detailed info for account, containers or objects |
183 |
* list List containers, object trees or objects in a directory |
184 |
* manifest Create a remote file of uploaded parts by manifestation |
185 |
* meta Get metadata for account, containers or objects |
186 |
* mkdir Create a directory |
187 |
* move Copy an object |
188 |
* overwrite Overwrite part (from start to end) of a remote file |
189 |
* permissions Get read and write permissions of an object |
190 |
* publish Publish the object and print the public url |
191 |
* purge Delete a container and release related data blocks |
192 |
* quota Get quota (in KB) for account or container |
193 |
* setgroup Set a user group |
194 |
* setmeta Set a piece of metadata for account, container or object |
195 |
* setpermissions Set permissions for an object |
196 |
* setquota Set new quota (in KB) for account or container |
197 |
* setversioning Set versioning mode (auto, none) for account or container |
198 |
* sharers List the accounts that share objects with current user |
199 |
* touch Create an empty object (file) |
200 |
* truncate Truncate remote file up to a size |
201 |
* unpublish Unpublish an object |
202 |
* upload Upload a file |
203 |
* versioning Get versioning for account or container |
204 |
* versions Get the list of object versions |
205 |
|
206 |
|
207 |
quotaholder commands (hidden) |
208 |
***************************** |
209 |
|
210 |
accept, ack, add, create, get, init, issue, list, query, reject, release, reset, resolve, set |
211 |
|
212 |
|
213 |
test commands (hidden) |
214 |
********************** |
215 |
|
216 |
* all test all clients |
217 |
* args Test how arguments are treated by kamaki |
218 |
* astakos test Astakos client |
219 |
* cyclades test Cyclades client |
220 |
* error Create an error message with optional message |
221 |
* image test Image client |
222 |
* pithos test Pithos client |
223 |
* prints user-test print methods for lists and dicts |
224 |
|
225 |
|
226 |
Author |
227 |
------ |
228 |
|
229 |
GRNET development team <synnefo-devel@googlegroups.com>. |
230 |
|