Documentation

webfaction_domain - Add or remove domains and subdomains on Webfaction

New in version 2.0.

Synopsis

Add or remove domains or subdomains on a Webfaction host. Further documentation at http://github.com/quentinsf/ansible-webfaction.

Options

parameter required default choices comments
login_name
 yes
    The webfaction account to use
    login_password
    		 yes
      The webfaction password to use
      name
      		 yes
        The name of the domain
        state
        		 no present
        • present
        • absent
        Whether the domain should exist
        subdomains
        		 no
          Any subdomains to create.

          Examples

          - name: Create a test domain
  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
  webfaction_domain:
    name: mydomain.com
    state: absent
    login_name: "{{webfaction_user}}"
    login_password: "{{webfaction_passwd}}"

          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.

          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.

          Note

          See the webfaction API for more info.

          This is an Extras Module

          For more information on what this means please read Extras Modules

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