fortinet.fortimanager.fmgr_pkg_authentication_setting module – Configure authentication setting.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_authentication_setting.

New in fortinet.fortimanager 2.1.0

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
pkg string / required	The parameter (pkg) in requested url.
pkg_authentication_setting dictionary	The top level parameters set.
active-auth-scheme string	Deprecated, please rename it to active_auth_scheme. Active authentication method
auth-https string	Deprecated, please rename it to auth_https. Enable/disable redirecting HTTP user authentication to HTTPS. Choices: "disable" "enable"
captive-portal string	Deprecated, please rename it to captive_portal. Captive portal host name.
captive-portal-ip string	Deprecated, please rename it to captive_portal_ip. Captive portal IP address.
captive-portal-ip6 string	Deprecated, please rename it to captive_portal_ip6. Captive portal IPv6 address.
captive-portal-port integer	Deprecated, please rename it to captive_portal_port. Captive portal port number
captive-portal-ssl-port integer	Deprecated, please rename it to captive_portal_ssl_port. Captive portal SSL port number
captive-portal-type string	Deprecated, please rename it to captive_portal_type. Captive portal type. Choices: "fqdn" "ip"
captive-portal6 string	Deprecated, please rename it to captive_portal6. IPv6 captive portal host name.
cert-auth string	Deprecated, please rename it to cert_auth. Enable/disable redirecting certificate authentication to HTTPS portal. Choices: "disable" "enable"
cert-captive-portal string	Deprecated, please rename it to cert_captive_portal. Certificate captive portal host name.
cert-captive-portal-ip string	Deprecated, please rename it to cert_captive_portal_ip. Certificate captive portal IP address.
cert-captive-portal-port integer	Deprecated, please rename it to cert_captive_portal_port. Certificate captive portal port number
cookie-max-age integer	Deprecated, please rename it to cookie_max_age. Persistent web portal cookie maximum age in minutes
cookie-refresh-div integer	Deprecated, please rename it to cookie_refresh_div. Refresh rate divider of persistent web portal cookie
dev-range any	(list or str) Deprecated, please rename it to dev_range. Address range for the IP based device query.
ip-auth-cookie string	Deprecated, please rename it to ip_auth_cookie. Enable/disable persistent cookie on IP based web portal authentication Choices: "disable" "enable"
persistent-cookie string	Deprecated, please rename it to persistent_cookie. Enable/disable persistent cookie on web portal authentication Choices: "disable" "enable"
rewrite-https-port integer	Deprecated, please rename it to rewrite_https_port. Rewrite to HTTPS port
sso-auth-scheme string	Deprecated, please rename it to sso_auth_scheme. Single-Sign-On authentication method
update-time string	Deprecated, please rename it to update_time. Time of the last update.
user-cert-ca any	(list or str) Deprecated, please rename it to user_cert_ca. CA certificate used for client certificate verification.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

• 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure authentication setting.
      fortinet.fortimanager.fmgr_pkg_authentication_setting:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg: <your own value>
        pkg_authentication_setting:
          active_auth_scheme: <string>
          auth_https: <value in [disable, enable]>
          captive_portal: <string>
          captive_portal_ip: <string>
          captive_portal_ip6: <string>
          captive_portal_port: <integer>
          captive_portal_ssl_port: <integer>
          captive_portal_type: <value in [fqdn, ip]>
          captive_portal6: <string>
          rewrite_https_port: <integer>
          sso_auth_scheme: <string>
          dev_range: <list or string>
          user_cert_ca: <list or string>
          cert_auth: <value in [disable, enable]>
          cert_captive_portal: <string>
          cert_captive_portal_ip: <string>
          cert_captive_portal_port: <integer>
          cookie_max_age: <integer>
          cookie_refresh_div: <integer>
          ip_auth_cookie: <value in [disable, enable]>
          persistent_cookie: <value in [disable, enable]>
          update_time: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)