ansible.builtin.fortios_web_proxy_profile (v2.8.20) — module

Configure web proxy profiles 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 community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS 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.2


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure web proxy profiles.
    fortios_web_proxy_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      web_proxy_profile:
        state: "present"
        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"

Inputs

    
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_profile:
    default: null
    description:
    - Configure web proxy profiles.
    suboptions:
      header-client-ip:
        choices:
        - pass
        - add
        - remove
        description:
        - 'Action to take on the HTTP client-IP header in forwarded requests: forwards
          (pass), adds, or removes the HTTP header.'
      header-front-end-https:
        choices:
        - pass
        - add
        - remove
        description:
        - 'Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards
          (pass), adds, or removes the HTTP header.'
      header-via-request:
        choices:
        - pass
        - add
        - remove
        description:
        - 'Action to take on the HTTP via header in forwarded requests: forwards (pass),
          adds, or removes the HTTP header.'
      header-via-response:
        choices:
        - pass
        - add
        - remove
        description:
        - 'Action to take on the HTTP via header in forwarded responses: forwards (pass),
          adds, or removes the HTTP header.'
      header-x-authenticated-groups:
        choices:
        - pass
        - add
        - remove
        description:
        - '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:
        choices:
        - pass
        - add
        - remove
        description:
        - '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:
        choices:
        - pass
        - add
        - remove
        description:
        - 'Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards
          (pass), adds, or removes the HTTP header.'
      headers:
        description:
        - Configure HTTP forwarded requests headers.
        suboptions:
          action:
            choices:
            - add-to-request
            - add-to-response
            - remove-from-request
            - remove-from-response
            description:
            - Action when HTTP the header forwarded.
          content:
            description:
            - HTTP header's content.
          id:
            description:
            - HTTP forwarded header id.
            required: true
          name:
            description:
            - HTTP forwarded header name.
      log-header-change:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging HTTP header changes.
      name:
        description:
        - Profile name.
        required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      strip-encoding:
        choices:
        - enable
        - disable
        description:
        - Enable/disable stripping unsupported encoding from the request header.

Outputs

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