-Commands
-========
-
List of commands
-----------------
+================
+
+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.
-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:
astakos (Identity Manager)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------
.. code-block:: text
authenticate: Authenticate a user
-Showcase: get user information, provided the token was set
+Showcase: get user information
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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>`_)
.. code-block:: console
:emphasize-lines: 1,4
username : 4215th3b357num9323v32
flavor (Compute/Cyclades)
-^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------
.. code-block:: text
list: List flavors
Showcase: show details for flavor with id 43
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console
:emphasize-lines: 1,4
name : C4R2048D10
ram : 2048
-image (Compute/Cyclades + Glance)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+image (Compute/Cyclades + Plankton)
+-----------------------------------
.. code-block:: text
shared : List shared images
Showcase: Pick an image and list the properties
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console
:emphasize-lines: 1,4,18
* list all available images *
[image]:list
- 1395fdfb-51b4-419f-bb02-f7d632860611 (Ubuntu Desktop LTS)
- 1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)
- 18a82962-43eb-4b32-8e28-8f8880af89d7 (Kubuntu LTS)
- 6aa6eafd-dccb-422d-a904-67fe2bdde87e (Debian Desktop)
- 6b5681e4-7502-46ae-b1e9-9fd837932095 (maelstrom)
- 78262ee7-949e-4d70-af3a-85360c3de57a (Windows Server 2012)
- 86bc2414-0fb3-4898-a637-240292243302 (Fedora)
- 926ab1c5-2d85-49d4-aebe-0fce712789b9 (Windows Server 2008)
- b2dffe52-64a4-48c3-8a4c-8214cc3165cf (Debian Base)
- baf2321c-57a0-4a69-825d-49f49cea163a (CentOS)
- c1d27b46-d875-4f5c-b7f1-f39b5af62905 (Kubuntu)
+ 1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
+ 1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
+ 18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
+ 6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
+ 6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
+ 78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
+ 86bc2414-0fb3-4898-a637-240292243302 Fedora
+ 926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
+ b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
+ baf2321c-57a0-4a69-825d-49f49cea163a CentOS
+ c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
* Get properties of image with id b2dffe52-64a4-48c3-8a4c-8214cc3165cf *
[image]:properties b2dffe52-64a4-48c3-8a4c-8214cc3165cf
users : root
server (Compute/Cyclades)
-^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------
.. code-block:: text
stats : Get server statistics
wait : Wait for server to finish
-Showcase: Create a server.
+Showcase: Create a server
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console
:emphasize-lines: 1,4,21,35,44,62
* List all available images *
[server]:/image list
- 1395fdfb-51b4-419f-bb02-f7d632860611 (Ubuntu Desktop LTS)
- 1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)
- 18a82962-43eb-4b32-8e28-8f8880af89d7 (Kubuntu LTS)
- 6aa6eafd-dccb-422d-a904-67fe2bdde87e (Debian Desktop)
- 6b5681e4-7502-46ae-b1e9-9fd837932095 (maelstrom)
- 78262ee7-949e-4d70-af3a-85360c3de57a (Windows Server 2012)
- 86bc2414-0fb3-4898-a637-240292243302 (Fedora)
- 926ab1c5-2d85-49d4-aebe-0fce712789b9 (Windows Server 2008)
- b2dffe52-64a4-48c3-8a4c-8214cc3165cf (Debian Base)
- baf2321c-57a0-4a69-825d-49f49cea163a (CentOS)
- c1d27b46-d875-4f5c-b7f1-f39b5af62905 (Kubuntu)
+ 1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
+ 1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
+ 18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
+ 6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
+ 6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
+ 78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
+ 86bc2414-0fb3-4898-a637-240292243302 Fedora
+ 926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
+ b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
+ baf2321c-57a0-4a69-825d-49f49cea163a CentOS
+ c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
* See details of flavor with id 1 *
[server]:/flavor info 1
* wait for server to build (optional) *
[server]:wait 11687
- Server 11687 still in BUILD mode ||||||||||||||||| | 80% - 3s
+ Server 11687 still in BUILD mode ||||||||||||||||| | 80%
Server 11687 is now in ACTIVE mode
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
network (Compute/Cyclades)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------
.. code-block:: text
rename : Update network name
Showcase: Connect a network to a VM
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console
:emphasize-lines: 1,4,9,24,27,44
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
store (Storage/Pithos+)
-^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------
.. code-block:: text
append : Append local file to remote
cat : Print a file to console
copy : Copy an object
- create : Create a container or a directory object
+ create : Create a container
delete : Delete a container [or an object]
delgroup : Delete a user group on an account
delmeta : Delete an existing metadatum of account [, container [or object]]
setquota : Set new quota (in KB) for account [or container]
setversioning : Set new versioning (auto, none) for account [or container]
sharers : List the accounts that share objects with default account
+ touch : Create an empty object (file)
truncate : Truncate remote file up to a size
unpublish : Unpublish an object
upload : Upload a file
versioning : Get versioning for account [or container ]
versions : Get the version list of an object
-Showcase: Upload and download a file.
+Showcase: Upload and download a file
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console
:emphasize-lines: 1,7,11,16,21,29,33,37,41,44,51,55,60,64
.. Note:: In kamaki shell, ! is used to execute OS shell commands (bash in the above)
+.. warning:: The container:object/path syntax does not function if the container and / or the object path contain one or more : characters. To use containers and objects with : use the --container and --dst-container arguments, e.g. to copy test.py object from grnet:dev container to grnet:deploy ::
-Command specifications
-----------------------
-
-cyclades_cli
-^^^^^^^^^^^^
-
-.. automodule:: kamaki.cli.commands.cyclades_cli
- :members:
- :undoc-members:
-
-
-pithos_cli
-^^^^^^^^^^
-
-.. automodule:: kamaki.cli.commands.pithos_cli
- :members:
- :show-inheritance:
- :undoc-members:
-
-image_cli
-^^^^^^^^^
-
-.. automodule:: kamaki.cli.commands.image_cli
- :members:
- :show-inheritance:
- :undoc-members:
-
-
-astakos_cli
-^^^^^^^^^^^
-
-.. automodule:: kamaki.cli.commands.astakos_cli
- :members:
- :undoc-members:
-
-config_cli
-^^^^^^^^^^
-
-.. automodule:: kamaki.cli.commands.config_cli
- :members:
- :undoc-members:
-
-history_cli
-^^^^^^^^^^^
-
-.. automodule:: kamaki.cli.commands.history_cli
- :members:
- :undoc-members:
+ $ kamaki store copy --container=grnet:dev test.py --dst-container=grnet:deploy
projects / kamaki / blobdiff