fortios_firewall_proxy_address – Configure web proxy address in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_proxy_address - Configure web proxy address. type: dict more...
- application - SaaS application. type: list member_path: application:name more...
- name - SaaS application name. type: str required: true more...
- case_sensitivity - Enable to make the pattern case sensitive. type: str choices: disable, enable more...
- category - FortiGuard category ID. type: list member_path: category:id more...
- color - Integer value to determine the color of the icon in the GUI (1 - 32). type: int more...
- comment - Optional comments. type: str more...
- header - HTTP header name as a regular expression. type: str more...
- header_group - HTTP header group. type: list member_path: header_group:id more...
- case_sensitivity - Case sensitivity in pattern. type: str choices: disable, enable more...
- header - HTTP header regular expression. type: str more...
- header_name - HTTP header. type: str more...
- id - ID. see Notes. type: int required: true more...
- header_name - Name of HTTP header. type: str more...
- host - Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name. type: str more...
- host_regex - Host name as a regular expression. type: str more...
- method - HTTP request methods to be used. type: list choices: get, post, put, head, connect, trace, options, delete more...
- name - Address name. type: str required: true more...
- path - URL path as a regular expression. type: str more...
- query - Match the query part of the URL as a regular expression. type: str more...
- referrer - Enable/disable use of referrer field in the HTTP header to match the address. type: str choices: enable, disable more...
- tagging - Config object tagging. type: list member_path: tagging:name more...
- category - Tag category. Source system.object-tagging.category. type: str more...
- name - Tagging entry name. type: str required: true more...
- tags - Tags. type: list member_path: tagging:name/tags:name more...
- name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...
- type - Proxy address type. type: str choices: host-regex, url, category, method, ua, header, src-advanced, dst-advanced, saas more...
- ua - Names of browsers to be used as user agent. type: list choices: chrome, ms, firefox, safari, ie, edge, other more...
- ua_max_ver - 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. type: str more...
- ua_min_ver - 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. type: str more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- visibility - Enable/disable visibility of the object in the GUI. type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: 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.