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

fortinet.fortios.fortios_firewall_proxy_address – Web proxy address configuration 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_firewall_proxy_address.

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

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

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 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_firewall_proxy_address_module.html