W3cubDocs

/Ansible 2.10

community.general.webfaction_domain – Add or remove domains and subdomains on Webfaction

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.webfaction_domain.

Synopsis

Parameters

Parameter Choices/Defaults Comments
login_name
string / required
The webfaction account to use
login_password
string / required
The webfaction password to use
name
string / required
The name of the domain
state
string
    Choices:
  • present ←
  • absent
Whether the domain should exist
subdomains
string
Default:
[]
Any subdomains to create.

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)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/webfaction_domain_module.html