#!/usr/bin/python # -*- coding: utf-8 -*- # # (c) 2015, René Moser # # 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 . DOCUMENTATION = ''' --- module: cs_staticnat short_description: Manages static NATs on Apache CloudStack based clouds. description: - Create, update and remove static NATs. version_added: '2.0' author: "René Moser (@resmo)" options: ip_address: description: - Public IP address the static NAT is assigned to. required: true vm: description: - Name of virtual machine which we make the static NAT for. - Required if C(state=present). required: false default: null vm_guest_ip: description: - VM guest NIC secondary IP address for the static NAT. required: false default: false state: description: - State of the static NAT. required: false default: 'present' choices: [ 'present', 'absent' ] domain: description: - Domain the static NAT is related to. required: false default: null account: description: - Account the static NAT is related to. required: false default: null project: description: - Name of the project the static NAT is related to. required: false default: null zone: description: - Name of the zone in which the virtual machine is in. - If not set, default zone is used. required: false default: null poll_async: description: - Poll async jobs until job has finished. required: false default: true extends_documentation_fragment: cloudstack ''' EXAMPLES = ''' # create a static NAT: 1.2.3.4 -> web01 - local_action: module: cs_staticnat ip_address: 1.2.3.4 vm: web01 # remove a static NAT - local_action: module: cs_staticnat ip_address: 1.2.3.4 state: absent ''' RETURN = ''' --- ip_address: description: Public IP address. returned: success type: string sample: 1.2.3.4 vm_name: description: Name of the virtual machine. returned: success type: string sample: web-01 vm_display_name: description: Display name of the virtual machine. returned: success type: string sample: web-01 vm_guest_ip: description: IP of the virtual machine. returned: success type: string sample: 10.101.65.152 zone: description: Name of zone the static NAT is related to. returned: success type: string sample: ch-gva-2 project: description: Name of project the static NAT is related to. returned: success type: string sample: Production account: description: Account the static NAT is related to. returned: success type: string sample: example account domain: description: Domain the static NAT is related to. returned: success type: string sample: example domain ''' try: from cs import CloudStack, CloudStackException, read_config has_lib_cs = True except ImportError: has_lib_cs = False # import cloudstack common from ansible.module_utils.cloudstack import * class AnsibleCloudStackStaticNat(AnsibleCloudStack): def __init__(self, module): AnsibleCloudStack.__init__(self, module) self.vm_default_nic = None # TODO: move it to cloudstack utils, also used in cs_portforward def get_vm_guest_ip(self): vm_guest_ip = self.module.params.get('vm_guest_ip') default_nic = self.get_vm_default_nic() if not vm_guest_ip: return default_nic['ipaddress'] for secondary_ip in default_nic['secondaryip']: if vm_guest_ip == secondary_ip['ipaddress']: return vm_guest_ip self.module.fail_json(msg="Secondary IP '%s' not assigned to VM" % vm_guest_ip) # TODO: move it to cloudstack utils, also used in cs_portforward def get_vm_default_nic(self): if self.vm_default_nic: return self.vm_default_nic nics = self.cs.listNics(virtualmachineid=self.get_vm(key='id')) if nics: for n in nics['nic']: if n['isdefault']: self.vm_default_nic = n return self.vm_default_nic self.module.fail_json(msg="No default IP address of VM '%s' found" % self.module.params.get('vm')) def create_static_nat(self, ip_address): self.result['changed'] = True args = {} args['virtualmachineid'] = self.get_vm(key='id') args['ipaddressid'] = ip_address['id'] args['vmguestip'] = self.get_vm_guest_ip() if not self.module.check_mode: res = self.cs.enableStaticNat(**args) if 'errortext' in res: self.module.fail_json(msg="Failed: '%s'" % res['errortext']) # reset ip address and query new values self.ip_address = None ip_address = self.get_ip_address() return ip_address def update_static_nat(self, ip_address): args = {} args['virtualmachineid'] = self.get_vm(key='id') args['ipaddressid'] = ip_address['id'] args['vmguestip'] = self.get_vm_guest_ip() # make an alias, so we can use _has_changed() ip_address['vmguestip'] = ip_address['vmipaddress'] if self._has_changed(args, ip_address): self.result['changed'] = True if not self.module.check_mode: res = self.cs.disableStaticNat(ipaddressid=ip_address['id']) if 'errortext' in res: self.module.fail_json(msg="Failed: '%s'" % res['errortext']) res = self._poll_job(res, 'staticnat') res = self.cs.enableStaticNat(**args) if 'errortext' in res: self.module.fail_json(msg="Failed: '%s'" % res['errortext']) # reset ip address and query new values self.ip_address = None ip_address = self.get_ip_address() return ip_address def present_static_nat(self): ip_address = self.get_ip_address() if not ip_address['isstaticnat']: ip_address = self.create_static_nat(ip_address) else: ip_address = self.update_static_nat(ip_address) return ip_address def absent_static_nat(self): ip_address = self.get_ip_address() if ip_address['isstaticnat']: self.result['changed'] = True if not self.module.check_mode: res = self.cs.disableStaticNat(ipaddressid=ip_address['id']) if 'errortext' in res: self.module.fail_json(msg="Failed: '%s'" % res['errortext']) poll_async = self.module.params.get('poll_async') if poll_async: res = self._poll_job(res, 'staticnat') return ip_address def get_result(self, ip_address): if ip_address: if 'zonename' in ip_address: self.result['zone'] = ip_address['zonename'] if 'domain' in ip_address: self.result['domain'] = ip_address['domain'] if 'account' in ip_address: self.result['account'] = ip_address['account'] if 'project' in ip_address: self.result['project'] = ip_address['project'] if 'virtualmachinedisplayname' in ip_address: self.result['vm_display_name'] = ip_address['virtualmachinedisplayname'] if 'virtualmachinename' in ip_address: self.result['vm'] = ip_address['virtualmachinename'] if 'vmipaddress' in ip_address: self.result['vm_guest_ip'] = ip_address['vmipaddress'] if 'ipaddress' in ip_address: self.result['ip_address'] = ip_address['ipaddress'] return self.result def main(): module = AnsibleModule( argument_spec = dict( ip_address = dict(required=True), vm = dict(default=None), vm_guest_ip = dict(default=None), state = dict(choices=['present', 'absent'], default='present'), zone = dict(default=None), domain = dict(default=None), account = dict(default=None), project = dict(default=None), poll_async = dict(choices=BOOLEANS, default=True), api_key = dict(default=None), api_secret = dict(default=None, no_log=True), api_url = dict(default=None), api_http_method = dict(choices=['get', 'post'], default='get'), api_timeout = dict(type='int', default=10), ), required_together = ( ['api_key', 'api_secret', 'api_url'], ), supports_check_mode=True ) if not has_lib_cs: module.fail_json(msg="python library cs required: pip install cs") try: acs_static_nat = AnsibleCloudStackStaticNat(module) state = module.params.get('state') if state in ['absent']: ip_address = acs_static_nat.absent_static_nat() else: ip_address = acs_static_nat.present_static_nat() result = acs_static_nat.get_result(ip_address) except CloudStackException, e: module.fail_json(msg='CloudStackException: %s' % str(e)) module.exit_json(**result) # import module snippets from ansible.module_utils.basic import * if __name__ == '__main__': main()