fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy module – Configure Explicit proxy policies.
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_firewall_explicitproxypolicy
.
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:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Policy action. Choices:
|
|
Active authentication method. Choices:
|
|
Application list. |
|
Antivirus profile. |
|
CASI profile. |
|
Comment. |
|
Web proxy disclaimer setting. Choices:
|
|
DLP sensor. |
|
Destination address name. |
|
IPv6 destination address |
|
Enable/disable negated destination address match. Choices:
|
|
Destination interface name. |
|
Label for global view. |
|
ICAP profile. |
|
Enable/disable identity-based policy. Choices:
|
|
Identity based policy. |
|
Application list. |
|
Antivirus profile. |
|
CASI profile. |
|
Web proxy disclaimer setting. Choices:
|
|
DLP sensor. |
|
Group name. |
|
ICAP profile. |
|
ID. |
|
IPS sensor. |
|
Enable/disable policy log traffic. Choices:
|
|
Enable/disable policy log traffic start. Choices:
|
|
Mms profile |
|
Profile group |
|
Profile protocol options. |
|
Profile type Choices:
|
|
Specify authentication replacement message override group. |
|
Enable/disable scanning of connections to Botnet servers. Choices:
|
|
Schedule name. |
|
Spam filter profile. |
|
SSL SSH Profile. |
|
User name. |
|
Enable AV/web/IPS protection profile. Choices:
|
|
Web application firewall profile. |
|
Web filter profile. |
|
Enable/disable IP-based authentication. Choices:
|
|
IPS sensor. |
|
Label for section view. |
|
Enable/disable policy log traffic. Choices:
|
|
Enable/disable policy log traffic start. Choices:
|
|
Mms profile |
|
Policy ID. |
|
Profile group |
|
Profile protocol options. |
|
Profile type Choices:
|
|
Explicit proxy type. Choices:
|
|
Specify authentication replacement message override group. |
|
Enable/disable requirement of 2-factor authentication. Choices:
|
|
Enable/disable scanning of connections to Botnet servers. Choices:
|
|
Schedule name. |
|
Service name. |
|
Enable/disable negated service match. Choices:
|
|
Spam filter profile. |
|
Source address name. |
|
IPv6 source address |
|
Enable/disable negated source address match. Choices:
|
|
SSL SSH Profile. |
|
SSO authentication method. Choices:
|
|
Enable/disable policy status. Choices:
|
|
Applied object tags. |
|
Enable/disable transaction based authentication. Choices:
|
|
Use IP address of client to connect to server. Choices:
|
|
Enable AV/web/IPS protection profile. Choices:
|
|
Universally Unique IDentifier. |
|
Web application firewall profile. |
|
Enable/disable Web authentication cookie. Choices:
|
|
Enable/disable web cache. Choices:
|
|
Enable/disable web cache for HTTPS. Choices:
|
|
Web filter profile. |
|
Web proxy forward server. |
|
Web proxy 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: Configure Explicit proxy policies.
fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy:
# 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: present # <value in [present, absent]>
pkg_firewall_explicitproxypolicy:
action: <value in [deny, accept]>
active_auth_method: <value in [ntlm, basic, digest, ...]>
application_list: <string>
av_profile: <string>
casi_profile: <string>
comments: <string>
disclaimer: <value in [disable, domain, policy, ...]>
dlp_sensor: <string>
dstaddr: <string>
dstaddr_negate: <value in [disable, enable]>
dstaddr6: <string>
dstintf: <string>
global_label: <string>
icap_profile: <string>
identity_based: <value in [disable, enable]>
identity_based_policy:
-
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>
ip_based: <value in [disable, enable]>
ips_sensor: <string>
label: <string>
logtraffic: <value in [disable, all, utm]>
logtraffic_start: <value in [disable, enable]>
mms_profile: <string>
policyid: <integer>
profile_group: <string>
profile_protocol_options: <string>
profile_type: <value in [single, group]>
proxy: <value in [web, ftp, wanopt]>
replacemsg_override_group: <string>
require_tfa: <value in [disable, enable]>
scan_botnet_connections: <value in [disable, block, monitor]>
schedule: <string>
service: <string>
service_negate: <value in [disable, enable]>
spamfilter_profile: <string>
srcaddr: <string>
srcaddr_negate: <value in [disable, enable]>
srcaddr6: <string>
ssl_ssh_profile: <string>
sso_auth_method: <value in [fsso, rsso, none]>
status: <value in [disable, enable]>
tags: <string>
transaction_based: <value in [disable, enable]>
transparent: <value in [disable, enable]>
utm_status: <value in [disable, enable]>
uuid: <string>
waf_profile: <string>
web_auth_cookie: <value in [disable, enable]>
webcache: <value in [disable, enable]>
webcache_https: <value in [disable, any, enable]>
webfilter_profile: <string>
webproxy_forward_server: <string>
webproxy_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 |