ansible / ansible.builtin / v2.8.20 / module / fortios_web_proxy_explicit Configure explicit Web proxy settings in Fortinet's FortiOS and FortiGate. | "added in version" 2.8 of ansible.builtin" Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityansible.builtin.fortios_web_proxy_explicit (v2.8.20) — module
pip
Install with pip install ansible==2.8.20
This module is able to configure a FortiGate or FortiOS 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.2
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" tasks: - name: Configure explicit Web proxy settings. fortios_web_proxy_explicit: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" web_proxy_explicit: ftp-incoming-port: "<your_own_value>" ftp-over-http: "enable" 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-url: "<your_own_value>" pac-policy: - comments: "<your_own_value>" dstaddr: - name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)" pac-file-data: "<your_own_value>" pac-file-name: "<your_own_value>" policyid: "25" srcaddr: - name: "default_name_27 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)" srcaddr6: - name: "default_name_29 (source firewall.address6.name firewall.addrgrp6.name)" status: "enable" pref-dns-result: "ipv4" realm: "<your_own_value>" sec-default-action: "accept" socks: "enable" socks-incoming-port: "<your_own_value>" ssl-algorithm: "low" status: "enable" strict-guest: "enable" trace-auth-no-rsp: "enable" unknown-http-version: "reject"
host: description: - FortiOS or FortiGate ip address. required: true vdom: default: root description: - 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. https: default: true description: - Indicates if the requests towards FortiGate must use HTTPS protocol type: bool password: default: '' description: - FortiOS or FortiGate password. username: description: - FortiOS or FortiGate username. required: true web_proxy_explicit: default: null description: - Configure explicit Web proxy settings. suboptions: ftp-incoming-port: description: - Accept incoming FTP-over-HTTP requests on one or more ports (0 - 65535, default = 0; use the same as HTTP). ftp-over-http: choices: - enable - disable description: - Enable to proxy FTP-over-HTTP sessions sent from a web browser. http-incoming-port: description: - Accept incoming HTTP requests on one or more ports (0 - 65535, default = 8080). https-incoming-port: description: - Accept incoming HTTPS requests on one or more ports (0 - 65535, default = 0, use the same as HTTP). https-replacement-message: choices: - enable - disable description: - Enable/disable sending the client a replacement message for HTTPS requests. incoming-ip: description: - Restrict the explicit HTTP proxy to only accept sessions from this IP address. An interface must have this IP address. incoming-ip6: description: - Restrict the explicit web proxy to only accept sessions from this IPv6 address. An interface must have this IPv6 address. ipv6-status: choices: - enable - disable description: - Enable/disable allowing an IPv6 web proxy destination in policies and all IPv6 related entries in this command. message-upon-server-error: choices: - enable - disable description: - Enable/disable displaying a replacement message when a server error is detected. outgoing-ip: description: - Outgoing HTTP requests will have this IP address as their source address. An interface must have this IP address. outgoing-ip6: description: - Outgoing HTTP requests will leave this IPv6. Multiple interfaces can be specified. Interfaces must have these IPv6 addresses. pac-file-data: description: - PAC file contents enclosed in quotes (maximum of 256K bytes). pac-file-name: description: - Pac file name. pac-file-server-port: description: - Port number that PAC traffic from client web browsers uses to connect to the explicit web proxy (0 - 65535, default = 0; use the same as HTTP). pac-file-server-status: choices: - enable - disable description: - Enable/disable Proxy Auto-Configuration (PAC) for users of this explicit proxy profile. pac-file-url: description: - PAC file access URL. pac-policy: description: - PAC policies. suboptions: comments: description: - Optional comments. dstaddr: description: - Destination address objects. suboptions: name: description: - Address name. Source firewall.address.name firewall.addrgrp.name. required: true pac-file-data: description: - PAC file contents enclosed in quotes (maximum of 256K bytes). pac-file-name: description: - Pac file name. policyid: description: - Policy ID. required: true srcaddr: description: - Source address objects. suboptions: name: description: - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name. required: true srcaddr6: description: - Source address6 objects. suboptions: name: description: - Address name. Source firewall.address6.name firewall.addrgrp6.name. required: true status: choices: - enable - disable description: - Enable/disable policy. pref-dns-result: choices: - ipv4 - ipv6 description: - Prefer resolving addresses using the configured IPv4 or IPv6 DNS server (default = ipv4). realm: description: - Authentication realm used to identify the explicit web proxy (maximum of 63 characters). sec-default-action: choices: - accept - deny description: - Accept or deny explicit web proxy sessions when no web proxy firewall policy exists. socks: choices: - enable - disable description: - Enable/disable the SOCKS proxy. socks-incoming-port: description: - Accept incoming SOCKS proxy requests on one or more ports (0 - 65535, default = 0; use the same as HTTP). ssl-algorithm: choices: - low description: - 'Relative strength of encryption algorithms accepted in HTTPS deep scan: high, medium, or low.' status: choices: - enable - disable description: - Enable/disable the explicit Web proxy for HTTP and HTTPS session. strict-guest: choices: - enable - disable description: - Enable/disable strict guest user checking by the explicit web proxy. trace-auth-no-rsp: choices: - enable - disable description: - Enable/disable logging timed-out authentication requests. unknown-http-version: choices: - reject - best-effort description: - Either reject unknown HTTP traffic as malformed or handle unknown HTTP traffic as best as the proxy server can.
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str