fortinet.fortimanager.fmgr_user_ldap module – Configure LDAP server entries.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_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.

adom

string / required

The parameter (adom) in requested url.

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"

user_ldap

dictionary

The top level parameters set.

account_key_cert_field

aliases: account-key-cert-field

string

Define subject identity field in certificate for user access right checking.

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

  • "cn"

account_key_filter

aliases: account-key-filter

string

Account key filter, using the UPN as the search filter.

account_key_name

aliases: account-key-name

string

Account key name, using the UPN as the search filter.

account_key_processing

aliases: account-key-processing

string

Account key processing operation, either keep or strip domain string of UPN in the token.

Choices:

  • "same"

  • "strip"

account_key_upn_san

aliases: account-key-upn-san

string

Define SAN in certificate for user principle name matching.

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

antiphish

string

Enable/disable AntiPhishing credential backend.

Choices:

  • "disable"

  • "enable"

ca_cert

aliases: ca-cert

string

CA certificate name.

client_cert

aliases: client-cert

string

Client certificate name.

client_cert_auth

aliases: client-cert-auth

string

Enable/disable using client certificate for TLS authentication.

Choices:

  • "disable"

  • "enable"

cnid

string

Common name identifier for the LDAP server.

dn

string

Distinguished name used to look up entries on the LDAP server.

dynamic_mapping

list / elements=dictionary

Dynamic mapping.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

account_key_cert_field

aliases: account-key-cert-field

string

Define subject identity field in certificate for user access right checking.

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

  • "cn"

account_key_filter

aliases: account-key-filter

string

Account key filter.

account_key_name

aliases: account-key-name

string

Account key name.

account_key_processing

aliases: account-key-processing

string

Account key processing.

Choices:

  • "same"

  • "strip"

account_key_upn_san

aliases: account-key-upn-san

string

Define SAN in certificate for user principle name matching.

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

antiphish

string

Enable/disable AntiPhishing credential backend.

Choices:

  • "disable"

  • "enable"

ca_cert

aliases: ca-cert

string

Ca cert.

client_cert

aliases: client-cert

string

Client certificate name.

client_cert_auth

aliases: client-cert-auth

string

Enable/disable using client certificate for TLS authentication.

Choices:

  • "disable"

  • "enable"

cnid

string

Cnid.

dn

string

Dn.

filter

string

Filter.

group

string

Group.

group_filter

aliases: group-filter

string

Group filter.

group_member_check

aliases: group-member-check

string

Group member check.

Choices:

  • "user-attr"

  • "group-object"

  • "posix-group-object"

group_object_filter

aliases: group-object-filter

string

Group object filter.

group_object_search_base

aliases: group-object-search-base

string

Group object search base.

group_search_base

aliases: group-search-base

string

Group search base.

interface

string

Interface.

interface_select_method

aliases: interface-select-method

string

Interface select method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

max_connections

aliases: max-connections

integer

Max connections.

member_attr

aliases: member-attr

string

Member attr.

obtain_user_info

aliases: obtain-user-info

string

Obtain user info.

Choices:

  • "disable"

  • "enable"

password

any

(list) Password.

password_attr

aliases: password-attr

string

Name of attribute to get password hash.

password_expiry_warning

aliases: password-expiry-warning

string

Password expiry warning.

Choices:

  • "disable"

  • "enable"

password_renewal

aliases: password-renewal

string

Password renewal.

Choices:

  • "disable"

  • "enable"

port

integer

Port.

retrieve_protection_profile

aliases: retrieve-protection-profile

string

Retrieve protection profile.

search_type

aliases: search-type

list / elements=string

Search type.

Choices:

  • "nested"

  • "recursive"

secondary_server

aliases: secondary-server

string

Secondary server.

secure

string

Secure.

Choices:

  • "disable"

  • "starttls"

  • "ldaps"

server

string

Server.

server_identity_check

aliases: server-identity-check

string

Server identity check.

Choices:

  • "disable"

  • "enable"

source_ip

aliases: source-ip

string

Source ip.

source_ip_interface

aliases: source-ip-interface

any

(list) Source interface for communication with the LDAP server.

source_port

aliases: source-port

integer

Source port to be used for communication with the LDAP server.

ssl_max_proto_version

aliases: ssl-max-proto-version

string

Ssl max proto version.

Choices:

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1"

  • "TLSv1-3"

ssl_min_proto_version

aliases: ssl-min-proto-version

