fortinet.fortimanager.fmgr_pkg_authentication_setting module – Configure authentication setting.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Active authentication method |
|
Enable/disable redirecting HTTP user authentication to HTTPS. Choices:
|
|
Captive portal host name. |
|
IPv6 captive portal host name. |
|
Captive portal IP address. |
|
Captive portal IPv6 address. |
|
Captive portal port number |
|
Captive portal SSL port number |
|
Captive portal type. Choices:
|
|
Enable/disable redirecting certificate authentication to HTTPS portal. Choices:
|
|
Certificate captive portal host name. |
|
Certificate captive portal IP address. |
|
Certificate captive portal port number |
|
Persistent web portal cookie maximum age in minutes |
|
Refresh rate divider of persistent web portal cookie |
|
(list or str) Address range for the IP based device query. |
|
Enable/disable persistent cookie on IP based web portal authentication Choices:
|
|
Enable/disable persistent cookie on web portal authentication Choices:
|
|
Rewrite to HTTPS port |
|
Single-Sign-On authentication method |
|
Time of the last update. |
|
(list or str) CA certificate used for client certificate verification. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |