W3cubDocs

/Ansible

community.general.webfaction_db – Add or remove a database on Webfaction

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.webfaction_db.

Synopsis

Parameters

Parameter Choices/Defaults Comments
login_name
string / required
The webfaction account to use
login_password
string / required
The webfaction password to use
machine
string
The machine name to use (optional for accounts with only one machine)
name
string / required
The name of the database
password
string
The password for the new database user.
state
string
    Choices:
  • present ←
  • absent
Whether the database should exist
type
string / required
    Choices:
  • mysql
  • postgresql
The type of database to create.

Notes

Note

  • You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API. The location is not important. However, running them on multiple hosts simultaneously is best avoided. If you don’t specify localhost as your host, you may want to add serial: 1 to the plays.
  • See the webfaction API for more info.

Examples

# This will also create a default DB user with the same
# name as the database, and the specified password.

- name: Create a database
  community.general.webfaction_db:
    name: "{{webfaction_user}}_db1"
    password: mytestsql
    type: mysql
    login_name: "{{webfaction_user}}"
    login_password: "{{webfaction_passwd}}"
    machine: "{{webfaction_machine}}"

# Note that, for symmetry's sake, deleting a database using
# 'state: absent' will also delete the matching user.

Authors

  • Quentin Stafford-Fraser (@quentinsf)

© 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/webfaction_db_module.html