fortios_user_setting.rst

source:	fortios_user_setting.py
orphan:

fortios_user_setting -- Configure user authentication setting in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Requirements

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

• ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_user_setting	v6.0.0 -> latest

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
• user_setting - Configure user authentication setting. type: dict more...

  	Supported Version Ranges
  user_setting	v6.0.0 -> latest

• auth_blackout_time - Time in seconds an IP address is denied access after failing to authenticate five times within one minute. type: int more...

  	Supported Version Ranges
  auth_blackout_time	v6.0.0 -> latest

• auth_ca_cert - HTTPS CA certificate for policy authentication. Source vpn.certificate.local.name. type: str more...

  	Supported Version Ranges
  auth_ca_cert	v6.0.0 -> latest

• auth_cert - HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. type: str more...

  	Supported Version Ranges
  auth_cert	v6.0.0 -> latest

• auth_http_basic - Enable/disable use of HTTP basic authentication for identity-based firewall policies. type: str choices: enable, disable more...

  	Supported Version Ranges
  auth_http_basic	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• auth_invalid_max - Maximum number of failed authentication attempts before the user is blocked. type: int more...

  	Supported Version Ranges
  auth_invalid_max	v6.0.0 -> latest

• auth_lockout_duration - Lockout period in seconds after too many login failures. type: int more...

  	Supported Version Ranges
  auth_lockout_duration	v6.0.0 -> latest

• auth_lockout_threshold - Maximum number of failed login attempts before login lockout is triggered. type: int more...

  	Supported Version Ranges
  auth_lockout_threshold	v6.0.0 -> latest

• auth_on_demand - Always/implicitly trigger firewall authentication on demand. type: str choices: always, implicitly more...

  	Supported Version Ranges
  auth_on_demand	v6.2.0 -> latest
  [always]	v6.0.0 -> latest
  [implicitly]	v6.0.0 -> latest

• auth_portal_timeout - Time in minutes before captive portal user have to re-authenticate (1 - 30 min). type: int more...

  	Supported Version Ranges
  auth_portal_timeout	v6.0.0 -> latest

• auth_ports - Set up non-standard ports for authentication with HTTP, HTTPS, FTP, and TELNET. type: list member_path: auth_ports:id more...

  	Supported Version Ranges
  auth_ports	v6.0.0 -> latest

• id - ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• port - Non-standard port for firewall user authentication. type: int more...

  	Supported Version Ranges
  port	v6.0.0 -> latest

• type - Service type. type: str choices: http, https, ftp, telnet more...

  	Supported Version Ranges
  type	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [https]	v6.0.0 -> latest
  [ftp]	v6.0.0 -> latest
  [telnet]	v6.0.0 -> latest

• auth_secure_http - Enable/disable redirecting HTTP user authentication to more secure HTTPS. type: str choices: enable, disable more...

  	Supported Version Ranges
  auth_secure_http	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• auth_src_mac - Enable/disable source MAC for user identity. type: str choices: enable, disable more...

  	Supported Version Ranges
  auth_src_mac	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• auth_ssl_allow_renegotiation - Allow/forbid SSL re-negotiation for HTTPS authentication. type: str choices: enable, disable more...

  	Supported Version Ranges
  auth_ssl_allow_renegotiation	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• auth_ssl_max_proto_version - Maximum supported protocol version for SSL/TLS connections . type: str choices: sslv3, tlsv1, tlsv1-1, tlsv1-2, tlsv1-3 more...

  	Supported Version Ranges
  auth_ssl_max_proto_version	v7.0.2 -> latest
  [sslv3]	v6.0.0 -> latest
  [tlsv1]	v6.0.0 -> latest
  [tlsv1-1]	v6.0.0 -> latest
  [tlsv1-2]	v6.0.0 -> latest
  [tlsv1-3]	v6.0.0 -> latest

• auth_ssl_min_proto_version - Minimum supported protocol version for SSL/TLS connections . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3 more...

  	Supported Version Ranges
  auth_ssl_min_proto_version	v6.2.0 -> latest
  [default]	v6.0.0 -> latest
  [SSLv3]	v6.0.0 -> latest
  [TLSv1]	v6.0.0 -> latest
  [TLSv1-1]	v6.0.0 -> latest
  [TLSv1-2]	v6.0.0 -> latest
  [TLSv1-3]	v7.4.1 -> latest

• auth_ssl_sigalgs - Set signature algorithms related to HTTPS authentication (affects TLS version <= 1.2 only). type: str choices: no-rsa-pss, all more...

  	Supported Version Ranges
  auth_ssl_sigalgs	v7.0.2 -> latest
  [no-rsa-pss]	v6.0.0 -> latest
  [all]	v6.0.0 -> latest

• auth_timeout - Time in minutes before the firewall user authentication timeout requires the user to re-authenticate. type: int more...

  	Supported Version Ranges
  auth_timeout	v6.0.0 -> latest

• auth_timeout_type - Control if authenticated users have to login again after a hard timeout, after an idle timeout, or after a session timeout. type: str choices: idle-timeout, hard-timeout, new-session more...

  	Supported Version Ranges
  auth_timeout_type	v6.0.0 -> latest
  [idle-timeout]	v6.0.0 -> latest
  [hard-timeout]	v6.0.0 -> latest
  [new-session]	v6.0.0 -> latest

• auth_type - Supported firewall policy authentication protocols/methods. type: list choices: http, https, ftp, telnet more...

  	Supported Version Ranges
  auth_type	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [https]	v6.0.0 -> latest
  [ftp]	v6.0.0 -> latest
  [telnet]	v6.0.0 -> latest

• default_user_password_policy - Default password policy to apply to all local users unless otherwise specified, as defined in config user password-policy. Source user .password-policy.name. type: str more...

  	Supported Version Ranges
  default_user_password_policy	v7.4.1 -> latest

• per_policy_disclaimer - Enable/disable per policy disclaimer. type: str choices: enable, disable more...

  	Supported Version Ranges
  per_policy_disclaimer	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• radius_ses_timeout_act - Set the RADIUS session timeout to a hard timeout or to ignore RADIUS server session timeouts. type: str choices: hard-timeout, ignore-timeout more...

  	Supported Version Ranges
  radius_ses_timeout_act	v6.0.0 -> latest
  [hard-timeout]	v6.0.0 -> latest
  [ignore-timeout]	v6.0.0 -> latest

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure user authentication setting.
  fortinet.fortios.fortios_user_setting:
      vdom: "{{ vdom }}"
      user_setting:
          auth_blackout_time: "0"
          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: "5"
          auth_lockout_duration: "0"
          auth_lockout_threshold: "3"
          auth_on_demand: "always"
          auth_portal_timeout: "3"
          auth_ports:
              -
                  id: "13"
                  port: "1024"
                  type: "http"
          auth_secure_http: "enable"
          auth_src_mac: "enable"
          auth_ssl_allow_renegotiation: "enable"
          auth_ssl_max_proto_version: "sslv3"
          auth_ssl_min_proto_version: "default"
          auth_ssl_sigalgs: "no-rsa-pss"
          auth_timeout: "5"
          auth_timeout_type: "idle-timeout"
          auth_type: "http"
          default_user_password_policy: "<your_own_value> (source user.password-policy.name)"
          per_policy_disclaimer: "enable"
          radius_ses_timeout_act: "hard-timeout"

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.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.