fortios_user_setting – Configure user authentication setting in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_user_setting – Configure user authentication setting in Fortinet’s FortiOS and FortiGate

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- 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

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
user_setting dictionary | Default: null | Configure user authentication setting.
| auth_blackout_time integer |  | Time in seconds an IP address is denied access after failing to authenticate five times within one minute.
| auth_ca_cert string |  | HTTPS CA certificate for policy authentication. Source vpn.certificate.local.name.
| auth_cert string |  | HTTPS server certificate for policy authentication. Source vpn.certificate.local.name.
| auth_http_basic string | Choices: enable disable | Enable/disable use of HTTP basic authentication for identity-based firewall policies.
| auth_invalid_max integer |  | Maximum number of failed authentication attempts before the user is blocked.
| auth_lockout_duration integer |  | Lockout period in seconds after too many login failures.
| auth_lockout_threshold integer |  | Maximum number of failed login attempts before login lockout is triggered.
| auth_portal_timeout integer |  | Time in minutes before captive portal user have to re-authenticate (1 - 30 min).
| auth_ports list |  | Set up non-standard ports for authentication with HTTP, HTTPS, FTP, and TELNET.
|  | id integer / required |  | ID.
|  | port integer |  | Non-standard port for firewall user authentication.
|  | type string | Choices: http https ftp telnet | Service type.
| auth_secure_http string | Choices: enable disable | Enable/disable redirecting HTTP user authentication to more secure HTTPS.
| auth_src_mac string | Choices: enable disable | Enable/disable source MAC for user identity.
| auth_ssl_allow_renegotiation string | Choices: enable disable | Allow/forbid SSL re-negotiation for HTTPS authentication.
| auth_timeout integer |  | Time in minutes before the firewall user authentication timeout requires the user to re-authenticate.
| auth_timeout_type string | Choices: idle-timeout hard-timeout new-session | Control if authenticated users have to login again after a hard timeout, after an idle timeout, or after a session timeout.
| auth_type string | Choices: http https ftp telnet | Supported firewall policy authentication protocols/methods.
| radius_ses_timeout_act string | Choices: hard-timeout ignore-timeout | Set the RADIUS session timeout to a hard timeout or to ignore RADIUS server session timeouts.
username string |  | FortiOS or FortiGate username.
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

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - 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"

## 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.