149 lines
4.4 KiB
Python
149 lines
4.4 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# Create webfaction mailbox using Ansible and the Webfaction API
|
|
#
|
|
# ------------------------------------------
|
|
# (c) Quentin Stafford-Fraser and Andy Baker 2015
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: webfaction_mailbox
|
|
short_description: Add or remove mailboxes on Webfaction
|
|
description:
|
|
- Add or remove mailboxes on a Webfaction account. Further documentation at http://github.com/quentinsf/ansible-webfaction.
|
|
author: Quentin Stafford-Fraser (@quentinsf)
|
|
version_added: "2.0"
|
|
notes:
|
|
- >
|
|
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 I(simultaneously) is best avoided. If you don't specify I(localhost) as
|
|
your host, you may want to add C(serial: 1) to the plays.
|
|
- See `the webfaction API <http://docs.webfaction.com/xmlrpc-api/>`_ for more info.
|
|
options:
|
|
|
|
mailbox_name:
|
|
description:
|
|
- The name of the mailbox
|
|
required: true
|
|
|
|
mailbox_password:
|
|
description:
|
|
- The password for the mailbox
|
|
required: true
|
|
default: null
|
|
|
|
state:
|
|
description:
|
|
- Whether the mailbox should exist
|
|
required: false
|
|
choices: ['present', 'absent']
|
|
default: "present"
|
|
|
|
login_name:
|
|
description:
|
|
- The webfaction account to use
|
|
required: true
|
|
|
|
login_password:
|
|
description:
|
|
- The webfaction password to use
|
|
required: true
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Create a mailbox
|
|
webfaction_mailbox:
|
|
mailbox_name="mybox"
|
|
mailbox_password="myboxpw"
|
|
state=present
|
|
login_name={{webfaction_user}}
|
|
login_password={{webfaction_passwd}}
|
|
'''
|
|
|
|
import socket
|
|
import xmlrpclib
|
|
|
|
webfaction = xmlrpclib.ServerProxy('https://api.webfaction.com/')
|
|
|
|
def main():
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
mailbox_name=dict(required=True),
|
|
mailbox_password=dict(required=True, no_log=True),
|
|
state=dict(required=False, choices=['present', 'absent'], default='present'),
|
|
login_name=dict(required=True),
|
|
login_password=dict(required=True, no_log=True),
|
|
),
|
|
supports_check_mode=True
|
|
)
|
|
|
|
mailbox_name = module.params['mailbox_name']
|
|
site_state = module.params['state']
|
|
|
|
session_id, account = webfaction.login(
|
|
module.params['login_name'],
|
|
module.params['login_password']
|
|
)
|
|
|
|
mailbox_list = [x['mailbox'] for x in webfaction.list_mailboxes(session_id)]
|
|
existing_mailbox = mailbox_name in mailbox_list
|
|
|
|
result = {}
|
|
|
|
# Here's where the real stuff happens
|
|
|
|
if site_state == 'present':
|
|
|
|
# Does a mailbox with this name already exist?
|
|
if existing_mailbox:
|
|
module.exit_json(changed=False,)
|
|
|
|
positional_args = [session_id, mailbox_name]
|
|
|
|
if not module.check_mode:
|
|
# If this isn't a dry run, create the mailbox
|
|
result.update(webfaction.create_mailbox(*positional_args))
|
|
|
|
elif site_state == 'absent':
|
|
|
|
# If the mailbox is already not there, nothing changed.
|
|
if not existing_mailbox:
|
|
module.exit_json(changed=False)
|
|
|
|
if not module.check_mode:
|
|
# If this isn't a dry run, delete the mailbox
|
|
result.update(webfaction.delete_mailbox(session_id, mailbox_name))
|
|
|
|
else:
|
|
module.fail_json(msg="Unknown state specified: {}".format(site_state))
|
|
|
|
module.exit_json(changed=True, result=result)
|
|
|
|
|
|
from ansible.module_utils.basic import *
|
|
|
|
if __name__ == '__main__':
|
|
main()
|