On this page
community.general.webfaction_app – Add or remove applications on a Webfaction host
Note
This plugin is part of the community.general collection (version 3.8.1).
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_app.
Synopsis
- Add or remove applications on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| autostart
        
        boolean
         | 
      
       
  | 
      
        
        Whether the app should restart with an  autostart.cgi script
        | 
     
| extra_info
        
        string
         | 
      Default: 
        ""
         | 
      
        
        Any extra parameters required by the app
         | 
     
| login_name
        
        string / required
         | 
      
        
        The webfaction account to use
         | 
     |
| login_password
        
        string / required
         | 
      
        
        The webfaction password to use
         | 
     |
| machine
        
        string
         | 
      
        
        The machine name to use (optional for accounts with only one machine)
         | 
     |
| name
        
        string / required
         | 
      
        
        The name of the application
         | 
     |
| port_open
        
        boolean
         | 
      
       
  | 
      
        
        IF the port should be opened
         | 
     
| state
        
        string
         | 
      
       
  | 
      
        
        Whether the application should exist
         | 
     
| type
        
        string / required
         | 
      
        
        The type of application to create. See the Webfaction docs at https://docs.webfaction.com/xmlrpc-api/apps.html for a list.
         | 
     
Notes
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: 1to the plays. - See the webfaction API for more info.
 
Examples
- name: Create a test app
  community.general.webfaction_app:
    name: "my_wsgi_app1"
    state: present
    type: mod_wsgi35-python27
    login_name: "{{webfaction_user}}"
    login_password: "{{webfaction_passwd}}"
    machine: "{{webfaction_machine}}"
  Authors
- Quentin Stafford-Fraser (@quentinsf)
 
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/latest/collections/community/general/webfaction_app_module.html