root / docs / commands.rst @ 52b2b3bd
History | View | Annotate | Download (16.3 kB)
1 | 2151584b | Stavros Sachtouris | List of commands |
---|---|---|---|
2 | 961e6040 | Stavros Sachtouris | ================ |
3 | 961e6040 | Stavros Sachtouris | |
4 | c4f606c0 | Stavros Sachtouris | Kamaki commands follow this scheme:: |
5 | c4f606c0 | Stavros Sachtouris | |
6 | c4f606c0 | Stavros Sachtouris | [kamaki] <object> <action> [identifiers] [non-positional arguments] |
7 | c4f606c0 | Stavros Sachtouris | |
8 | c4f606c0 | Stavros Sachtouris | In this context, objects are not services, but virtual objects like a server, a |
9 | c4f606c0 | Stavros Sachtouris | file or an image. The action concerns objects of the specified type. Some |
10 | c4f606c0 | Stavros Sachtouris | actions (e.g. "delete" or "info") need to operate on an existing object. The |
11 | 7a3c66e1 | Stavros Sachtouris | identifiers strictly identify this object and they should have the form of an id |
12 | 7a3c66e1 | Stavros Sachtouris | (e.g., `server delete <SERVER_ID>`). |
13 | c4f606c0 | Stavros Sachtouris | |
14 | c4f606c0 | Stavros Sachtouris | The examples bellow showcase some commands. The kamaki-shell (check |
15 | fa382f9e | Stavros Sachtouris | `Usage section <usage.html#interactive-shell>`_ for details) is chosen as the |
16 | fa382f9e | Stavros Sachtouris | execution environment. |
17 | 2151584b | Stavros Sachtouris | |
18 | 2151584b | Stavros Sachtouris | |
19 | c4f606c0 | Stavros Sachtouris | user (Identity/Astakos) |
20 | 0ea31480 | Stavros Sachtouris | ----------------------- |
21 | 2151584b | Stavros Sachtouris | |
22 | 2151584b | Stavros Sachtouris | .. code-block:: text |
23 | 2151584b | Stavros Sachtouris | |
24 | c4f606c0 | Stavros Sachtouris | info Get info for (current) session user |
25 | c4f606c0 | Stavros Sachtouris | uuid2name Get user name(s) from uuid(s) |
26 | c4f606c0 | Stavros Sachtouris | authenticate Authenticate a user and get all authentication information |
27 | c4f606c0 | Stavros Sachtouris | list List (cached) session users |
28 | c4f606c0 | Stavros Sachtouris | add Authenticate user by token and add to kamaki session (cache) |
29 | c4f606c0 | Stavros Sachtouris | name2uuid Get user uuid(s) from name(s) |
30 | c4f606c0 | Stavros Sachtouris | select Select user from the (cached) list as current session user |
31 | c4f606c0 | Stavros Sachtouris | delete Delete user (token) from the (cached) list of session users |
32 | 2151584b | Stavros Sachtouris | |
33 | 961e6040 | Stavros Sachtouris | Showcase: get user information |
34 | 961e6040 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
35 | 961e6040 | Stavros Sachtouris | |
36 | c4f606c0 | Stavros Sachtouris | In the following, cloud URL and TOKEN were set in a previous step (see |
37 | fa382f9e | Stavros Sachtouris | `setup section <setup.html>`_ or the |
38 | fa382f9e | Stavros Sachtouris | `quick setup guide <usage.html#quick-setup>`_) |
39 | 2151584b | Stavros Sachtouris | |
40 | 2151584b | Stavros Sachtouris | .. code-block:: console |
41 | 2151584b | Stavros Sachtouris | :emphasize-lines: 1,4 |
42 | 2151584b | Stavros Sachtouris | |
43 | 0ea31480 | Stavros Sachtouris | * Enter user context * |
44 | 0ea31480 | Stavros Sachtouris | [kamaki]: user |
45 | 2151584b | Stavros Sachtouris | |
46 | 2151584b | Stavros Sachtouris | * Authenticate user * |
47 | c4f606c0 | Stavros Sachtouris | [user]: info |
48 | fa382f9e | Stavros Sachtouris | ... |
49 | c4f606c0 | Stavros Sachtouris | name: My Real Name |
50 | c4f606c0 | Stavros Sachtouris | id: ab1cde23-45fg-6h7i-8j9k-10l1m11no2pq |
51 | c4f606c0 | Stavros Sachtouris | |
52 | c4f606c0 | Stavros Sachtouris | [user]: exit |
53 | c4f606c0 | Stavros Sachtouris | [kamaki]: |
54 | c4f606c0 | Stavros Sachtouris | |
55 | c4f606c0 | Stavros Sachtouris | project (Astakos) |
56 | c4f606c0 | Stavros Sachtouris | ----------------- |
57 | c4f606c0 | Stavros Sachtouris | |
58 | c4f606c0 | Stavros Sachtouris | .. code-block:: text |
59 | c4f606c0 | Stavros Sachtouris | |
60 | c4f606c0 | Stavros Sachtouris | info Get details for a project |
61 | c4f606c0 | Stavros Sachtouris | unsuspend Resume a suspended project (special privileges needed) |
62 | c4f606c0 | Stavros Sachtouris | suspend Suspend a project (special privileges needed) |
63 | c4f606c0 | Stavros Sachtouris | list List all projects |
64 | c4f606c0 | Stavros Sachtouris | create Apply for a new project |
65 | c4f606c0 | Stavros Sachtouris | modify Modify a project |
66 | c4f606c0 | Stavros Sachtouris | terminate Terminate a project (special privileges needed) |
67 | c4f606c0 | Stavros Sachtouris | application Application management commands |
68 | c4f606c0 | Stavros Sachtouris | reinstate Reinstate a terminated project (special privileges needed) |
69 | c4f606c0 | Stavros Sachtouris | |
70 | 9d84caa4 | Stavros Sachtouris | membership (Astakos) |
71 | 9d84caa4 | Stavros Sachtouris | -------------------- |
72 | 9d84caa4 | Stavros Sachtouris | |
73 | 9d84caa4 | Stavros Sachtouris | .. code-block:: text |
74 | 9d84caa4 | Stavros Sachtouris | |
75 | 9d84caa4 | Stavros Sachtouris | info Details on a membership |
76 | 9d84caa4 | Stavros Sachtouris | enroll Enroll somebody to a project you manage |
77 | 9d84caa4 | Stavros Sachtouris | join Join a project |
78 | 9d84caa4 | Stavros Sachtouris | list List all memberships |
79 | 9d84caa4 | Stavros Sachtouris | accept Accept a membership for a project you manage |
80 | 9d84caa4 | Stavros Sachtouris | leave Leave a project you have membership to |
81 | 9d84caa4 | Stavros Sachtouris | remove Remove a membership for a project you manage |
82 | 9d84caa4 | Stavros Sachtouris | reject Reject a membership for a project you manage |
83 | 9d84caa4 | Stavros Sachtouris | cancel Cancel your (probably pending) membership to a project |
84 | 9d84caa4 | Stavros Sachtouris | |
85 | c4f606c0 | Stavros Sachtouris | quota (Account/Astakos) |
86 | c4f606c0 | Stavros Sachtouris | ----------------------- |
87 | c4f606c0 | Stavros Sachtouris | |
88 | c4f606c0 | Stavros Sachtouris | .. code-block:: text |
89 | fa382f9e | Stavros Sachtouris | |
90 | c4f606c0 | Stavros Sachtouris | list Get user quotas |
91 | c4f606c0 | Stavros Sachtouris | info Get quota for a service (cyclades, pithos, astakos) |
92 | c4f606c0 | Stavros Sachtouris | |
93 | c4f606c0 | Stavros Sachtouris | resource (Astakos) |
94 | c4f606c0 | Stavros Sachtouris | ------------------ |
95 | c4f606c0 | Stavros Sachtouris | |
96 | c4f606c0 | Stavros Sachtouris | .. code-block:: text |
97 | c4f606c0 | Stavros Sachtouris | |
98 | c4f606c0 | Stavros Sachtouris | list List user resources |
99 | e9e547ed | Stavros Sachtouris | |
100 | 2151584b | Stavros Sachtouris | flavor (Compute/Cyclades) |
101 | 961e6040 | Stavros Sachtouris | ------------------------- |
102 | 2151584b | Stavros Sachtouris | |
103 | 2151584b | Stavros Sachtouris | .. code-block:: text |
104 | 2151584b | Stavros Sachtouris | |
105 | 2151584b | Stavros Sachtouris | info: Get flavor details |
106 | 2151584b | Stavros Sachtouris | list: List flavors |
107 | 2151584b | Stavros Sachtouris | |
108 | 2151584b | Stavros Sachtouris | Showcase: show details for flavor with id 43 |
109 | 961e6040 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
110 | 2151584b | Stavros Sachtouris | |
111 | 2151584b | Stavros Sachtouris | .. code-block:: console |
112 | 2151584b | Stavros Sachtouris | :emphasize-lines: 1,4 |
113 | 2151584b | Stavros Sachtouris | |
114 | 2151584b | Stavros Sachtouris | * Enter flavor context * |
115 | 2151584b | Stavros Sachtouris | [kamaki]: flavor |
116 | 2151584b | Stavros Sachtouris | |
117 | 2151584b | Stavros Sachtouris | * Get details about flavor with id 43 * |
118 | 2151584b | Stavros Sachtouris | [flavor]: info 43 |
119 | 2151584b | Stavros Sachtouris | SNF:disk_template: drbd |
120 | c4f606c0 | Stavros Sachtouris | cpu: 4 |
121 | fa382f9e | Stavros Sachtouris | disk: 10 |
122 | c4f606c0 | Stavros Sachtouris | id: 43 |
123 | fa382f9e | Stavros Sachtouris | name: C4R2048D10 |
124 | c4f606c0 | Stavros Sachtouris | ram: 2048 |
125 | 2151584b | Stavros Sachtouris | |
126 | c4f606c0 | Stavros Sachtouris | image (Image/Plankton) |
127 | c4f606c0 | Stavros Sachtouris | ---------------------- |
128 | 2151584b | Stavros Sachtouris | |
129 | 2151584b | Stavros Sachtouris | .. code-block:: text |
130 | 2151584b | Stavros Sachtouris | |
131 | c4f606c0 | Stavros Sachtouris | info Get image metadata |
132 | c4f606c0 | Stavros Sachtouris | list List images accessible by user |
133 | c4f606c0 | Stavros Sachtouris | register (Re)Register an image file to an Image service |
134 | c4f606c0 | Stavros Sachtouris | modify Add / update metadata and properties for an image |
135 | c4f606c0 | Stavros Sachtouris | unregister Unregister an image (does not delete the image file) |
136 | 2151584b | Stavros Sachtouris | |
137 | 2151584b | Stavros Sachtouris | Showcase: Pick an image and list the properties |
138 | 961e6040 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
139 | 2151584b | Stavros Sachtouris | |
140 | 2151584b | Stavros Sachtouris | .. code-block:: console |
141 | 2151584b | Stavros Sachtouris | :emphasize-lines: 1,4,18 |
142 | 2151584b | Stavros Sachtouris | |
143 | 2151584b | Stavros Sachtouris | * Enter image context * |
144 | 0ea31480 | Stavros Sachtouris | [kamaki]: image |
145 | 2151584b | Stavros Sachtouris | |
146 | 2151584b | Stavros Sachtouris | * list all available images * |
147 | 0ea31480 | Stavros Sachtouris | [image]: list |
148 | fa382f9e | Stavros Sachtouris | 926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008 |
149 | 573be34f | Stavros Sachtouris | container_format: bare |
150 | c4f606c0 | Stavros Sachtouris | disk_format: diskdump |
151 | c4f606c0 | Stavros Sachtouris | id: 926ab1c5-2d85-49d4-aebe-0fce712789b9 |
152 | c4f606c0 | Stavros Sachtouris | size: 11917066240 |
153 | c4f606c0 | Stavros Sachtouris | status: available |
154 | fa382f9e | Stavros Sachtouris | 78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012 |
155 | 573be34f | Stavros Sachtouris | container_format: bare |
156 | c4f606c0 | Stavros Sachtouris | disk_format: diskdump |
157 | c4f606c0 | Stavros Sachtouris | id: 78262ee7-949e-4d70-af3a-85360c3de57a |
158 | c4f606c0 | Stavros Sachtouris | size: 11697913856 |
159 | c4f606c0 | Stavros Sachtouris | status: available |
160 | fa382f9e | Stavros Sachtouris | 5ed5a29b-292c-4fe0-b32c-2e2b65628635 ubuntu |
161 | 573be34f | Stavros Sachtouris | container_format: bare |
162 | c4f606c0 | Stavros Sachtouris | disk_format: diskdump |
163 | c4f606c0 | Stavros Sachtouris | id: 5ed5a29b-292c-4fe0-b32c-2e2b65628635 |
164 | c4f606c0 | Stavros Sachtouris | size: 2578100224 |
165 | c4f606c0 | Stavros Sachtouris | status: available |
166 | fa382f9e | Stavros Sachtouris | 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe Debian_Wheezy_Base |
167 | 573be34f | Stavros Sachtouris | container_format: bare |
168 | c4f606c0 | Stavros Sachtouris | disk_format: diskdump |
169 | c4f606c0 | Stavros Sachtouris | id: 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe |
170 | c4f606c0 | Stavros Sachtouris | size: 795107328 |
171 | c4f606c0 | Stavros Sachtouris | status: available |
172 | c4f606c0 | Stavros Sachtouris | |
173 | c4f606c0 | Stavros Sachtouris | * Get details for image with id 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe * |
174 | c4f606c0 | Stavros Sachtouris | [image]: info 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe |
175 | c4f606c0 | Stavros Sachtouris | name: Debian_Wheezy_Base |
176 | c4f606c0 | Stavros Sachtouris | container_format: bare |
177 | c4f606c0 | Stavros Sachtouris | disk_format: diskdump |
178 | c4f606c0 | Stavros Sachtouris | id: 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe |
179 | c4f606c0 | Stavros Sachtouris | size: 795107328 |
180 | c4f606c0 | Stavros Sachtouris | status: available |
181 | c4f606c0 | Stavros Sachtouris | owner: s0m3-u53r-1d (user@example.com) |
182 | c4f606c0 | Stavros Sachtouris | DESCRIPTION: Debian Wheezy Base (Stable) |
183 | c4f606c0 | Stavros Sachtouris | GUI: No GUI |
184 | c4f606c0 | Stavros Sachtouris | KERNEL: 2.6.32 |
185 | c4f606c0 | Stavros Sachtouris | OS: debian |
186 | c4f606c0 | Stavros Sachtouris | OSFAMILY: linux |
187 | c4f606c0 | Stavros Sachtouris | ROOT_PARTITION: 1 |
188 | c4f606c0 | Stavros Sachtouris | SORTORDER: 1 |
189 | c4f606c0 | Stavros Sachtouris | USERS: root |
190 | c4f606c0 | Stavros Sachtouris | |
191 | c4f606c0 | Stavros Sachtouris | imagecompute (Compute/Cyclades) |
192 | c4f606c0 | Stavros Sachtouris | ------------------------------- |
193 | c4f606c0 | Stavros Sachtouris | |
194 | c4f606c0 | Stavros Sachtouris | .. code-block:: text |
195 | c4f606c0 | Stavros Sachtouris | |
196 | c4f606c0 | Stavros Sachtouris | info Get detailed information on an image |
197 | c4f606c0 | Stavros Sachtouris | list List images |
198 | c4f606c0 | Stavros Sachtouris | modify Modify image properties (metadata) |
199 | c4f606c0 | Stavros Sachtouris | delete Delete an image (WARNING: image file is also removed) |
200 | 2151584b | Stavros Sachtouris | |
201 | 2151584b | Stavros Sachtouris | server (Compute/Cyclades) |
202 | 961e6040 | Stavros Sachtouris | ------------------------- |
203 | 2151584b | Stavros Sachtouris | |
204 | 2151584b | Stavros Sachtouris | .. code-block:: text |
205 | 2151584b | Stavros Sachtouris | |
206 | c4f606c0 | Stavros Sachtouris | info Detailed information on a Virtual Machine |
207 | c4f606c0 | Stavros Sachtouris | modify Modify attributes of a virtual server |
208 | c4f606c0 | Stavros Sachtouris | create Create a server (aka Virtual Machine) |
209 | c4f606c0 | Stavros Sachtouris | list List virtual servers accessible by user |
210 | c4f606c0 | Stavros Sachtouris | reboot Reboot a virtual server |
211 | c4f606c0 | Stavros Sachtouris | start Start an existing virtual server |
212 | c4f606c0 | Stavros Sachtouris | shutdown Shutdown an active virtual server |
213 | c4f606c0 | Stavros Sachtouris | delete Delete a virtual server |
214 | edd4eacc | Stavros Sachtouris | console Create a VMC console and show connection information |
215 | c4f606c0 | Stavros Sachtouris | wait Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE] |
216 | 2151584b | Stavros Sachtouris | |
217 | 961e6040 | Stavros Sachtouris | Showcase: Create a server |
218 | 961e6040 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
219 | 2151584b | Stavros Sachtouris | |
220 | 2151584b | Stavros Sachtouris | .. code-block:: console |
221 | 2151584b | Stavros Sachtouris | :emphasize-lines: 1,4,21,35,44,62 |
222 | 2151584b | Stavros Sachtouris | |
223 | 0ea31480 | Stavros Sachtouris | [kamaki]: server |
224 | 2151584b | Stavros Sachtouris | |
225 | 0ea31480 | Stavros Sachtouris | [server]: create -h |
226 | c4f606c0 | Stavros Sachtouris | usage: create --name NAME --flavor-id FLAVOR_ID --image-id IMAGE_ID |
227 | fa382f9e | Stavros Sachtouris | [--personality PERSONALITY] [-h] [--config CONFIG] [--cloud CLOUD] |
228 | 2151584b | Stavros Sachtouris | |
229 | 2151584b | Stavros Sachtouris | Create a server |
230 | 2151584b | Stavros Sachtouris | |
231 | 2151584b | Stavros Sachtouris | optional arguments: |
232 | 2151584b | Stavros Sachtouris | -v, --verbose More info at response |
233 | 2151584b | Stavros Sachtouris | --personality PERSONALITY |
234 | 2151584b | Stavros Sachtouris | add a personality file |
235 | 2151584b | Stavros Sachtouris | -d, --debug Include debug output |
236 | 2151584b | Stavros Sachtouris | -h, --help Show help message |
237 | 2151584b | Stavros Sachtouris | -i, --include Include protocol headers in the output |
238 | 2151584b | Stavros Sachtouris | --config CONFIG Path to configuration file |
239 | 2151584b | Stavros Sachtouris | -s, --silent Do not output anything |
240 | fa382f9e | Stavros Sachtouris | --cloud CLOUD Chose a cloud to connect to |
241 | 2151584b | Stavros Sachtouris | |
242 | 2151584b | Stavros Sachtouris | * List all available images * |
243 | 0ea31480 | Stavros Sachtouris | [server]: /image compute list |
244 | e3a1d743 | Stavros Sachtouris | 1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS |
245 | e3a1d743 | Stavros Sachtouris | 1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop |
246 | e3a1d743 | Stavros Sachtouris | 18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS |
247 | e3a1d743 | Stavros Sachtouris | 6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop |
248 | e3a1d743 | Stavros Sachtouris | 6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom |
249 | e3a1d743 | Stavros Sachtouris | 78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012 |
250 | e3a1d743 | Stavros Sachtouris | 86bc2414-0fb3-4898-a637-240292243302 Fedora |
251 | e3a1d743 | Stavros Sachtouris | 926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008 |
252 | e3a1d743 | Stavros Sachtouris | b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base |
253 | e3a1d743 | Stavros Sachtouris | baf2321c-57a0-4a69-825d-49f49cea163a CentOS |
254 | e3a1d743 | Stavros Sachtouris | c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu |
255 | 2151584b | Stavros Sachtouris | |
256 | 2151584b | Stavros Sachtouris | * See details of flavor with id 1 * |
257 | 0ea31480 | Stavros Sachtouris | [server]: /flavor info 1 |
258 | 2151584b | Stavros Sachtouris | SNF:disk_template: drbd |
259 | 2151584b | Stavros Sachtouris | cpu : 1 |
260 | 2151584b | Stavros Sachtouris | disk : 20 |
261 | 2151584b | Stavros Sachtouris | id : 1 |
262 | 2151584b | Stavros Sachtouris | name : C1R1024D20 |
263 | 2151584b | Stavros Sachtouris | ram : 1024 |
264 | 2151584b | Stavros Sachtouris | |
265 | 2151584b | Stavros Sachtouris | * Create a debian server named 'My Small Debian Server' |
266 | c4f606c0 | Stavros Sachtouris | [server]: create --name='My Small Debian Server' --flavor-id=1 --image-id=b2dffe52-64a4-48c3-8a4c-8214cc3165cf |
267 | 2151584b | Stavros Sachtouris | adminPass: L8gu2wbZ94 |
268 | 2151584b | Stavros Sachtouris | created : 2012-11-23T16:56:04.190813+00:00 |
269 | 2151584b | Stavros Sachtouris | flavorRef: 1 |
270 | 2151584b | Stavros Sachtouris | hostId : |
271 | 2151584b | Stavros Sachtouris | id : 11687 |
272 | 2151584b | Stavros Sachtouris | imageRef : b2dffe52-64a4-48c3-8a4c-8214cc3165cf |
273 | 2151584b | Stavros Sachtouris | metadata : |
274 | fa382f9e | Stavros Sachtouris | os : debian |
275 | fa382f9e | Stavros Sachtouris | users: root |
276 | 2151584b | Stavros Sachtouris | name : My Small Debian Server |
277 | 2151584b | Stavros Sachtouris | progress : 0 |
278 | 2151584b | Stavros Sachtouris | status : BUILD |
279 | 2151584b | Stavros Sachtouris | suspended: False |
280 | 2151584b | Stavros Sachtouris | updated : 2012-11-23T16:56:04.761962+00:00 |
281 | 2151584b | Stavros Sachtouris | |
282 | 2151584b | Stavros Sachtouris | * wait for server to build (optional) * |
283 | 0ea31480 | Stavros Sachtouris | [server]: wait 11687 |
284 | e3a1d743 | Stavros Sachtouris | Server 11687 still in BUILD mode ||||||||||||||||| | 80% |
285 | 2151584b | Stavros Sachtouris | Server 11687 is now in ACTIVE mode |
286 | 2151584b | Stavros Sachtouris | |
287 | c4f606c0 | Stavros Sachtouris | .. Note:: In kamaki shell, / is used to access commands from top-level |
288 | 2151584b | Stavros Sachtouris | |
289 | c4f606c0 | Stavros Sachtouris | ip (Network/Cyclades) |
290 | 6489c38b | Stavros Sachtouris | --------------------- |
291 | 6489c38b | Stavros Sachtouris | |
292 | 6489c38b | Stavros Sachtouris | .. code-block:: text |
293 | 6489c38b | Stavros Sachtouris | |
294 | c4f606c0 | Stavros Sachtouris | info Get details on a floating IP |
295 | c4f606c0 | Stavros Sachtouris | create Reserve an IP on a network |
296 | c4f606c0 | Stavros Sachtouris | list List reserved floating IPs |
297 | c4f606c0 | Stavros Sachtouris | delete Unreserve an IP (also delete the port, if attached) |
298 | cc5da5a5 | Stavros Sachtouris | attach Attach an IP on a virtual server |
299 | cc5da5a5 | Stavros Sachtouris | detach Detach an IP from a virtual server |
300 | c4f606c0 | Stavros Sachtouris | |
301 | c4f606c0 | Stavros Sachtouris | port (Network/Cyclades) |
302 | c4f606c0 | Stavros Sachtouris | ----------------------- |
303 | c4f606c0 | Stavros Sachtouris | |
304 | c4f606c0 | Stavros Sachtouris | .. code-block:: text |
305 | c4f606c0 | Stavros Sachtouris | |
306 | c4f606c0 | Stavros Sachtouris | info Get details about a port |
307 | c4f606c0 | Stavros Sachtouris | list List all ports |
308 | c4f606c0 | Stavros Sachtouris | create Create a new port (== connect server to network) |
309 | c4f606c0 | Stavros Sachtouris | modify Modify the attributes of a port |
310 | c4f606c0 | Stavros Sachtouris | delete Delete a port (== disconnect server from network) |
311 | c4f606c0 | Stavros Sachtouris | wait Wait for port to finish [ACTIVE, DOWN, BUILD, ERROR] |
312 | 6489c38b | Stavros Sachtouris | |
313 | 6489c38b | Stavros Sachtouris | Showcase: Reserve and attach IP to server |
314 | c4f606c0 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
315 | 6489c38b | Stavros Sachtouris | |
316 | 6489c38b | Stavros Sachtouris | .. code-block:: text |
317 | 6489c38b | Stavros Sachtouris | |
318 | c4f606c0 | Stavros Sachtouris | * Enter port context * |
319 | c4f606c0 | Stavros Sachtouris | [kamaki]: port |
320 | 6489c38b | Stavros Sachtouris | |
321 | c4f606c0 | Stavros Sachtouris | * Reserve an IP and see servers and networks* |
322 | c4f606c0 | Stavros Sachtouris | [port]: /ip create |
323 | 6489c38b | Stavros Sachtouris | 123.456.78.9 |
324 | c4f606c0 | Stavros Sachtouris | [port]: /server list |
325 | 6489c38b | Stavros Sachtouris | 42 My Windows Server |
326 | 6489c38b | Stavros Sachtouris | 43 My Linux Server |
327 | c4f606c0 | Stavros Sachtouris | [port]: /network list |
328 | c4f606c0 | Stavros Sachtouris | 101 My Network 1 |
329 | c4f606c0 | Stavros Sachtouris | 102 My Network 2 |
330 | 6489c38b | Stavros Sachtouris | |
331 | 6489c38b | Stavros Sachtouris | * Attach IP to server |
332 | c4f606c0 | Stavros Sachtouris | [port]: port create --device-id=43 --network-id=101 --ip-address=123.456.78.9 --wait |
333 | c4f606c0 | Stavros Sachtouris | Creating new port 7 between server 43 and network 101 |
334 | c4f606c0 | Stavros Sachtouris | Port 7 still in BUILD mode ||||||||||||||||| | 80% |
335 | c4f606c0 | Stavros Sachtouris | Port 7 is now in ACTIVE mode |
336 | 6489c38b | Stavros Sachtouris | |
337 | 6489c38b | Stavros Sachtouris | .. Note:: In kamaki shell, / is used to access top-level command groups while |
338 | 6489c38b | Stavros Sachtouris | working in command group contexts |
339 | 6489c38b | Stavros Sachtouris | |
340 | 76769d2f | Stavros Sachtouris | network (Network/Cyclades) |
341 | 961e6040 | Stavros Sachtouris | -------------------------- |
342 | 2151584b | Stavros Sachtouris | |
343 | 2151584b | Stavros Sachtouris | .. code-block:: text |
344 | 2151584b | Stavros Sachtouris | |
345 | c4f606c0 | Stavros Sachtouris | info Get details about a network |
346 | c4f606c0 | Stavros Sachtouris | disconnect Disconnect a network from a device |
347 | c4f606c0 | Stavros Sachtouris | modify Modify network attributes |
348 | c4f606c0 | Stavros Sachtouris | create Create a new network |
349 | c4f606c0 | Stavros Sachtouris | list List networks |
350 | c4f606c0 | Stavros Sachtouris | connect Connect a network with a device (server or router) |
351 | c4f606c0 | Stavros Sachtouris | delete Delete a network |
352 | 2151584b | Stavros Sachtouris | |
353 | 2151584b | Stavros Sachtouris | Showcase: Connect a network to a VM |
354 | 961e6040 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
355 | 2151584b | Stavros Sachtouris | |
356 | 2151584b | Stavros Sachtouris | .. code-block:: console |
357 | 2151584b | Stavros Sachtouris | :emphasize-lines: 1,4,9,24,27,44 |
358 | 2151584b | Stavros Sachtouris | |
359 | 2151584b | Stavros Sachtouris | * Enter network context * |
360 | 0ea31480 | Stavros Sachtouris | [kamaki]: network |
361 | 2151584b | Stavros Sachtouris | |
362 | 2151584b | Stavros Sachtouris | * List user-owned VMs * |
363 | 0ea31480 | Stavros Sachtouris | [network]: /server list |
364 | 2151584b | Stavros Sachtouris | 11687 (My Small Debian Server) |
365 | 2151584b | Stavros Sachtouris | 11688 (An Ubuntu server) |
366 | 2151584b | Stavros Sachtouris | |
367 | 2151584b | Stavros Sachtouris | * Try network-connect (to get help) * |
368 | 0ea31480 | Stavros Sachtouris | [network]: connect |
369 | 2151584b | Stavros Sachtouris | Syntax error |
370 | 7a3c66e1 | Stavros Sachtouris | usage: connect <network id> --device-id <DEVICE_ID> [-s] [-h] [-i] [--config CONFIG] |
371 | 2151584b | Stavros Sachtouris | |
372 | 2151584b | Stavros Sachtouris | Connect a server to a network |
373 | 2151584b | Stavros Sachtouris | |
374 | 2151584b | Stavros Sachtouris | Syntax: connect <server id> <network id> |
375 | 2151584b | Stavros Sachtouris | --config : Path to configuration file |
376 | 2151584b | Stavros Sachtouris | -d,--debug : Include debug output |
377 | 2151584b | Stavros Sachtouris | -h,--help : Show help message |
378 | 2151584b | Stavros Sachtouris | -i,--include: Include protocol headers in the output |
379 | 2151584b | Stavros Sachtouris | -s,--silent : Do not output anything |
380 | 2151584b | Stavros Sachtouris | -v,--verbose: More info at response |
381 | 2151584b | Stavros Sachtouris | |
382 | 2151584b | Stavros Sachtouris | * Connect VM with id 11687 to network with id 1409 |
383 | 3b6d09dc | Stavros Sachtouris | [network]: connect 1409 --device-id=11687 --wait |
384 | c4f606c0 | Stavros Sachtouris | Creating port between network 1409 and server 11687 |
385 | c4f606c0 | Stavros Sachtouris | New port: 8 |
386 | 2151584b | Stavros Sachtouris | |
387 | 2151584b | Stavros Sachtouris | * Get details on network with id 1409 |
388 | 0ea31480 | Stavros Sachtouris | [network]: info 1409 |
389 | c4f606c0 | Stavros Sachtouris | attachments: |
390 | c4f606c0 | Stavros Sachtouris | 8 |
391 | fa382f9e | Stavros Sachtouris | cidr : 192.168.1.0/24 |
392 | fa382f9e | Stavros Sachtouris | cidr6 : None |
393 | fa382f9e | Stavros Sachtouris | created : 2012-11-23T17:17:20.560098+00:00 |
394 | fa382f9e | Stavros Sachtouris | dhcp : True |
395 | fa382f9e | Stavros Sachtouris | gateway : None |
396 | fa382f9e | Stavros Sachtouris | gateway6: None |
397 | fa382f9e | Stavros Sachtouris | id : 1409 |
398 | fa382f9e | Stavros Sachtouris | name : my network |
399 | fa382f9e | Stavros Sachtouris | public : False |
400 | fa382f9e | Stavros Sachtouris | status : ACTIVE |
401 | fa382f9e | Stavros Sachtouris | type : MAC_FILTERED |
402 | fa382f9e | Stavros Sachtouris | updated : 2012-11-23T17:18:25.095225+00:00 |
403 | 2151584b | Stavros Sachtouris | |
404 | 2151584b | Stavros Sachtouris | * Get connectivity details on VM with id 11687 * |
405 | c4f606c0 | Stavros Sachtouris | [network]: /server info 11687 --nics |
406 | c4f606c0 | Stavros Sachtouris | nic-11687-1 |
407 | 2151584b | Stavros Sachtouris | ipv4 : 192.168.1.1 |
408 | 2151584b | Stavros Sachtouris | ipv6 : None |
409 | 2151584b | Stavros Sachtouris | mac_address: aa:0f:c2:0b:0e:85 |
410 | 2151584b | Stavros Sachtouris | network_id : 1409 |
411 | 2151584b | Stavros Sachtouris | firewallProfile: DISABLED |
412 | c4f606c0 | Stavros Sachtouris | nic-11687-0 |
413 | 2151584b | Stavros Sachtouris | ipv4 : 83.212.106.111 |
414 | 2151584b | Stavros Sachtouris | ipv6 : 2001:648:2ffc:1116:a80c:f2ff:fe12:a9e |
415 | 2151584b | Stavros Sachtouris | mac_address : aa:0c:f2:12:0a:9e |
416 | 2151584b | Stavros Sachtouris | network_id : 1369 |
417 | 2151584b | Stavros Sachtouris | |
418 | 2151584b | Stavros Sachtouris | .. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts |
419 | 2151584b | Stavros Sachtouris | |
420 | c4f606c0 | Stavros Sachtouris | container (Storage/Pithos+) |
421 | c4f606c0 | Stavros Sachtouris | --------------------------- |
422 | c4f606c0 | Stavros Sachtouris | |
423 | 76769d2f | Stavros Sachtouris | .. code-block:: text |
424 | 76769d2f | Stavros Sachtouris | |
425 | c4f606c0 | Stavros Sachtouris | info Get information about a container |
426 | c4f606c0 | Stavros Sachtouris | modify Modify the properties of a container |
427 | c4f606c0 | Stavros Sachtouris | create Create a new container |
428 | c4f606c0 | Stavros Sachtouris | list List all containers, or their contents |
429 | c4f606c0 | Stavros Sachtouris | empty Empty a container |
430 | c4f606c0 | Stavros Sachtouris | delete Delete a container |
431 | c4f606c0 | Stavros Sachtouris | |
432 | c4f606c0 | Stavros Sachtouris | group (Storage/Pithos+) |
433 | c4f606c0 | Stavros Sachtouris | ----------------------- |
434 | c4f606c0 | Stavros Sachtouris | |
435 | 76769d2f | Stavros Sachtouris | .. code-block:: text |
436 | 76769d2f | Stavros Sachtouris | |
437 | c4f606c0 | Stavros Sachtouris | create Create a group of users |
438 | c4f606c0 | Stavros Sachtouris | list List all groups and group members |
439 | c4f606c0 | Stavros Sachtouris | delete Delete a user group |
440 | c4f606c0 | Stavros Sachtouris | |
441 | c4f606c0 | Stavros Sachtouris | sharer (Storage/Pithos+) |
442 | c4f606c0 | Stavros Sachtouris | ------------------------ |
443 | c4f606c0 | Stavros Sachtouris | |
444 | 76769d2f | Stavros Sachtouris | .. code-block:: text |
445 | 76769d2f | Stavros Sachtouris | |
446 | c4f606c0 | Stavros Sachtouris | info Details on a Pithos+ sharer account (default: current account) |
447 | c4f606c0 | Stavros Sachtouris | list List accounts who share file objects with current user |
448 | c4f606c0 | Stavros Sachtouris | |
449 | 0ea31480 | Stavros Sachtouris | file (Storage/Pithos+) |
450 | 0ea31480 | Stavros Sachtouris | ---------------------- |
451 | 2151584b | Stavros Sachtouris | |
452 | 2151584b | Stavros Sachtouris | .. code-block:: text |
453 | 2151584b | Stavros Sachtouris | |
454 | c4f606c0 | Stavros Sachtouris | info Get information/details about a file |
455 | c4f606c0 | Stavros Sachtouris | truncate Truncate remote file up to size |
456 | c4f606c0 | Stavros Sachtouris | mkdir Create a directory |
457 | c4f606c0 | Stavros Sachtouris | create Create an empty file |
458 | c4f606c0 | Stavros Sachtouris | move Move objects, even between different accounts or containers |
459 | c4f606c0 | Stavros Sachtouris | list List all objects in a container or a directory object |
460 | c4f606c0 | Stavros Sachtouris | upload Upload a file |
461 | c4f606c0 | Stavros Sachtouris | cat Fetch remote file contents |
462 | c4f606c0 | Stavros Sachtouris | modify Modify the attributes of a file or directory object |
463 | c4f606c0 | Stavros Sachtouris | append Append local file to (existing) remote object |
464 | c4f606c0 | Stavros Sachtouris | download Download a remove file or directory object to local file system |
465 | c4f606c0 | Stavros Sachtouris | copy Copy objects, even between different accounts or containers |
466 | c4f606c0 | Stavros Sachtouris | overwrite Overwrite part of a remote file |
467 | c4f606c0 | Stavros Sachtouris | delete Delete a file or directory object |
468 | 2151584b | Stavros Sachtouris | |
469 | 961e6040 | Stavros Sachtouris | Showcase: Upload and download a file |
470 | 961e6040 | Stavros Sachtouris | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
471 | 2151584b | Stavros Sachtouris | |
472 | 2151584b | Stavros Sachtouris | .. code-block:: console |
473 | 2151584b | Stavros Sachtouris | :emphasize-lines: 1,7,11,16,21,29,33,37,41,44,51,55,60,64 |
474 | 2151584b | Stavros Sachtouris | |
475 | 2151584b | Stavros Sachtouris | * Create a random binarry file at current OS path * |
476 | 0ea31480 | Stavros Sachtouris | [kamaki]: !dd bs=4M if=/dev/zero of=rndm_local.file count=5 |
477 | 2151584b | Stavros Sachtouris | 5+0 records in |
478 | 2151584b | Stavros Sachtouris | 5+0 records out |
479 | 2151584b | Stavros Sachtouris | 20971520 bytes (21 MB) copied, 0.016162 s, 1.3 GB/s |
480 | 2151584b | Stavros Sachtouris | |
481 | 0ea31480 | Stavros Sachtouris | * Enter file context * |
482 | 0ea31480 | Stavros Sachtouris | [kamaki]: file |
483 | 2151584b | Stavros Sachtouris | |
484 | 2151584b | Stavros Sachtouris | |
485 | 2151584b | Stavros Sachtouris | * Check local file * |
486 | 0ea31480 | Stavros Sachtouris | [file]: !ls -lh rndm_local.file |
487 | 2151584b | Stavros Sachtouris | -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file |
488 | 2151584b | Stavros Sachtouris | |
489 | 2151584b | Stavros Sachtouris | |
490 | 2151584b | Stavros Sachtouris | * Create two containers * |
491 | c4f606c0 | Stavros Sachtouris | [file]: /container create mycont1 |
492 | c4f606c0 | Stavros Sachtouris | [file]: /container create mycont2 |
493 | 2151584b | Stavros Sachtouris | |
494 | 2151584b | Stavros Sachtouris | |
495 | 2151584b | Stavros Sachtouris | * List accessible containers * |
496 | c4f606c0 | Stavros Sachtouris | [file]: /container list |
497 | 2151584b | Stavros Sachtouris | 1. mycont1 (0B, 0 objects) |
498 | 2151584b | Stavros Sachtouris | 2. mycont2 (0B, 0 objects) |
499 | 2151584b | Stavros Sachtouris | 3. pithos (0B, 0 objects) |
500 | 2151584b | Stavros Sachtouris | 4. trash (0B, 0 objects) |
501 | 2151584b | Stavros Sachtouris | |
502 | 2151584b | Stavros Sachtouris | |
503 | 2151584b | Stavros Sachtouris | * Upload local file to 1st container * |
504 | c4f606c0 | Stavros Sachtouris | [file]: upload /mycont1/rndm_local.file |
505 | 2151584b | Stavros Sachtouris | |
506 | 2151584b | Stavros Sachtouris | |
507 | 2151584b | Stavros Sachtouris | * Check if file has been uploaded * |
508 | c4f606c0 | Stavros Sachtouris | [file]: list /mycont1 |
509 | 2151584b | Stavros Sachtouris | 1. 20M rndm_local.file |
510 | 2151584b | Stavros Sachtouris | |
511 | 2151584b | Stavros Sachtouris | * Create directory mydir on second container * |
512 | c4f606c0 | Stavros Sachtouris | [file]: mkdir /mycont2/mydir |
513 | 2151584b | Stavros Sachtouris | |
514 | 2151584b | Stavros Sachtouris | * Move file from 1st to 2nd container (and in the directory) * |
515 | c4f606c0 | Stavros Sachtouris | [file]: move /mycont1/rndm_local.file /mycont2/mydir/rndm_local.file |
516 | 2151584b | Stavros Sachtouris | |
517 | 2151584b | Stavros Sachtouris | * Check contents of both containers * |
518 | c4f606c0 | Stavros Sachtouris | [file]: list /mycont1 |
519 | c4f606c0 | Stavros Sachtouris | [file]: list /mycont2 |
520 | 2151584b | Stavros Sachtouris | 1. D mydir/ |
521 | 2151584b | Stavros Sachtouris | 2. 20M mydir/rndm_local.file |
522 | 2151584b | Stavros Sachtouris | |
523 | 2151584b | Stavros Sachtouris | * Copy file from 2nd to 1st container, with a new name * |
524 | c4f606c0 | Stavros Sachtouris | [file]: copy /mycont2/mydir/rndm_local.file /mycont1/rndm_remote.file |
525 | 2151584b | Stavros Sachtouris | |
526 | 2151584b | Stavros Sachtouris | * Check pasted file * |
527 | c4f606c0 | Stavros Sachtouris | [file]: list /mycont1 |
528 | 2151584b | Stavros Sachtouris | 1. 20M rndm_remote.file |
529 | 2151584b | Stavros Sachtouris | |
530 | 2151584b | Stavros Sachtouris | * Download pasted file to local file system * |
531 | c4f606c0 | Stavros Sachtouris | [file]: download /mycont1/rndm_remote.file |
532 | c4f606c0 | Stavros Sachtouris | Downloading: ||||||||||||||||| | 72% |
533 | 2151584b | Stavros Sachtouris | |
534 | 2151584b | Stavros Sachtouris | * Check if file is downloaded and if it is the same to original * |
535 | 0ea31480 | Stavros Sachtouris | [file]: !ls -lh *.file |
536 | 2151584b | Stavros Sachtouris | -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file |
537 | 2151584b | Stavros Sachtouris | -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:42 rndm_remote.file |
538 | 0ea31480 | Stavros Sachtouris | [file]: !diff rndm_local.file rndm_remote.file |
539 | 2151584b | Stavros Sachtouris | |
540 | 16d7b9ff | Stavros Sachtouris | .. Note:: In kamaki shell, ! is used to execute OS shell commands (e.g., bash) |