Added Ansible UTM Module for managing AAA groups. (#49860)
* Added Ansible UTM Module for managing AAA groups. * - Fix sanity checks - Fixed documentation trailing whitespaces - Added missing documentation * - Fixed minor language/typing/formatting issues.
This commit is contained in:
getjack
John R Barker
parent
754e63ab67
commit
6bc5d4dd8e
1 changed files with 220 additions and 0 deletions
|
|
@ -0,0 +1,220 @@
|
|||
#!/usr/bin/python
|
||||
|
||||
# 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
|
||||
|
||||
ANSIBLE_METADATA = {
|
||||
'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'
|
||||
}
|
||||
|
||||
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.
|
||||
|
||||
version_added: "2.8"
|
||||
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- The name of the object. Will be used to identify the entry.
|
||||
required: true
|
||||
adirectory_groups:
|
||||
description:
|
||||
- List of adirectory group strings.
|
||||
type: list
|
||||
adirectory_groups_sids:
|
||||
description:
|
||||
- Dictionary of group sids.
|
||||
type: list
|
||||
backend_match:
|
||||
description:
|
||||
- The backend for the group.
|
||||
default: none
|
||||
choices:
|
||||
- none
|
||||
- adirectory
|
||||
- edirectory
|
||||
- radius
|
||||
- tacacs
|
||||
- ldap
|
||||
comment:
|
||||
description:
|
||||
- Comment that describes the AAA group.
|
||||
default: ''
|
||||
type: str
|
||||
required: false
|
||||
dynamic:
|
||||
description:
|
||||
- Group type. Is static if none is selected.
|
||||
default: none
|
||||
choices:
|
||||
- none
|
||||
- ipsec_dn
|
||||
- directory_groups
|
||||
edirectory_groups:
|
||||
description:
|
||||
- List of edirectory group strings.
|
||||
type: list
|
||||
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).
|
||||
default: []
|
||||
network:
|
||||
description:
|
||||
- The network reference name. The objects contains the known ip addresses for the authentication object (network/aaa).
|
||||
default: ""
|
||||
radius_groups:
|
||||
description:
|
||||
- A list of radius group strings.
|
||||
default: []
|
||||
tacacs_groups:
|
||||
description:
|
||||
- A list of tacacs group strings.
|
||||
default: []
|
||||
|
||||
extends_documentation_fragment:
|
||||
- utm
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Create UTM aaa_group
|
||||
utm_aaa_group:
|
||||
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
|
||||
utm_aaa_group:
|
||||
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: string
|
||||
_locked:
|
||||
description: Whether or not the object is currently locked.
|
||||
type: boolean
|
||||
_type:
|
||||
description: The type of the object.
|
||||
type: string
|
||||
name:
|
||||
description: The name of the object.
|
||||
type: string
|
||||
adirectory_groups:
|
||||
description: List of Active Directory Groups.
|
||||
type: string
|
||||
adirectory_groups_sids:
|
||||
description: List of Active Directory Groups SIDS.
|
||||
type: list
|
||||
backend_match:
|
||||
description: The backend to use.
|
||||
type: string
|
||||
comment:
|
||||
description: The comment string.
|
||||
type: string
|
||||
dynamic:
|
||||
description: Whether the group match is ipsec_dn or directory_group.
|
||||
type: string
|
||||
edirectory_groups:
|
||||
description: List of eDirectory Groups.
|
||||
type: string
|
||||
ipsec_dn:
|
||||
description: ipsec_dn identifier to match.
|
||||
type: string
|
||||
ldap_attribute:
|
||||
description: The LDAP Attribute to match against.
|
||||
type: string
|
||||
ldap_attribute_value:
|
||||
description: The LDAP Attribute Value to match against.
|
||||
type: string
|
||||
members:
|
||||
description: List of member identifiers of the group.
|
||||
type: list
|
||||
network:
|
||||
description: The identifier of the network (network/aaa).
|
||||
type: string
|
||||
radius_group:
|
||||
description: The radius group identifier.
|
||||
type: string
|
||||
tacacs_group:
|
||||
description: The tacacs group identifier.
|
||||
type: string
|
||||
"""
|
||||
|
||||
from ansible.module_utils.utm_utils import UTM, UTMModule
|
||||
from ansible.module_utils._text import to_native
|
||||
|
||||
|
||||
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()
|
||||
Loading…
Reference in a new issue