fortios_firewall_proxy_policy – Configure proxy policies in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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_policy 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
| fortios_firewall_proxy_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- firewall_proxy_policy - Configure proxy policies. type: dict more...
- access_proxy - Access Proxy. type: list more...
- name - Access Proxy name. Source firewall.access-proxy.name. type: str required: True more...
- action - Accept or deny traffic matching the policy parameters. type: str choices: accept, deny, redirect more...
- application_list - Name of an existing Application list. Source application.list.name. type: str more...
- av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...
- cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...
- comments - Optional comments. type: str more...
- decrypted_traffic_mirror - Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. type: str more...
- device_ownership - When enabled, the ownership enforcement will be done at policy level. type: str choices: enable, disable more...
- disclaimer - Web proxy disclaimer setting: by domain, policy, or user. type: str choices: disable, domain, policy, user more...
- dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
- dstaddr - Destination address objects. type: list more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall.vip.name firewall.vipgrp.name firewall.vip46.name firewall.vipgrp46.name system.external-resource.name. type: str required: True more...
- dstaddr_negate - When enabled, destination addresses match against any address EXCEPT the specified destination addresses. type: str choices: enable, disable more...
- dstaddr6 - IPv6 destination address objects. type: list more...
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name firewall.vip64.name firewall.vipgrp64.name system.external-resource.name. type: str required: True more...
- dstintf - Destination interface names. type: list more...
- name - Interface name. Source system.interface.name system.zone.name. type: str required: True more...
- emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
- file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str more...
- global_label - Global web-based manager visible label. type: str more...
- groups - Names of group objects. type: list more...
- name - Group name. Source user.group.name. type: str required: True more...
- http_tunnel_auth - Enable/disable HTTP tunnel authentication. type: str choices: enable, disable more...
- icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...
- internet_service - Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. type: str choices: enable, disable more...
- internet_service_custom - Custom Internet Service name. type: list more...
- name - Custom name. Source firewall.internet-service-custom.name. type: str required: True more...
- internet_service_custom_group - Custom Internet Service group name. type: list more...
- name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: True more...
- internet_service_group - Internet Service group name. type: list more...
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: True more...
- internet_service_id - Internet Service ID. type: list more...
- id - Internet Service ID. Source firewall.internet-service.id. type: int required: True more...
- internet_service_name - Internet Service name. type: list more...
- name - Internet Service name. Source firewall.internet-service-name.name. type: str required: True more...
- internet_service_negate - When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service. type: str choices: enable, disable more...
- ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
- label - VDOM-specific GUI visible label. type: str more...
- logtraffic - Enable/disable logging traffic through the policy. type: str choices: all, utm, disable more...
- logtraffic_start - Enable/disable policy log traffic start. type: str choices: enable, disable more...
- mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str more...
- name - Policy name. type: str more...
- policyid - Policy ID. type: int required: True more...
- poolname - Name of IP pool object. type: list more...
- name - IP pool name. Source firewall.ippool.name. type: str required: True more...
- profile_group - Name of profile group. Source firewall.profile-group.name. type: str more...
- profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str more...
- profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group more...
- proxy - Type of explicit proxy. type: str choices: explicit-web, transparent-web, ftp, ssh, ssh-tunnel, wanopt, access-proxy more...
- redirect_url - Redirect URL for further explicit web proxy processing. type: str more...
- replacemsg_override_group - Authentication replacement message override group. Source system.replacemsg-group.name. type: str more...
- scan_botnet_connections - Enable/disable scanning of connections to Botnet servers. type: str choices: disable, block, monitor more...
- schedule - Name of schedule object. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...
- service - Name of service objects. type: list more...
- name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: True more...
- service_negate - When enabled, services match against any service EXCEPT the specified destination services. type: str choices: enable, disable more...
- session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: int more...
- spamfilter_profile - Name of an existing Spam filter profile. Source spamfilter.profile.name. type: str more...
- srcaddr - Source address objects. type: list more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. type: str required: True more...
- srcaddr_negate - When enabled, source addresses match against any address EXCEPT the specified source addresses. type: str choices: enable, disable more...
- srcaddr6 - IPv6 source address objects. type: list more...
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: True more...
- srcintf - Source interface names. type: list more...
- name - Interface name. Source system.interface.name system.zone.name. type: str required: True more...
- ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str more...
- ssh_policy_redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: enable, disable more...
- ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str more...
- status - Enable/disable the active status of the policy. type: str choices: enable, disable more...
- transparent - Enable to use the IP address of the client to connect to the server. type: str choices: enable, disable more...
- users - Names of user objects. type: list more...
- name - Group name. Source user.local.name. type: str required: True more...
- utm_status - Enable the use of UTM profiles/sensors/lists. type: str choices: enable, disable more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- videofilter_profile - Name of an existing VideoFilter profile. Source videofilter.profile.name. type: str more...
- voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str more...
- waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str more...
- webcache - Enable/disable web caching. type: str choices: enable, disable more...
- webcache_https - Enable/disable web caching for HTTPS (Requires deep-inspection enabled in ssl-ssh-profile). type: str choices: disable, enable more...
- webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str more...
- webproxy_forward_server - Name of web proxy forward server. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str more...
- webproxy_profile - Name of web proxy profile. Source web-proxy.profile.name. type: str more...
- ztna_ems_tag - ZTNA EMS Tag names. type: list more...
- name - EMS Tag name. Source firewall.address.name firewall.addrgrp.name. type: str required: True more...
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: Configure proxy policies.
fortios_firewall_proxy_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_policy:
access_proxy:
-
name: "default_name_4 (source firewall.access-proxy.name)"
action: "accept"
application_list: "<your_own_value> (source application.list.name)"
av_profile: "<your_own_value> (source antivirus.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
device_ownership: "enable"
disclaimer: "disable"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dstaddr:
-
name: "default_name_15 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall.vip
.name firewall.vipgrp.name firewall.vip46.name firewall.vipgrp46.name system.external-resource.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name firewall.vip64.name firewall
.vipgrp64.name system.external-resource.name)"
dstintf:
-
name: "default_name_20 (source system.interface.name system.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_25 (source user.group.name)"
http_tunnel_auth: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_30 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_32 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_34 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "36 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_38 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
label: "<your_own_value>"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_45"
policyid: "46"
poolname:
-
name: "default_name_48 (source firewall.ippool.name)"
profile_group: "<your_own_value> (source firewall.profile-group.name)"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
profile_type: "single"
proxy: "explicit-web"
redirect_url: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
scan_botnet_connections: "disable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_58 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "60"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
srcaddr:
-
name: "default_name_63 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
.external-resource.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_66 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_68 (source system.interface.name system.zone.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
transparent: "enable"
users:
-
name: "default_name_75 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
voip_profile: "<your_own_value> (source voip.profile.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
ztna_ems_tag:
-
name: "default_name_87 (source firewall.address.name firewall.addrgrp.name)"
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