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/web_infrastructure/sophos_utm/utm_aaa_group.py

227 lines
7 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 COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: utm_aaa_group
author:
- Johannes Brunswicker (@MatrixCrawler)
short_description: Create, update or destroy an aaa group object in Sophos UTM.
description:
- Create, update or destroy an aaa group object in Sophos UTM.
- This module needs to have the REST Ability of the UTM to be activated.
options:
name:
description:
- The name of the object. Will be used to identify the entry.
type: str
required: true
adirectory_groups:
description:
- List of adirectory group strings.
type: list
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
elements: str
2020-03-09 10:11:07 +01:00
adirectory_groups_sids:
description:
- Dictionary of group sids.
type: dict
backend_match:
description:
- The backend for the group.
type: str
choices:
- none
- adirectory
- edirectory
- radius
- tacacs
- ldap
default: none
comment:
description:
- Comment that describes the AAA group.
type: str
default: ''
dynamic:
description:
- Group type. Is static if none is selected.
type: str
default: none
choices:
- none
- ipsec_dn
- directory_groups
edirectory_groups:
description:
- List of edirectory group strings.
type: list
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
elements: str
2020-03-09 10:11:07 +01:00
ipsec_dn:
description:
- The ipsec dn string.
type: str
ldap_attribute:
description:
- The ldap attribute to check against.
type: str
ldap_attribute_value:
description:
- The ldap attribute value to check against.
type: str
members:
description:
- A list of user ref names (aaa/user).
type: list
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
elements: str
2020-03-09 10:11:07 +01:00
default: []
network:
description:
- The network reference name. The objects contains the known ip addresses for the authentication object (network/aaa).
type: str
default: ""
radius_groups:
description:
- A list of radius group strings.
type: list
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
elements: str
2020-03-09 10:11:07 +01:00
default: []
tacacs_groups:
description:
- A list of tacacs group strings.
type: list
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
elements: str
2020-03-09 10:11:07 +01:00
default: []
extends_documentation_fragment:
- community.general.utm
'''
EXAMPLES = """
- name: Create UTM aaa_group
community.general.utm_aaa_group:
2020-03-09 10:11:07 +01:00
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAAAGroupEntry
backend_match: ldap
dynamic: directory_groups
ldap_attributes: memberof
ldap_attributes_value: "cn=groupname,ou=Groups,dc=mydomain,dc=com"
network: REF_OBJECT_STRING
state: present
- name: Remove UTM aaa_group
community.general.utm_aaa_group:
2020-03-09 10:11:07 +01:00
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAAAGroupEntry
state: absent
"""
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
adirectory_groups:
description: List of Active Directory Groups.
type: str
adirectory_groups_sids:
description: List of Active Directory Groups SIDS.
type: list
backend_match:
description: The backend to use.
type: str
comment:
description: The comment string.
type: str
dynamic:
description: Whether the group match is ipsec_dn or directory_group.
type: str
edirectory_groups:
description: List of eDirectory Groups.
type: str
ipsec_dn:
description: ipsec_dn identifier to match.
type: str
ldap_attribute:
description: The LDAP Attribute to match against.
type: str
ldap_attribute_value:
description: The LDAP Attribute Value to match against.
type: str
members:
description: List of member identifiers of the group.
type: list
network:
description: The identifier of the network (network/aaa).
type: str
radius_group:
description: The radius group identifier.
type: str
tacacs_group:
description: The tacacs group identifier.
type: str
"""
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 = "aaa/group"
key_to_check_for_changes = ["comment", "adirectory_groups", "adirectory_groups_sids", "backend_match", "dynamic",
"edirectory_groups", "ipsec_dn", "ldap_attribute", "ldap_attribute_value", "members",
"network", "radius_groups", "tacacs_groups"]
module = UTMModule(
argument_spec=dict(
name=dict(type='str', required=True),
adirectory_groups=dict(type='list', elements='str', required=False, default=[]),
adirectory_groups_sids=dict(type='dict', required=False, default={}),
backend_match=dict(type='str', required=False, default="none",
choices=["none", "adirectory", "edirectory", "radius", "tacacs", "ldap"]),
comment=dict(type='str', required=False, default=""),
dynamic=dict(type='str', required=False, default="none", choices=["none", "ipsec_dn", "directory_groups"]),
edirectory_groups=dict(type='list', elements='str', required=False, default=[]),
ipsec_dn=dict(type='str', required=False, default=""),
ldap_attribute=dict(type='str', required=False, default=""),
ldap_attribute_value=dict(type='str', required=False, default=""),
members=dict(type='list', elements='str', required=False, default=[]),
network=dict(type='str', required=False, default=""),
radius_groups=dict(type='list', elements='str', required=False, default=[]),
tacacs_groups=dict(type='list', elements='str', required=False, default=[]),
)
)
try:
UTM(module, endpoint, key_to_check_for_changes).execute()
except Exception as e:
module.fail_json(msg=to_native(e))
if __name__ == '__main__':
main()