fmgr_pkg_authentication_rule – Configure Authentication Rules.¶
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 |
|
| pkg_authentication_rule | 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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_authentication_rule - Configure Authentication Rules. type: dict
- active-auth-method - Select an active authentication method. type: str more...
- comments - Comment. type: str more...
- ip-based - Enable/disable IP-based authentication. type: str choices: [disable, enable] more...
- name - Authentication rule name. type: str more...
- protocol - Select the protocol to use for authentication (default = http). type: str choices: [http, ftp, socks, ssh] more...
- srcaddr - Select an IPv4 source address from available options. type: str more...
- srcaddr6 - Select an IPv6 source address. type: str more...
- sso-auth-method - Select a single-sign on (SSO) authentication method. type: str more...
- status - Enable/disable this authentication rule. type: str choices: [disable, enable] more...
- transaction-based - Enable/disable transaction based authentication (default = disable). type: str choices: [disable, enable] more...
- web-auth-cookie - Enable/disable Web authentication cookies (default = disable). type: str choices: [disable, enable] more...
- web-portal - Enable/disable web portal for proxy transparent policy (default = enable). type: str choices: [disable, enable] more...
- dstaddr - Select an IPv4 destination address from available options. type: str more...
- dstaddr6 - Select an IPv6 destination address from available options. type: str more...
- srcintf - Incoming (ingress) interface. 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: Configure Authentication Rules.
fmgr_pkg_authentication_rule:
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>
state: <value in [present, absent]>
pkg_authentication_rule:
active-auth-method: <value of string>
comments: <value of string>
ip-based: <value in [disable, enable]>
name: <value of string>
protocol: <value in [http, ftp, socks, ...]>
srcaddr: <value of string>
srcaddr6: <value of string>
sso-auth-method: <value of string>
status: <value in [disable, enable]>
transaction-based: <value in [disable, enable]>
web-auth-cookie: <value in [disable, enable]>
web-portal: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr6: <value of string>
srcintf: <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