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

Note

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

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

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

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

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

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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=dictionary

Adom.

adom_name

string

Admin domain names.

adom_access

string

set all or specify adom access type.

all - All ADOMs access.

specify - Specify ADOMs access.

Choices:

  • "all"

  • "specify"

adom_attr

string

Attribute used to retrieve adom

attributes

string

Attributes used for group searching.

ca_cert

string

CA certificate name.

cnid

string

Common Name Identifier

connect_timeout

integer

LDAP connection timeout

dn

string

Distinguished Name.

filter

string

Filter used for group searching.

group

string

Full base DN used for group searching.

memberof_attr

string

Attribute used to retrieve memeberof.

name

string / required

LDAP server entry name.

password

any

(list) Password for initial binding.

port

integer

Port number of LDAP server

profile_attr

string

Attribute used to retrieve admin profile.

secondary_server

string

No description

secure

string

SSL connection.

disable - No SSL.

starttls - Use StartTLS.

ldaps - Use LDAPS.

Choices:

  • "disable"

  • "starttls"

  • "ldaps"

server

string

No description

ssl_protocol

string

set the lowest SSL protocol version for connection to ldap server.

follow-global-ssl-protocol - Follow system.

sslv3 - set SSLv3 as the lowest version.

tlsv1.

tlsv1.

tlsv1.

tlsv1.

Choices:

  • "follow-global-ssl-protocol"

  • "sslv3"

  • "tlsv1.0"

  • "tlsv1.1"

  • "tlsv1.2"

  • "tlsv1.3"

tertiary_server

string

No description

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"

  • "anonymous"

  • "regular"

username

string

Username

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: LDAP server entry configuration.
      fortinet.fortimanager.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: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the LDAP servers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_ldap"
          params:
            ldap: "your_value"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)