Statistics
| Branch: | Tag: | Revision:

root / docs / commands.rst @ ef04bdeb

History | View | Annotate | Download (14.3 kB)

1
List of commands
2
================
3

    
4
The commands described bellow are grouped by service. The examples showcase a
5
sample set of group commands. The kamaki interactive shell (check
6
`Usage section <usage.html#interactive-shell>`_ for details) is chosen as the
7
execution environment.
8

    
9

    
10
user (Identity Manager)
11
-----------------------
12

    
13
.. code-block:: text
14

    
15
    authenticate:  Authenticate a user
16

    
17
Showcase: get user information
18
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
19

    
20
In the following, the token has been set in a previous step (see
21
`setup section <setup.html>`_ or the
22
`quick setup guide <usage.html#quick-setup>`_)
23

    
24
.. code-block:: console
25
    :emphasize-lines: 1,4
26

    
27
    * Enter user context *
28
    [kamaki]: user
29

    
30
    * Authenticate user *
31
    [user]: authenticate
32
    ...
33
    user:
34
        name:  My Real Name
35
        uuid:  ab1cde23-45fg-6h7i-8j9k-10l1m11no2pq
36

    
37
.. note:: actual call returns a full list of service endpoints accessible to
38
    the user with a specific token
39

    
40
flavor (Compute/Cyclades)
41
-------------------------
42

    
43
.. code-block:: text
44

    
45
    info:  Get flavor details
46
    list:  List flavors
47

    
48
Showcase: show details for flavor with id 43
49
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
50

    
51
.. code-block:: console
52
    :emphasize-lines: 1,4
53

    
54
    * Enter flavor context *
55
    [kamaki]: flavor
56

    
57
    * Get details about flavor with id 43 *
58
    [flavor]: info 43
59
    SNF:disk_template:  drbd
60
    cpu :  4
61
    disk:  10
62
    id  :  43
63
    name:  C4R2048D10
64
    ram :  2048
65

    
66
image (Plankton commands + Compute Image subcommands)
67
-----------------------------------------------------
68

    
69
.. code-block:: text
70

    
71
    list      :  List images accessible by user
72
    meta      :  Get image metadata
73
    register  :  (Re)Register an image
74
    unregister:  Unregister an image (does not delete the image file)
75
    shared    :  List shared images
76
    compute   :  Compute Image API commands
77
        list      :  List images
78
        delete    :  Delete image
79
        info      :  Get image details
80
        properties:  Manage properties related to OS installation in an image
81
            add   :  Add a property to an image
82
            delete:  Delete a property from an image
83
            get   :  Get an image property
84
            list  :  List all image properties
85
            set   :  Add / update a set of properties for an image
86
    members   :  Manage members (users who can modify an image)
87
        add   :  Add a member to an image
88
        delete:  Remove a member from an image
89
        list  :  List members of an image
90
        set   :  Set the members of an image
91

    
92
Showcase: Pick an image and list the properties
93
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94

    
95
.. code-block:: console
96
    :emphasize-lines: 1,4,18
97

    
98
    * Enter image context *
99
    [kamaki]: image
100

    
101
    * list all available images *
102
    [image]: list
103
    926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
104
     container_format:  bare
105
     disk_format     :  diskdump
106
     id              :  926ab1c5-2d85-49d4-aebe-0fce712789b9
107
     size            :  11917066240
108
     status          :  available
109
    78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
110
     container_format:  bare
111
     disk_format     :  diskdump
112
     id              :  78262ee7-949e-4d70-af3a-85360c3de57a
113
     size            :  11697913856
114
     status          :  available
115
    5ed5a29b-292c-4fe0-b32c-2e2b65628635 ubuntu
116
     container_format:  bare
117
     disk_format     :  diskdump
118
     id              :  5ed5a29b-292c-4fe0-b32c-2e2b65628635
119
     size            :  2578100224
120
     status          :  available
