fortinet.fortimanager.fmgr_system_admin_ldap – LDAP server entry configuration.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_admin_ldap.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_admin_ldap
dictionary
the top level parameters set
adom
list / elements=string
Adom.
adom-name
string
Admin domain names.
adom-attr
string
Attribute used to retrieve adom
attributes
string
Default:
"member,uniquemember,memberuid"
Attributes used for group searching.
ca-cert
string
CA certificate name.
cnid
string
Default:
"cn"
Common Name Identifier (default = CN).
connect-timeout
integer
Default:
500
LDAP connection timeout (msec).
dn
string
Distinguished Name.
filter
string
Default:
"(objectclass=*)"
Filter used for group searching.
group
string
Full base DN used for group searching.
memberof-attr
string
Attribute used to retrieve memeberof.
name
string
LDAP server entry name.
password
string
Password for initial binding.
port
integer
Default:
389
Port number of LDAP server (default = 389).
profile-attr
string
Attribute used to retrieve admin profile.
secondary-server
string
{<name_str|ip_str>} secondary LDAP server domain name or IP.
secure
string
    Choices:
  • disable ←
  • starttls
  • ldaps
SSL connection.
disable - No SSL.
starttls - Use StartTLS.
ldaps - Use LDAPS.
server
string
{<name_str|ip_str>} LDAP server domain name or IP.
tertiary-server
string
{<name_str|ip_str>} tertiary LDAP server domain name or IP.
type
string
    Choices:
  • simple ←
  • anonymous
  • regular
Type of LDAP binding.
simple - Simple password authentication without search.
anonymous - Bind using anonymous user search.
regular - Bind using username/password and then search.
username
string
Username (full DN) for initial binding.
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the LDAP servers
     fmgr_fact:
       facts:
           selector: 'system_admin_ldap'
           params:
               ldap: ''
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: LDAP server entry configuration.
     fmgr_system_admin_ldap:
        bypass_validation: False
        state: present
        system_admin_ldap:
           adom:
             -
                 adom-name: ansible
           name: ansible-test-ldap
           password: Fortinet
           port: 390
           server: ansible
           type: regular #<value in [simple, anonymous, regular]>
           username: ansible-username

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)