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