fortinet.fortios.fortios_web_proxy_profile – Configure web proxy profiles in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
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.8: 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 | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
state string added in 2.9 of fortinet.fortios |
| Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | ||
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_profile dictionary | Configure web proxy profiles. | |||
header_client_ip string |
| Actions to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. | ||
header_front_end_https string |
| Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. | ||
header_via_request string |
| Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. | ||
header_via_response string |
| Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. | ||
header_x_authenticated_groups string |
| Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. | ||
header_x_authenticated_user string |
| Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. | ||
header_x_forwarded_for string |
| Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. | ||
headers list / elements=string | Configure HTTP forwarded requests headers. | |||
action string |
| Action when HTTP the header forwarded. | ||
content string | HTTP header"s content. | |||
id integer / required | HTTP forwarded header id. | |||
name string | HTTP forwarded header name. | |||
log_header_change string |
| Enable/disable logging HTTP header changes. | ||
name string / required | Profile name. | |||
state string |
| Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. | ||
strip_encoding string |
| Enable/disable stripping unsupported encoding from the request header. |
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 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_for: "pass" headers: - action: "add-to-request" content: "<your_own_value>" id: "13" name: "default_name_14" log_header_change: "enable" name: "default_name_16" strip_encoding: "enable"
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/2.11/collections/fortinet/fortios/fortios_web_proxy_profile_module.html