Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_user_domain_controller.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
| enable_log boolean |
| Enable/Disable logging for task. | ||
| state string / required |
| Indicates whether to create or remove the object. | ||
| user_domain_controller dictionary | Configure domain controller entries. | |||
| ad_mode string |
| Set Active Directory mode. | ||
| adlds_dn string | AD LDS distinguished name. | |||
| adlds_ip6 string | AD LDS IPv6 address. | |||
| adlds_ip_address string | AD LDS IPv4 address. | |||
| adlds_port integer | Port number of AD LDS service . | |||
| dns_srv_lookup string |
| Enable/disable DNS service lookup. | ||
| domain_name string | Domain DNS name. | |||
| extra_server list / elements=string | extra servers. | |||
| id integer / required | Server ID. | |||
| ip_address string | Domain controller IP address. | |||
| port integer | Port to be used for communication with the domain controller . | |||
| source_ip_address string | FortiGate IPv4 address to be used for communication with the domain controller. | |||
| source_port integer | Source port to be used for communication with the domain controller. | |||
| hostname string | Hostname of the server to connect to. | |||
| interface string | Specify outgoing interface to reach server. Source system.interface.name. | |||
| interface_select_method string |
| Specify how to select outgoing interface to reach server. | ||
| ip6 string | Domain controller IPv6 address. | |||
| ip_address string | Domain controller IP address. | |||
| ldap_server string | LDAP server name. Source user.ldap.name. | |||
| name string / required | Domain controller entry name. | |||
| password string | Password for specified username. | |||
| port integer | Port to be used for communication with the domain controller . | |||
| replication_port integer | Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discovery. | |||
| source_ip6 string | FortiGate IPv6 address to be used for communication with the domain controller. | |||
| source_ip_address string | FortiGate IPv4 address to be used for communication with the domain controller. | |||
| source_port integer | Source port to be used for communication with the domain controller. | |||
| username string | User name to sign in with. Must have proper permissions for service. | |||
| vdom string | Default: "root" | 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. | ||
Note
- 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: "7"
dns_srv_lookup: "enable"
domain_name: "<your_own_value>"
extra_server:
-
id: "11"
ip_address: "<your_own_value>"
port: "13"
source_ip_address: "<your_own_value>"
source_port: "15"
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: "<your_own_value> (source user.ldap.name)"
name: "default_name_22"
password: "<your_own_value>"
port: "24"
replication_port: "25"
source_ip_address: "<your_own_value>"
source_ip6: "<your_own_value>"
source_port: "28"
username: "<your_own_value>"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build string | always | Build number of the fortigate image Sample: 1547 |
| http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
| http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
| mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
| name string | always | Name of the table used to fulfill the request Sample: urlfilter |
| path string | always | Path of the table used to fulfill the request Sample: webfilter |
| revision string | always | Internal revision number Sample: 17.0.2.10658 |
| serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
| status string | always | Indication of the operation's result Sample: success |
| vdom string | always | Virtual domain used Sample: root |
| version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_domain_controller_module.html