fortinet.fortimanager.fmgr_user_domaincontroller module – Configure domain controller entries.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_domaincontroller.
New in fortinet.fortimanager 2.1.0
Synopsis
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.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to ad_mode. Set Active Directory mode. Choices:
|
|
Deprecated, please rename it to adlds_dn. AD LDS distinguished name. |
|
Deprecated, please rename it to adlds_ip_address. AD LDS IPv4 address. |
|
Deprecated, please rename it to adlds_ip6. AD LDS IPv6 address. |
|
Deprecated, please rename it to adlds_port. Port number of AD LDS service |
|
Deprecated, please rename it to change_detection. Enable/disable detection of a configuration change in the Active Directo… Choices:
|
|
Deprecated, please rename it to change_detection_period. Minutes to detect a configuration change in the Active Directory … |
|
Deprecated, please rename it to dns_srv_lookup. Enable/disable DNS service lookup. Choices:
|
|
Deprecated, please rename it to domain_name. Domain DNS name. |
|
Deprecated, please rename it to extra_server. Extra-Server. |
|
Server ID. |
|
Deprecated, please rename it to ip_address. Domain controller IP address. |
|
Port to be used for communication with the domain controller |
|
Deprecated, please rename it to source_ip_address. FortiGate IPv4 address to be used for communication with the do… |
|
Deprecated, please rename it to source_port. Source port to be used for communication with the domain controller. |
|
Hostname of the server to connect to. |
|
Specify outgoing interface to reach server. |
|
Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. Choices:
|
|
Deprecated, please rename it to ip_address. Domain controller IP address. |
|
Domain controller IPv6 address. |
|
(list or str) Deprecated, please rename it to ldap_server. LDAP server name. |
|
Domain controller entry name. |
|
(list) Password for specified username. |
|
Port to be used for communication with the domain controller |
|
Deprecated, please rename it to replication_port. Port to be used for communication with the domain controller for replica… |
|
Deprecated, please rename it to source_ip_address. FortiGate IPv4 address to be used for communication with the domain con… |
|
Deprecated, please rename it to source_ip6. FortiGate IPv6 address to be used for communication with the domain controller. |
|
Deprecated, please rename it to source_port. Source port to be used for communication with the domain controller. |
|
User name to sign in with. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure domain controller entries.
fortinet.fortimanager.fmgr_user_domaincontroller:
# 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: present # <value in [present, absent]>
user_domaincontroller:
domain_name: <string>
extra_server:
-
id: <integer>
ip_address: <string>
port: <integer>
source_ip_address: <string>
source_port: <integer>
ip_address: <string>
ldap_server: <list or string>
name: <string>
port: <integer>
ad_mode: <value in [none, ds, lds]>
adlds_dn: <string>
adlds_ip_address: <string>
adlds_ip6: <string>
adlds_port: <integer>
dns_srv_lookup: <value in [disable, enable]>
hostname: <string>
interface: <string>
interface_select_method: <value in [auto, sdwan, specify]>
ip6: <string>
password: <list or string>
replication_port: <integer>
source_ip_address: <string>
source_ip6: <string>
source_port: <integer>
username: <string>
change_detection: <value in [disable, enable]>
change_detection_period: <integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |