fortinet.fortios.fortios_user_ldap – Configure LDAP server entries in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_user_ldap.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

Parameters

Parameter		Choices/Defaults	Comments
access_token string			Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task.
state string / required		Choices: present absent	Indicates whether to create or remove the object.
user_ldap dictionary			Configure LDAP server entries.
	account_key_filter string		Account key filter, using the UPN as the search filter.
	account_key_processing string	Choices: same strip	Account key processing operation, either keep or strip domain string of UPN in the token.
	antiphish string	Choices: enable disable	Enable/disable AntiPhishing credential backend.
	ca_cert string		CA certificate name. Source vpn.certificate.ca.name.
	cnid string		Common name identifier for the LDAP server. The common name identifier for most LDAP servers is "cn".
	dn string		Distinguished name used to look up entries on the LDAP server.
	group_filter string		Filter used for group matching.
	group_member_check string	Choices: user-attr group-object posix-group-object	Group member checking methods.
	group_object_filter string		Filter used for group searching.
	group_search_base string		Search base used for group searching.
	interface string		Specify outgoing interface to reach server. Source system.interface.name.
	interface_select_method string	Choices: auto sdwan specify	Specify how to select outgoing interface to reach server.
	member_attr string		Name of attribute from which to get group membership.
	name string / required		LDAP server entry name.
	obtain_user_info string	Choices: enable disable	Enable/disable obtaining of user information.
	password string		Password for initial binding.
	password_attr string		Name of attribute to get password hash.
	password_expiry_warning string	Choices: enable disable	Enable/disable password expiry warnings.
	password_renewal string	Choices: enable disable	Enable/disable online password renewal.
	port integer		Port to be used for communication with the LDAP server .
	search_type list / elements=string	Choices: recursive	Search type.
	secondary_server string		Secondary LDAP server CN domain name or IP.
	secure string	Choices: disable starttls ldaps	Port to be used for authentication.
	server string		LDAP server CN domain name or IP.
	server_identity_check string	Choices: enable disable	Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate).
	source_ip string		Source IP for communications to LDAP server.
	source_port integer		Source port to be used for communication with the LDAP server.
	ssl_min_proto_version string	Choices: default SSLv3 TLSv1 TLSv1-1 TLSv1-2	Minimum supported protocol version for SSL/TLS connections .
	tertiary_server string		Tertiary LDAP server CN domain name or IP.
	two_factor string	Choices: disable fortitoken-cloud	Enable/disable two-factor authentication.
	two_factor_authentication string	Choices: fortitoken email sms	Authentication method by FortiToken Cloud.
	two_factor_notification string	Choices: email sms	Notification method for user activation by FortiToken Cloud.
	type string	Choices: simple anonymous regular	Authentication type for LDAP searches.
	user_info_exchange_server string		MS Exchange server from which to fetch user information. Source user.exchange.name.
	username string		Username (full DN) for initial binding.
vdom string		Default: "root"	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.

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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 Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_ldap_module.html