fortios_firewall_proxy_address – Web proxy address configuration in Fortinet’s FortiOS and FortiGate.

New in version 2.8.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy_address 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

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • vdom - 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. type: str default: root
  • state - 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. type: str required: False choices: present, absent
  • firewall_proxy_address - Web proxy address configuration. type: dict
    • state - B(Deprecated) type: str required: False choices: present, absent
    • case_sensitivity - Enable to make the pattern case sensitive. type: str choices: disable, enable
    • category - FortiGuard category ID. type: list
      • id - Fortiguard category id. type: int required: True
    • color - Integer value to determine the color of the icon in the GUI (1 - 32). type: int
    • comment - Optional comments. type: str
    • header - HTTP header name as a regular expression. type: str
    • header_group - HTTP header group. type: list
      • case_sensitivity - Case sensitivity in pattern. type: str choices: disable, enable
      • header - HTTP header regular expression. type: str
      • header_name - HTTP header. type: str
      • id - ID. type: int required: True
    • header_name - Name of HTTP header. type: str
    • host - Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name. type: str
    • host_regex - Host name as a regular expression. type: str
    • method - HTTP request methods to be used. type: str choices: get, post, put, head, connect, trace, options, delete
    • name - Address name. type: str required: True
    • path - URL path as a regular expression. type: str
    • query - Match the query part of the URL as a regular expression. type: str
    • referrer - Enable/disable use of referrer field in the HTTP header to match the address. type: str choices: enable, disable
    • tagging - Config object tagging. type: list
      • category - Tag category. Source system.object-tagging.category. type: str
      • name - Tagging entry name. type: str required: True
      • tags - Tags. type: list
        • name - Tag name. Source system.object-tagging.tags.name. type: str required: True
    • type - Proxy address type. type: str choices: host-regex, url, category, method, ua, header, src-advanced, dst-advanced
    • ua - Names of browsers to be used as user agent. type: str choices: chrome, ms, firefox, safari, other
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
    • visibility - Enable/disable visibility of the object in the GUI. type: str choices: enable, disable

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: Web proxy address configuration.
    fortios_firewall_proxy_address:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_proxy_address:
        case_sensitivity: "disable"
        category:
         -
            id:  "5"
        color: "6"
        comment: "Optional comments."
        header: "<your_own_value>"
        header_group:
         -
            case_sensitivity: "disable"
            header: "<your_own_value>"
            header_name: "<your_own_value>"
            id:  "13"
        header_name: "<your_own_value>"
        host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
        host_regex: "myhostname"
        method: "get"
        name: "default_name_18"
        path: "<your_own_value>"
        query: "<your_own_value>"
        referrer: "enable"
        tagging:
         -
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_24"
            tags:
             -
                name: "default_name_26 (source system.object-tagging.tags.name)"
        type: "host-regex"
        ua: "chrome"
        uuid: "<your_own_value>"
        visibility: "enable"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.