fortinet.fortios.fortios_firewall_proxy_address module – Configure web proxy address in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_proxy_address
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure web proxy address. |
|
SaaS application. |
|
SaaS application name. |
|
Enable to make the pattern case sensitive. Choices:
|
|
FortiGuard category ID. |
|
FortiGuard category ID. see <a href=’#notes’>Notes</a>. |
|
Integer value to determine the color of the icon in the GUI (1 - 32). |
|
Optional comments. |
|
HTTP header name as a regular expression. |
|
HTTP header group. |
|
Case sensitivity in pattern. Choices:
|
|
HTTP header regular expression. |
|
HTTP header. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Name of HTTP header. |
|
Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name. |
|
Host name as a regular expression. |
|
HTTP request methods to be used. Choices:
|
|
Address name. |
|
URL path as a regular expression. |
|
Match the query part of the URL as a regular expression. |
|
Enable/disable use of referrer field in the HTTP header to match the address. Choices:
|
|
Config object tagging. |
|
Tag category. Source system.object-tagging.category. |
|
Tagging entry name. |
|
Tags. |
|
Tag name. Source system.object-tagging.tags.name. |
|
Proxy address type. Choices:
|
|
Names of browsers to be used as user agent. Choices:
|
|
Maximum version of the user agent specified in dotted notation. For example, use 120 with the ua field set to “chrome” to require Google Chrome”s maximum version must be 120. |
|
Minimum version of the user agent specified in dotted notation. For example, use 90.0.1 with the ua field set to “chrome” to require Google Chrome”s minimum version must be 90.0.1. |
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable/disable visibility of the object in the GUI. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure web proxy address.
fortinet.fortios.fortios_firewall_proxy_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_address:
application:
-
name: "default_name_4"
case_sensitivity: "disable"
category:
-
id: "7"
color: "0"
comment: "Optional comments."
header: "<your_own_value>"
header_group:
-
case_sensitivity: "disable"
header: "<your_own_value>"
header_name: "<your_own_value>"
id: "15"
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_20"
path: "<your_own_value>"
query: "<your_own_value>"
referrer: "enable"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_26"
tags:
-
name: "default_name_28 (source system.object-tagging.tags.name)"
type: "host-regex"
ua: "chrome"
ua_max_ver: "<your_own_value>"
ua_min_ver: "<your_own_value>"
uuid: "<your_own_value>"
visibility: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |