fortinet.fortios.fortios_web_proxy_explicit module – Configure explicit Web proxy settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_web_proxy_explicit
.
New in fortinet.fortios 2.0.0
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 explicit 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: |
|
Configure explicit Web proxy settings. |
|
Enable/disable to request client certificate. Choices:
|
|
Action of an empty client certificate. Choices:
|
|
Accept incoming FTP-over-HTTP requests on one or more ports (0 - 65535). |
|
Enable to proxy FTP-over-HTTP sessions sent from a web browser. Choices:
|
|
HTTP connection mode . Choices:
|
|
Accept incoming HTTP requests on one or more ports (0 - 65535). |
|
Accept incoming HTTPS requests on one or more ports (0 - 65535). |
|
Enable/disable sending the client a replacement message for HTTPS requests. Choices:
|
|
Restrict the explicit HTTP proxy to only accept sessions from this IP address. An interface must have this IP address. |
|
Restrict the explicit web proxy to only accept sessions from this IPv6 address. An interface must have this IPv6 address. |
|
Enable/disable allowing an IPv6 web proxy destination in policies and all IPv6 related entries in this command. Choices:
|
|
Enable/disable displaying a replacement message when a server error is detected. Choices:
|
|
Outgoing HTTP requests will have this IP address as their source address. An interface must have this IP address. |
|
Outgoing HTTP requests will leave this IPv6. Multiple interfaces can be specified. Interfaces must have these IPv6 addresses. |
|
PAC file contents enclosed in quotes (maximum of 256K bytes). |
|
Pac file name. |
|
Port number that PAC traffic from client web browsers uses to connect to the explicit web proxy (0 - 65535). |
|
Enable/disable Proxy Auto-Configuration (PAC) for users of this explicit proxy profile. Choices:
|
|
Enable/disable to get Proxy Auto-Configuration (PAC) through HTTPS. Choices:
|
|
PAC file access URL. |
|
PAC policies. |
|
Optional comments. |
|
Destination address objects. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
PAC file contents enclosed in quotes (maximum of 256K bytes). |
|
Pac file name. |
|
Policy ID. see <a href=’#notes’>Notes</a>. |
|
Source address objects. |
|
Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name. |
|
Source address6 objects. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
Enable/disable policy. Choices:
|
|
Prefer resolving addresses using the configured IPv4 or IPv6 DNS server . Choices:
|
|
Authentication realm used to identify the explicit web proxy (maximum of 63 characters). |
|
Accept or deny explicit web proxy sessions when no web proxy firewall policy exists. Choices:
|
|
Enable/disable/require the secure web proxy for HTTP and HTTPS session. Choices:
|
|
Name of certificates for secure web proxy. |
|
Certificate list. Source vpn.certificate.local.name. |
|
Enable/disable the SOCKS proxy. Choices:
|
|
Accept incoming SOCKS proxy requests on one or more ports (0 - 65535). |
|
Relative strength of encryption algorithms accepted in HTTPS deep scan: high, medium, or low. Choices:
|
|
Bit-size of Diffie-Hellman (DH) prime used in DHE-RSA negotiation . Choices:
|
|
Enable/disable the explicit Web proxy for HTTP and HTTPS session. Choices:
|
|
Enable/disable strict guest user checking by the explicit web proxy. Choices:
|
|
Enable/disable logging timed-out authentication requests. Choices:
|
|
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. Choices:
|
|
Enable/disable to detect device type by HTTP user-agent if no client certificate provided. Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure explicit Web proxy settings.
fortinet.fortios.fortios_web_proxy_explicit:
vdom: "{{ vdom }}"
web_proxy_explicit:
client_cert: "disable"
empty_cert_action: "accept"
ftp_incoming_port: "<your_own_value>"
ftp_over_http: "enable"
http_connection_mode: "static"
http_incoming_port: "<your_own_value>"
https_incoming_port: "<your_own_value>"
https_replacement_message: "enable"
incoming_ip: "<your_own_value>"
incoming_ip6: "<your_own_value>"
ipv6_status: "enable"
message_upon_server_error: "enable"
outgoing_ip: "<your_own_value>"
outgoing_ip6: "<your_own_value>"
pac_file_data: "<your_own_value>"
pac_file_name: "<your_own_value>"
pac_file_server_port: "<your_own_value>"
pac_file_server_status: "enable"
pac_file_through_https: "enable"
pac_file_url: "<your_own_value>"
pac_policy:
-
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_26 (source firewall.address.name firewall.addrgrp.name)"
pac_file_data: "<your_own_value>"
pac_file_name: "<your_own_value>"
policyid: "<you_own_value>"
srcaddr:
-
name: "default_name_31 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
srcaddr6:
-
name: "default_name_33 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
pref_dns_result: "ipv4"
realm: "<your_own_value>"
sec_default_action: "accept"
secure_web_proxy: "disable"
secure_web_proxy_cert:
-
name: "default_name_40 (source vpn.certificate.local.name)"
socks: "enable"
socks_incoming_port: "<your_own_value>"
ssl_algorithm: "high"
ssl_dh_bits: "768"
status: "enable"
strict_guest: "enable"
trace_auth_no_rsp: "enable"
unknown_http_version: "reject"
user_agent_detect: "disable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |