fortios_firewall_policy – Configure IPv4/IPv6 policies 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 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.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
  • 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. type: str required: false choices: present, absent
  • firewall_policy - Configure IPv4/IPv6 policies. type: dict more...
    • action - Policy action (accept/deny/ipsec). type: str choices: accept, deny, ipsec more...
    • anti_replay - Enable/disable anti-replay check. type: str choices: enable, disable more...
    • app_category - Application category ID list. type: list member_path: app_category:id more...
      • id - Category IDs. see Notes. type: int required: true more...
    • app_group - Application group names. type: list member_path: app_group:name more...
      • name - Application group names. Source application.group.name. type: str required: true more...
    • application - Application ID list. type: list member_path: application:id more...
      • id - Application IDs. see Notes. type: int required: true more...
    • application_list - Name of an existing Application list. Source application.list.name. type: str more...
    • auth_cert - HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. type: str more...
    • auth_path - Enable/disable authentication-based routing. type: str choices: enable, disable more...
    • auth_redirect_addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str more...
    • auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable more...
    • av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...
    • block_notification - Enable/disable block notification. type: str choices: enable, disable more...
    • captive_portal_exempt - Enable to exempt some users from the captive portal. type: str choices: enable, disable more...
    • capture_packet - Enable/disable capture packets. type: str choices: enable, disable more...
    • casb_profile - Name of an existing CASB profile. Source casb.profile.name. type: str more...
    • cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...
    • comments - Comment. type: str more...
    • custom_log_fields - Custom fields to append to log messages for this policy. type: list member_path: custom_log_fields:field_id more...
      • field_id - Custom log field. Source log.custom-field.id. type: str required: true more...
    • decrypted_traffic_mirror - Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. type: str more...
    • delay_tcp_npu_session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str choices: enable, disable more...
    • devices - Names of devices or device groups that can be matched by the policy. type: list member_path: devices:name more...
      • name - Device or group name. Source user.device.alias user.device-group.name user.device-category.name. type: str required: true more...
    • diameter_filter_profile - Name of an existing Diameter filter profile. Source diameter-filter.profile.name. type: str more...
    • diffserv_copy - Enable to copy packet"s DiffServ values from session"s original direction to its reply direction. type: str choices: enable, disable more...
    • diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable more...
    • diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable more...
    • diffservcode_forward - Change packet"s DiffServ to this value. type: str more...
    • diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str more...
    • disclaimer - Enable/disable user authentication disclaimer. type: str choices: enable, disable more...
    • dlp_profile - Name of an existing DLP profile. Source dlp.profile.name. type: str more...
    • dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
    • dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str more...
    • dscp_match - Enable DSCP check. type: str choices: enable, disable more...
    • dscp_negate - Enable negated DSCP match. type: str choices: enable, disable more...
    • dscp_value - DSCP value. type: str more...
    • dsri - Enable DSRI to ignore HTTP server responses. type: str choices: enable, disable more...
    • dstaddr - Destination IPv4 address and address group names. type: list member_path: dstaddr:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. type: str required: true more...
    • dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable more...
    • dstaddr6 - Destination IPv6 address name and address group names. type: list member_path: dstaddr6:name more...
      • name - Address name. Source firewall.address6.name firewall.vipgrp6.name firewall.vip6.name system.external-resource.name firewall .addrgrp6.name. type: str required: true more...
    • dstaddr6_negate - When enabled dstaddr6 specifies what the destination address must NOT be. type: str choices: enable, disable more...
    • dstintf - Outgoing (egress) interface. type: list member_path: dstintf:name more...
      • name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...
    • dynamic_shaping - Enable/disable dynamic RADIUS defined traffic shaping. type: str choices: enable, disable more...
    • email_collect - Enable/disable email collection. type: str choices: enable, disable more...
    • emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
    • fec - Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. type: str choices: enable, disable more...
    • file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str more...
    • firewall_session_dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: check-all, check-new more...
    • fixedport - Enable to prevent source NAT from changing a session"s source port. type: str choices: enable, disable more...
    • fsso - Enable/disable Fortinet Single Sign-On. type: str choices: enable, disable more...
    • fsso_agent_for_ntlm - FSSO agent to use for NTLM authentication. Source user.fsso.name. type: str more...
    • fsso_groups - Names of FSSO groups. type: list member_path: fsso_groups:name more...
      • name - Names of FSSO groups. Source user.adgrp.name. type: str required: true more...
    • geoip_anycast - Enable/disable recognition of anycast IP addresses using the geography IP database. type: str choices: enable, disable more...
    • geoip_match - Match geography address based either on its physical location or registered location. type: str choices: physical-location, registered-location more...
    • global_label - Label for the policy that appears when the GUI is in Global View mode. type: str more...
    • groups - Names of user groups that can authenticate with this policy. type: list member_path: groups:name more...
      • name - Group name. Source user.group.name. type: str required: true more...
    • gtp_profile - GTP profile. Source firewall.gtp.name. type: str more...
    • http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable more...
    • icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...
    • identity_based_route - Name of identity-based routing rule. Source firewall.identity-based-route.name. type: str more...
    • inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: enable, disable more...
    • inspection_mode - Policy inspection mode (Flow/proxy). Default is Flow mode. type: str choices: proxy, flow 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 member_path: internet_service_custom:name more...
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
    • internet_service_custom_group - Custom Internet Service group name. type: list member_path: internet_service_custom_group:name 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 member_path: internet_service_group:name 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 member_path: internet_service_id:id more...
      • id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...
    • internet_service_name - Internet Service name. type: list member_path: internet_service_name:name more...
      • name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...
    • internet_service_negate - When enabled internet-service specifies what the service must NOT be. type: str choices: enable, disable more...
    • 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 more...
    • internet_service_src_custom - Custom Internet Service source name. type: list member_path: internet_service_src_custom:name more...
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
    • internet_service_src_custom_group - Custom Internet Service source group name. type: list member_path: internet_service_src_custom_group:name more...
      • name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
    • internet_service_src_group - Internet Service source group name. type: list member_path: internet_service_src_group:name more...
      • name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...
    • internet_service_src_id - Internet Service source ID. type: list member_path: internet_service_src_id:id more...
      • id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...
    • internet_service_src_name - Internet Service source name. type: list member_path: internet_service_src_name:name more...
      • name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...
    • internet_service_src_negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: enable, disable more...
    • internet_service6 - Enable/disable use of IPv6 Internet Services for this policy. If enabled, destination address and service are not used. type: str choices: enable, disable more...
    • internet_service6_custom - Custom IPv6 Internet Service name. type: list member_path: internet_service6_custom:name more...
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
    • internet_service6_custom_group - Custom Internet Service6 group name. type: list member_path: internet_service6_custom_group:name more...
      • name - Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
    • internet_service6_group - Internet Service group name. type: list member_path: internet_service6_group:name more...
      • name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...
    • internet_service6_name - IPv6 Internet Service name. type: list member_path: internet_service6_name:name more...
      • name - IPv6 Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...
    • internet_service6_negate - When enabled internet-service6 specifies what the service must NOT be. type: str choices: enable, disable more...
    • internet_service6_src - Enable/disable use of IPv6 Internet Services in source for this policy. If enabled, source address is not used. type: str choices: enable, disable more...
    • internet_service6_src_custom - Custom IPv6 Internet Service source name. type: list member_path: internet_service6_src_custom:name more...
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
    • internet_service6_src_custom_group - Custom Internet Service6 source group name. type: list member_path: internet_service6_src_custom_group:name more...
      • name - Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
    • internet_service6_src_group - Internet Service6 source group name. type: list member_path: internet_service6_src_group:name more...
      • name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...
    • internet_service6_src_name - IPv6 Internet Service source name. type: list member_path: internet_service6_src_name:name more...
      • name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...
    • internet_service6_src_negate - When enabled internet-service6-src specifies what the service must NOT be. type: str choices: enable, disable more...
    • ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable more...
    • ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
    • ips_voip_filter - Name of an existing VoIP (ips) profile. Source voip.profile.name. type: str more...
    • label - Label for the policy that appears when the GUI is in Section View mode. type: str more...
    • learning_mode - Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. type: str choices: enable, disable more...
    • logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable more...
    • logtraffic_start - Record logs when a session starts. type: str choices: enable, disable more...
    • match_vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str choices: enable, disable more...
    • 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 more...
    • mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str more...
    • name - Policy name. type: str more...
    • nat - Enable/disable source NAT. type: str choices: enable, disable more...
    • nat46 - Enable/disable NAT46. type: str choices: enable, disable more...
    • nat64 - Enable/disable NAT64. type: str choices: enable, disable more...
    • natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: enable, disable more...
    • natip - Policy-based IPsec VPN: source NAT IP address for outgoing traffic. type: str more...
    • natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: enable, disable more...
    • network_service_dynamic - Dynamic Network Service name. type: list member_path: network_service_dynamic:name more...
      • name - Dynamic Network Service name. Source firewall.network-service-dynamic.name. type: str required: true more...
    • network_service_src_dynamic - Dynamic Network Service source name. type: list member_path: network_service_src_dynamic:name more...
      • name - Dynamic Network Service name. Source firewall.network-service-dynamic.name. type: str required: true more...
    • np_acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: enable, disable more...
    • ntlm - Enable/disable NTLM authentication. type: str choices: enable, disable more...
    • ntlm_enabled_browsers - HTTP-User-Agent value of supported browsers. type: list member_path: ntlm_enabled_browsers:user_agent_string more...
      • user_agent_string - User agent string. type: str required: true more...
    • ntlm_guest - Enable/disable NTLM guest user access. type: str choices: enable, disable more...
    • outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: enable, disable more...
    • passive_wan_health_measurement - Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. type: str choices: enable, disable more...
    • pcp_inbound - Enable/disable PCP inbound DNAT. type: str choices: enable, disable more...
    • pcp_outbound - Enable/disable PCP outbound SNAT. type: str choices: enable, disable more...
    • pcp_poolname - PCP pool names. type: list member_path: pcp_poolname:name more...
      • name - PCP pool name. Source system.pcp-server.pools.name. type: str required: true more...
    • per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str more...
    • permit_any_host - Accept UDP packets from any host. type: str choices: enable, disable more...
    • permit_stun_host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str choices: enable, disable more...
    • pfcp_profile - PFCP profile. Source firewall.pfcp.name. type: str more...
    • policy_expiry - Enable/disable policy expiry. type: str choices: enable, disable more...
    • policy_expiry_date - Policy expiry date (YYYY-MM-DD HH:MM:SS). type: str more...
    • policy_expiry_date_utc - Policy expiry date and time, in epoch format. type: str more...
    • policyid - Policy ID (0 - 4294967294). see Notes. type: int required: true more...
    • poolname - IP Pool names. type: list member_path: poolname:name more...
      • name - IP pool name. Source firewall.ippool.name. type: str required: true more...
    • poolname6 - IPv6 pool names. type: list member_path: poolname6:name more...
      • name - IPv6 pool name. Source firewall.ippool6.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...
    • radius_mac_auth_bypass - Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server. type: str choices: enable, disable more...
    • redirect_url - URL users are directed to after seeing and accepting the disclaimer or authenticating. type: str more...
    • replacemsg_override_group - Override the default replacement message group for this policy. Source system.replacemsg-group.name. type: str more...
    • reputation_direction - Direction of the initial traffic for reputation to take effect. type: str choices: source, destination more...
    • reputation_direction6 - Direction of the initial traffic for IPv6 reputation to take effect. type: str choices: source, destination more...
    • reputation_minimum - Minimum Reputation to take action. Source firewall.internet-service-reputation.id. type: int more...
    • reputation_minimum6 - IPv6 Minimum Reputation to take action. Source firewall.internet-service-reputation.id. type: int more...
    • rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: enable, disable more...
    • rtp_addr - Address names if this is an RTP NAT policy. type: list member_path: rtp_addr:name more...
      • name - Address name. Source firewall.internet-service-custom-group.name firewall.addrgrp.name. type: str required: true more...
    • rtp_nat - Enable Real Time Protocol (RTP) NAT. type: str choices: disable, enable more...
    • scan_botnet_connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str choices: disable, block, monitor more...
    • schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...
    • 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 more...
    • sctp_filter_profile - Name of an existing SCTP filter profile. Source sctp-filter.profile.name. type: str more...
    • send_deny_packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: disable, enable more...
    • service - Service and service group names. type: list member_path: service:name more...
      • name - Service and service group names. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
    • service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable more...
    • session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: str more...
    • sgt - Security group tags. type: list member_path: sgt:id more...
      • id - Security group tag (1 - 65535). see Notes. type: int required: true more...
    • sgt_check - Enable/disable security group tags (SGT) check. type: str choices: enable, disable more...
    • spamfilter_profile - Name of an existing Spam filter profile. Source spamfilter.profile.name. type: str more...
    • src_vendor_mac - Vendor MAC source ID. type: list member_path: src_vendor_mac:id more...
      • id - Vendor MAC ID. see Notes. Source firewall.vendor-mac.id. type: int required: true more...
    • srcaddr - Source IPv4 address and address group names. type: list member_path: srcaddr:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true more...
    • srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable more...
    • srcaddr6 - Source IPv6 address name and address group names. type: list member_path: srcaddr6:name more...
      • name - Address name. Source firewall.address6.name system.external-resource.name firewall.addrgrp6.name. type: str required: true more...
    • srcaddr6_negate - When enabled srcaddr6 specifies what the source address must NOT be. type: str choices: enable, disable more...
    • srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name more...
      • name - Interface name. Source system.interface.name system.zone.name system.sdwan.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_mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: enable, disable more...
    • ssl_mirror_intf - SSL mirror interface name. type: list member_path: ssl_mirror_intf:name more...
      • name - Mirror Interface name. Source system.interface.name system.zone.name. type: str required: true more...
    • ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str more...
    • status - Enable or disable this policy. type: str choices: enable, disable more...
    • tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int more...
    • tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int more...
    • tcp_session_without_syn - Enable/disable creation of TCP session without SYN flag. type: str choices: all, data-only, disable more...
    • timeout_send_rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: enable, disable more...
    • tos - ToS (Type of Service) value used for comparison. type: str more...
    • tos_mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
    • tos_negate - Enable negated TOS match. type: str choices: enable, disable more...
    • traffic_shaper - Traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...
    • traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...
    • url_category - URL category ID list. type: list member_path: url_category:id more...
      • id - URL category ID. see Notes. type: int required: true more...
    • users - Names of individual users that can authenticate with this policy. type: list member_path: users:name more...
      • name - Names of individual users that can authenticate with this policy. Source user.local.name user.certificate.name. type: str required: true more...
    • utm_status - Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. 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...
    • virtual_patch_profile - Name of an existing virtual-patch profile. Source virtual-patch.profile.name. type: str more...
    • vlan_cos_fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int more...
    • vlan_cos_rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int more...
    • vlan_filter - VLAN ranges to allow type: str more...
    • voip_profile - Name of an existing VoIP (voipd) profile. Source voip.profile.name. type: str more...
    • vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. type: str more...
    • waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str more...
    • wanopt - Enable/disable WAN optimization. type: str choices: enable, disable more...
    • wanopt_detection - WAN optimization auto-detection mode. type: str choices: active, passive, off more...
    • 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 more...
    • wanopt_peer - WAN optimization peer. Source wanopt.peer.peer-host-id. type: str more...
    • wanopt_profile - WAN optimization profile. Source wanopt.profile.name. type: str more...
    • wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str choices: enable, disable more...
    • webcache - Enable/disable web cache. type: str choices: enable, disable more...
    • webcache_https - Enable/disable web cache for HTTPS. 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 - Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str more...
    • webproxy_profile - Webproxy profile name. Source web-proxy.profile.name. type: str more...
    • wsso - Enable/disable WiFi Single Sign On (WSSO). type: str choices: enable, disable more...
    • ztna_device_ownership - Enable/disable zero trust device ownership. type: str choices: enable, disable more...
    • ztna_ems_tag - Source ztna-ems-tag names. type: list member_path: ztna_ems_tag:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
    • ztna_ems_tag_secondary - Source ztna-ems-tag-secondary names. type: list member_path: ztna_ems_tag_secondary:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
    • ztna_geo_tag - Source ztna-geo-tag names. type: list member_path: ztna_geo_tag:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
    • ztna_policy_redirect - Redirect ZTNA traffic to matching Access-Proxy proxy-policy. type: str choices: enable, disable more...
    • ztna_status - Enable/disable zero trust access. type: str choices: enable, disable more...
    • ztna_tags_match_logic - ZTNA tag matching logic. type: str choices: or, and more...

