community.general.webfaction_db module – Add or remove a database on Webfaction
Note
This module is part of the community.general collection (version 5.8.3).
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
Add or remove a database on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.
Parameters
Parameter |
Comments |
---|---|
The webfaction account to use |
|
The webfaction password to use |
|
The machine name to use (optional for accounts with only one machine) |
|
The name of the database |
|
The password for the new database user. |
|
Whether the database should exist Choices:
|
|
The type of database to create. Choices:
|
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 <https://docs.webfaction.com/xmlrpc-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.
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication