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 * delmeta Delete server (VM) metadata
120 * firewall Set the server (VM) firewall profile on VMs public network
121 * info Detailed information on a Virtual Machine
122 * list List Virtual Machines accessible by user
123 * meta Get a server's metadatum
124 * reboot Reboot a server (VM)
125 * rename Set/update a server (VM) name
126 * setmeta set server (VM) metadata
127 * shutdown Shutdown an active server (VM)
128 * start Start an existing server (VM)
129 * stats Get server (VM) statistics
130 * wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
137 * info get flavor details
143 * addmember Add a member to an image
144 * addproperty Add an OS-related property to an image
145 * delete Delete an image (image file remains intact)
146 * delmember Remove a member from an image
147 * delproperty Delete a property of an image
148 * info Get detailed information on an image
149 * members Get image members
150 * meta Get image metadata
151 * properties Get properties related to OS installation in an image
152 * list List images accessible by user
153 * register (Re)Register an image
154 * setmembers Set the members of an image
155 * setproperty Update an existing property in an image
156 * shared List images shared by a member
157 * compute Compute Image API commands
159 * delete Delete image
160 * info Get image details
161 * properties Get image properties
162 * delproperty Delete an image property
163 * setproperty Update an image property
169 * connect Connect a server to a network
170 * create Create an (unconnected) network
171 * delete Delete a network
172 * disconnect Disconnect a nic that connects a server to a network
173 * info Detailed information on a network
175 * rename Set the name of a network
181 * append Append local file to (existing) remote object
182 * cat Print remote file contents to console
183 * copy Copy an object from container to (another) container
184 * create Create a container
185 * delete Delete a container [or an object]
186 * delgroup Delete a user group
187 * delmeta Delete metadata from account, container or object
188 * delpermissions Delete all permissions set on object
189 * download Download remote object as local file
190 * group Get groups and group members
191 * hashmap Get the hash-map of an object
192 * info Get detailed info for account, containers or objects
193 * list List containers, object trees or objects in a directory
194 * manifest Create a remote file of uploaded parts by manifestation
195 * meta Get metadata for account, containers or objects
196 * mkdir Create a directory
197 * move Copy an object
198 * overwrite Overwrite part (from start to end) of a remote file
199 * permissions Get read and write permissions of an object
200 * publish Publish the object and print the public url
201 * purge Delete a container and release related data blocks
202 * quota Get quota (in KB) for account or container
203 * setgroup Set a user group
204 * setmeta Set a piece of metadata for account, container or object
205 * setpermissions Set permissions for an object
206 * containerlimit set Set new limit for container
207 * containerlimit get Get container limit
208 * setversioning Set versioning mode (auto, none) for account or container
209 * sharers List the accounts that share objects with current user
210 * touch Create an empty object (file)
211 * truncate Truncate remote file up to a size
212 * unpublish Unpublish an object
213 * upload Upload a file
214 * versioning Get versioning for account or container
215 * versions Get the list of object versions
218 test commands (hidden)
219 **********************
221 * all test all clients
222 * args test how arguments are treated by kamaki
223 * astakos test Astakos client
224 * cyclades test Cyclades client
225 * error Create an error message with optional message
226 * image test Image client
227 * pithos test Pithos client
228 * prints user-test print methods for lists and dicts
234 GRNET development team <synnefo-devel@googlegroups.com>.