fortios_authentication_scheme – Configure Authentication Schemes in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- authentication_scheme - Configure Authentication Schemes. type: dict more...
- domain_controller - Domain controller setting. Source user.domain-controller.name. type: str more...
- ems_device_owner - Enable/disable SSH public-key authentication with device owner . type: str choices: enable, disable more...
- fsso_agent_for_ntlm - FSSO agent to use for NTLM authentication. Source user.fsso.name. type: str more...
- fsso_guest - Enable/disable user fsso-guest authentication . type: str choices: enable, disable more...
- kerberos_keytab - Kerberos keytab setting. Source user.krb-keytab.name. type: str more...
- method - Authentication methods . type: list choices: ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, cert, saml more...
- name - Authentication scheme name. type: str required: true more...
- negotiate_ntlm - Enable/disable negotiate authentication for NTLM . type: str choices: enable, disable more...
- require_tfa - Enable/disable two-factor authentication . type: str choices: enable, disable more...
- saml_server - SAML configuration. Source user.saml.name. type: str more...
- saml_timeout - SAML authentication timeout in seconds. type: int more...
- ssh_ca - SSH CA name. Source firewall.ssh.local-ca.name. type: str more...
- user_cert - Enable/disable authentication with user certificate . type: str choices: enable, disable more...
- user_database - Authentication server to contain user information; "local" (default) or "123" (for LDAP). type: list member_path: user_database:name more...
- name - Authentication server name. Source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.name. type: str required: true more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure Authentication Schemes.
fortinet.fortios.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: "120"
ssh_ca: "<your_own_value> (source firewall.ssh.local-ca.name)"
user_cert: "enable"
user_database:
-
name: "default_name_17 (source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.name)"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.