string

Ssl min proto version.

Choices:

  • "default"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1-3"

status_ttl

aliases: status-ttl

integer

Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at l…

tertiary_server

aliases: tertiary-server

string

Tertiary server.

two_factor

aliases: two-factor

string

Two factor.

Choices:

  • "disable"

  • "fortitoken-cloud"

two_factor_authentication

aliases: two-factor-authentication

string

Two factor authentication.

Choices:

  • "fortitoken"

  • "email"

  • "sms"

two_factor_filter

aliases: two-factor-filter

string

Filter used to synchronize users to FortiToken Cloud.

two_factor_notification

aliases: two-factor-notification

string

Two factor notification.

Choices:

  • "email"

  • "sms"

type

string

Type.

Choices:

  • "simple"

  • "anonymous"

  • "regular"

user_info_exchange_server

aliases: user-info-exchange-server

string

User info exchange server.

username

string

Username.

group_filter

aliases: group-filter

string

Filter used for group matching.

group_member_check

aliases: group-member-check

string

Group member checking methods.

Choices:

  • "user-attr"

  • "group-object"

  • "posix-group-object"

group_object_filter

aliases: group-object-filter

string

Filter used for group searching.

group_object_search_base

aliases: group-object-search-base

string

Search base used for group searching.

group_search_base

aliases: group-search-base

string

Search base used for group searching.

interface

string

Specify outgoing interface to reach server.

interface_select_method

aliases: interface-select-method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

member_attr

aliases: member-attr

string

Name of attribute from which to get group membership.

name

string / required

LDAP server entry name.

obtain_user_info

aliases: obtain-user-info

string

Enable/disable obtaining of user information.

Choices:

  • "disable"

  • "enable"

password

any

(list) Password for initial binding.

password_attr

aliases: password-attr

string

Name of attribute to get password hash.

password_expiry_warning

aliases: password-expiry-warning

string

Enable/disable password expiry warnings.

Choices:

  • "disable"

  • "enable"

password_renewal

aliases: password-renewal

string

Enable/disable online password renewal.

Choices:

  • "disable"

  • "enable"

port

integer

Port to be used for communication with the LDAP server

search_type

aliases: search-type

list / elements=string

Search type.

Choices:

  • "nested"

  • "recursive"

secondary_server

aliases: secondary-server

string

Secondary LDAP server CN domain name or IP.

secure

string

Port to be used for authentication.

Choices:

  • "disable"

  • "starttls"

  • "ldaps"

server

string

LDAP server CN domain name or IP.

server_identity_check

aliases: server-identity-check

string

Enable/disable LDAP server identity check

Choices:

  • "disable"

  • "enable"

source_ip

aliases: source-ip

string

Source IP for communications to LDAP server.

source_ip_interface

aliases: source-ip-interface

any

(list) Source interface for communication with the LDAP server.

source_port

aliases: source-port

integer

Source port to be used for communication with the LDAP server.

ssl_min_proto_version

aliases: ssl-min-proto-version

string

Minimum supported protocol version for SSL/TLS connections

Choices:

  • "default"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1-3"

status_ttl

aliases: status-ttl

integer

Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least thi…

tertiary_server

aliases: tertiary-server

string

Tertiary LDAP server CN domain name or IP.

two_factor

aliases: two-factor

string

Enable/disable two-factor authentication.

Choices:

  • "disable"

  • "fortitoken-cloud"

two_factor_authentication

aliases: two-factor-authentication

string

Authentication method by FortiToken Cloud.

Choices:

  • "fortitoken"

  • "email"

  • "sms"

two_factor_filter

aliases: two-factor-filter

string

Filter used to synchronize users to FortiToken Cloud.

two_factor_notification

aliases: two-factor-notification

string

Notification method for user activation by FortiToken Cloud.

Choices:

  • "email"

  • "sms"

type

string

Authentication type for LDAP searches.

Choices:

  • "simple"

  • "anonymous"

  • "regular"

user_info_exchange_server

aliases: user-info-exchange-server

string

MS Exchange server from which to fetch user information.

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: Configure LDAP server entries.
      fortinet.fortimanager.fmgr_user_ldap:
        bypass_validation: false
        adom: ansible
        state: present
        user_ldap:
          dn: ansible-test
          name: ansible-test-ldap
          password: fortinet
          port: 9000
          server: ansible

- 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 server entries
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap"
          params:
            adom: "ansible"
            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)