Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
duality-group
duality-group / ansible python
Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
from __future__ import (absolute_import, division, print_function)
# Copyright: (c) 2022 Fortinet
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
__metaclass__ = type
ANSIBLE_METADATA = {'status': ['preview'],
'supported_by': 'community',
'metadata_version': '1.1'}
DOCUMENTATION = '''
---
module: fortios_user_ldap
short_description: Configure LDAP server entries in Fortinet's FortiOS and FortiGate.
description:
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the
user to set and modify user feature and ldap category.
Examples include all parameters and values need to be adjusted to datasources before usage.
Tested with FOS v6.0.0
version_added: "2.0.0"
author:
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
notes:
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
requirements:
- ansible>=2.9.0
options:
access_token:
description:
- Token-based authentication.
Generated from GUI of Fortigate.
type: str
required: false
enable_log:
description:
- Enable/Disable logging for task.
type: bool
required: false
default: false
vdom:
description:
- Virtual domain, among those defined previously. A vdom is a
virtual instance of the FortiGate that can be configured and
used as a different unit.
type: str
default: root
member_path:
type: str
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
member_state:
type: str
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
choices:
- present
- absent
state:
description:
- Indicates whether to create or remove the object.
type: str
required: true
choices:
- present
- absent
user_ldap:
description:
- Configure LDAP server entries.
default: null
type: dict
suboptions:
account_key_filter:
description:
- Account key filter, using the UPN as the search filter.
type: str
account_key_processing:
description:
- Account key processing operation, either keep or strip domain string of UPN in the token.
type: str
choices:
- same
- strip
antiphish:
description:
- Enable/disable AntiPhishing credential backend.
type: str
choices:
- enable
- disable
ca_cert:
description:
- CA certificate name. Source vpn.certificate.ca.name.
type: str
cnid:
description:
- Common name identifier for the LDAP server. The common name identifier for most LDAP servers is "cn".
type: str
dn:
description:
- Distinguished name used to look up entries on the LDAP server.
type: str
group_filter:
description:
- Filter used for group matching.
type: str
group_member_check:
description:
- Group member checking methods.
type: str
choices:
- user-attr
- group-object
- posix-group-object
group_object_filter:
description:
- Filter used for group searching.
type: str
group_search_base:
description:
- Search base used for group searching.
type: str
interface:
description:
- Specify outgoing interface to reach server. Source system.interface.name.
type: str
interface_select_method:
description:
- Specify how to select outgoing interface to reach server.
type: str
choices:
- auto
- sdwan
- specify
member_attr:
description:
- Name of attribute from which to get group membership.
type: str
name:
description:
- LDAP server entry name.
required: true
type: str
obtain_user_info:
description:
- Enable/disable obtaining of user information.
type: str
choices:
- enable
- disable
password:
description:
- Password for initial binding.
type: str
password_attr:
description:
- Name of attribute to get password hash.
type: str
password_expiry_warning:
description:
- Enable/disable password expiry warnings.
type: str
choices:
- enable
- disable
password_renewal:
description:
- Enable/disable online password renewal.
type: str
choices:
- enable
- disable
port:
description:
- Port to be used for communication with the LDAP server .
type: int
search_type:
description:
- Search type.
type: list
elements: str
choices:
- recursive
secondary_server:
description:
- Secondary LDAP server CN domain name or IP.
type: str
secure:
description:
- Port to be used for authentication.
type: str
choices:
- disable
- starttls
- ldaps
server:
description:
- LDAP server CN domain name or IP.
type: str
server_identity_check:
description:
- Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate).
type: str
choices:
- enable
- disable
source_ip:
description:
- FortiGate IP address to be used for communication with the LDAP server.
type: str
source_port:
description:
- Source port to be used for communication with the LDAP server.
type: int
ssl_min_proto_version:
description:
- Minimum supported protocol version for SSL/TLS connections .
type: str
choices:
- default
- SSLv3
- TLSv1
- TLSv1-1
- TLSv1-2
tertiary_server:
description:
- Tertiary LDAP server CN domain name or IP.
type: str
two_factor:
description:
- Enable/disable two-factor authentication.
type: str
choices:
- disable
- fortitoken-cloud
two_factor_authentication:
description:
- Authentication method by FortiToken Cloud.
type: str
choices:
- fortitoken
- email
- sms
two_factor_notification:
description:
- Notification method for user activation by FortiToken Cloud.
type: str
choices:
- email
- sms
type:
description:
- Authentication type for LDAP searches.
type: str
choices:
- simple
- anonymous
- regular
user_info_exchange_server:
description:
- MS Exchange server from which to fetch user information. Source user.exchange.name.
type: str
username:
description:
- Username (full DN) for initial binding.
type: str
'''
EXAMPLES = '''
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure LDAP server entries.
fortios_user_ldap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_ldap:
account_key_filter: "<your_own_value>"
account_key_processing: "same"
antiphish: "enable"
ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
cnid: "<your_own_value>"
dn: "<your_own_value>"
group_filter: "<your_own_value>"
group_member_check: "user-attr"
group_object_filter: "<your_own_value>"
group_search_base: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
member_attr: "<your_own_value>"
name: "default_name_16"
obtain_user_info: "enable"
password: "<your_own_value>"
password_attr: "<your_own_value>"
password_expiry_warning: "enable"
password_renewal: "enable"
port: "22"
search_type: "recursive"
secondary_server: "<your_own_value>"
secure: "disable"
server: "192.168.100.40"
server_identity_check: "enable"
source_ip: "84.230.14.43"
source_port: "29"
ssl_min_proto_version: "default"
tertiary_server: "<your_own_value>"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_notification: "email"
type: "simple"
user_info_exchange_server: "<your_own_value> (source user.exchange.name)"
username: "<your_own_value>"
'''
RETURN = '''
build:
description: Build number of the fortigate image
returned: always
type: str
sample: '1547'
http_method:
description: Last method used to provision the content into FortiGate
returned: always
type: str
sample: 'PUT'
http_status:
description: Last result given by FortiGate on last operation applied
returned: always
type: str
sample: "200"
mkey:
description: Master key (id) used in the last call to FortiGate
returned: success
type: str
sample: "id"
name:
description: Name of the table used to fulfill the request
returned: always
type: str
sample: "urlfilter"
path:
description: Path of the table used to fulfill the request
returned: always
type: str
sample: "webfilter"
revision:
description: Internal revision number
returned: always
type: str
sample: "17.0.2.10658"
serial:
description: Serial number of the unit
returned: always
type: str
sample: "FGVMEVYYQT3AB5352"
status:
description: Indication of the operation's result
returned: always
type: str
sample: "success"
vdom:
description: Virtual domain used
returned: always
type: str
sample: "root"
version:
description: Version of the FortiGate
returned: always
type: str
sample: "v5.6.3"
'''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import FortiOSHandler
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import check_legacy_fortiosapi
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import schema_to_module_spec
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import check_schema_versioning
from ansible_collections.fortinet.fortios.plugins.module_utils.fortimanager.common import FAIL_SOCKET_MSG
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.comparison import is_same_comparison
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.comparison import serialize
def filter_user_ldap_data(json):
option_list = ['account_key_filter', 'account_key_processing', 'antiphish',
'ca_cert', 'cnid', 'dn',
'group_filter', 'group_member_check', 'group_object_filter',
'group_search_base', 'interface', 'interface_select_method',
'member_attr', 'name', 'obtain_user_info',
'password', 'password_attr', 'password_expiry_warning',
'password_renewal', 'port', 'search_type',
'secondary_server', 'secure', 'server',
'server_identity_check', 'source_ip', 'source_port',
'ssl_min_proto_version', 'tertiary_server', 'two_factor',
'two_factor_authentication', 'two_factor_notification', 'type',
'user_info_exchange_server', 'username']
dictionary = {}
for attribute in option_list:
if attribute in json and json[attribute] is not None:
dictionary[attribute] = json[attribute]
return dictionary
def flatten_single_path(data, path, index):
if not data or index == len(path) or path[index] not in data or not data[path[index]]:
return
if index == len(path) - 1:
data[path[index]] = ' '.join(str(elem) for elem in data[path[index]])
elif isinstance(data[path[index]], list):
for value in data[path[index]]:
flatten_single_path(value, path, index + 1)
else:
flatten_single_path(data[path[index]], path, index + 1)
def flatten_multilists_attributes(data):
multilist_attrs = [
[u'search_type'],
]
for attr in multilist_attrs:
flatten_single_path(data, attr, 0)
return data
def underscore_to_hyphen(data):
if isinstance(data, list):
for i, elem in enumerate(data):
data[i] = underscore_to_hyphen(elem)
elif isinstance(data, dict):
new_data = {}
for k, v in data.items():
new_data[k.replace('_', '-')] = underscore_to_hyphen(v)
data = new_data
return data
def user_ldap(data, fos, check_mode=False):
vdom = data['vdom']
state = data['state']
user_ldap_data = data['user_ldap']
user_ldap_data = flatten_multilists_attributes(user_ldap_data)
filtered_data = underscore_to_hyphen(filter_user_ldap_data(user_ldap_data))
# check_mode starts from here
if check_mode:
mkey = fos.get_mkey('user', 'ldap', filtered_data, vdom=vdom)
current_data = fos.get('user', 'ldap', vdom=vdom, mkey=mkey)
is_existed = current_data and current_data.get('http_status') == 200 \
and isinstance(current_data.get('results'), list) \
and len(current_data['results']) > 0
# 2. if it exists and the state is 'present' then compare current settings with desired
if state == 'present' or state is True:
if mkey is None:
return False, True, filtered_data
# if mkey exists then compare each other
# record exits and they're matched or not
if is_existed:
is_same = is_same_comparison(
serialize(current_data['results'][0]), serialize(filtered_data))
return False, not is_same, filtered_data
# record does not exist
return False, True, filtered_data
if state == 'absent':
if mkey is None:
return False, False, filtered_data
if is_existed:
return False, True, filtered_data
return False, False, filtered_data
return True, False, {'reason: ': 'Must provide state parameter'}
if state == "present" or state is True:
return fos.set('user',
'ldap',
data=filtered_data,
vdom=vdom)
elif state == "absent":
return fos.delete('user',
'ldap',
mkey=filtered_data['name'],
vdom=vdom)
else:
fos._module.fail_json(msg='state must be present or absent!')
def is_successful_status(resp):
return 'status' in resp and resp['status'] == 'success' or \
'http_status' in resp and resp['http_status'] == 200 or \
'http_method' in resp and resp['http_method'] == "DELETE" and resp['http_status'] == 404
def fortios_user(data, fos, check_mode):
fos.do_member_operation('user', 'ldap')
if data['user_ldap']:
resp = user_ldap(data, fos, check_mode)
else:
fos._module.fail_json(msg='missing task body: %s' % ('user_ldap'))
if check_mode:
return resp
return not is_successful_status(resp), \
is_successful_status(resp) and \
(resp['revision_changed'] if 'revision_changed' in resp else True), \
resp
versioned_schema = {
"elements": "dict",
"type": "list",
"children": {
"username": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"secure": {
"type": "string",
"options": [
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "starttls",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "ldaps",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"group_filter": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"account_key_filter": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"user_info_exchange_server": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"two_factor_notification": {
"type": "string",
"options": [
{
"value": "email",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "sms",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": False,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"secondary_server": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"password_attr": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": False,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": False,
"v6.4.1": False,
"v6.2.0": False,
"v6.2.3": False,
"v6.2.5": False,
"v6.2.7": False,
"v6.0.11": False
}
},
"group_search_base": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"port": {
"type": "integer",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"password_renewal": {
"type": "string",
"options": [
{
"value": "enable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"member_attr": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"type": {
"type": "string",
"options": [
{
"value": "simple",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "anonymous",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "regular",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"dn": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"group_object_filter": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"ca_cert": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"account_key_processing": {
"type": "string",
"options": [
{
"value": "same",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "strip",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"server_identity_check": {
"type": "string",
"options": [
{
"value": "enable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"cnid": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"interface": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": False,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"password": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"two_factor_authentication": {
"type": "string",
"options": [
{
"value": "fortitoken",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "email",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "sms",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": False,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"name": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"antiphish": {
"type": "string",
"options": [
{
"value": "enable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True
}
},
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": False,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": False,
"v6.4.1": False,
"v6.2.0": False,
"v6.2.3": False,
"v6.2.5": False,
"v6.2.7": False,
"v6.0.11": False
}
},
"obtain_user_info": {
"type": "string",
"options": [
{
"value": "enable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"password_expiry_warning": {
"type": "string",
"options": [
{
"value": "enable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"two_factor": {
"type": "string",
"options": [
{
"value": "disable",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "fortitoken-cloud",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"source_ip": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"server": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"search_type": {
"multiple_values": True,
"elements": "str",
"type": "list",
"options": [
{
"value": "recursive",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"interface_select_method": {
"type": "string",
"options": [
{
"value": "auto",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "sdwan",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
},
{
"value": "specify",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.5": True,
"v6.2.7": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": False,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": False
}
},
"source_port": {
"type": "integer",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": False,
"v6.0.5": False,
"v6.0.0": False,
"v6.4.0": False,
"v6.4.1": False,
"v6.2.0": False,
"v6.2.3": False,
"v6.2.5": False,
"v6.2.7": False,
"v6.0.11": False
}
},
"ssl_min_proto_version": {
"type": "string",
"options": [
{
"value": "default",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "SSLv3",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "TLSv1",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "TLSv1-1",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "TLSv1-2",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"tertiary_server": {
"type": "string",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
"group_member_check": {
"type": "string",
"options": [
{
"value": "user-attr",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "group-object",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
},
{
"value": "posix-group-object",
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
],
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
},
"revisions": {
"v7.0.3": True,
"v7.0.2": True,
"v7.0.1": True,
"v7.0.0": True,
"v7.0.5": True,
"v7.0.4": True,
"v6.4.4": True,
"v6.0.5": True,
"v6.0.0": True,
"v6.4.0": True,
"v6.4.1": True,
"v6.2.0": True,
"v6.2.3": True,
"v6.2.5": True,
"v6.2.7": True,
"v6.0.11": True
}
}
def main():
module_spec = schema_to_module_spec(versioned_schema)
mkeyname = 'name'
fields = {
"access_token": {"required": False, "type": "str", "no_log": True},
"enable_log": {"required": False, "type": 'bool', "default": False},
"vdom": {"required": False, "type": "str", "default": "root"},
"member_path": {"required": False, "type": "str"},
"member_state": {
"type": "str",
"required": False,
"choices": ["present", "absent"]
},
"state": {"required": True, "type": "str",
"choices": ["present", "absent"]},
"user_ldap": {
"required": False, "type": "dict", "default": None,
"options": {
}
}
}
for attribute_name in module_spec['options']:
fields["user_ldap"]['options'][attribute_name] = module_spec['options'][attribute_name]
if mkeyname and mkeyname == attribute_name:
fields["user_ldap"]['options'][attribute_name]['required'] = True
module = AnsibleModule(argument_spec=fields,
supports_check_mode=True)
check_legacy_fortiosapi(module)
versions_check_result = None
if module._socket_path:
connection = Connection(module._socket_path)
if 'access_token' in module.params:
connection.set_option('access_token', module.params['access_token'])
if 'enable_log' in module.params:
connection.set_option('enable_log', module.params['enable_log'])
else:
connection.set_option('enable_log', False)
fos = FortiOSHandler(connection, module, mkeyname)
versions_check_result = check_schema_versioning(fos, versioned_schema, "user_ldap")
is_error, has_changed, result = fortios_user(module.params, fos, module.check_mode)
else:
module.fail_json(**FAIL_SOCKET_MSG)
if versions_check_result and versions_check_result['matched'] is False:
module.warn("Ansible has detected version mismatch between FortOS system and your playbook, see more details by specifying option -vvv")
if not is_error:
if versions_check_result and versions_check_result['matched'] is False:
module.exit_json(changed=has_changed, version_check_warning=versions_check_result, meta=result)
else:
module.exit_json(changed=has_changed, meta=result)
else:
if versions_check_result and versions_check_result['matched'] is False:
module.fail_json(msg="Error in repo", version_check_warning=versions_check_result, meta=result)
else:
module.fail_json(msg="Error in repo", meta=result)
if __name__ == '__main__':
main()