121
    1f8454f0-8e3e-4b6c-ab8e-5236b728dffe Debian_Wheezy_Base
122
     container_format:  bare
123
     disk_format     :  diskdump
124
     id              :  1f8454f0-8e3e-4b6c-ab8e-5236b728dffe
125
     size            :  795107328
126
     status          :  available
127

    
128
    * Get properties of image with id 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe *
129
    [image]: compute properties 1f8454f0-8e3e-4b6c-ab8e-5236b728dffe
130
    description   :  Debian 6.0.6 (Squeeze) Base System
131
    gui           :  No GUI
132
    kernel        :  2.6.32
133
    os            :  debian
134
    osfamily      :  linux
135
    root_partition:  1
136
    sortorder     :  1
137
    users         :  root
138

    
139
server (Compute/Cyclades)
140
-------------------------
141

    
142
.. code-block:: text
143

    
144
    addr    :  List a server's nic address
145
    console :  Get a VNC console
146
    create  :  Create a server
147
    delete  :  Delete a server
148
    firewall:  Manage server's firewall profile
149
        set :  Set the server's firewall profile
150
        get :  Get the server's firewall profile
151
    info    :  Get server details
152
    list    :  List servers
153
    metadata:  Manage Server Metadata
154
        list  :  List server metadata
155
        set   :  Add / update server metadata
156
        delete:  Delete a piece of server metadata
157
    meta    :  Get a server's metadata
158
    reboot  :  Reboot a server
159
    rename  :  Update a server's name
160
    shutdown:  Shutdown a server
161
    start   :  Start a server
162
    stats   :  Get server statistics
163
    resize  :  Set a different flavor for an existing server
164
    wait    :  Wait for server to finish
165

    
166
Showcase: Create a server
167
^^^^^^^^^^^^^^^^^^^^^^^^^
168

    
169
.. code-block:: console
170
    :emphasize-lines: 1,4,21,35,44,62
171

    
172
    * Enter server context *
173
    [kamaki]: server
174

    
175
    * See server-create help *
176
    [server]: create -h
177
    usage: create <name> <flavor id> <image id>
178
            [--personality PERSONALITY] [-h] [--config CONFIG] [--cloud CLOUD]
179

    
180
    Create a server
181

    
182
    optional arguments:
183
      -v, --verbose         More info at response
184
      --personality PERSONALITY
185
                            add a personality file
186
      -d, --debug           Include debug output
187
      -h, --help            Show help message
188
      -i, --include         Include protocol headers in the output
189
      --config CONFIG       Path to configuration file
190
      -s, --silent          Do not output anything
191
      --cloud CLOUD         Chose a cloud to connect to
192

    
193
    * List all available images *
194
    [server]: /image compute list
195
    1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
196
    1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
197
    18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
198
    6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
199
    6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
200
    78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
201
    86bc2414-0fb3-4898-a637-240292243302 Fedora
202
    926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
203
    b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
204
    baf2321c-57a0-4a69-825d-49f49cea163a CentOS
205
    c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
206

    
207
    * See details of flavor with id 1 *
208
    [server]: /flavor info 1
209
    SNF:disk_template:  drbd
210
    cpu              :  1
211
    disk             :  20
212
    id               :  1
213
    name             :  C1R1024D20
214
    ram              :  1024
215

    
216
    * Create a debian server named 'My Small Debian Server'
217
    [server]: create 'My Small Debian Server' 1 b2dffe52-64a4-48c3-8a4c-8214cc3165cf
218
    adminPass:  L8gu2wbZ94
219
    created  :  2012-11-23T16:56:04.190813+00:00
220
    flavorRef:  1
221
    hostId   :  
222
    id       :  11687
223
    imageRef :  b2dffe52-64a4-48c3-8a4c-8214cc3165cf
224
    metadata : 
225
               os   :  debian
226
               users:  root
227
    name     :  My Small Debian Server
228
    progress :  0
229
    status   :  BUILD
230
    suspended:  False
