fortios_firewall_policy – Configure IPv4/IPv6 policies 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 policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.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
- action - the action indiactor to move an object in the list type: str choices: move
- self - mkey of self identifier type: str
- after - mkey of target identifier type: str
- before - mkey of target identifier type: str
- 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_policy - Configure IPv4/IPv6 policies. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- action - Policy action (allow/deny/ipsec). type: str choices: accept, deny, ipsec
- anti_replay - Enable/disable anti-replay check. type: str choices: enable, disable
- app_category - Application category ID list. type: list
- id - Category IDs. type: int required: True
- app_group - Application group names. type: list
- name - Application group names. type: str required: True
- application - Application ID list. type: list
- id - Application IDs. type: int required: True
- application_list - Name of an existing Application list. Source application.list.name. type: str
- auth_cert - HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. type: str
- auth_path - Enable/disable authentication-based routing. type: str choices: enable, disable
- auth_redirect_addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str
- auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable
- av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str
- block_notification - Enable/disable block notification. type: str choices: enable, disable
- captive_portal_exempt - Enable to exempt some users from the captive portal. type: str choices: enable, disable
- capture_packet - Enable/disable capture packets. type: str choices: enable, disable
- cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str
- comments - Comment. type: str
- custom_log_fields - Custom fields to append to log messages for this policy. type: list
- field_id - Custom log field. Source log.custom-field.id. type: str
- decrypted_traffic_mirror - Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. type: str
- delay_tcp_npu_session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str choices: enable, disable
- diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable
- diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable
- diffservcode_forward - Change packet"s DiffServ to this value. type: str
- diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str
- disclaimer - Enable/disable user authentication disclaimer. type: str choices: enable, disable
- dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str
- dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str
- dsri - Enable DSRI to ignore HTTP server responses. type: str choices: enable, disable
- dstaddr - Destination IPv4 address and address group names. type: list
- name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. type: str required: True
- dstaddr_negate - When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. type: str choices: enable, disable
- dstaddr6 - Destination IPv6 address name and address group names. type: list
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vipgrp6.name firewall.vip6.name system .external-resource.name. type: str required: True
- dstintf - Outgoing (egress) interface. type: list
- name - Interface name. Source system.interface.name system.zone.name. type: str required: True
- email_collect - Enable/disable email collection. type: str choices: enable, disable
- emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str
- firewall_session_dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: check-all, check-new
- fixedport - Enable to prevent source NAT from changing a session"s source port. type: str choices: enable, disable
- fsso_agent_for_ntlm - FSSO agent to use for NTLM authentication. Source user.fsso.name. type: str
- fsso_groups - Names of FSSO groups. type: list
- name - Names of FSSO groups. Source user.adgrp.name. type: str required: True
- geoip_anycast - Enable/disable recognition of anycast IP addresses using the geography IP database. type: str choices: enable, disable
- geoip_match - Match geography address based either on its physical location or registered location. type: str choices: physical-location, registered-location
- groups - Names of user groups that can authenticate with this policy. type: list
- name - Group name. Source user.group.name. type: str required: True
- http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable
- icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str
- identity_based_route - Name of identity-based routing rule. Source firewall.identity-based-route.name. type: str
- inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: enable, disable
- inspection_mode - Policy inspection mode (Flow/proxy). Default is Flow mode. type: str choices: proxy, flow
- 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
- internet_service_custom - Custom Internet Service name. type: list
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: True
- internet_service_custom_group - Custom Internet Service group name. type: list
- name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: True
- internet_service_group - Internet Service group name. type: list
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: True
- internet_service_name - Internet Service name. type: list
- name - Internet Service name. Source firewall.internet-service-name.name. type: str required: True
- internet_service_negate - When enabled internet-service specifies what the service must NOT be. type: str choices: enable, disable
- internet_service_src - Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. type: str choices: enable, disable
- internet_service_src_custom - Custom Internet Service source name. type: list
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: True
- internet_service_src_custom_group - Custom Internet Service source group name. type: list
- name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: True
- internet_service_src_group - Internet Service source group name. type: list
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: True
- internet_service_src_name - Internet Service source name. type: list
- name - Internet Service name. Source firewall.internet-service-name.name. type: str required: True
- internet_service_src_negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: enable, disable
- ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable
- ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str
- logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable
- logtraffic_start - Record logs when a session starts. type: str choices: enable, disable
- match_vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str choices: enable, disable
- match_vip_only - Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. type: str choices: enable, disable
- name - Policy name. type: str
- nat - Enable/disable source NAT. type: str choices: enable, disable
- natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: enable, disable
- natip - Policy-based IPsec VPN: source NAT IP address for outgoing traffic. type: str
- natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: enable, disable
- ntlm - Enable/disable NTLM authentication. type: str choices: enable, disable
- ntlm_enabled_browsers - HTTP-User-Agent value of supported browsers. type: list
- user_agent_string - User agent string. type: str
- ntlm_guest - Enable/disable NTLM guest user access. type: str choices: enable, disable
- outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: enable, disable
- per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str
- permit_any_host - Accept UDP packets from any host. type: str choices: enable, disable
- permit_stun_host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str choices: enable, disable
- policyid - Policy ID (0 - 4294967294). type: int required: True
- poolname - IP Pool names. type: list
- name - IP pool name. Source firewall.ippool.name. type: str required: True
- poolname6 - IPv6 pool names. type: list
- name - IPv6 pool name. Source firewall.ippool6.name. type: str required: True
- profile_group - Name of profile group. Source firewall.profile-group.name. type: str
- profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str
- profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group
- radius_mac_auth_bypass - Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server. type: str choices: enable, disable
- redirect_url - URL users are directed to after seeing and accepting the disclaimer or authenticating. type: str
- replacemsg_override_group - Override the default replacement message group for this policy. Source system.replacemsg-group.name. type: str
- reputation_direction - Direction of the initial traffic for reputation to take effect. type: str choices: source, destination
- reputation_minimum - Minimum Reputation to take action. Source firewall.internet-service-reputation.id. type: int
- rtp_addr - Address names if this is an RTP NAT policy. type: list
- name - Address name. Source firewall.internet-service-custom-group.name firewall.addrgrp.name. type: str required: True
- rtp_nat - Enable Real Time Protocol (RTP) NAT. type: str choices: disable, enable
- schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str
- schedule_timeout - Enable to force current sessions to end when the schedule object times out. Disable allows them to end from inactivity. type: str choices: enable, disable
- send_deny_packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: disable, enable
- service - Service and service group names. type: list
- name - Service and service group names. Source firewall.service.custom.name firewall.service.group.name. type: str required: True
- service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable
- session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: str
- src_vendor_mac - Vendor MAC source ID. type: list
- id - Vendor MAC ID. Source firewall.vendor-mac.id. type: int required: True
- srcaddr - Source IPv4 address and address group names. type: list
- name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: True
- srcaddr_negate - When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. type: str choices: enable, disable
- srcaddr6 - Source IPv6 address name and address group names. type: list
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: True
- srcintf - Incoming (ingress) interface. type: list
- name - Interface name. Source system.interface.name system.zone.name. type: str required: True
- ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str
- ssh_policy_redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: enable, disable
- ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str
- status - Enable or disable this policy. type: str choices: enable, disable
- tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int
- tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int
- tcp_session_without_syn - Enable/disable creation of TCP session without SYN flag. type: str choices: all, data-only, disable
- timeout_send_rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: enable, disable
- tos - ToS (Type of Service) value used for comparison. type: str
- tos_mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str
- tos_negate - Enable negated TOS match. type: str choices: enable, disable
- traffic_shaper - Traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
- traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
- url_category - URL category ID list. type: list
- id - URL category ID. type: int required: True
- users - Names of individual users that can authenticate with this policy. type: list
- name - Names of individual users that can authenticate with this policy. Source user.local.name. type: str required: True
- utm_status - Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. type: str choices: enable, disable
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
- vlan_cos_fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int
- vlan_cos_rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int
- vlan_filter - Set VLAN filters. type: str
- voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str
- vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. type: str
- waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str
- wanopt - Enable/disable WAN optimization. type: str choices: enable, disable
- wanopt_detection - WAN optimization auto-detection mode. type: str choices: active, passive, False
- wanopt_passive_opt - WAN optimization passive mode options. This option decides what IP address will be used to connect server. type: str choices: default, transparent, non-transparent
- wanopt_peer - WAN optimization peer. Source wanopt.peer.peer-host-id. type: str
- wanopt_profile - WAN optimization profile. Source wanopt.profile.name. type: str
- wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str choices: enable, disable
- webcache - Enable/disable web cache. type: str choices: enable, disable
- webcache_https - Enable/disable web cache for HTTPS. type: str choices: disable, enable
- webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str
- webproxy_forward_server - Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str
- webproxy_profile - Webproxy profile name. Source web-proxy.profile.name. type: str
Notes¶
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- Adjust object order by moving self after(before) another.
- Only one of [after, before] must be specified when action is moving an object.
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 IPv4/IPv6 policies.
fortios_firewall_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8"
application:
-
id: "10"
application_list: "<your_own_value> (source application.list.name)"
auth_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_path: "enable"
auth_redirect_addr: "<your_own_value>"
auto_asic_offload: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
block_notification: "enable"
captive_portal_exempt: "enable"
capture_packet: "enable"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
delay_tcp_npu_session: "enable"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
disclaimer: "enable"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
dsri: "enable"
dstaddr:
-
name: "default_name_35 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_38 (source firewall.address6.name firewall.addrgrp6.name firewall.vipgrp6.name firewall.vip6.name system.external-resource
.name)"
dstintf:
-
name: "default_name_40 (source system.interface.name system.zone.name)"
email_collect: "enable"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
fsso_groups:
-
name: "default_name_47 (source user.adgrp.name)"
geoip_anycast: "enable"
geoip_match: "physical-location"
groups:
-
name: "default_name_51 (source user.group.name)"
http_policy_redirect: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
identity_based_route: "<your_own_value> (source firewall.identity-based-route.name)"
inbound: "enable"
inspection_mode: "proxy"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_59 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_61 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_63 (source firewall.internet-service-group.name)"
internet_service_name:
-
name: "default_name_65 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_69 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_71 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_73 (source firewall.internet-service-group.name)"
internet_service_src_name:
-
name: "default_name_75 (source firewall.internet-service-name.name)"
internet_service_src_negate: "enable"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
logtraffic: "all"
logtraffic_start: "enable"
match_vip: "enable"
match_vip_only: "enable"
name: "default_name_83"
nat: "enable"
natinbound: "enable"
natip: "<your_own_value>"
natoutbound: "enable"
ntlm: "enable"
ntlm_enabled_browsers:
-
user_agent_string: "<your_own_value>"
ntlm_guest: "enable"
outbound: "enable"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
permit_any_host: "enable"
permit_stun_host: "enable"
policyid: "96"
poolname:
-
name: "default_name_98 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_100 (source firewall.ippool6.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"
radius_mac_auth_bypass: "enable"
redirect_url: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
reputation_direction: "source"
reputation_minimum: "108 (source firewall.internet-service-reputation.id)"
rtp_addr:
-
name: "default_name_110 (source firewall.internet-service-custom-group.name firewall.addrgrp.name)"
rtp_nat: "disable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
schedule_timeout: "enable"
send_deny_packet: "disable"
service:
-
name: "default_name_116 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "<your_own_value>"
src_vendor_mac:
-
id: "120 (source firewall.vendor-mac.id)"
srcaddr:
-
name: "default_name_122 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_125 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_127 (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"
tcp_mss_receiver: "132"
tcp_mss_sender: "133"
tcp_session_without_syn: "all"
timeout_send_rst: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "142"
users:
-
name: "default_name_144 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
vlan_cos_fwd: "147"
vlan_cos_rev: "148"
vlan_filter: "<your_own_value>"
voip_profile: "<your_own_value> (source voip.profile.name)"
vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
wanopt: "enable"
wanopt_detection: "active"
wanopt_passive_opt: "default"
wanopt_peer: "<your_own_value> (source wanopt.peer.peer-host-id)"
wanopt_profile: "<your_own_value> (source wanopt.profile.name)"
wccp: "enable"
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)"
- name: move firewall.policy
fortios_firewall_policy:
vdom: "root"
action: "move"
self: "<mkey of self identifier>"
after: "<mkey of target identifier>"
#before: "<mkey of target identifier>"
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