Documentation

webfaction_site - Add or remove a website on a Webfaction host

New in version 2.0.

Synopsis

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

Options

parameter required default choices comments
host
 yes
    The webfaction host on which the site should be created.
    https
    		 no false
    • True
    • False
    Whether or not to use HTTPS
    login_name
    		 yes
      The webfaction account to use
      login_password
      		 yes
        The webfaction password to use
        name
        		 yes
          The name of the website
          site_apps
          		 no
            A mapping of URLs to apps
            state
            		 no present
            • present
            • absent
            Whether the website should exist
            subdomains
            		 no
              A list of subdomains associated with this site.

              Examples

              - name: create website
  webfaction_site:
    name: testsite1
    state: present
    host: myhost.webfaction.com
    subdomains:
      - 'testsite1.my_domain.org'
    site_apps:
      - ['testapp1', '/']
    https: no
    login_name: "{{webfaction_user}}"
    login_password: "{{webfaction_passwd}}"

              Notes

              Note

              Sadly, you do need to know your webfaction hostname for the host parameter. But at least, unlike the API, you don’t need to know the IP address - you can use a DNS name.

              Note

              If a site of the same name exists in the account but on a different host, the operation will exit.

              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.