On this page
rax_cdb_database - create / delete a database in the Cloud Databases
New in version 1.8.
Synopsis
- create / delete a database in the Cloud Databases.
 
Requirements
The below requirements are needed on the host that executes this module.
- pyrax
 - python >= 2.6
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| api_key | 
        
        Rackspace API key, overrides credentials.
        
       aliases: password  | 
     |
| auth_endpoint  
        (added in 1.5)
         | 
      Default: 
        "https://identity.api.rackspacecloud.com/v2.0/"
         | 
      
        
        The URI of the authentication service.
         | 
     
| cdb_id | 
        
        The databases server UUID
         | 
     |
| character_set | Default: 
        "utf8"
         | 
      
        
        Set of symbols and encodings
         | 
     
| collate | Default: 
        "utf8_general_ci"
         | 
      
        
        Set of rules for comparing characters in a character set
         | 
     
| credentials | 
        
        File to find the Rackspace credentials in. Ignored if api_key and username are provided.
        
       aliases: creds_file  | 
     |
| env  
        (added in 1.5)
         | 
      
        
        Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
         | 
     |
| identity_type  
        (added in 1.5)
         | 
      Default: 
        "rackspace"
         | 
      
        
        Authentication mechanism to use, such as rackspace or keystone.
         | 
     
| name | 
        
        Name to give to the database
         | 
     |
| region | Default: 
        "DFW"
         | 
      
        
        Region to create an instance in.
         | 
     
| state | 
       
  | 
      
        
        Indicate desired state of the resource
         | 
     
| tenant_id  
        (added in 1.5)
         | 
      
        
        The tenant ID used for authentication.
         | 
     |
| tenant_name  
        (added in 1.5)
         | 
      
        
        The tenant name used for authentication.
         | 
     |
| username | 
        
        Rackspace username, overrides credentials.
         | 
     |
| verify_ssl  
        (added in 1.5)
         | 
      
        
        Whether or not to require SSL validation of API endpoints.
         | 
     
Notes
Note
- The following environment variables can be used, 
RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION. RAX_CREDENTIALSandRAX_CREDS_FILEpoints to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAMEandRAX_API_KEYobviate the use of a credentials fileRAX_REGIONdefines a Rackspace Public Cloud region (DFW, ORD, LON, …)- The following environment variables can be used, 
RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION. RAX_CREDENTIALSandRAX_CREDS_FILEpoints to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAMEandRAX_API_KEYobviate the use of a credentials fileRAX_REGIONdefines a Rackspace Public Cloud region (DFW, ORD, LON, …)
Examples
- name: Build a database in Cloud Databases
  tasks:
    - name: Database build request
      local_action:
        module: rax_cdb_database
        credentials: ~/.raxpub
        region: IAD
        cdb_id: 323e7ce0-9cb0-11e3-a5e2-0800200c9a66
        name: db1
        state: present
      register: rax_db_database
  Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Simon JAILLET (@jails)
 
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/2.6/modules/rax_cdb_database_module.html