community.general.webfaction_domain – Add or remove domains and subdomains on Webfaction
Note
This plugin is part of the community.general collection (version 3.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_domain
.
Synopsis
Add or remove domains or subdomains 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 name of the domain |
|
Whether the domain should exist Choices:
|
|
Any subdomains to create. Default: [] |
Notes
Note
If you are deleting domains by using
state=absent
, then note that if you specify subdomains, just those particular subdomains will be deleted. If you don’t specify subdomains, the domain will be deleted.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
- name: Create a test domain
community.general.webfaction_domain:
name: mydomain.com
state: present
subdomains:
- www
- blog
login_name: "{{webfaction_user}}"
login_password: "{{webfaction_passwd}}"
- name: Delete test domain and any subdomains
community.general.webfaction_domain:
name: mydomain.com
state: absent
login_name: "{{webfaction_user}}"
login_password: "{{webfaction_passwd}}"
Authors
Quentin Stafford-Fraser (@quentinsf)