Synnefo » ./kamaki

Ubuntu and Debian packages

^^^^^^^^^^^^^^^^^^^^^^^^^^

------

Windows

Options

-------

Commands

History

-------

From the early start, we needed a simple command-line tool to test the OpenStack API. That's why we developed *kamaki*, which proved to be powerful and intuitive enough, to be used not only for testing purposes but also as a complete Openstack Compute API v1.1 client, able to manage our cloud from the command line.

    $ kamaki store list mycontainer

Example 2.3.2 showcases a command without parameters (the group is "server", the command is "list").

    $ kamaki server info 42

Client commands can feature an arbitarry number of terms:

    kamaki <group> <command> [arguments]

astakos (Identity Manager)

""""""""""""""""""""""""""

Showcase: get user information, provided the token was set

.. code-block:: console

    [kamaki]:astakos

    [astakos]:authenticate

Showcase: show details for flavor with id 43

.. code-block:: console

    [kamaki]: flavor

    [flavor]: info 43

Showcase: show a list of public images, list the properties of Debian Base

.. code-block:: console

    [kamaki]:image

    [image]:list

Showcase: Create a server: Show create help, find a flavor and an image make a server. Wait for server to be build, get server details. Note that the progress bar feature is optional (see )

.. code-block:: console

    [kamaki]:server

    [server]:create -h

      --config CONFIG       Path to configuration file

      -s, --silent          Do not output anything

    [server]:/image list

    1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)

    [server]:/flavor info 1

    SNF:disk_template:  drbd

    cpu              :  1

        read_permition=False,

        write_permition=False):

        """Give read/write permisions to an object.

        """

        perms = dict(read='' if not read_permition else read_permition,

            write='' if not write_permition else write_permition)

        r = self.object_post(object, update=True, permissions=perms)

            to caller application, e.g. a progress bar. Its next is called

            whenever a block is uploaded

        """

        self.assert_container()

        meta = self.get_container_info()

        blocksize = int(meta['x-container-block-size'])

        source_file,

        upload_cb=None):

        """Overwrite a part of an object with given source file

           @end the part of the remote object to stop overwriting to, in bytes

        """

        self.assert_container()

        meta = self.get_container_info()

        blocksize = int(meta['x-container-block-size'])

        @param until (string): optional timestamp

        --- --- optional request headers ---

        @param if_modified_since (string): Retrieve if account has changed

        @param if_unmodified_since (string): Retrieve if account has not

        """

        self.assert_account()

        path = path4url(self.account)

        """  Full Pithos+ GET at account level

        --- request parameters ---

        @param limit (integer): The amount of results requested

        @param marker (string): Return containers with name

        @param format (string): reply format can be json or xml

        @param shared (bool): If true, only shared containers will be

        @param until (string): optional timestamp

        --- --- optional request headers ---

        @param if_modified_since (string): Retrieve if account has changed

        @param if_unmodified_since (string): Retrieve if account has not

        """

        self.assert_account()

        self.set_param('format', format, iff=format is not None)

        @param update (bool): if True, Do not replace metadata/groups

        --- request headers ---

        @groups (dict): Optional user defined groups in the form

        @metadata (dict): Optional user defined metadata in the form

        @param quota(integer): If supported, sets the Account quota

        @param versioning(string): If supported, sets the Account versioning

        """

        self.assert_account()

        self.set_param('update', iff=update)

        @param until (string): optional timestamp

        --- optional request headers ---

        @param if_modified_since (string): Retrieve if account has changed

        @param if_unmodified_since (string): Retrieve if account has not

        """

        self.assert_container()

        self.set_param('until', until, iff=until is not None)

        """ Full Pithos+ GET at container level

        --- request parameters ---

        @param limit (integer): The amount of results requested

        @param marker (string): Return containers with name lexicographically

        @param prefix (string): Return objects starting with prefix

        @param delimiter (string): Return objects up to the delimiter

        @param path (string): assume prefix = path and delimiter = /

        @param format (string): reply format can be json or xml (default:json)

        @param meta (list): Return objects that satisfy the key queries in

        @param shared (bool): If true, only shared containers will be included

        in results

        @param until (string): optional timestamp

        --- --- optional request headers ---

        @param if_modified_since (string): Retrieve if account has changed

        @param if_unmodified_since (string): Retrieve if account has not

        """

        self.assert_container()

        self.set_param('format', format, iff=format is not None)

        """ Full Pithos+ DELETE at container level

        --- request parameters ---

        @param until (timestamp string): if defined, container is purged up to

        """

        self.assert_container()

        self.set_param('until', until, iff=until is not None)

        @param version (string): optional version identified

        --- request headers ---

        @param if_etag_match (string): if provided, return only results

        @param if_etag_not_match (string): if provided, return only results

        @param if_modified_since (string): Retrieve if account has changed

        @param if_unmodified_since (string): Retrieve if account has not

        """

        self.assert_container()

        self.set_param('version', version, iff=version is not None)

        @param data_range (string): Optional range of data to retrieve

        @param if_range (bool):

        @param if_etag_match (string): if provided, return only results

        @param if_etag_not_match (string): if provided, return only results

        @param if_modified_since (string): Retrieve if account has changed

        @param if_unmodified_since (string): Retrieve if account has not

        """

        self.assert_container()

        self.set_param('format', format, iff=format is not None)

        @param hashmap (bool): Optional hashmap provided instead of data

        --- request headers ---

        @param if_etag_match (string): if provided, return only results

        @param if_etag_not_match (string): if provided, return only results

        @param etag (string): The MD5 hash of the object (optional to check

        @param content_length (integer): The size of the data written

        @param content_type (string): The MIME content type of the object

        @param transfer_encoding (string): Set to chunked to specify

        @param copy_from (string): The source path in the form

        @param move_from (string): The source path in the form

        @param source_account (string): The source account to copy/move from

        @param source_version (string): The source version to copy from

        @param conent_encoding (string): The encoding of the object

        @param content_disposition (string): Presentation style of the object

        @param manifest (string): Object parts prefix in

        @param permissions (dict): Object permissions in the form (all fields

        @param public (bool): If true, Object is publicly accessible,

        @param metadata (dict): Optional user defined metadata in the form

        """

        self.assert_container()

        self.set_param('format', format, iff=format is not None)

        @param format (string): json (default) or xml

        @param ignore_content_type (bool): Ignore the supplied Content-Type

        --- request headers ---

        @param if_etag_not_match (string): if provided, copy only results

        @param destination (string): The destination path in the form

        @param destination_account (string): The destination account to copy to

        @param content_type (string): The MIME content type of the object

        @param content_encoding (string): The encoding of the object

        @param content_disposition (string): Object resentation style

        @param source_version (string): The source version to copy from

        @param permissions (dict): Object permissions in the form

        @param public (bool): If true, Object is publicly accessible

        @param metadata (dict): Optional user defined metadata in the form

        """

        self.assert_container()

        self.set_param('format', format, iff=format is not None)

        @param format (string): json (default) or xml

        @param ignore_content_type (bool): Ignore the supplied Content-Type

        --- request headers ---

        @param if_etag_not_match (string): if provided, return only results

        @param destination (string): The destination path in the form

        @param destination_account (string): The destination account to copy to

        @param content_type (string): The MIME content type of the object

        @param content_encoding (string): The encoding of the object

        @param content_disposition (string): Object presentation style

        @param source_version (string): The source version to copy from

        @param permissions (dict): Object permissions in the form

        @param public (bool): If true, Object is publicly accessible

        @param metadata (dict): Optional user defined metadata in the form

        """

        self.assert_container()

        self.set_param('format', format, iff=format is not None)

        @param update (bool): Do not replace metadata

        --- request headers ---

        @param if_etag_match (string): if provided, return only results

        @param if_etag_not_match (string): if provided, return only results

        @param content_length (string): The size of the data written

        @param content_type (string): The MIME content type of the object

        @param content_range (string): The range of data supplied

        @param transfer_encoding (string): Set to chunked to specify

        @param content_encoding (string): The encoding of the object

        @param content_disposition (string): Object presentation style

        @param source_object (string): Update with data from the object at

        @param source_account (string): The source account to update from

        @param source_version (string): The source version to copy from

        @param object_bytes (integer): The updated objects final size

        @param manifest (string): Object parts prefix as /<container>/<object>

        @param permissions (dict): Object permissions in the form (all fields

        @param public (bool): If true, Object is publicly accessible

        @param metadata (dict): Optional user defined metadata in the form

        """

        self.assert_container()

        self.set_param('format', format, iff=format is not None)

def matches(val1, val2, exactMath=True):

    """Case Insenstive match"""

    if exactMath:

        return True if val1.lower() == val2.lower() else False

    else:

    """@return a dict that contains the entries of d

        that are NOT prefixed with prefic

    """

    ret = {}

    for key, val in d.items():

        if not matches(key, prefix, exactMath=exactMatch):

    """@return a dict that contains only the entries of d

        that are prefixed with prefix

    """

    ret = {}

    for key, val in d.items():

        if matches(key, prefix, exactMath=exactMatch):

def prefix_keys(d, prefix):

    """@return a sallow copy of d with all its keys prefixed with prefix

    """

    ret = {}

    for key, val in d.items():

        ret[prefix + key] = val

    """@return a string with all args in the form /arg1/arg2/...

       @param args must be strings

    """

    path = ''

    for arg in args:

        suffix = unicode(arg)

def params4url(params):

    """@return a string with all params in the form ?key1=val1&key2=val2&...

       @param should be a dict.

    """

    assert(type(params) is dict)

    result = ''

    dlmtr = '?'

def list2str(alist, seperator=','):

    """@return a string of comma seperated elements of the list"""

    ret = ''

    slist = sorted(alist)

    for item in slist: