webfaction_site – Add or remove a website on a Webfaction host

From Get docs
Ansible/docs/2.7/modules/webfaction site module


webfaction_site – Add or remove a website on a Webfaction host

New in version 2.0.


Synopsis

Parameters

Parameter Choices/Defaults Comments

host

- / required

The webfaction host on which the site should be created.

https

boolean

  • no

  • yes

Whether or not to use HTTPS

login_name

- / required

The webfaction account to use

login_password

- / required

The webfaction password to use

name

- / required

The name of the website

site_apps

-

Default:

[]

A mapping of URLs to apps

state

-

  • present

  • absent

Whether the website should exist

subdomains

-

Default:

[]

A list of subdomains associated with this site.



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.
  • If a site of the same name exists in the account but on a different host, the operation will exit.
  • 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 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}}"

Status

Authors

  • Quentin Stafford-Fraser (@quentinsf)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/webfaction_site_module.html