Revision 961e6040 docs/commands.rst
| b/docs/commands.rst | ||
|---|---|---|
| 1 |
Commands |
|
| 2 |
======== |
|
| 3 |
|
|
| 4 | 1 |
List of commands |
| 5 |
---------------- |
|
| 2 |
================ |
|
| 3 |
|
|
| 4 |
The commands described bellow are grouped by service. The examples showcase a sample set of group commands. The kamaki interactive shell (check `Usage section <usage.html#interactive-shell>`_ for details) is chosen as the execution environment. |
|
| 6 | 5 |
|
| 7 |
The commands described bellow are grouped by service. The examples showcase a sample set of group commands. The kamaki interactive shell (check `Usage section <usage.html#interactive-shell>`_ for details) is chosen as the execution environment: |
|
| 8 | 6 |
|
| 9 | 7 |
astakos (Identity Manager) |
| 10 |
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
| 8 |
--------------------------
|
|
| 11 | 9 |
|
| 12 | 10 |
.. code-block:: text |
| 13 | 11 |
|
| 14 | 12 |
authenticate: Authenticate a user |
| 15 | 13 |
|
| 16 |
Showcase: get user information, provided the token was set |
|
| 14 |
Showcase: get user information |
|
| 15 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 16 |
|
|
| 17 |
In the following, the token has been set in a previous step (see `setup section <setup.html>`_ or the `quick setup guide <usage.html#quick-setup>`_) |
|
| 17 | 18 |
|
| 18 | 19 |
.. code-block:: console |
| 19 | 20 |
:emphasize-lines: 1,4 |
| ... | ... | |
| 34 | 35 |
username : 4215th3b357num9323v32 |
| 35 | 36 |
|
| 36 | 37 |
flavor (Compute/Cyclades) |
| 37 |
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
| 38 |
-------------------------
|
|
| 38 | 39 |
|
| 39 | 40 |
.. code-block:: text |
| 40 | 41 |
|
| ... | ... | |
| 42 | 43 |
list: List flavors |
| 43 | 44 |
|
| 44 | 45 |
Showcase: show details for flavor with id 43 |
| 46 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 45 | 47 |
|
| 46 | 48 |
.. code-block:: console |
| 47 | 49 |
:emphasize-lines: 1,4 |
| ... | ... | |
| 59 | 61 |
ram : 2048 |
| 60 | 62 |
|
| 61 | 63 |
image (Compute/Cyclades + Glance) |
| 62 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
| 64 |
---------------------------------
|
|
| 63 | 65 |
|
| 64 | 66 |
.. code-block:: text |
| 65 | 67 |
|
| ... | ... | |
| 80 | 82 |
shared : List shared images |
| 81 | 83 |
|
| 82 | 84 |
Showcase: Pick an image and list the properties |
| 85 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 83 | 86 |
|
| 84 | 87 |
.. code-block:: console |
| 85 | 88 |
:emphasize-lines: 1,4,18 |
| ... | ... | |
| 113 | 116 |
users : root |
| 114 | 117 |
|
| 115 | 118 |
server (Compute/Cyclades) |
| 116 |
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
| 119 |
-------------------------
|
|
| 117 | 120 |
|
| 118 | 121 |
.. code-block:: text |
| 119 | 122 |
|
| ... | ... | |
| 135 | 138 |
stats : Get server statistics |
| 136 | 139 |
wait : Wait for server to finish |
| 137 | 140 |
|
| 138 |
Showcase: Create a server. |
|
| 141 |
Showcase: Create a server |
|
| 142 |
^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 139 | 143 |
|
| 140 | 144 |
.. code-block:: console |
| 141 | 145 |
:emphasize-lines: 1,4,21,35,44,62 |
| ... | ... | |
| 209 | 213 |
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts |
| 210 | 214 |
|
| 211 | 215 |
network (Compute/Cyclades) |
| 212 |
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
| 216 |
--------------------------
|
|
| 213 | 217 |
|
| 214 | 218 |
.. code-block:: text |
| 215 | 219 |
|
| ... | ... | |
| 222 | 226 |
rename : Update network name |
| 223 | 227 |
|
| 224 | 228 |
Showcase: Connect a network to a VM |
| 229 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 225 | 230 |
|
| 226 | 231 |
.. code-block:: console |
| 227 | 232 |
:emphasize-lines: 1,4,9,24,27,44 |
| ... | ... | |
| 286 | 291 |
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts |
| 287 | 292 |
|
| 288 | 293 |
store (Storage/Pithos+) |
| 289 |
^^^^^^^^^^^^^^^^^^^^^^^
|
|
| 294 |
-----------------------
|
|
| 290 | 295 |
|
| 291 | 296 |
.. code-block:: text |
| 292 | 297 |
|
| ... | ... | |
| 324 | 329 |
versioning : Get versioning for account [or container ] |
| 325 | 330 |
versions : Get the version list of an object |
| 326 | 331 |
|
| 327 |
Showcase: Upload and download a file. |
|
| 332 |
Showcase: Upload and download a file |
|
| 333 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
| 328 | 334 |
|
| 329 | 335 |
.. code-block:: console |
| 330 | 336 |
:emphasize-lines: 1,7,11,16,21,29,33,37,41,44,51,55,60,64 |
| ... | ... | |
| 399 | 405 |
[store]:!diff rndm_local.file rndm_remote.file |
| 400 | 406 |
|
| 401 | 407 |
.. Note:: In kamaki shell, ! is used to execute OS shell commands (bash in the above) |
| 402 |
|
|
| 403 |
|
|
| 404 |
Command specifications |
|
| 405 |
---------------------- |
|
| 406 |
|
|
| 407 |
cyclades_cli |
|
| 408 |
^^^^^^^^^^^^ |
|
| 409 |
|
|
| 410 |
.. automodule:: kamaki.cli.commands.cyclades_cli |
|
| 411 |
:members: |
|
| 412 |
:undoc-members: |
|
| 413 |
|
|
| 414 |
|
|
| 415 |
pithos_cli |
|
| 416 |
^^^^^^^^^^ |
|
| 417 |
|
|
| 418 |
.. automodule:: kamaki.cli.commands.pithos_cli |
|
| 419 |
:members: |
|
| 420 |
:show-inheritance: |
|
| 421 |
:undoc-members: |
|
| 422 |
|
|
| 423 |
image_cli |
|
| 424 |
^^^^^^^^^ |
|
| 425 |
|
|
| 426 |
.. automodule:: kamaki.cli.commands.image_cli |
|
| 427 |
:members: |
|
| 428 |
:show-inheritance: |
|
| 429 |
:undoc-members: |
|
| 430 |
|
|
| 431 |
|
|
| 432 |
astakos_cli |
|
| 433 |
^^^^^^^^^^^ |
|
| 434 |
|
|
| 435 |
.. automodule:: kamaki.cli.commands.astakos_cli |
|
| 436 |
:members: |
|
| 437 |
:undoc-members: |
|
| 438 |
|
|
| 439 |
config_cli |
|
| 440 |
^^^^^^^^^^ |
|
| 441 |
|
|
| 442 |
.. automodule:: kamaki.cli.commands.config_cli |
|
| 443 |
:members: |
|
| 444 |
:undoc-members: |
|
| 445 |
|
|
| 446 |
history_cli |
|
| 447 |
^^^^^^^^^^^ |
|
| 448 |
|
|
| 449 |
.. automodule:: kamaki.cli.commands.history_cli |
|
| 450 |
:members: |
|
| 451 |
:undoc-members: |
|
Also available in: Unified diff