fortinet.fortios.fortios_web_proxy_profile module – Configure web proxy profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
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_profile.
New in version 2.0.0: 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 profile 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 |
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:
|
|
Indicates whether to create or remove the object. 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: “root” |
|
Configure web proxy profiles. |
|
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Choices:
|
|
Configure HTTP forwarded requests headers. |
|
Action when the HTTP header is forwarded. Choices:
|
|
Configure options to append content to existing HTTP header or add new HTTP header. Choices:
|
|
Enable/disable use of base64 encoding of HTTP content. Choices:
|
|
HTTP header content. |
|
Destination address and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
Destination address and address group names (IPv6). |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
HTTP forwarded header id. |
|
HTTP forwarded header name. |
|
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Choices:
|
|
Enable/disable logging HTTP header changes. Choices:
|
|
Profile name. |
|
Enable/disable stripping unsupported encoding from the request header. Choices:
|
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 profiles.
fortios_web_proxy_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_profile:
header_client_ip: "pass"
header_front_end_https: "pass"
header_via_request: "pass"
header_via_response: "pass"
header_x_authenticated_groups: "pass"
header_x_authenticated_user: "pass"
header_x_forwarded_client_cert: "pass"
header_x_forwarded_for: "pass"
headers:
-
action: "add-to-request"
add_option: "append"
base64_encoding: "disable"
content: "<your_own_value>"
dstaddr:
-
name: "default_name_17 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
id: "20"
name: "default_name_21"
protocol: "https"
log_header_change: "enable"
name: "default_name_24"
strip_encoding: "enable"
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: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always 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)