fmgr_pkg_authentication_setting – Configure authentication setting.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
pkg_authentication_setting | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_authentication_setting - no description type: dict
- active-auth-scheme - Active authentication method (scheme name). type: str more...
- auth-https - Enable/disable redirecting HTTP user authentication to HTTPS. type: str choices: [disable, enable] more...
- captive-portal - Captive portal host name. type: str more...
- captive-portal-ip - Captive portal IP address. type: str more...
- captive-portal-ip6 - Captive portal IPv6 address. type: str more...
- captive-portal-port - Captive portal port number (1 - 65535, default = 7830). type: int more...
- captive-portal-ssl-port - Captive portal SSL port number (1 - 65535, default = 7831). type: int more...
- captive-portal-type - Captive portal type. type: str choices: [fqdn, ip] more...
- captive-portal6 - IPv6 captive portal host name. type: str more...
- rewrite-https-port - Rewrite to HTTPS port (0 - 65535, default = 0). type: int more...
- sso-auth-scheme - Single-Sign-On authentication method (scheme name). type: str more...
- dev-range - Address range for the IP based device query. type: str more...
- user-cert-ca - CA certificate used for client certificate verification. type: str more...
- cert-auth - Enable/disable redirecting certificate authentication to HTTPS portal. type: str choices: [disable, enable] more...
- cert-captive-portal - Certificate captive portal host name. type: str more...
- cert-captive-portal-ip - Certificate captive portal IP address. type: str more...
- cert-captive-portal-port - Certificate captive portal port number (1 - 65535, default = 7832). type: int more...
- cookie-max-age - Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week), default = 480 (8 hours)). type: int more...
- cookie-refresh-div - Refresh rate divider of persistent web portal cookie (default = 2). type: int more...
- ip-auth-cookie - Enable/disable persistent cookie on IP based web portal authentication (default = disable). type: str choices: [disable, enable] more...
- persistent-cookie - Enable/disable persistent cookie on web portal authentication (default = enable). type: str choices: [disable, enable] more...
- update-time - Time of the last update. type: str 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
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: <value of string>
auth-https: <value in [disable, enable]>
captive-portal: <value of string>
captive-portal-ip: <value of string>
captive-portal-ip6: <value of string>
captive-portal-port: <value of integer>
captive-portal-ssl-port: <value of integer>
captive-portal-type: <value in [fqdn, ip]>
captive-portal6: <value of string>
rewrite-https-port: <value of integer>
sso-auth-scheme: <value of string>
dev-range: <value of string>
user-cert-ca: <value of string>
cert-auth: <value in [disable, enable]>
cert-captive-portal: <value of string>
cert-captive-portal-ip: <value of string>
cert-captive-portal-port: <value of integer>
cookie-max-age: <value of integer>
cookie-refresh-div: <value of integer>
ip-auth-cookie: <value in [disable, enable]>
persistent-cookie: <value in [disable, enable]>
update-time: <value of 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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict