fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy module – Configure 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_proxypolicy
.
New in fortinet.fortimanager 2.0.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. |
|
Assigned policy block. |
|
(list or str) Access Proxy. |
|
(list or str) IPv6 access proxy. |
|
Accept or deny traffic matching the policy parameters. Choices:
|
|
Name of an existing Application list. |
|
Name of an existing Antivirus profile. |
|
Enable/disable block notification. Choices:
|
|
Name of an existing CASB profile. |
|
Name of an existing CIFS profile. |
|
Optional comments. |
|
Decrypted traffic mirror. |
|
Enable/disable detection of HTTPS in HTTP request. Choices:
|
|
When enabled, the ownership enforcement will be done at policy level. Choices:
|
|
Name of an existing Diameter filter profile. |
|
Web proxy disclaimer setting Choices:
|
|
Name of an existing DLP profile. |
|
Name of an existing DLP sensor. |
|
(list) Name of an existing DNS filter profile. |
|
(list or str) Destination address objects. |
|
(list or str) IPv6 destination address objects. |
|
When enabled, destination addresses match against any address EXCEPT the specified destination addresses. Choices:
|
|
(list or str) Destination interface names. |
|
Name of an existing email filter profile. |
|
Name of an existing file-filter profile. |
|
Global web-based manager visible label. |
|
(list or str) Names of group objects. |
|
Enable/disable HTTP tunnel authentication. Choices:
|
|
Name of an existing ICAP profile. |
|
Enable/disable use of Internet Services for this policy. Choices:
|
|
Enable/disable use of Internet Services IPv6 for this policy. Choices:
|
|
(list) Custom Internet Service IPv6 name. |
|
(list) Custom Internet Service IPv6 group name. |
|
(list) Internet Service IPv6 group name. |
|
(list) Internet Service IPv6 name. |
|
When enabled, Internet Services match against any internet service IPv6 EXCEPT the selected Internet Service IPv6. Choices:
|
|
(list or str) Custom Internet Service name. |
|
(list or str) Custom Internet Service group name. |
|
(list or str) Internet Service group name. |
|
(list or str) Internet Service ID. |
|
(list or str) Internet Service name. |
|
When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service. Choices:
|
|
Name of an existing IPS sensor. |
|
Name of an existing VoIP |
|
VDOM-specific GUI visible label. |
|
Enable/disable HTTP transaction log. Choices:
|
|
Enable/disable logging traffic through the policy. Choices:
|
|
Enable/disable policy log traffic start. Choices:
|
|
Name of an existing MMS profile. |
|
Policy name. |
|
Policy ID. |
|
(list or str) Name of IP pool object. |
|
Name of profile group. |
|
Name of an existing Protocol options profile. |
|
Determine whether the firewall policy allows security profile groups or single profiles only. Choices:
|
|
Type of explicit proxy. Choices:
|
|
Redirect URL for further explicit web proxy processing. |
|
Authentication replacement message override group. |
|
Enable/disable scanning of connections to Botnet servers. Choices:
|
|
Name of schedule object. |
|
Name of an existing SCTP filter profile. |
|
(list or str) Name of service objects. |
|
When enabled, services match against any service EXCEPT the specified destination services. Choices:
|
|
(int or str) TTL in seconds for sessions accepted by this policy |
|
Name of an existing Spam filter profile. |
|
(list or str) Source address objects |
|
(list or str) IPv6 source address objects. |
|
When enabled, source addresses match against any address EXCEPT the specified source addresses. Choices:
|
|
(list or str) Source interface names. |
|
Name of an existing SSH filter profile. |
|
Redirect SSH traffic to matching transparent proxy policy. Choices:
|
|
Name of an existing SSL SSH profile. |
|
Enable/disable the active status of the policy. Choices:
|
|
Names of object-tags applied to address. |
|
Enable to use the IP address of the client to connect to the server. Choices:
|
|
(list or str) Names of user objects. |
|
Enable the use of UTM profiles/sensors/lists. Choices:
|
|
Universally Unique Identifier |
|
Name of an existing VideoFilter profile. |
|
Virtual patch profile. |
|
Name of an existing VoIP profile. |
|
Name of an existing Web application firewall profile. |
|
Enable/disable web caching. Choices:
|
|
Enable/disable web caching for HTTPS Choices:
|
|
Name of an existing Web filter profile. |
|
Name of web proxy forward server. |
|
Name of web proxy profile. |
|
(list or str) ZTNA EMS Tag names. |
|
(list) IPv4 ZTNA traffic forward proxy. |
|
ZTNA tag matching logic. Choices:
|
|
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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure proxy policies.
fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy:
bypass_validation: false
adom: ansible
pkg: ansible # package name
state: present
pkg_firewall_proxypolicy:
action: accept # <value in [accept, deny, redirect]>
comments: ansible-comment
dstaddr: all
dstintf: any
policyid: 1
schedule: always
service: ALL
srcaddr: all
srcintf: any
status: disable
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the proxy policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_firewall_proxypolicy"
params:
adom: "ansible"
proxy-policy: "your_value"
pkg: "ansible" # package name
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 |