drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_ldap_dynamicmapping Configure LDAP server entries. | "added in version" 2.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_user_ldap_dynamicmapping (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- hosts: fortimanager00 collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure dynamic mappings of LDAP server fmgr_user_ldap_dynamicmapping: bypass_validation: False adom: ansible ldap: ansible-test-ldap # name state: present user_ldap_dynamicmapping: _scope: - name: FGT_AWS # need a valid device name vdom: root # need a valid vdom name under the device dn: ansible-test-dn password: fortinet port: 9000 server: ansible username: ansible-test-dyn
- 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 dynamic mappings of LDAP server fmgr_fact: facts: selector: 'user_ldap_dynamicmapping' params: adom: 'ansible' ldap: 'ansible-test-ldap' # name dynamic_mapping: 'your_value'
adom: description: the parameter (adom) in requested url required: true type: str ldap: description: the parameter (ldap) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str user_ldap_dynamicmapping: description: the top level parameters set required: false suboptions: _scope: description: description elements: dict suboptions: name: description: no description type: str vdom: description: no description type: str type: list account-key-filter: description: no description type: str account-key-name: description: no description type: str account-key-processing: choices: - same - strip description: no description type: str account-key-upn-san: choices: - othername - rfc822name - dnsname description: Define SAN in certificate for user principle name matching. type: str antiphish: choices: - disable - enable description: Enable/disable AntiPhishing credential backend. type: str ca-cert: description: no description type: str client-cert: description: Client certificate name. type: str client-cert-auth: choices: - disable - enable description: Enable/disable using client certificate for TLS authentication. type: str cnid: description: no description type: str dn: description: no description type: str filter: description: no description type: str group: description: no description type: str group-filter: description: no description type: str group-member-check: choices: - user-attr - group-object - posix-group-object description: no description type: str group-object-filter: description: no description type: str group-object-search-base: description: no description type: str group-search-base: description: no description type: str interface: description: no description type: str interface-select-method: choices: - auto - sdwan - specify description: no description type: str member-attr: description: no description type: str obtain-user-info: choices: - disable - enable description: no description type: str password: description: description type: str password-attr: description: Name of attribute to get password hash. type: str password-expiry-warning: choices: - disable - enable description: no description type: str password-renewal: choices: - disable - enable description: no description type: str port: description: no description type: int retrieve-protection-profile: description: no description type: str search-type: choices: - nested - recursive description: description elements: str type: list secondary-server: description: no description type: str secure: choices: - disable - starttls - ldaps description: no description type: str server: description: no description type: str server-identity-check: choices: - disable - enable description: no description type: str source-ip: description: no description type: str source-port: description: Source port to be used for communication with the LDAP server. type: int ssl-min-proto-version: choices: - default - TLSv1 - TLSv1-1 - TLSv1-2 - SSLv3 description: no description type: str tertiary-server: description: no description type: str two-factor: choices: - disable - fortitoken-cloud description: no description type: str two-factor-authentication: choices: - fortitoken - email - sms description: no description type: str two-factor-filter: description: Filter used to synchronize users to FortiToken Cloud. type: str two-factor-notification: choices: - email - sms description: no description type: str type: choices: - simple - anonymous - regular description: no description type: str user-info-exchange-server: description: no description type: str username: description: no description type: str type: dict workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list