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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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 - LDAP server entry configuration. type: dict
- adom - No description for the parameter type: array
- adom-name - Admin domain names. type: str
- adom-attr - Attribute used to retrieve adom type: str
- attributes - Attributes used for group searching. type: str default: member,uniquemember,memberuid
- ca-cert - CA certificate name. type: str
- cnid - Common Name Identifier (default = CN). type: str default: cn
- connect-timeout - LDAP connection timeout (msec). type: int default: 500
- dn - Distinguished Name. type: str
- filter - Filter used for group searching. type: str default: (objectclass=*)
- group - Full base DN used for group searching. type: str
- memberof-attr - Attribute used to retrieve memeberof. type: str
- name - LDAP server entry name. type: str
- password - No description for the parameter type: str
- port - Port number of LDAP server (default = 389). type: int default: 389
- profile-attr - Attribute used to retrieve admin profile. type: str
- secondary-server - {
- secure - SSL connection. type: str choices: [disable, starttls, ldaps] default: disable
- server - {
- tertiary-server - {
- type - Type of LDAP binding. type: str choices: [simple, anonymous, regular] default: simple
- username - Username (full DN) for initial binding. type: str
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: fortimanager-inventory
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
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_admin_ldap:
adom:
-
adom-name: <value of string>
adom-attr: <value of string>
attributes: <value of string>
ca-cert: <value of string>
cnid: <value of string>
connect-timeout: <value of integer>
dn: <value of string>
filter: <value of string>
group: <value of string>
memberof-attr: <value of string>
name: <value of string>
password: <value of string>
port: <value of integer>
profile-attr: <value of string>
secondary-server: <value of string>
secure: <value in [disable, starttls, ldaps]>
server: <value of string>
tertiary-server: <value of string>
type: <value in [simple, anonymous, regular]>
username: <value of string>
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