fmgd_user_setting – Configure user authentication setting.
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- user_setting - Configure user authentication setting. type: dict
- auth_blackout_time (Alias name: auth-blackout-time) Time in seconds an ip address is denied access after failing to authenticate five times within one minute. type: int more...
- auth_ca_cert (Alias name: auth-ca-cert) Https ca certificate for policy authentication. type: list more...
- auth_cert (Alias name: auth-cert) Https server certificate for policy authentication. type: list more...
- auth_http_basic (Alias name: auth-http-basic) Enable/disable use of http basic authentication for identity-based firewall policies. type: str choices: [disable, enable] more...
- auth_invalid_max (Alias name: auth-invalid-max) Maximum number of failed authentication attempts before the user is blocked. type: int more...
- auth_lockout_duration (Alias name: auth-lockout-duration) Lockout period in seconds after too many login failures. type: int more...
- auth_lockout_threshold (Alias name: auth-lockout-threshold) Maximum number of failed login attempts before login lockout is triggered. type: int more...
- auth_on_demand (Alias name: auth-on-demand) Always/implicitly trigger firewall authentication on demand. type: str choices: [always, implicitly] more...
- auth_portal_timeout (Alias name: auth-portal-timeout) Time in minutes before captive portal user have to re-authenticate (1 - 30 min, default 3 min). type: int more...
- auth_ports (Alias name: auth-ports) Auth ports. type: list more...
- auth_secure_http (Alias name: auth-secure-http) Enable/disable redirecting http user authentication to more secure https. type: str choices: [disable, enable] more...
- auth_src_mac (Alias name: auth-src-mac) Enable/disable source mac for user identity. type: str choices: [disable, enable] more...
- auth_ssl_allow_renegotiation (Alias name: auth-ssl-allow-renegotiation) Allow/forbid ssl re-negotiation for https authentication. type: str choices: [disable, enable] more...
- auth_ssl_max_proto_version (Alias name: auth-ssl-max-proto-version) Maximum supported protocol version for ssl/tls connections (default is no limit). type: str choices: [tlsv1-1, tlsv1-2, sslv3, tlsv1, tlsv1-3] more...
- auth_ssl_min_proto_version (Alias name: auth-ssl-min-proto-version) Minimum supported protocol version for ssl/tls connections (default is to follow system global setting). type: str choices: [default, TLSv1-1, TLSv1-2, SSLv3, TLSv1, TLSv1-3] more...
- auth_ssl_sigalgs (Alias name: auth-ssl-sigalgs) Set signature algorithms related to https authentication (affects tls version <= 1. type: str choices: [no-rsa-pss, all] more...
- auth_timeout (Alias name: auth-timeout) Time in minutes before the firewall user authentication timeout requires the user to re-authenticate. type: int more...
- auth_timeout_type (Alias name: 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...
- auth_type (Alias name: auth-type) Supported firewall policy authentication protocols/methods. type: list choices: [http, https, ftp, telnet] more...
- default_user_password_policy (Alias name: default-user-password-policy) Default password policy to apply to all local users unless otherwise specified, as defined in config user password-policy. type: list more...
- per_policy_disclaimer (Alias name: per-policy-disclaimer) Enable/disable per policy disclaimer. type: str choices: [disable, enable] more...
- radius_ses_timeout_act (Alias name: 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...
- cors Enable/disable allowed origins white list for cors. type: str choices: [disable, enable] more...
- cors_allowed_origins (Alias name: cors-allowed-origins) Allowed origins white list for cors. type: list more...
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure user authentication setting.
fortinet.fmgdevice.fmgd_user_setting:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
user_setting:
# auth_blackout_time: <integer>
# auth_ca_cert: <list or string>
# auth_cert: <list or string>
# auth_http_basic: <value in [disable, enable]>
# auth_invalid_max: <integer>
# auth_lockout_duration: <integer>
# auth_lockout_threshold: <integer>
# auth_on_demand: <value in [always, implicitly]>
# auth_portal_timeout: <integer>
# auth_ports:
# - id: <integer>
# port: <integer>
# type: <value in [http, https, ftp, ...]>
# auth_secure_http: <value in [disable, enable]>
# auth_src_mac: <value in [disable, enable]>
# auth_ssl_allow_renegotiation: <value in [disable, enable]>
# auth_ssl_max_proto_version: <value in [tlsv1-1, tlsv1-2, sslv3, ...]>
# auth_ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
# auth_ssl_sigalgs: <value in [no-rsa-pss, all]>
# auth_timeout: <integer>
# auth_timeout_type: <value in [idle-timeout, hard-timeout, new-session]>
# auth_type:
# - "http"
# - "https"
# - "ftp"
# - "telnet"
# default_user_password_policy: <list or string>
# per_policy_disclaimer: <value in [disable, enable]>
# radius_ses_timeout_act: <value in [hard-timeout, ignore-timeout]>
# cors: <value in [disable, enable]>
# cors_allowed_origins: <list or string>
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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.