Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_web_proxy_profile_module.html

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 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_profile.

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 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.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
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
    Choices:
  • pass
  • add
  • remove
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
header_front_end_https
string
    Choices:
  • pass
  • add
  • remove
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
    Choices:
  • pass
  • add
  • remove
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
header_via_response
string
    Choices:
  • pass
  • add
  • remove
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header.
header_x_authenticated_groups
string
    Choices:
  • pass
  • add
  • remove
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
    Choices:
  • pass
  • add
  • remove
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
    Choices:
  • pass
  • add
  • remove
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
    Choices:
  • add-to-request
  • add-to-response
  • remove-from-request
  • remove-from-response
Action when HTTP the header forwarded.
add_option
string
    Choices:
  • append
  • new-on-not-found
  • new
Configure options to append content to existing HTTP header or add new HTTP header.
base64_encoding
string
    Choices:
  • disable
  • enable
Enable/disable use of base64 encoding of HTTP content.
content
string
HTTP header"s content.
dstaddr
list / elements=string
Destination address and address group names.
name
string / required
Address name. Source firewall.address.name firewall.addrgrp.name.
dstaddr6
list / elements=string
Destination address and address group names (IPv6).
name
string / required
Address name. Source firewall.address6.name firewall.addrgrp6.name.
id
integer / required
HTTP forwarded header id.
name
string
HTTP forwarded header name.
protocol
list / elements=string
    Choices:
  • https
  • http
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both).
log_header_change
string
    Choices:
  • enable
  • disable
Enable/disable logging HTTP header changes.
name
string / required
Profile name.
strip_encoding
string
    Choices:
  • enable
  • disable
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"
            add_option: "append"
            base64_encoding: "disable"
            content: "<your_own_value>"
            dstaddr:
             -
                name: "default_name_16 (source firewall.address.name firewall.addrgrp.name)"
            dstaddr6:
             -
                name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name)"
            id:  "19"
            name: "default_name_20"
            protocol: "https"
        log_header_change: "enable"
        name: "default_name_23"
        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/latest/collections/fortinet/fortios/fortios_web_proxy_profile_module.html