Try SpotterConfigure user authentication setting in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure user authentication setting.
fortios_user_setting:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
user_setting:
auth_blackout_time: "3"
auth_ca_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_http_basic: "enable"
auth_invalid_max: "7"
auth_lockout_duration: "8"
auth_lockout_threshold: "9"
auth_portal_timeout: "10"
auth_ports:
-
id: "12"
port: "13"
type: "http"
auth_secure_http: "enable"
auth_src_mac: "enable"
auth_ssl_allow_renegotiation: "enable"
auth_timeout: "18"
auth_timeout_type: "idle-timeout"
auth_type: "http"
radius_ses_timeout_act: "hard-timeout"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
vdom:
default: root
description:
- 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
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
user_setting:
default: null
description:
- Configure user authentication setting.
suboptions:
auth_blackout_time:
description:
- Time in seconds an IP address is denied access after failing to authenticate
five times within one minute.
type: int
auth_ca_cert:
description:
- HTTPS CA certificate for policy authentication. Source vpn.certificate.local.name.
type: str
auth_cert:
description:
- HTTPS server certificate for policy authentication. Source vpn.certificate.local.name.
type: str
auth_http_basic:
choices:
- enable
- disable
description:
- Enable/disable use of HTTP basic authentication for identity-based firewall
policies.
type: str
auth_invalid_max:
description:
- Maximum number of failed authentication attempts before the user is blocked.
type: int
auth_lockout_duration:
description:
- Lockout period in seconds after too many login failures.
type: int
auth_lockout_threshold:
description:
- Maximum number of failed login attempts before login lockout is triggered.
type: int
auth_portal_timeout:
description:
- Time in minutes before captive portal user have to re-authenticate (1 - 30 min).
type: int
auth_ports:
description:
- Set up non-standard ports for authentication with HTTP, HTTPS, FTP, and TELNET.
suboptions:
id:
description:
- ID.
required: true
type: int
port:
description:
- Non-standard port for firewall user authentication.
type: int
type:
choices:
- http
- https
- ftp
- telnet
description:
- Service type.
type: str
type: list
auth_secure_http:
choices:
- enable
- disable
description:
- Enable/disable redirecting HTTP user authentication to more secure HTTPS.
type: str
auth_src_mac:
choices:
- enable
- disable
description:
- Enable/disable source MAC for user identity.
type: str
auth_ssl_allow_renegotiation:
choices:
- enable
- disable
description:
- Allow/forbid SSL re-negotiation for HTTPS authentication.
type: str
auth_timeout:
description:
- Time in minutes before the firewall user authentication timeout requires the
user to re-authenticate.
type: int
auth_timeout_type:
choices:
- idle-timeout
- hard-timeout
- new-session
description:
- Control if authenticated users have to login again after a hard timeout, after
an idle timeout, or after a session timeout.
type: str
auth_type:
choices:
- http
- https
- ftp
- telnet
description:
- Supported firewall policy authentication protocols/methods.
type: str
radius_ses_timeout_act:
choices:
- hard-timeout
- ignore-timeout
description:
- Set the RADIUS session timeout to a hard timeout or to ignore RADIUS server
session timeouts.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str