os_server_tag.yml

os_server_tag.yml

#!/usr/bin/python
# coding: utf-8 -*-

# (c) 2018, Artem Goncharov <artem.goncharov@gmail.com>
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function
__metaclass__ = type


ANSIBLE_METADATA = {'metadata_version': '1.1',
                    'status': ['preview'],
                    'supported_by': 'community'}


DOCUMENTATION = '''
---
module: os_server_tag
short_description: Manage server tags
extends_documentation_fragment: openstack
version_added: "2.8"
author: Artem Goncharov (@gtema)
description:
    - set or delete tags on the Nova server
options:
   server:
      description:
        - Name or id of the server
      required: true
   state:
     description:
       - Should the resource be present or absent.
     choices: [ present, absent ]
     default: present
   tags:
     description:
       - tag names
     required: true
   availability_zone:
     description:
       - Ignored. Present for backwards compatibility
requirements:
    - "python >= 2.7"
    - "openstacksdk"
'''
EXAMPLES = '''
---
- name: set the tags on the instance
  os_server_tag:
    server: "{{ server_name }}"
    state: present
    tags: tagname.tag
'''

RETURN = '''
server:
    description: UUID of the server.
    returned: success
    type: str
'''

from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.openstack import (
        openstack_full_argument_spec, openstack_module_kwargs,
        openstack_cloud_from_module)
from ansible.module_utils._text import to_native
from openstack import connect

def main():


    argument_spec = openstack_full_argument_spec(
        server=dict(required=True),
        state=dict(default='present', choices=['absent', 'present']),
        tags=dict(default=[], type='list'),
    )

    module_kwargs = openstack_module_kwargs()
    module = AnsibleModule(argument_spec, **module_kwargs)

    server = module.params['server']
    state = module.params['state']
    tags = module.params['tags']

    conn = connect()
    sdk, cloud = openstack_cloud_from_module(module)
    server = cloud.get_server(server)
    server = conn.compute.get_server(server.id)
    current_tagging = server.fetch_tags(conn.compute)

    try:
        if state == 'present':
            if set(current_tagging.tags) == set(tags):
                module.exit_json(changed=False)
            else:
                server.set_tags(conn.compute, tags)
                module.exit_json(changed=True,
                             server=server.id,
                             )
        elif state == 'absent':
            for tag in tags:
                if tag in current_tagging.tags:
                    server.remove_tag(conn.compute, tag)
                    module.exit_json(changed=True)
                else:
                    module.exit_json(changed=False)

    except sdk.exceptions.OpenStackCloudException as e:
        module.fail_json(msg=to_native(e))


if __name__ == '__main__':
    main()