:source: fortios_firewall_policy.py :orphan: .. fortios_firewall_policy: fortios_firewall_policy -- Configure IPv4/IPv6 policies in Fortinet's FortiOS and FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 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.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v7.6.6 Parameters ---------- .. raw:: html 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. - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure IPv4/IPv6 policies. fortinet.fortios.fortios_firewall_policy: vdom: "{{ vdom }}" state: "present" access_token: "" firewall_policy: action: "accept" anti_replay: "enable" app_category: - id: "6" app_group: - name: "default_name_8 (source application.group.name)" app_monitor: "enable" application: - id: "11" application_list: " (source application.list.name)" auth_cert: " (source vpn.certificate.local.name)" auth_path: "enable" auth_redirect_addr: "" auto_asic_offload: "enable" av_profile: " (source antivirus.profile.name)" block_notification: "enable" captive_portal_exempt: "enable" capture_packet: "enable" casb_profile: " (source casb.profile.name)" cifs_profile: " (source cifs.profile.name)" comments: "" custom_log_fields: - field_id: " (source log.custom-field.id)" decrypted_traffic_mirror: " (source firewall.decrypted-traffic-mirror.name)" delay_tcp_npu_session: "enable" devices: - name: "default_name_29 (source user.device.alias user.device-group.name user.device-category.name)" diameter_filter_profile: " (source diameter-filter.profile.name)" diffserv_copy: "enable" diffserv_forward: "enable" diffserv_reverse: "enable" diffservcode_forward: "" diffservcode_rev: "" disclaimer: "enable" dlp_profile: " (source dlp.profile.name)" dlp_sensor: " (source dlp.sensor.name)" dnsfilter_profile: " (source dnsfilter.profile.name)" dscp_match: "enable" dscp_negate: "enable" dscp_value: "" dsri: "enable" dstaddr: - name: "default_name_45 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name)" dstaddr_negate: "enable" dstaddr6: - name: "default_name_48 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name)" dstaddr6_negate: "enable" dstintf: - name: "default_name_51 (source system.interface.name system.zone.name system.sdwan.zone.name)" dynamic_shaping: "enable" email_collect: "enable" emailfilter_profile: " (source emailfilter.profile.name)" fec: "enable" file_filter_profile: " (source file-filter.profile.name)" firewall_session_dirty: "check-all" fixedport: "enable" fsso: "enable" fsso_agent_for_ntlm: " (source user.fsso.name)" fsso_groups: - name: "default_name_62 (source user.adgrp.name)" geoip_anycast: "enable" geoip_match: "physical-location" global_label: "" groups: - name: "default_name_67 (source user.group.name)" gtp_profile: " (source firewall.gtp.name)" http_policy_redirect: "enable" icap_profile: " (source icap.profile.name)" identity_based_route: " (source firewall.identity-based-route.name)" inbound: "enable" inspection_mode: "proxy" internet_service: "enable" internet_service_custom: - name: "default_name_76 (source firewall.internet-service-custom.name)" internet_service_custom_group: - name: "default_name_78 (source firewall.internet-service-custom-group.name)" internet_service_fortiguard: - name: "default_name_80 (source firewall.internet-service-fortiguard.name)" internet_service_group: - name: "default_name_82 (source firewall.internet-service-group.name)" internet_service_id: - id: "84 (source firewall.internet-service.id)" internet_service_name: - name: "default_name_86 (source firewall.internet-service-name.name)" internet_service_negate: "enable" internet_service_src: "enable" internet_service_src_custom: - name: "default_name_90 (source firewall.internet-service-custom.name)" internet_service_src_custom_group: - name: "default_name_92 (source firewall.internet-service-custom-group.name)" internet_service_src_fortiguard: - name: "default_name_94 (source firewall.internet-service-fortiguard.name)" internet_service_src_group: - name: "default_name_96 (source firewall.internet-service-group.name)" internet_service_src_id: - id: "98 (source firewall.internet-service.id)" internet_service_src_name: - name: "default_name_100 (source firewall.internet-service-name.name)" internet_service_src_negate: "enable" internet_service6: "enable" internet_service6_custom: - name: "default_name_104 (source firewall.internet-service-custom.name)" internet_service6_custom_group: - name: "default_name_106 (source firewall.internet-service-custom-group.name)" internet_service6_fortiguard: - name: "default_name_108 (source firewall.internet-service-fortiguard.name)" internet_service6_group: - name: "default_name_110 (source firewall.internet-service-group.name)" internet_service6_name: - name: "default_name_112 (source firewall.internet-service-name.name)" internet_service6_negate: "enable" internet_service6_src: "enable" internet_service6_src_custom: - name: "default_name_116 (source firewall.internet-service-custom.name)" internet_service6_src_custom_group: - name: "default_name_118 (source firewall.internet-service-custom-group.name)" internet_service6_src_fortiguard: - name: "default_name_120 (source firewall.internet-service-fortiguard.name)" internet_service6_src_group: - name: "default_name_122 (source firewall.internet-service-group.name)" internet_service6_src_name: - name: "default_name_124 (source firewall.internet-service-name.name)" internet_service6_src_negate: "enable" ippool: "enable" ips_sensor: " (source ips.sensor.name)" ips_voip_filter: " (source voip.profile.name)" label: "" learning_mode: "enable" log_http_transaction: "enable" logtraffic: "all" logtraffic_start: "enable" match_vip: "enable" match_vip_only: "enable" mms_profile: " (source firewall.mms-profile.name)" name: "default_name_137" nat: "enable" nat46: "enable" nat64: "enable" natinbound: "enable" natip: "" natoutbound: "enable" network_service_dynamic: - name: "default_name_145 (source firewall.network-service-dynamic.name)" network_service_src_dynamic: - name: "default_name_147 (source firewall.network-service-dynamic.name)" np_acceleration: "enable" ntlm: "enable" ntlm_enabled_browsers: - user_agent_string: "" ntlm_guest: "enable" outbound: "enable" passive_wan_health_measurement: "enable" pcp_inbound: "enable" pcp_outbound: "enable" pcp_poolname: - name: "default_name_158 (source system.pcp-server.pools.name)" per_ip_shaper: " (source firewall.shaper.per-ip-shaper.name)" permit_any_host: "enable" permit_stun_host: "enable" pfcp_profile: " (source firewall.pfcp.name)" policy_expiry: "enable" policy_expiry_date: "" policy_expiry_date_utc: "" policyid: "" poolname: - name: "default_name_168 (source firewall.ippool.name)" poolname6: - name: "default_name_170 (source firewall.ippool6.name)" port_preserve: "enable" port_random: "enable" profile_group: " (source firewall.profile-group.name)" profile_protocol_options: " (source firewall.profile-protocol-options.name)" profile_type: "single" radius_ip_auth_bypass: "enable" radius_mac_auth_bypass: "enable" redirect_url: "" replacemsg_override_group: " (source system.replacemsg-group.name)" reputation_direction: "source" reputation_direction6: "source" reputation_minimum: "0" reputation_minimum6: "0" rsso: "enable" rtp_addr: - name: "default_name_186 (source firewall.internet-service-custom-group.name firewall.addrgrp.name)" rtp_nat: "disable" saml_server: " (source user.saml.name)" scan_botnet_connections: "disable" schedule: " (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)" schedule_timeout: "enable" scim: "enable" scim_groups: - name: "default_name_194" scim_users: - name: "default_name_196" sctp_filter_profile: " (source sctp-filter.profile.name)" send_deny_packet: "disable" service: - name: "default_name_200 (source firewall.service.custom.name firewall.service.group.name)" service_negate: "enable" session_ttl: "" sgt: - id: "204" sgt_check: "enable" spamfilter_profile: " (source spamfilter.profile.name)" src_vendor_mac: - id: "208 (source firewall.vendor-mac.id)" srcaddr: - name: "default_name_210 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)" srcaddr_negate: "enable" srcaddr6: - name: "default_name_213 (source firewall.address6.name system.external-resource.name firewall.addrgrp6.name)" srcaddr6_negate: "enable" srcintf: - name: "default_name_216 (source system.interface.name system.zone.name system.sdwan.zone.name)" ssh_filter_profile: " (source ssh-filter.profile.name)" ssh_policy_redirect: "enable" ssl_mirror: "enable" ssl_mirror_intf: - name: "default_name_221 (source system.interface.name system.zone.name)" ssl_ssh_profile: " (source firewall.ssl-ssh-profile.name)" status: "enable" tcp_mss_receiver: "0" tcp_mss_sender: "0" tcp_session_without_syn: "all" telemetry_profile: " (source telemetry-controller.profile.name)" timeout_send_rst: "enable" tos: "" tos_mask: "" tos_negate: "enable" traffic_shaper: " (source firewall.shaper.traffic-shaper.name)" traffic_shaper_reverse: " (source firewall.shaper.traffic-shaper.name)" url_category: - id: "235" users: - name: "default_name_237 (source user.local.name user.certificate.name)" utm_status: "enable" uuid: "" videofilter_profile: " (source videofilter.profile.name)" virtual_patch_profile: " (source virtual-patch.profile.name)" vlan_cos_fwd: "255" vlan_cos_rev: "255" vlan_filter: "" voip_profile: " (source voip.profile.name)" vpntunnel: " (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)" waf_profile: " (source waf.profile.name)" wanopt: "enable" wanopt_detection: "active" wanopt_passive_opt: "default" wanopt_peer: " (source wanopt.peer.peer-host-id)" wanopt_profile: " (source wanopt.profile.name)" wccp: "enable" webcache: "enable" webcache_https: "disable" webfilter_profile: " (source webfilter.profile.name)" webproxy_forward_server: " (source web-proxy.forward-server.name web-proxy.forward-server-group.name)" webproxy_profile: " (source web-proxy.profile.name)" wsso: "enable" ztna_device_ownership: "enable" ztna_ems_tag: - name: "default_name_262 (source firewall.address.name firewall.addrgrp.name)" ztna_ems_tag_negate: "enable" ztna_ems_tag_secondary: - name: "default_name_265 (source firewall.address.name firewall.addrgrp.name)" ztna_geo_tag: - name: "default_name_267 (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: .. raw:: html
  • 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.