fortinet.fortios.fortios_web_proxy_global – Configure Web proxy global settings in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_web_proxy_global.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| vdom
string
|
Default:
"root"
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.
|
||
| web_proxy_global
dictionary
|
Configure Web proxy global settings.
|
|||
| fast_policy_match
string
|
|
Enable/disable fast matching algorithm for explicit and transparent proxy policy.
|
||
| forward_proxy_auth
string
|
|
Enable/disable forwarding proxy authentication headers.
|
||
| forward_server_affinity_timeout
integer
|
Period of time before the source IP"s traffic is no longer assigned to the forwarding server (6 - 60 min).
|
|||
| learn_client_ip
string
|
|
Enable/disable learning the client"s IP address from headers.
|
||
| learn_client_ip_from_header
list / elements=string
|
|
Learn client IP address from the specified headers.
|
||
| learn_client_ip_srcaddr
list / elements=string
|
Source address name (srcaddr or srcaddr6 must be set).
|
|||
| name
string / required
|
Address name. Source firewall.address.name firewall.addrgrp.name.
|
|||
| learn_client_ip_srcaddr6
list / elements=string
|
IPv6 Source address name (srcaddr or srcaddr6 must be set).
|
|||
| name
string / required
|
Address name. Source firewall.address6.name firewall.addrgrp6.name.
|
|||
| max_message_length
integer
|
Maximum length of HTTP message, not including body (16 - 256 Kbytes).
|
|||
| max_request_length
integer
|
Maximum length of HTTP request line (2 - 64 Kbytes).
|
|||
| max_waf_body_cache_length
integer
|
Maximum length of HTTP messages processed by Web Application Firewall (WAF) (10 - 1024 Kbytes).
|
|||
| proxy_fqdn
string
|
Fully Qualified Domain Name (FQDN) that clients connect to to connect to the explicit web proxy.
|
|||
| src_affinity_exempt_addr
string
|
IPv4 source addresses to exempt proxy affinity.
|
|||
| src_affinity_exempt_addr6
string
|
IPv6 source addresses to exempt proxy affinity.
|
|||
| ssl_ca_cert
string
|
SSL CA certificate for SSL interception. Source vpn.certificate.local.name.
|
|||
| ssl_cert
string
|
SSL certificate for SSL interception. Source vpn.certificate.local.name.
|
|||
| strict_web_check
string
|
|
Enable/disable strict web checking to block web sites that send incorrect headers that don"t conform to HTTP 1.1.
|
||
| tunnel_non_http
string
|
|
Enable/disable allowing non-HTTP traffic. Allowed non-HTTP traffic is tunneled.
|
||
| unknown_http_version
string
|
|
Action to take when an unknown version of HTTP is encountered: reject, allow (tunnel), or proceed with best-effort.
|
||
| webproxy_profile
string
|
Name of the web proxy profile to apply when explicit proxy traffic is allowed by default and traffic is accepted that does not match an explicit proxy policy. Source web-proxy.profile.name.
|
|||
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Web proxy global settings.
fortios_web_proxy_global:
vdom: "{{ vdom }}"
web_proxy_global:
fast_policy_match: "enable"
forward_proxy_auth: "enable"
forward_server_affinity_timeout: "5"
learn_client_ip: "enable"
learn_client_ip_from_header: "true-client-ip"
learn_client_ip_srcaddr:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
learn_client_ip_srcaddr6:
-
name: "default_name_11 (source firewall.address6.name firewall.addrgrp6.name)"
max_message_length: "12"
max_request_length: "13"
max_waf_body_cache_length: "14"
proxy_fqdn: "<your_own_value>"
src_affinity_exempt_addr: "<your_own_value>"
src_affinity_exempt_addr6: "<your_own_value>"
ssl_ca_cert: "<your_own_value> (source vpn.certificate.local.name)"
ssl_cert: "<your_own_value> (source vpn.certificate.local.name)"
strict_web_check: "enable"
tunnel_non_http: "enable"
unknown_http_version: "reject"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_web_proxy_global_module.html