mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
Start using this to construct shade OpenStack Cloud objects in a consistent manner. This will let us centralize things like dealing with password arguments and whatnot. It also allows us to introduce the ability to pass a fully formed config dict directly to the module. Migrate all OpenStack modules to use openstack_cloud_from_module. Have it return the shade library since it's responsible for importing shade and shade is needed for the exceptions. Only pull specific OpenStack arguments for the constructor Rather than passing **module.params to the shade constructor, pull out only the values that make sense. This should prevent the issues with module parameters stepping on shade parameters. Replace module.params.pop with module.params.get We don't need to pop these anymore since the shade constructor is now using opt-in values. Using real urls is ungood. Use example.com domains. Also, get rid of the antiquated port numbers.
135 lines
3.9 KiB
Python
135 lines
3.9 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
|
# Copyright (c) 2013, Benno Joy <benno@ansible.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_security_group
|
|
short_description: Add/Delete security groups from an OpenStack cloud.
|
|
extends_documentation_fragment: openstack
|
|
author: "Monty Taylor (@emonty)"
|
|
version_added: "2.0"
|
|
description:
|
|
- Add or Remove security groups from an OpenStack cloud.
|
|
options:
|
|
name:
|
|
description:
|
|
- Name that has to be given to the security group. This module
|
|
requires that security group names be unique.
|
|
required: true
|
|
description:
|
|
description:
|
|
- Long description of the purpose of the security group
|
|
required: false
|
|
default: None
|
|
state:
|
|
description:
|
|
- Should the resource be present or absent.
|
|
choices: [present, absent]
|
|
default: present
|
|
availability_zone:
|
|
description:
|
|
- Ignored. Present for backwards compatibility
|
|
required: false
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Create a security group
|
|
- os_security_group:
|
|
cloud: mordred
|
|
state: present
|
|
name: foo
|
|
description: security group for foo servers
|
|
|
|
# Update the existing 'foo' security group description
|
|
- os_security_group:
|
|
cloud: mordred
|
|
state: present
|
|
name: foo
|
|
description: updated description for the foo security group
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.openstack import openstack_full_argument_spec, openstack_module_kwargs, openstack_cloud_from_module
|
|
|
|
|
|
def _needs_update(module, secgroup):
|
|
"""Check for differences in the updatable values.
|
|
|
|
NOTE: We don't currently allow name updates.
|
|
"""
|
|
if secgroup['description'] != module.params['description']:
|
|
return True
|
|
return False
|
|
|
|
|
|
def _system_state_change(module, secgroup):
|
|
state = module.params['state']
|
|
if state == 'present':
|
|
if not secgroup:
|
|
return True
|
|
return _needs_update(module, secgroup)
|
|
if state == 'absent' and secgroup:
|
|
return True
|
|
return False
|
|
|
|
|
|
def main():
|
|
argument_spec = openstack_full_argument_spec(
|
|
name=dict(required=True),
|
|
description=dict(default=''),
|
|
state=dict(default='present', choices=['absent', 'present']),
|
|
)
|
|
|
|
module_kwargs = openstack_module_kwargs()
|
|
module = AnsibleModule(argument_spec,
|
|
supports_check_mode=True,
|
|
**module_kwargs)
|
|
|
|
name = module.params['name']
|
|
state = module.params['state']
|
|
description = module.params['description']
|
|
|
|
shade, cloud = openstack_cloud_from_module(module)
|
|
try:
|
|
secgroup = cloud.get_security_group(name)
|
|
|
|
if module.check_mode:
|
|
module.exit_json(changed=_system_state_change(module, secgroup))
|
|
|
|
changed = False
|
|
if state == 'present':
|
|
if not secgroup:
|
|
secgroup = cloud.create_security_group(name, description)
|
|
changed = True
|
|
else:
|
|
if _needs_update(module, secgroup):
|
|
secgroup = cloud.update_security_group(
|
|
secgroup['id'], description=description)
|
|
changed = True
|
|
module.exit_json(
|
|
changed=changed, id=secgroup['id'], secgroup=secgroup)
|
|
|
|
if state == 'absent':
|
|
if secgroup:
|
|
cloud.delete_security_group(secgroup['id'])
|
|
changed = True
|
|
module.exit_json(changed=changed)
|
|
|
|
except shade.OpenStackCloudException as e:
|
|
module.fail_json(msg=str(e))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|