1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/utm_proxy_location_info.py

126 lines
3.5 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
2020-03-09 10:11:07 +01:00
# Copyright (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: utm_proxy_location_info
author:
- Johannes Brunswicker (@MatrixCrawler)
short_description: create, update or destroy reverse_proxy location entry in Sophos UTM
description:
- Create, update or destroy a reverse_proxy location entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
options:
name:
Tidy up validate-modules ignores for modules: web_infrastructure/sophos_utm (#1351) * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_dns_host.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py * fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py * Enabling validation-modules for web_infrastructure/sophos_utm modules * Rolled back utm_network_interface_address.py for 2.9 sake
2020-11-22 12:17:46 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- The name of the object. Will be used to identify the entry
required: true
extends_documentation_fragment:
- community.general.utm
'''
EXAMPLES = """
- name: Remove UTM proxy_location
community.general.utm_proxy_location_info:
2020-03-09 10:11:07 +01:00
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestLocationEntry
"""
RETURN = """
result:
description: The utm object that was created
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
type: str
_locked:
description: Whether or not the object is currently locked
type: bool
_type:
description: The type of the object
type: str
name:
description: The name of the object
type: str
access_control:
description: Whether to use access control state
type: str
allowed_networks:
description: List of allowed network reference names
type: list
auth_profile:
description: The auth profile reference name
type: str
backend:
description: The backend reference name
type: str
be_path:
description: The backend path
type: str
comment:
description: The comment string
type: str
denied_networks:
description: The list of the denied network names
type: list
hot_standby:
description: Use hot standy
type: bool
path:
description: Path name
type: str
status:
description: Whether the object is active or not
type: bool
stickysession_id:
description: The identifier of the stickysession
type: str
stickysession_status:
description: Whether to use stickysession or not
type: bool
websocket_passthrough:
description: Whether websocket passthrough will be used or not
type: bool
"""
from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule
from ansible.module_utils.common.text.converters import to_native
2020-03-09 10:11:07 +01:00
def main():
endpoint = "reverse_proxy/location"
key_to_check_for_changes = []
module = UTMModule(
argument_spec=dict(
name=dict(type='str', required=True),
),
supports_check_mode=True,
2020-03-09 10:11:07 +01:00
)
try:
UTM(module, endpoint, key_to_check_for_changes, info_only=True).execute()
except Exception as e:
module.fail_json(msg=to_native(e))
if __name__ == '__main__':
main()