fmgr_system_admin_ldap – LDAP server entry configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| system_admin_ldap | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- system_admin_ldap - no description type: dict
- adom - Adom. type: array
more...
- adom-name - Admin domain names. type: str more...
- adom-attr - Attribute used to retrieve adom type: str more...
- attributes - Attributes used for group searching. type: str default: member,uniquemember,memberuid more...
- ca-cert - CA certificate name. type: str more...
- cnid - Common Name Identifier (default = CN). type: str default: cn more...
- connect-timeout - LDAP connection timeout (msec). type: int default: 500 more...
- dn - Distinguished Name. type: str more...
- filter - Filter used for group searching. type: str default: (objectclass=*) more...
- group - Full base DN used for group searching. type: str more...
- memberof-attr - Attribute used to retrieve memeberof. type: str more...
- name - LDAP server entry name. type: str more...
- password - Password for initial binding. type: str more...
- port - Port number of LDAP server (default = 389). type: int default: 389 more...
- profile-attr - Attribute used to retrieve admin profile. type: str more...
- secondary-server - {
- secure - SSL connection. type: str choices: [disable, starttls, ldaps] default: disable more...
- server - {
- tertiary-server - {
- type - Type of LDAP binding. type: str choices: [simple, anonymous, regular] default: simple more...
- username - Username (full DN) for initial binding. type: str more...
- adom-access - set all or specify adom access type. type: str choices: [all, specify] default: all more...
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: 'your_value'
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict