fortinet.fortimanager.fmgr_system_admin_ldap module – LDAP server entry configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

Comments

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

the directive to create, update or delete an object

Choices:

  • present

  • absent

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

Attributes used for group searching.

Default: “member,uniquemember,memberuid”

ca-cert

string

CA certificate name.

cnid

string

Common Name Identifier (default = CN).

Default: “cn”

connect-timeout

integer

LDAP connection timeout (msec).

Default: 500

dn

string

Distinguished Name.

filter

string

Filter used for group searching.

Default: “(objectclass=*)”

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

Port number of LDAP server (default = 389).

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

SSL connection.

disable - No SSL.

starttls - Use StartTLS.

ldaps - Use LDAPS.

Choices:

  • disable ← (default)

  • starttls

  • 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

Type of LDAP binding.

simple - Simple password authentication without search.

anonymous - Bind using anonymous user search.

regular - Bind using username/password and then search.

Choices:

  • simple ← (default)

  • anonymous

  • regular

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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

- 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
- 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: ''

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)