231
    updated  :  2012-11-23T16:56:04.761962+00:00
232

    
233
    * wait for server to build (optional) *
234
    [server]: wait 11687
235
    Server 11687 still in BUILD mode |||||||||||||||||    | 80%
236
    Server 11687 is now in ACTIVE mode
237

    
238
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
239

    
240
network (Compute/Cyclades)
241
--------------------------
242

    
243
.. code-block:: text
244

    
245
    connect   :  Connect a server to a network
246
    create    :  Create a network
247
    delete    :  Delete a network
248
    disconnect:  Disconnect a nic of a server to a network
249
    info      :  Get network details
250
    list      :  List networks
251
    rename    :  Update network name
252

    
253
Showcase: Connect a network to a VM
254
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
255

    
256
.. code-block:: console
257
    :emphasize-lines: 1,4,9,24,27,44
258

    
259
    * Enter network context *
260
    [kamaki]: network
261

    
262
    * List user-owned VMs *
263
    [network]: /server list
264
    11687 (My Small Debian Server)
265
    11688 (An Ubuntu server)
266

    
267
    * Try network-connect (to get help) *
268
    [network]: connect 
269
    Syntax error
270
    usage: connect <server id> <network id> [-s] [-h] [-i] [--config CONFIG]
271

    
272
    Connect a server to a network
273

    
274
    Syntax: connect  <server id> <network id>
275
      --config    :  Path to configuration file
276
      -d,--debug  :  Include debug output
277
      -h,--help   :  Show help message
278
      -i,--include:  Include protocol headers in the output
279
      -s,--silent :  Do not output anything
280
      -v,--verbose:  More info at response
281

    
282
    * Connect VM with id 11687 to network with id 1409
283
    [network]: connect 11687 1409
284

    
285
    * Get details on network with id 1409
286
    [network]: info 1409
287
      attachments: 
288
                 nic-11687-1
289
      cidr    :  192.168.1.0/24
290
      cidr6   :  None
291
      created :  2012-11-23T17:17:20.560098+00:00
292
      dhcp    :  True
293
      gateway :  None
294
      gateway6:  None
295
      id      :  1409
296
      name    :  my network
297
      public  :  False
298
      status  :  ACTIVE
299
      type    :  MAC_FILTERED
300
      updated :  2012-11-23T17:18:25.095225+00:00
301

    
302
    * Get connectivity details on VM with id 11687 *
303
    [network]: /server addr 11687
304
    id:  nic-11687-1
305
        ipv4       :  192.168.1.1
306
        ipv6       :  None
307
        mac_address:  aa:0f:c2:0b:0e:85
308
        network_id :  1409
309
        firewallProfile:  DISABLED
310
    id:  nic-11687-0
311
        ipv4           :  83.212.106.111
312
        ipv6           :  2001:648:2ffc:1116:a80c:f2ff:fe12:a9e
313
        mac_address    :  aa:0c:f2:12:0a:9e
314
        network_id     :  1369
315

    
316
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
317

    
318
file (Storage/Pithos+)
319
----------------------
320

    
321
.. code-block:: text
322

    
323
    append        :  Append local file to remote
324
    cat           :  Print a file to console
325
    copy          :  Copy an object
326
    containerlimit:  Container size limit commands
327
        set       :  Set container data limit
328
        get       :  Get container data limit
329
    create        :  Create a container
330
    delete        :  Delete a container [or an object]
331
    download      :  Download a file or directory
332
    group         :  Manage access groups and group members
333
        delete:  Delete a user group
334
        list  :  List groups and group members
335
        set   :  Set a user group
336
    hashmap       :  Get the hashmap of an object
337
    info          :  Get information for account [, container [or object]]
338
    list          :  List containers, object trees or objects in a directory
339
    manifest      :  Create a remote file with uploaded parts by manifestation
340
    metadata      :  Metadata are attached on objects (key:value pairs)
341
        delete:  Delete metadata with given key
342
        get   :  Get metadatum
