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