Docs4dev
Docs
ansible / latest / collections / community / general / rax_cdb_database_module.html

community.general.rax_cdb_database – create / delete a database in the Cloud Databases

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.rax_cdb_database.

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
string
Rackspace API key, overrides credentials.

aliases: password
auth_endpoint
string
The URI of the authentication service.
If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/
cdb_id
string / required
The databases server UUID
character_set
string
Default:
"utf8"
Set of symbols and encodings
collate
string
Default:
"utf8_general_ci"
Set of rules for comparing characters in a character set
credentials
path
File to find the Rackspace credentials in. Ignored if api_key and username are provided.

aliases: creds_file
env
string
identity_type
string
Default:
"rackspace"
Authentication mechanism to use, such as rackspace or keystone.
name
string / required
Name to give to the database
region
string
Region to create an instance in.
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the resource
tenant_id
string
The tenant ID used for authentication.
tenant_name
string
The tenant name used for authentication.
username
string
Rackspace username, overrides credentials.
validate_certs
boolean
    Choices:
  • no
  • yes
Whether or not to require SSL validation of API endpoints.

aliases: verify_ssl

Notes

Note

  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
  • 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
  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
  • RAX_REGION defines 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_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
  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
  • RAX_REGION defines 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

Authors

  • Simon JAILLET (@jails)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/rax_cdb_database_module.html