fmgr_user_ldap – Configure LDAP server entries.¶
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
- adom - The parameter in requested url type: str required: true
- user_ldap - Configure LDAP server entries. type: dict
- account-key-filter - Account key filter, using the UPN as the search filter. type: str
- account-key-processing - Account key processing operation, either keep or strip domain string of UPN in the token. type: str choices: [same, strip]
- ca-cert - CA certificate name. type: str
- cnid - Common name identifier for the LDAP server. type: str
- dn - Distinguished name used to look up entries on the LDAP server. type: str
- dynamic_mapping - No description for the parameter type: array
- _scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- account-key-filter - No description for the parameter type: str
- account-key-name - No description for the parameter type: str
- account-key-processing - No description for the parameter type: str choices: [same, strip]
- ca-cert - No description for the parameter type: str
- cnid - No description for the parameter type: str
- dn - No description for the parameter type: str
- filter - No description for the parameter type: str
- group - No description for the parameter type: str
- group-filter - No description for the parameter type: str
- group-member-check - No description for the parameter type: str choices: [user-attr, group-object, posix-group-object]
- group-object-filter - No description for the parameter type: str
- group-object-search-base - No description for the parameter type: str
- group-search-base - No description for the parameter type: str
- member-attr - No description for the parameter type: str
- obtain-user-info - No description for the parameter type: str choices: [disable, enable]
- password - No description for the parameter type: str
- password-expiry-warning - No description for the parameter type: str choices: [disable, enable]
- password-renewal - No description for the parameter type: str choices: [disable, enable]
- port - No description for the parameter type: int
- retrieve-protection-profile - No description for the parameter type: str
- search-type - No description for the parameter type: array choices: [nested, recursive]
- secondary-server - No description for the parameter type: str
- secure - No description for the parameter type: str choices: [disable, starttls, ldaps]
- server - No description for the parameter type: str
- server-identity-check - No description for the parameter type: str choices: [disable, enable]
- source-ip - No description for the parameter type: str
- ssl-min-proto-version - No description for the parameter type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3]
- tertiary-server - No description for the parameter type: str
- type - No description for the parameter type: str choices: [simple, anonymous, regular]
- user-info-exchange-server - No description for the parameter type: str
- username - No description for the parameter type: str
- _scope - No description for the parameter type: array
- group-filter - Filter used for group matching. type: str
- group-member-check - Group member checking methods. type: str choices: [user-attr, group-object, posix-group-object]
- group-object-filter - Filter used for group searching. type: str
- group-search-base - Search base used for group searching. type: str
- member-attr - Name of attribute from which to get group membership. type: str
- name - LDAP server entry name. type: str
- password - No description for the parameter type: str
- password-expiry-warning - Enable/disable password expiry warnings. type: str choices: [disable, enable]
- password-renewal - Enable/disable online password renewal. type: str choices: [disable, enable]
- port - Port to be used for communication with the LDAP server (default = 389). type: int
- secondary-server - Secondary LDAP server CN domain name or IP. type: str
- secure - Port to be used for authentication. type: str choices: [disable, starttls, ldaps]
- server - LDAP server CN domain name or IP. type: str
- server-identity-check - Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate). type: str choices: [disable, enable]
- source-ip - Source IP for communications to LDAP server. type: str
- ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3]
- tertiary-server - Tertiary LDAP server CN domain name or IP. type: str
- type - Authentication type for LDAP searches. type: str choices: [simple, anonymous, regular]
- 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: Configure LDAP server entries.
fmgr_user_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, ...]
adom: <your own value>
state: <value in [present, absent]>
user_ldap:
account-key-filter: <value of string>
account-key-processing: <value in [same, strip]>
ca-cert: <value of string>
cnid: <value of string>
dn: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
account-key-filter: <value of string>
account-key-name: <value of string>
account-key-processing: <value in [same, strip]>
ca-cert: <value of string>
cnid: <value of string>
dn: <value of string>
filter: <value of string>
group: <value of string>
group-filter: <value of string>
group-member-check: <value in [user-attr, group-object, posix-group-object]>
group-object-filter: <value of string>
group-object-search-base: <value of string>
group-search-base: <value of string>
member-attr: <value of string>
obtain-user-info: <value in [disable, enable]>
password: <value of string>
password-expiry-warning: <value in [disable, enable]>
password-renewal: <value in [disable, enable]>
port: <value of integer>
retrieve-protection-profile: <value of string>
search-type:
- nested
- recursive
secondary-server: <value of string>
secure: <value in [disable, starttls, ldaps]>
server: <value of string>
server-identity-check: <value in [disable, enable]>
source-ip: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
tertiary-server: <value of string>
type: <value in [simple, anonymous, regular]>
user-info-exchange-server: <value of string>
username: <value of string>
group-filter: <value of string>
group-member-check: <value in [user-attr, group-object, posix-group-object]>
group-object-filter: <value of string>
group-search-base: <value of string>
member-attr: <value of string>
name: <value of string>
password: <value of string>
password-expiry-warning: <value in [disable, enable]>
password-renewal: <value in [disable, enable]>
port: <value of integer>
secondary-server: <value of string>
secure: <value in [disable, starttls, ldaps]>
server: <value of string>
server-identity-check: <value in [disable, enable]>
source-ip: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
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