diff options
Diffstat (limited to 'lib/ansible/modules/cloud/openstack/os_listener.py')
| -rw-r--r-- | lib/ansible/modules/cloud/openstack/os_listener.py | 256 |
1 files changed, 0 insertions, 256 deletions
diff --git a/lib/ansible/modules/cloud/openstack/os_listener.py b/lib/ansible/modules/cloud/openstack/os_listener.py deleted file mode 100644 index 6d29f55e9f..0000000000 --- a/lib/ansible/modules/cloud/openstack/os_listener.py +++ /dev/null @@ -1,256 +0,0 @@ -#!/usr/bin/python - -# Copyright (c) 2018 Catalyst Cloud Ltd. -# 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_listener -short_description: Add/Delete a listener for a load balancer from OpenStack Cloud -extends_documentation_fragment: openstack -version_added: "2.7" -author: "Lingxian Kong (@lingxiankong)" -description: - - Add or Remove a listener for a load balancer from the OpenStack load-balancer service. -options: - name: - description: - - Name that has to be given to the listener - required: true - state: - description: - - Should the resource be present or absent. - choices: [present, absent] - default: present - loadbalancer: - description: - - The name or id of the load balancer that this listener belongs to. - required: true - protocol: - description: - - The protocol for the listener. - choices: [HTTP, HTTPS, TCP, TERMINATED_HTTPS] - default: HTTP - protocol_port: - description: - - The protocol port number for the listener. - default: 80 - wait: - description: - - If the module should wait for the load balancer to be ACTIVE. - type: bool - default: 'yes' - timeout: - description: - - The amount of time the module should wait for the load balancer to get - into ACTIVE state. - default: 180 - availability_zone: - description: - - Ignored. Present for backwards compatibility -requirements: ["openstacksdk"] -''' - -RETURN = ''' -id: - description: The listener UUID. - returned: On success when I(state) is 'present' - type: str - sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" -listener: - description: Dictionary describing the listener. - returned: On success when I(state) is 'present' - type: complex - contains: - id: - description: Unique UUID. - type: str - sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" - name: - description: Name given to the listener. - type: str - sample: "test" - description: - description: The listener description. - type: str - sample: "description" - load_balancer_id: - description: The load balancer UUID this listener belongs to. - type: str - sample: "b32eef7e-d2a6-4ea4-a301-60a873f89b3b" - loadbalancers: - description: A list of load balancer IDs.. - type: list - sample: [{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}] - provisioning_status: - description: The provisioning status of the listener. - type: str - sample: "ACTIVE" - operating_status: - description: The operating status of the listener. - type: str - sample: "ONLINE" - is_admin_state_up: - description: The administrative state of the listener. - type: bool - sample: true - protocol: - description: The protocol for the listener. - type: str - sample: "HTTP" - protocol_port: - description: The protocol port number for the listener. - type: int - sample: 80 -''' - -EXAMPLES = ''' -# Create a listener, wait for the loadbalancer to be active. -- os_listener: - cloud: mycloud - endpoint_type: admin - state: present - name: test-listener - loadbalancer: test-loadbalancer - protocol: HTTP - protocol_port: 8080 - -# Create a listener, do not wait for the loadbalancer to be active. -- os_listener: - cloud: mycloud - endpoint_type: admin - state: present - name: test-listener - loadbalancer: test-loadbalancer - protocol: HTTP - protocol_port: 8080 - wait: no - -# Delete a listener -- os_listener: - cloud: mycloud - endpoint_type: admin - state: absent - name: test-listener - loadbalancer: test-loadbalancer -''' - -import time - -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 _lb_wait_for_status(module, cloud, lb, status, failures, interval=5): - """Wait for load balancer to be in a particular provisioning status.""" - timeout = module.params['timeout'] - - total_sleep = 0 - if failures is None: - failures = [] - - while total_sleep < timeout: - lb = cloud.load_balancer.get_load_balancer(lb.id) - if lb.provisioning_status == status: - return None - if lb.provisioning_status in failures: - module.fail_json( - msg="Load Balancer %s transitioned to failure state %s" % - (lb.id, lb.provisioning_status) - ) - - time.sleep(interval) - total_sleep += interval - - module.fail_json( - msg="Timeout waiting for Load Balancer %s to transition to %s" % - (lb.id, status) - ) - - -def main(): - argument_spec = openstack_full_argument_spec( - name=dict(required=True), - state=dict(default='present', choices=['absent', 'present']), - loadbalancer=dict(required=True), - protocol=dict(default='HTTP', - choices=['HTTP', 'HTTPS', 'TCP', 'TERMINATED_HTTPS']), - protocol_port=dict(default=80, type='int', required=False), - ) - module_kwargs = openstack_module_kwargs() - module = AnsibleModule(argument_spec, **module_kwargs) - sdk, cloud = openstack_cloud_from_module(module) - loadbalancer = module.params['loadbalancer'] - loadbalancer_id = None - - try: - changed = False - listener = cloud.load_balancer.find_listener( - name_or_id=module.params['name']) - - if module.params['state'] == 'present': - if not listener: - lb = cloud.load_balancer.find_load_balancer(loadbalancer) - if not lb: - module.fail_json( - msg='load balancer %s is not found' % loadbalancer - ) - loadbalancer_id = lb.id - - listener = cloud.load_balancer.create_listener( - name=module.params['name'], - loadbalancer_id=loadbalancer_id, - protocol=module.params['protocol'], - protocol_port=module.params['protocol_port'], - ) - changed = True - - if not module.params['wait']: - module.exit_json(changed=changed, - listener=listener.to_dict(), - id=listener.id) - - if module.params['wait']: - # Check in case the listener already exists. - lb = cloud.load_balancer.find_load_balancer(loadbalancer) - if not lb: - module.fail_json( - msg='load balancer %s is not found' % loadbalancer - ) - _lb_wait_for_status(module, cloud, lb, "ACTIVE", ["ERROR"]) - - module.exit_json(changed=changed, listener=listener.to_dict(), - id=listener.id) - elif module.params['state'] == 'absent': - if not listener: - changed = False - else: - cloud.load_balancer.delete_listener(listener) - changed = True - - if module.params['wait']: - # Wait for the load balancer to be active after deleting - # the listener. - lb = cloud.load_balancer.find_load_balancer(loadbalancer) - if not lb: - module.fail_json( - msg='load balancer %s is not found' % loadbalancer - ) - _lb_wait_for_status(module, cloud, lb, "ACTIVE", ["ERROR"]) - - module.exit_json(changed=changed) - except sdk.exceptions.OpenStackCloudException as e: - module.fail_json(msg=str(e), extra_data=e.extra_data) - - -if __name__ == "__main__": - main() |