Try SpotterConfigure LDAP server entries in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
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.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure LDAP server entries.
fortios_user_ldap:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
user_ldap:
account_key_filter: "<your_own_value>"
account_key_processing: "same"
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>"
member_attr: "<your_own_value>"
name: "default_name_13"
password: "<your_own_value>"
password_expiry_warning: "enable"
password_renewal: "enable"
port: "17"
secondary_server: "<your_own_value>"
secure: "disable"
server: "192.168.100.40"
server_identity_check: "enable"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
tertiary_server: "<your_own_value>"
type: "simple"
username: "<your_own_value>"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
vdom:
default: root
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
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
user_ldap:
default: null
description:
- Configure LDAP server entries.
suboptions:
account_key_filter:
description:
- Account key filter, using the UPN as the search filter.
type: str
account_key_processing:
choices:
- same
- strip
description:
- Account key processing operation, either keep or strip domain string of UPN
in the token.
type: str
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:
choices:
- user-attr
- group-object
- posix-group-object
description:
- Group member checking methods.
type: str
group_object_filter:
description:
- Filter used for group searching.
type: str
group_search_base:
description:
- Search base used for group searching.
type: str
member_attr:
description:
- Name of attribute from which to get group membership.
type: str
name:
description:
- LDAP server entry name.
required: true
type: str
password:
description:
- Password for initial binding.
type: str
password_expiry_warning:
choices:
- enable
- disable
description:
- Enable/disable password expiry warnings.
type: str
password_renewal:
choices:
- enable
- disable
description:
- Enable/disable online password renewal.
type: str
port:
description:
- Port to be used for communication with the LDAP server .
type: int
secondary_server:
description:
- Secondary LDAP server CN domain name or IP.
type: str
secure:
choices:
- disable
- starttls
- ldaps
description:
- Port to be used for authentication.
type: str
server:
description:
- LDAP server CN domain name or IP.
type: str
server_identity_check:
choices:
- enable
- disable
description:
- Enable/disable LDAP server identity check (verify server domain name/IP address
against the server certificate).
type: str
source_ip:
description:
- Source IP for communications to LDAP server.
type: str
ssl_min_proto_version:
choices:
- default
- SSLv3
- TLSv1
- TLSv1-1
- TLSv1-2
description:
- Minimum supported protocol version for SSL/TLS connections .
type: str
tertiary_server:
description:
- Tertiary LDAP server CN domain name or IP.
type: str
type:
choices:
- simple
- anonymous
- regular
description:
- Authentication type for LDAP searches.
type: str
username:
description:
- Username (full DN) for initial binding.
type: str
type: dict
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str