root / docs / man / kamaki.rst @ 404eb288
History | View | Annotate | Download (7.2 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 |
user |
40 |
|
41 |
Get information from Astakos API |
42 |
|
43 |
server |
44 |
|
45 |
Manage compute API virtual machines. |
46 |
|
47 |
flavor |
48 |
|
49 |
Manage compute API flavors. |
50 |
|
51 |
network |
52 |
|
53 |
Manage compute API networks. |
54 |
|
55 |
image |
56 |
|
57 |
Manage images on Plankton (and Compute). |
58 |
|
59 |
file |
60 |
|
61 |
Manage Pithos+ API. |
62 |
|
63 |
|
64 |
Hidden command groups |
65 |
--------------------- |
66 |
|
67 |
livetest |
68 |
|
69 |
LIve tests that check kamaki against running services. To enable: |
70 |
kamaki config set livetest.cli livetest |
71 |
|
72 |
|
73 |
Options |
74 |
------- |
75 |
|
76 |
.. code-block:: console |
77 |
|
78 |
--help, -h Show help message and exit. |
79 |
-v Use verbose output. |
80 |
-d Use debug output. |
81 |
-o KEY=VAL Override a config value (can be used multiple times) |
82 |
|
83 |
|
84 |
Commands |
85 |
-------- |
86 |
|
87 |
config commands |
88 |
*************** |
89 |
|
90 |
* list list configuration options |
91 |
* get get a configuration option |
92 |
* set set a configuration option |
93 |
* del delete a configuration option |
94 |
|
95 |
|
96 |
history commands |
97 |
**************** |
98 |
|
99 |
Command user history, as stored in ~/.kamaki.history |
100 |
|
101 |
* show show intersession history |
102 |
* clean clean up history |
103 |
* run run/show previously executed command(s) |
104 |
|
105 |
|
106 |
user commands |
107 |
************* |
108 |
|
109 |
* authenticate Authenticate a user, show user information |
110 |
|
111 |
|
112 |
server commands |
113 |
*************** |
114 |
|
115 |
* addr List the addresses of all network interfaces on a server (VM) |
116 |
* console Get a VNC console to access an existing server (VM) |
117 |
* create Create a server (aka Virtual Machine) |
118 |
* delete Delete a server (VM) |
119 |
* firewall Set the server (VM) firewall profile for public networks |
120 |
* set Set the firewall profile |
121 |
* get Get the firewall profile |
122 |
* ip Manage floating IPs for the servers |
123 |
* attach Attach a floating ip to a server with server_id |
124 |
* info A floating IPs' details |
125 |
* detach Detach floating ip from server |
126 |
* list List all floating ips |
127 |
* create Create a new floating IP |
128 |
* delete Delete a floating ip |
129 |
* pools List all floating pools of floating ips |
130 |
* info Detailed information on a Virtual Machine |
131 |
* list List Virtual Machines accessible by user |
132 |
* metadata Manage a server metadata |
133 |
* list List server metadata |
134 |
* set Add or update server metadata |
135 |
* delete Delete a piece of server metadata |
136 |
* reboot Reboot a server (VM) |
137 |
* rename Set/update a server (VM) name |
138 |
* shutdown Shutdown an active server (VM) |
139 |
* start Start an existing server (VM) |
140 |
* stats Get server (VM) statistics |
141 |
* resize Set a different flavor for an existing server |
142 |
* wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
143 |
|
144 |
|
145 |
flavor commands |
146 |
*************** |
147 |
|
148 |
* list list flavors |
149 |
* info get flavor details |
150 |
|
151 |
|
152 |
image commands |
153 |
************** |
154 |
|
155 |
* list List images accessible by user |
156 |
* meta Manage image metadata |
157 |
* list Get image metadata |
158 |
* set Add / update metadata and properties for an image |
159 |
* delete Remove/empty image metadata and/or custom properties |
160 |
* register (Re)Register an image |
161 |
* unregister Unregister an image (does not delete the image file) |
162 |
* shared List shared images |
163 |
* compute Compute Image API commands |
164 |
* list List images |
165 |
* delete Delete image |
166 |
* info Get image details |
167 |
* properties Manage properties related to OS installation in an image |
168 |
* delete Delete a property from an image |
169 |
* get Get an image property |
170 |
* list List all image properties |
171 |
* set Add / update a set of properties for an image |
172 |
* members Manage members (users who can modify an image) |
173 |
* add Add a member to an image |
174 |
* delete Remove a member from an image |
175 |
* list List members of an image |
176 |
* set Set the members of an image |
177 |
|
178 |
|
179 |
network commands |
180 |
**************** |
181 |
|
182 |
* connect Connect a server to a network |
183 |
* create Create an (unconnected) network |
184 |
* delete Delete a network |
185 |
* disconnect Disconnect a nic that connects a server to a network |
186 |
* info Detailed information on a network |
187 |
* list List networks |
188 |
* rename Set the name of a network |
189 |
|
190 |
|
191 |
file commands |
192 |
************** |
193 |
|
194 |
* append Append local file to remote file |
195 |
* cat Print a file to console |
196 |
* copy Copy an object |
197 |
* containerlimit Container size limit commands |
198 |
* set Set container data limit |
199 |
* get Get container data limit |
200 |
* create Create a container |
201 |
* delete Delete a container [or an object] |
202 |
* download Download a file or directory |
203 |
* group Manage access groups and group members |
204 |
* delete Delete a user group |
205 |
* list List groups and group members |
206 |
* set Set a user group |
207 |
* hashmap Get the hashmap of an object |
208 |
* info Get information for account [, container [or object]] |
209 |
* list List containers, object trees or objects in a directory |
210 |
* manifest Create a remote file with uploaded parts by manifestation |
211 |
* metadata Metadata are attached on objects (key:value pairs) |
212 |
* delete Delete metadata with given key |
213 |
* get Get metadatum |
214 |
* set Set a piece of metadata |
215 |
* mkdir Create a directory |
216 |
* move Copy an object |
217 |
* overwrite Overwrite part (from start to end) of a remote file |
218 |
* permissions Manage user and group accessibility for objects |
219 |
* delete Delete all permissions set on object |
220 |
* get Get read and write permissions of an object |
221 |
* set Set permissions for an object |
222 |
* publish Publish an object |
223 |
* purge Purge a container |
224 |
* quota Get quota for account |
225 |
* sharers List the accounts that share objects with default account |
226 |
* touch Create an empty object (file) |
227 |
* truncate Truncate remote file up to a size |
228 |
* unpublish Unpublish an object |
229 |
* upload Upload a file or directory |
230 |
* versioning Manage the versioning scheme of current pithos user account |
231 |
* get Get versioning for account or container |
232 |
* set Set versioning mode (auto, none) for account or container |
233 |
* versions Get the version list of an object |
234 |
|
235 |
|
236 |
test commands (hidden) |
237 |
********************** |
238 |
|
239 |
* all test all clients |
240 |
* args test how arguments are treated by kamaki |
241 |
* astakos test Astakos client |
242 |
* cyclades test Cyclades client |
243 |
* error Create an error message with optional message |
244 |
* image test Image client |
245 |
* pithos test Pithos client |
246 |
* prints user-test print methods for lists and dicts |
247 |
|
248 |
|
249 |
Author |
250 |
------ |
251 |
|
252 |
Synnefo development team <synnefo-devel@googlegroups.com>. |
253 |
|