root / docs / man / kamaki.rst @ 329753ae
History | View | Annotate | Download (4.9 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 | 5f9bb293 | Kostas Papadimitriou | server |
40 | 5f9bb293 | Kostas Papadimitriou | |
41 | 5f9bb293 | Kostas Papadimitriou | Manage compute API virtual machines. |
42 | 5f9bb293 | Kostas Papadimitriou | |
43 | 5f9bb293 | Kostas Papadimitriou | flavor |
44 | 5f9bb293 | Kostas Papadimitriou | |
45 | 5f9bb293 | Kostas Papadimitriou | Manage compute API flavors. |
46 | 5f9bb293 | Kostas Papadimitriou | |
47 | 5f9bb293 | Kostas Papadimitriou | network |
48 | 5f9bb293 | Kostas Papadimitriou | |
49 | 5f9bb293 | Kostas Papadimitriou | Manage compute API networks. |
50 | 5f9bb293 | Kostas Papadimitriou | |
51 | cf49aa14 | Stavros Sachtouris | image |
52 | 5f9bb293 | Kostas Papadimitriou | |
53 | cf49aa14 | Stavros Sachtouris | Manage compute API and glance images. |
54 | 5f9bb293 | Kostas Papadimitriou | |
55 | 5f9bb293 | Kostas Papadimitriou | store |
56 | 5f9bb293 | Kostas Papadimitriou | |
57 | 5f9bb293 | Kostas Papadimitriou | Manage store API. |
58 | 5f9bb293 | Kostas Papadimitriou | |
59 | 5f9bb293 | Kostas Papadimitriou | |
60 | 5f9bb293 | Kostas Papadimitriou | Options |
61 | 5f9bb293 | Kostas Papadimitriou | ------- |
62 | 5f9bb293 | Kostas Papadimitriou | |
63 | cf49aa14 | Stavros Sachtouris | --help, -h Show help message and exit. |
64 | 5f9bb293 | Kostas Papadimitriou | -v Use verbose output. |
65 | 5f9bb293 | Kostas Papadimitriou | -d Use debug output. |
66 | 5f9bb293 | Kostas Papadimitriou | -o KEY=VAL Override a config value (can be used multiple times) |
67 | 5f9bb293 | Kostas Papadimitriou | |
68 | 5f9bb293 | Kostas Papadimitriou | |
69 | 5f9bb293 | Kostas Papadimitriou | Commands |
70 | 5f9bb293 | Kostas Papadimitriou | -------- |
71 | 5f9bb293 | Kostas Papadimitriou | |
72 | 5f9bb293 | Kostas Papadimitriou | config commands |
73 | 5f9bb293 | Kostas Papadimitriou | *************** |
74 | 5f9bb293 | Kostas Papadimitriou | |
75 | 5f9bb293 | Kostas Papadimitriou | * list list configuration options |
76 | 5f9bb293 | Kostas Papadimitriou | * get get a configuration option |
77 | 5f9bb293 | Kostas Papadimitriou | * set set a configuration option |
78 | 5f9bb293 | Kostas Papadimitriou | * del delete a configuration option |
79 | 5f9bb293 | Kostas Papadimitriou | |
80 | 5f9bb293 | Kostas Papadimitriou | |
81 | cf49aa14 | Stavros Sachtouris | history commands |
82 | cf49aa14 | Stavros Sachtouris | **************** |
83 | cf49aa14 | Stavros Sachtouris | |
84 | 329753ae | Stavros Sachtouris | Command user history, as stored in ~/.kamaki.history |
85 | cf49aa14 | Stavros Sachtouris | |
86 | 329753ae | Stavros Sachtouris | * all show user history |
87 | cf49aa14 | Stavros Sachtouris | * clean clean up history |
88 | cf49aa14 | Stavros Sachtouris | |
89 | 5f9bb293 | Kostas Papadimitriou | |
90 | 5f9bb293 | Kostas Papadimitriou | server commands |
91 | 5f9bb293 | Kostas Papadimitriou | *************** |
92 | 5f9bb293 | Kostas Papadimitriou | |
93 | 5f9bb293 | Kostas Papadimitriou | * list list servers |
94 | 5f9bb293 | Kostas Papadimitriou | * info get server details |
95 | 5f9bb293 | Kostas Papadimitriou | * create create server |
96 | 5f9bb293 | Kostas Papadimitriou | * rename update server name |
97 | 5f9bb293 | Kostas Papadimitriou | * delete delete server |
98 | 5f9bb293 | Kostas Papadimitriou | * reboot reboot server |
99 | 5f9bb293 | Kostas Papadimitriou | * start start server |
100 | 5f9bb293 | Kostas Papadimitriou | * shutdown shutdown server |
101 | 5f9bb293 | Kostas Papadimitriou | * console get a VNC console |
102 | 5f9bb293 | Kostas Papadimitriou | * firewall set the firewall profile |
103 | 5f9bb293 | Kostas Papadimitriou | * addr list server addresses |
104 | 5f9bb293 | Kostas Papadimitriou | * meta get server metadata |
105 | 5f9bb293 | Kostas Papadimitriou | * addmeta add server metadata |
106 | 5f9bb293 | Kostas Papadimitriou | * setmeta update server metadata |
107 | 5f9bb293 | Kostas Papadimitriou | * delmeta delete server metadata |
108 | 5f9bb293 | Kostas Papadimitriou | * stats get server statistics |
109 | 329753ae | Stavros Sachtouris | * wait wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
110 | 5f9bb293 | Kostas Papadimitriou | |
111 | 5f9bb293 | Kostas Papadimitriou | |
112 | 5f9bb293 | Kostas Papadimitriou | flavor commands |
113 | 5f9bb293 | Kostas Papadimitriou | *************** |
114 | 5f9bb293 | Kostas Papadimitriou | |
115 | 5f9bb293 | Kostas Papadimitriou | * list list flavors |
116 | 5f9bb293 | Kostas Papadimitriou | * info get flavor details |
117 | 5f9bb293 | Kostas Papadimitriou | |
118 | 5f9bb293 | Kostas Papadimitriou | |
119 | 5f9bb293 | Kostas Papadimitriou | image commands and options |
120 | 5f9bb293 | Kostas Papadimitriou | ************************** |
121 | 5f9bb293 | Kostas Papadimitriou | |
122 | cf49aa14 | Stavros Sachtouris | * list list images |
123 | cf49aa14 | Stavros Sachtouris | * info get image details |
124 | cf49aa14 | Stavros Sachtouris | * public list public images |
125 | cf49aa14 | Stavros Sachtouris | * shared list shared images |
126 | cf49aa14 | Stavros Sachtouris | * delete delete image |
127 | cf49aa14 | Stavros Sachtouris | * register register an image |
128 | 329753ae | Stavros Sachtouris | * reregister re-register an image (preserve and update properties) |
129 | cf49aa14 | Stavros Sachtouris | * meta get image metadata |
130 | cf49aa14 | Stavros Sachtouris | * members get image members |
131 | cf49aa14 | Stavros Sachtouris | * addmember add a member to an image |
132 | cf49aa14 | Stavros Sachtouris | * delmember remove a member from an image |
133 | cf49aa14 | Stavros Sachtouris | * setmembers set the members of an image |
134 | cf49aa14 | Stavros Sachtouris | * properties get image properties |
135 | cf49aa14 | Stavros Sachtouris | * setproperty update an image property |
136 | cf49aa14 | Stavros Sachtouris | * addproperty add an image property |
137 | cf49aa14 | Stavros Sachtouris | * delproperty delete an image property |
138 | 5f9bb293 | Kostas Papadimitriou | |
139 | 5f9bb293 | Kostas Papadimitriou | network commands |
140 | 5f9bb293 | Kostas Papadimitriou | **************** |
141 | 5f9bb293 | Kostas Papadimitriou | |
142 | 5f9bb293 | Kostas Papadimitriou | * list list networks |
143 | 5f9bb293 | Kostas Papadimitriou | * create create a network |
144 | 5f9bb293 | Kostas Papadimitriou | * info get network details |
145 | 5f9bb293 | Kostas Papadimitriou | * rename update network name |
146 | 5f9bb293 | Kostas Papadimitriou | * delete delete a network |
147 | 5f9bb293 | Kostas Papadimitriou | * connect connect a server to a network |
148 | 5f9bb293 | Kostas Papadimitriou | * disconnect disconnect a server from a network |
149 | 5f9bb293 | Kostas Papadimitriou | |
150 | 5f9bb293 | Kostas Papadimitriou | |
151 | 5f9bb293 | Kostas Papadimitriou | store commands |
152 | 5f9bb293 | Kostas Papadimitriou | ************** |
153 | 5f9bb293 | Kostas Papadimitriou | |
154 | 85e3803d | Stavros Sachtouris | * append Append local file to (existing) remote object |
155 | 85e3803d | Stavros Sachtouris | * cat Print a file to console |
156 | 85e3803d | Stavros Sachtouris | * copy Copy an object |
157 | 85e3803d | Stavros Sachtouris | * create Create a container or a directory object |
158 | 85e3803d | Stavros Sachtouris | * delete Delete a container [or an object] |
159 | 85e3803d | Stavros Sachtouris | * delgroup Delete a user group on an account |
160 | 85e3803d | Stavros Sachtouris | * delmeta Delete an existing metadatum of account [, container [or object]] |
161 | 85e3803d | Stavros Sachtouris | * delpermissions Delete all sharing permissions |
162 | 85e3803d | Stavros Sachtouris | * download Download a file |
163 | 85e3803d | Stavros Sachtouris | * group Get user groups details for account |
164 | 85e3803d | Stavros Sachtouris | * hashmap Get the hashmap of an object |
165 | 85e3803d | Stavros Sachtouris | * info Get information for account [, container [or object]] |
166 | 85e3803d | Stavros Sachtouris | * list List containers, object trees or objects in a directory |
167 | 85e3803d | Stavros Sachtouris | * manifest Create a remote file with uploaded parts by manifestation |
168 | 85e3803d | Stavros Sachtouris | * meta Get custom meta-content for account [, container [or object]] |
169 | 85e3803d | Stavros Sachtouris | * mkdir Create a directory |
170 | 85e3803d | Stavros Sachtouris | * move Copy an object |
171 | 85e3803d | Stavros Sachtouris | * overwrite Overwrite part (from start to end) of a remote file |
172 | 85e3803d | Stavros Sachtouris | * permissions Get object read/write permissions |
173 | 85e3803d | Stavros Sachtouris | * publish Publish an object |
174 | 85e3803d | Stavros Sachtouris | * purge Purge a container |
175 | 85e3803d | Stavros Sachtouris | * quota Get quota for account [or container] |
176 | 85e3803d | Stavros Sachtouris | * setgroup Create/update a new user group on account |
177 | 85e3803d | Stavros Sachtouris | * setmeta Set a new metadatum for account [, container [or object]] |
178 | 85e3803d | Stavros Sachtouris | * setpermissions Set sharing permissions |
179 | 85e3803d | Stavros Sachtouris | * setquota Set new quota (in KB) for account [or container] |
180 | 85e3803d | Stavros Sachtouris | * setversioning Set new versioning (auto, none) for account [or container] |
181 | 85e3803d | Stavros Sachtouris | * sharers List the accounts that share objects with default account |
182 | 85e3803d | Stavros Sachtouris | * truncate Truncate remote file up to a size |
183 | 85e3803d | Stavros Sachtouris | * unpublish Unpublish an object |
184 | 85e3803d | Stavros Sachtouris | * upload Upload a file |
185 | 85e3803d | Stavros Sachtouris | * versioning Get versioning for account [or container ] |
186 | 85e3803d | Stavros Sachtouris | * versions Get the version list of an object |
187 | 85e3803d | Stavros Sachtouris | |
188 | 5f9bb293 | Kostas Papadimitriou | |
189 | 5f9bb293 | Kostas Papadimitriou | |
190 | 5f9bb293 | Kostas Papadimitriou | Author |
191 | 5f9bb293 | Kostas Papadimitriou | ------ |
192 | 5f9bb293 | Kostas Papadimitriou | |
193 | 5f9bb293 | Kostas Papadimitriou | GRNET development team <synnefo@lists.grnet.gr>. |