ansible.builtin.rax_cdb (v2.9.27) — module

create/delete or resize a Rackspace Cloud Databases instance

| "added in version" 1.8 of ansible.builtin"

Authors: Simon JAILLET (@jails)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be 'running'. The name option needs to be unique since it's used to identify the instance.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Build a Cloud Databases
  gather_facts: False
  tasks:
    - name: Server build request
      local_action:
        module: rax_cdb
        credentials: ~/.raxpub
        region: IAD
        name: db-server1
        flavor: 1
        volume: 2
        cdb_type: MySQL
        cdb_version: 5.6
        wait: yes
        state: present
      register: rax_db_server

Inputs

    
env:
    description:
    - Environment as configured in I(~/.pyrax.cfg), see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
    type: str

name:
    description:
    - Name of the databases server instance

wait:
    default: 'no'
    description:
    - wait for the instance to be in state 'running' before returning
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state of the resource

flavor:
    default: 1
    description:
    - flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB)

region:
    description:
    - Region to create an instance in.
    type: str

volume:
    default: 2
    description:
    - Volume size of the database 1-150GB

api_key:
    aliases:
    - password
    description:
    - Rackspace API key, overrides I(credentials).
    type: str

cdb_type:
    aliases:
    - type
    default: MySQL
    description:
    - type of instance (i.e. MySQL, MariaDB, Percona)
    version_added: '2.0'
    version_added_collection: ansible.builtin

username:
    description:
    - Rackspace username, overrides I(credentials).
    type: str

tenant_id:
    description:
    - The tenant ID used for authentication.
    type: str

cdb_version:
    aliases:
    - version
    choices:
    - '5.1'
    - '5.6'
    - '10'
    description:
    - version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports
      5.6)
    version_added: '2.0'
    version_added_collection: ansible.builtin

credentials:
    aliases:
    - creds_file
    description:
    - File to find the Rackspace credentials in. Ignored if I(api_key) and I(username)
      are provided.
    type: path

tenant_name:
    description:
    - The tenant name used for authentication.
    type: str

wait_timeout:
    default: 300
    description:
    - how long before wait gives up, in seconds

auth_endpoint:
    description:
    - The URI of the authentication service.
    - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/)
    type: str

identity_type:
    default: rackspace
    description:
    - Authentication mechanism to use, such as rackspace or keystone.
    type: str

validate_certs:
    aliases:
    - verify_ssl
    description:
    - Whether or not to require SSL validation of API endpoints.
    type: bool