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