fortios_user_ldap – Configure LDAP server entries in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- user_ldap - Configure LDAP server entries. type: dict
- account_key_filter - Account key filter, using the UPN as the search filter. type: str
- account_key_processing - Account key processing operation, either keep or strip domain string of UPN in the token. type: str choices: same, strip
- ca_cert - CA certificate name. Source vpn.certificate.ca.name. type: str
- cnid - Common name identifier for the LDAP server. The common name identifier for most LDAP servers is "cn". type: str
- dn - Distinguished name used to look up entries on the LDAP server. type: str
- group_filter - Filter used for group matching. type: str
- group_member_check - Group member checking methods. type: str choices: user-attr, group-object, posix-group-object
- group_object_filter - Filter used for group searching. type: str
- group_search_base - Search base used for group searching. type: str
- member_attr - Name of attribute from which to get group membership. type: str
- name - LDAP server entry name. type: str required: True
- password - Password for initial binding. type: str
- password_expiry_warning - Enable/disable password expiry warnings. type: str choices: enable, disable
- password_renewal - Enable/disable online password renewal. type: str choices: enable, disable
- port - Port to be used for communication with the LDAP server . type: int
- secondary_server - Secondary LDAP server CN domain name or IP. type: str
- secure - Port to be used for authentication. type: str choices: disable, starttls, ldaps
- server - LDAP server CN domain name or IP. type: str
- source_ip - Source IP for communications to LDAP server. type: str
- tertiary_server - Tertiary LDAP server CN domain name or IP. type: str
- type - Authentication type for LDAP searches. type: str choices: simple, anonymous, regular
- username - 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"
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"
source_ip: "84.230.14.43"
tertiary_server: "<your_own_value>"
type: "simple"
username: "<your_own_value>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3