Documentation

webfaction_db - Add or remove a database on Webfaction

New in version 2.0.

Synopsis

Options

parameter required default choices comments
login_name
yes
The webfaction account to use
login_password
yes
The webfaction password to use
machine
no
The machine name to use (optional for accounts with only one machine)
name
yes
The name of the database
password
no None
The password for the new database user.
state
no present
  • present
  • absent
Whether the database should exist
type
yes
  • mysql
  • postgresql
The type of database to create.

Examples

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

- name: Create a database
  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.

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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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