Notes

Note

  • We highly recommend using your own value as the policyid instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.

  • 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

- name: Configure IPv4/IPv6 policies.
  fortinet.fortios.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 (source application.group.name)"
          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"
          casb_profile: "<your_own_value> (source casb.profile.name)"
          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"
          devices:
              -
                  name: "default_name_28 (source user.device.alias user.device-group.name user.device-category.name)"
          diameter_filter_profile: "<your_own_value> (source diameter-filter.profile.name)"
          diffserv_copy: "enable"
          diffserv_forward: "enable"
          diffserv_reverse: "enable"
          diffservcode_forward: "<your_own_value>"
          diffservcode_rev: "<your_own_value>"
          disclaimer: "enable"
          dlp_profile: "<your_own_value> (source dlp.profile.name)"
          dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
          dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
          dscp_match: "enable"
          dscp_negate: "enable"
          dscp_value: "<your_own_value>"
          dsri: "enable"
          dstaddr:
              -
                  name: "default_name_44 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource
                    .name)"
          dstaddr_negate: "enable"
          dstaddr6:
              -
                  name: "default_name_47 (source firewall.address6.name firewall.vipgrp6.name firewall.vip6.name system.external-resource.name firewall
                    .addrgrp6.name)"
          dstaddr6_negate: "enable"
          dstintf:
              -
                  name: "default_name_50 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          dynamic_shaping: "enable"
          email_collect: "enable"
          emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
          fec: "enable"
          file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
          firewall_session_dirty: "check-all"
          fixedport: "enable"
          fsso: "enable"
          fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
          fsso_groups:
              -
                  name: "default_name_61 (source user.adgrp.name)"
          geoip_anycast: "enable"
          geoip_match: "physical-location"
          global_label: "<your_own_value>"
          groups:
              -
                  name: "default_name_66 (source user.group.name)"
          gtp_profile: "<your_own_value> (source firewall.gtp.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_75 (source firewall.internet-service-custom.name)"
          internet_service_custom_group:
              -
                  name: "default_name_77 (source firewall.internet-service-custom-group.name)"
          internet_service_group:
              -
                  name: "default_name_79 (source firewall.internet-service-group.name)"
          internet_service_id:
              -
                  id: "81 (source firewall.internet-service.id)"
          internet_service_name:
              -
                  name: "default_name_83 (source firewall.internet-service-name.name)"
          internet_service_negate: "enable"
          internet_service_src: "enable"
          internet_service_src_custom:
              -
                  name: "default_name_87 (source firewall.internet-service-custom.name)"
          internet_service_src_custom_group:
              -
                  name: "default_name_89 (source firewall.internet-service-custom-group.name)"
          internet_service_src_group:
              -
                  name: "default_name_91 (source firewall.internet-service-group.name)"
          internet_service_src_id:
              -
                  id: "93 (source firewall.internet-service.id)"
          internet_service_src_name:
              -
                  name: "default_name_95 (source firewall.internet-service-name.name)"
          internet_service_src_negate: "enable"
          internet_service6: "enable"
          internet_service6_custom:
              -
                  name: "default_name_99 (source firewall.internet-service-custom.name)"
          internet_service6_custom_group:
              -
                  name: "default_name_101 (source firewall.internet-service-custom-group.name)"
          internet_service6_group:
              -
                  name: "default_name_103 (source firewall.internet-service-group.name)"
          internet_service6_name:
              -
                  name: "default_name_105 (source firewall.internet-service-name.name)"
          internet_service6_negate: "enable"
          internet_service6_src: "enable"
          internet_service6_src_custom:
              -
                  name: "default_name_109 (source firewall.internet-service-custom.name)"
          internet_service6_src_custom_group:
              -
                  name: "default_name_111 (source firewall.internet-service-custom-group.name)"
          internet_service6_src_group:
              -
                  name: "default_name_113 (source firewall.internet-service-group.name)"
          internet_service6_src_name:
              -
                  name: "default_name_115 (source firewall.internet-service-name.name)"
          internet_service6_src_negate: "enable"
          ippool: "enable"
          ips_sensor: "<your_own_value> (source ips.sensor.name)"
          ips_voip_filter: "<your_own_value> (source voip.profile.name)"
          label: "<your_own_value>"
          learning_mode: "enable"
          logtraffic: "all"
          logtraffic_start: "enable"
          match_vip: "enable"
          match_vip_only: "enable"
          mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
          name: "default_name_127"
          nat: "enable"
          nat46: "enable"
          nat64: "enable"
          natinbound: "enable"
          natip: "<your_own_value>"
          natoutbound: "enable"
          network_service_dynamic:
              -
                  name: "default_name_135 (source firewall.network-service-dynamic.name)"
          network_service_src_dynamic:
              -
                  name: "default_name_137 (source firewall.network-service-dynamic.name)"
          np_acceleration: "enable"
          ntlm: "enable"
          ntlm_enabled_browsers:
              -
                  user_agent_string: "<your_own_value>"
          ntlm_guest: "enable"
          outbound: "enable"
          passive_wan_health_measurement: "enable"
          pcp_inbound: "enable"
          pcp_outbound: "enable"
          pcp_poolname:
              -
                  name: "default_name_148 (source system.pcp-server.pools.name)"
          per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
          permit_any_host: "enable"
          permit_stun_host: "enable"
          pfcp_profile: "<your_own_value> (source firewall.pfcp.name)"
          policy_expiry: "enable"
          policy_expiry_date: "<your_own_value>"
          policy_expiry_date_utc: "<your_own_value>"
          policyid: "<you_own_value>"
          poolname:
              -
                  name: "default_name_158 (source firewall.ippool.name)"
          poolname6:
              -
                  name: "default_name_160 (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_direction6: "source"
          reputation_minimum: "0"
          reputation_minimum6: "0"
          rsso: "enable"
          rtp_addr:
              -
                  name: "default_name_173 (source firewall.internet-service-custom-group.name firewall.addrgrp.name)"
          rtp_nat: "disable"
          scan_botnet_connections: "disable"
          schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
          schedule_timeout: "enable"
          sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.name)"
          send_deny_packet: "disable"
          service:
              -
                  name: "default_name_181 (source firewall.service.custom.name firewall.service.group.name)"
          service_negate: "enable"
          session_ttl: "<your_own_value>"
          sgt:
              -
                  id: "185"
          sgt_check: "enable"
          spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
          src_vendor_mac:
              -
                  id: "189 (source firewall.vendor-mac.id)"
          srcaddr:
              -
                  name: "default_name_191 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
          srcaddr_negate: "enable"
          srcaddr6:
              -
                  name: "default_name_194 (source firewall.address6.name system.external-resource.name firewall.addrgrp6.name)"
          srcaddr6_negate: "enable"
          srcintf:
              -
                  name: "default_name_197 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
          ssh_policy_redirect: "enable"
          ssl_mirror: "enable"
          ssl_mirror_intf:
              -
                  name: "default_name_202 (source system.interface.name system.zone.name)"
          ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
          status: "enable"
          tcp_mss_receiver: "0"
          tcp_mss_sender: "0"
          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: "215"
          users:
              -
                  name: "default_name_217 (source user.local.name user.certificate.name)"
          utm_status: "enable"
          uuid: "<your_own_value>"
          videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
          virtual_patch_profile: "<your_own_value> (source virtual-patch.profile.name)"
          vlan_cos_fwd: "255"
          vlan_cos_rev: "255"
          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)"
          wsso: "enable"
          ztna_device_ownership: "enable"
          ztna_ems_tag:
              -
                  name: "default_name_242 (source firewall.address.name firewall.addrgrp.name)"
          ztna_ems_tag_secondary:
              -
                  name: "default_name_244 (source firewall.address.name firewall.addrgrp.name)"
          ztna_geo_tag:
              -
                  name: "default_name_246 (source firewall.address.name firewall.addrgrp.name)"
          ztna_policy_redirect: "enable"
          ztna_status: "enable"
          ztna_tags_match_logic: "or"

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.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.