Documentation

rax_cdb_user - create / delete a Rackspace Cloud Database

New in version 1.8.

Synopsis

create / delete a database in the Cloud Databases.

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
api_key
 no
    Rackspace API key (overrides credentials)

    aliases: password
    cdb_id
    		 no
      The databases server UUID
      credentials
      		 no
        File to find the Rackspace credentials in (ignored if api_key and username are provided)

        aliases: creds_file
        databases
        		 no
          Name of the databases that the user can access
          db_password
          		 no
            Database user password
            db_username
            		 no
              Name of the database user
              env
              (added in 1.5)
              		 no
                host
                		 no %
                  Specifies the host from which a user is allowed to connect to the database. Possible values are a string containing an IPv4 address or "%" to allow connecting from any host
                  region
                  		 no DFW
                    Region to create an instance in
                    state
                    		 no present
                    • present
                    • absent
                    Indicate desired state of the resource
                    username
                    		 no
                      Rackspace username (overrides credentials)
                      verify_ssl
                      (added in 1.5)
                      		 no
                        Whether or not to require SSL validation of API endpoints

                        Examples

                        - name: Build a user in Cloud Databases
  tasks:
    - name: User build request
      local_action:
        module: rax_cdb_user
        credentials: ~/.raxpub
        region: IAD
        cdb_id: 323e7ce0-9cb0-11e3-a5e2-0800200c9a66
        db_username: user1
        db_password: user1
        databases: ['db1']
        state: present
      register: rax_db_user

                        Notes

                        Note

                        The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

                        Note

                        RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating

                        Note

                        RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

                        Note

                        RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)

                        This is a Core Module

                        For more information on what this means please read Core Modules

                        For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.