fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_admin_ldap LDAP server entry configuration. | "added in version" 2.0.0 of fortinet.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 communityfortinet.fortimanager.fmgr_system_admin_ldap (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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"
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 type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. 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. type: bool system_admin_ldap: description: The top level parameters set. required: false suboptions: adom: description: Adom. elements: dict suboptions: adom-name: description: Deprecated, please rename it to adom_name. Admin domain names. type: str type: list adom-access: choices: - all - specify description: - Deprecated, please rename it to adom_access. - set all or specify adom access type. - all - All ADOMs access. - specify - Specify ADOMs access. type: str adom-attr: description: Deprecated, please rename it to adom_attr. Attribute used to retrieve adom type: str attributes: description: Attributes used for group searching. type: str ca-cert: description: Deprecated, please rename it to ca_cert. CA certificate name. type: str cnid: description: Common Name Identifier type: str connect-timeout: description: Deprecated, please rename it to connect_timeout. LDAP connection timeout type: int dn: description: Distinguished Name. type: str filter: description: Filter used for group searching. type: str group: description: Full base DN used for group searching. type: str memberof-attr: description: Deprecated, please rename it to memberof_attr. Attribute used to retrieve memeberof. type: str name: description: LDAP server entry name. required: true type: str password: description: (list) Password for initial binding. type: raw port: description: Port number of LDAP server type: int profile-attr: description: Deprecated, please rename it to profile_attr. Attribute used to retrieve admin profile. type: str secondary-server: description: Deprecated, please rename it to secondary_server. No description type: str secure: choices: - disable - starttls - ldaps description: - SSL connection. - disable - No SSL. - starttls - Use StartTLS. - ldaps - Use LDAPS. type: str server: description: No description type: str tertiary-server: description: Deprecated, please rename it to tertiary_server. No description type: str type: choices: - simple - anonymous - regular description: - Type of LDAP binding. - simple - Simple password authentication without search. - anonymous - Bind using anonymous user search. - regular - Bind using username/password and then search. type: str username: description: Username type: str type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. 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