fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy_identitybasedpolicy module – Identity-based policy.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_firewall_explicitproxypolicy_identitybasedpolicy.
New in fortinet.fortimanager 2.2.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:
|
|
Deprecated, please use “explicit_proxy_policy” |
|
The parameter (explicit-proxy-policy) in requested url. |
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Deprecated, please rename it to application_list. Application list. |
|
Deprecated, please rename it to av_profile. Antivirus profile. |
|
Deprecated, please rename it to casi_profile. CASI profile. |
|
Web proxy disclaimer setting. Choices:
|
|
Deprecated, please rename it to dlp_sensor. DLP sensor. |
|
Group name. |
|
Deprecated, please rename it to icap_profile. ICAP profile. |
|
ID. |
|
Deprecated, please rename it to ips_sensor. IPS sensor. |
|
Enable/disable policy log traffic. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Enable/disable policy log traffic start. Choices:
|
|
Deprecated, please rename it to mms_profile. Mms profile |
|
Deprecated, please rename it to profile_group. Profile group |
|
Deprecated, please rename it to profile_protocol_options. Profile protocol options. |
|
Deprecated, please rename it to profile_type. Profile type Choices:
|
|
Deprecated, please rename it to replacemsg_override_group. Specify authentication replacement message override group. |
|
Deprecated, please rename it to scan_botnet_connections. Enable/disable scanning of connections to Botnet servers. Choices:
|
|
Schedule name. |
|
Deprecated, please rename it to spamfilter_profile. Spam filter profile. |
|
Deprecated, please rename it to ssl_ssh_profile. SSL SSH Profile. |
|
User name. |
|
Deprecated, please rename it to utm_status. Enable AV/web/IPS protection profile. Choices:
|
|
Deprecated, please rename it to waf_profile. Web application firewall profile. |
|
Deprecated, please rename it to webfilter_profile. Web filter profile. |
|
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 directive to create, update or delete an object. Choices:
|
|
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.
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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Identity-based policy.
fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy_identitybasedpolicy:
# 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>
explicit_proxy_policy: <your own value>
state: present # <value in [present, absent]>
pkg_firewall_explicitproxypolicy_identitybasedpolicy:
application_list: <string>
av_profile: <string>
casi_profile: <string>
disclaimer: <value in [disable, domain, policy, ...]>
dlp_sensor: <string>
groups: <string>
icap_profile: <string>
id: <integer>
ips_sensor: <string>
logtraffic: <value in [disable, all, utm]>
logtraffic_start: <value in [disable, enable]>
mms_profile: <string>
profile_group: <string>
profile_protocol_options: <string>
profile_type: <value in [single, group]>
replacemsg_override_group: <string>
scan_botnet_connections: <value in [disable, block, monitor]>
schedule: <string>
spamfilter_profile: <string>
ssl_ssh_profile: <string>
users: <string>
utm_status: <value in [disable, enable]>
waf_profile: <string>
webfilter_profile: <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 |