fortinet.fortios.fortios_user_domain_controller module – Configure domain controller entries in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_domain_controller.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and domain_controller category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.9
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure domain controller entries. |
|
Set Active Directory mode. Choices:
|
|
AD LDS distinguished name. |
|
AD LDS IPv6 address. |
|
AD LDS IPv4 address. |
|
Port number of AD LDS service . |
|
Enable/disable detection of a configuration change in the Active Directory server. Choices:
|
|
Minutes to detect a configuration change in the Active Directory server (5 - 10080 minutes (7 days)). |
|
Enable/disable DNS service lookup. Choices:
|
|
Domain DNS name. |
|
Extra servers. |
|
Server ID. |
|
Domain controller IP address. |
|
Port to be used for communication with the domain controller . |
|
FortiGate IPv4 address to be used for communication with the domain controller. |
|
Source port to be used for communication with the domain controller. |
|
Hostname of the server to connect to. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Domain controller IPv6 address. |
|
Domain controller IPv4 address. |
|
LDAP server name(s). Source user.ldap.name. |
|
LDAP server name. Source user.ldap.name. |
|
Domain controller entry name. |
|
Password for specified username. |
|
Port to be used for communication with the domain controller . |
|
Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discovery. |
|
FortiGate IPv6 address to be used for communication with the domain controller. |
|
FortiGate IPv4 address to be used for communication with the domain controller. |
|
Source port to be used for communication with the domain controller. |
|
User name to sign in with. Must have proper permissions for service. |
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure domain controller entries.
fortios_user_domain_controller:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_domain_controller:
ad_mode: "none"
adlds_dn: "<your_own_value>"
adlds_ip_address: "<your_own_value>"
adlds_ip6: "<your_own_value>"
adlds_port: "389"
change_detection: "enable"
change_detection_period: "60"
dns_srv_lookup: "enable"
domain_name: "<your_own_value>"
extra_server:
-
id: "13"
ip_address: "<your_own_value>"
port: "445"
source_ip_address: "<your_own_value>"
source_port: "0"
hostname: "myhostname"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip_address: "<your_own_value>"
ip6: "<your_own_value>"
ldap_server:
-
name: "default_name_24 (source user.ldap.name)"
name: "default_name_25"
password: "<your_own_value>"
port: "445"
replication_port: "0"
source_ip_address: "<your_own_value>"
source_ip6: "<your_own_value>"
source_port: "0"
username: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |