fortinet.fortios.fortios_authentication_scheme – Configure Authentication Schemes in Fortinet’s FortiOS and FortiGate.

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_authentication_scheme.

New in version 2.10: of fortinet.fortios

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify authentication feature and scheme 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.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
authentication_scheme dictionary				Configure Authentication Schemes.
	domain_controller string			Domain controller setting. Source user.domain-controller.name.
	ems_device_owner string		Choices: enable disable	Enable/disable SSH public-key authentication with device owner .
	fsso_agent_for_ntlm string			FSSO agent to use for NTLM authentication. Source user.fsso.name.
	fsso_guest string		Choices: enable disable	Enable/disable user fsso-guest authentication .
	kerberos_keytab string			Kerberos keytab setting. Source user.krb-keytab.name.
	method list / elements=string		Choices: ntlm basic digest form negotiate fsso rsso ssh-publickey cert saml	Authentication methods .
	name string / required			Authentication scheme name.
	negotiate_ntlm string		Choices: enable disable	Enable/disable negotiate authentication for NTLM .
	require_tfa string		Choices: enable disable	Enable/disable two-factor authentication .
	saml_server string			SAML configuration. Source user.saml.name.
	saml_timeout integer			SAML authentication timeout in seconds.
	ssh_ca string			SSH CA name. Source firewall.ssh.local-ca.name.
	user_database list / elements=string			Authentication server to contain user information; "local" (default) or "123" (for LDAP).
		name string / required		Authentication server name. Source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.name.
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
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.

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 Authentication Schemes.
    fortios_authentication_scheme:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      authentication_scheme:
        domain_controller: "<your_own_value> (source user.domain-controller.name)"
        ems_device_owner: "enable"
        fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
        fsso_guest: "enable"
        kerberos_keytab: "<your_own_value> (source user.krb-keytab.name)"
        method: "ntlm"
        name: "default_name_9"
        negotiate_ntlm: "enable"
        require_tfa: "enable"
        saml_server: "<your_own_value> (source user.saml.name)"
        saml_timeout: "13"
        ssh_ca: "<your_own_value> (source firewall.ssh.local-ca.name)"
        user_database:
         -
            name: "default_name_16 (source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.name)"

Return Values

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

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 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_authentication_scheme_module.html

Docs

Docs4dev

Title here