343
        set   :  Set a piece of metadata
344
    mkdir         :  Create a directory
345
    move          :  Copy an object
346
    overwrite     :  Overwrite part (from start to end) of a remote file
347
    permissions   :  Manage user and group accessibility for objects
348
        delete:  Delete all permissions set on object
349
        get   :  Get read and write permissions of an object
350
        set   :  Set permissions for an object
351
    publish       :  Publish an object
352
    purge         :  Purge a container
353
    quota         :  Get  quota for account
354
    sharers       :  List the accounts that share objects with default account
355
    touch         :  Create an empty object (file)
356
    truncate      :  Truncate remote file up to a size
357
    unpublish     :  Unpublish an object
358
    upload        :  Upload a file or directory
359
    versioning    :  Manage the versioning scheme of current pithos user account
360
        get:  Get  versioning for account or container
361
        set:  Set versioning mode (auto, none) for account or container
362
    versions      :  Get the version list of an object
363

    
364
Showcase: Upload and download a file
365
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
366

    
367
.. code-block:: console
368
    :emphasize-lines: 1,7,11,16,21,29,33,37,41,44,51,55,60,64
369

    
370
    * Create a random binarry file at current OS path *
371
    [kamaki]: !dd bs=4M if=/dev/zero of=rndm_local.file count=5
372
    5+0 records in
373
    5+0 records out
374
    20971520 bytes (21 MB) copied, 0.016162 s, 1.3 GB/s
375

    
376
    * Enter file context *
377
    [kamaki]: file
378

    
379

    
380
    * Check local file *
381
    [file]: !ls -lh rndm_local.file
382
    -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file
383

    
384

    
385
    * Create two containers *
386
    [file]: create mycont1
387
    [file]: create mycont2
388

    
389

    
390
    * List accessible containers *    
391
    [file]: list
392
    1. mycont1 (0B, 0 objects)
393
    2. mycont2 (0B, 0 objects)
394
    3. pithos (0B, 0 objects)
395
    4. trash (0B, 0 objects)
396

    
397

    
398
    * Upload local file to 1st container *
399
    [file]: upload rndm_local.file mycont1
400

    
401

    
402
    * Check if file has been uploaded *
403
    [file]: list mycont1
404
    1.    20M rndm_local.file
405

    
406
    * Create directory mydir on second container *
407
    [file]: mkdir mycont2:mydir
408

    
409

    
410
    * Move file from 1st to 2nd container (and in the directory) *
411
    [file]: move mycont1:rndm_local.file mycont2:mydir/rndm_local.file
412

    
413
    * Check contents of both containers *
414
    [file]: list mycont1
415
    [file]: list mycont2
416
    1.      D mydir/
417
    2.    20M mydir/rndm_local.file
418

    
419

    
420
    * Copy file from 2nd to 1st container, with a new name *
421
    [file]: copy mycont2:mydir/rndm_local.file mycont1:rndm_remote.file
422

    
423

    
424
    * Check pasted file *
425
    [file]: list mycont1
426
    1.    20M rndm_remote.file
427

    
428

    
429
    * Download pasted file to local file system *
430
    [file]: download mycont1:rndm_remote.file rndm_remote.file
431

    
432

    
433
    * Check if file is downloaded and if it is the same to original *
434
    [file]: !ls -lh *.file
435
    -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file
436
    -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:42 rndm_remote.file
437
    [file]: !diff rndm_local.file rndm_remote.file
438

    
439
.. Note:: In kamaki shell, ! is used to execute OS shell commands (e.g. bash)
440

    
441
.. warning:: The container:object/path syntax does not function if the
442
    container and / or the object path contain one or more : characters. To use
443
    containers and objects with : use the --container and --dst-container
444
    arguments, e.g. to copy test.py object from grnet:dev container to
445
    grnet:deploy ::
446

    
447
        $ kamaki file copy --container=grnet:dev test.py --dst-container=grnet:deploy