3 kamaki tool manual page
4 =======================
9 **kamaki** [*group*] [*command*] [...] [*options*]
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.
18 To run kamaki as an interactive shell, type
22 To run kamaki as tool type
24 kamaki <group> <command> [...] [options]
26 The kamaki clients API can be imported in python applications as kamaki.clients
29 List of available command groups:
33 Edit configuration options. Config options are stored in ~/.kamakirc file.
37 Access kamaki user history, which is stored in ~/.kamaki.history file.
41 Get information from Astakos API
45 Manage compute API virtual machines.
49 Manage compute API flavors.
53 Manage compute API networks.
57 Manage images on Plankton (and Compute).
69 LIve tests that check kamaki against running services. To enable:
70 kamaki config set livetest.cli livetest
76 .. code-block:: console
78 --help, -h Show help message and exit.
79 -v Use verbose output.
81 -o KEY=VAL Override a config value (can be used multiple times)
90 * list list configuration options
91 * get get a configuration option
92 * set set a configuration option
93 * del delete a configuration option
99 Command user history, as stored in ~/.kamaki.history
101 * show show intersession history
102 * clean clean up history
103 * run run/show previously executed command(s)
109 * authenticate Authenticate a user, show user information
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 * info Detailed information on a Virtual Machine
123 * list List Virtual Machines accessible by user
124 * metadata Manage a server metadata
125 * list List server metadata
126 * set Add or update server metadata
127 * delete Delete a piece of server metadata
128 * reboot Reboot a server (VM)
129 * rename Set/update a server (VM) name
130 * shutdown Shutdown an active server (VM)
131 * start Start an existing server (VM)
132 * stats Get server (VM) statistics
133 * wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
140 * info get flavor details
146 * list List images accessible by user
147 * meta Get image metadata
148 * register (Re)Register an image
149 * unregister Unregister an image (does not delete the image file)
150 * shared List shared images
151 * compute Compute Image API commands
153 * delete Delete image
154 * info Get image details
155 * properties Manage properties related to OS installation in an image
156 * add Add a property to an image
157 * delete Delete a property from an image
158 * get Get an image property
159 * list List all image properties
160 * set Add / update a set of properties for an image
161 * members Manage members (users who can modify an image)
162 * add Add a member to an image
163 * delete Remove a member from an image
164 * list List members of an image
165 * set Set the members of an image
171 * connect Connect a server to a network
172 * create Create an (unconnected) network
173 * delete Delete a network
174 * disconnect Disconnect a nic that connects a server to a network
175 * info Detailed information on a network
177 * rename Set the name of a network
183 * append Append local file to remote
184 * cat Print a file to console
185 * copy Copy an object
186 * containerlimit Container size limit commands
187 * set Set container data limit
188 * get Get container data limit
189 * create Create a container
190 * delete Delete a container [or an object]
191 * download Download a file or directory
192 * group Manage access groups and group members
193 * delete Delete a user group
194 * get Get groups and group members
195 * set Set a user group
196 * hashmap Get the hashmap of an object
197 * info Get information for account [, container [or object]]
198 * list List containers, object trees or objects in a directory
199 * manifest Create a remote file with uploaded parts by manifestation
200 * metadata Metadata are attached on objects (key:value pairs)
201 * delete Delete metadata with given key
203 * set Set a piece of metadata
204 * mkdir Create a directory
205 * move Copy an object
206 * overwrite Overwrite part (from start to end) of a remote file
207 * permissions Manage user and group accessibility for objects
208 * delete Delete all permissions set on object
209 * get Get read and write permissions of an object
210 * set Set permissions for an object
211 * publish Publish an object
212 * purge Purge a container
213 * quota Get quota for account
214 * sharers List the accounts that share objects with default account
215 * touch Create an empty object (file)
216 * truncate Truncate remote file up to a size
217 * unpublish Unpublish an object
218 * upload Upload a file or directory
219 * versioning Manage the versioning scheme of current pithos user account
220 * get Get versioning for account or container
221 * set Set versioning mode (auto, none) for account or container
222 * versions Get the version list of an object
225 test commands (hidden)
226 **********************
228 * all test all clients
229 * args test how arguments are treated by kamaki
230 * astakos test Astakos client
231 * cyclades test Cyclades client
232 * error Create an error message with optional message
233 * image test Image client
234 * pithos test Pithos client
235 * prints user-test print methods for lists and dicts
241 Synnefo development team <synnefo-devel@googlegroups.com>.