.. meta::
    :description: This documentation will guide you through the use of the Memset API.

.. index::
   double: Methods; openstack

.. _openstack:

Openstack Methods
-----------------

API for Cloud IaaS (powered by OpenStack) services.

These methods complement the standard `OpenStack APIs <https://developer.openstack.org/>`_ .

.. function:: openstack.list_projects

    List live Cloud IaaS (powered by OpenStack) projects.
    
    
    :returns: A dictionary of dictionaries keyed by project name with values
              with the following keys:
    
        **project_id**
            String: The unique id of the project.
    
        **auth_url**
            String: The URL of the identity endpoint (Keystone)
    
        **firewall_type**
            String: The type of firewalling for this project
    
        **firewall_rule_group**
            Dictionary: A dictionary as described in :func:`firewalling.rule_group_info`
            if applicable.

.. function:: openstack.sync_users

    Synchronise user changes in relevant OpenStack projects.
    
    Running this will ensure that the current state of your account
    OpenStack users is synced with relevant OpenStack projects in our
    cloud.
    
    You may poll the job returned to discover when this has been done.
    We don't guarantee any particular timescale for this, but normally
    it will only take a few seconds.
    
    
    :returns: A dictionary as described in :func:`job.status`.