fmgr_pkg_firewall_policy – Configure IPv4 policies.

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
True True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • pkg - The parameter in requested url type: str required: true
  • pkg_firewall_policy - Configure IPv4 policies. type: dict
    • action - Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn, redirect, isolate] more...
    • app-category - Application category ID list. type: str more...
    • application - Application ID list. type: int more...
    • application-list - Name of an existing Application list. type: str more...
    • auth-cert - HTTPS server certificate for policy authentication. type: str more...
    • auth-path - Enable/disable authentication-based routing. type: str choices: [disable, enable] more...
    • auth-redirect-addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str more...
    • auto-asic-offload - Enable/disable offloading security profile processing to CP processors. type: str choices: [disable, enable] more...
    • av-profile - Name of an existing Antivirus profile. type: str more...
    • block-notification - Enable/disable block notification. type: str choices: [disable, enable] more...
    • captive-portal-exempt - Enable to exempt some users from the captive portal. type: str choices: [disable, enable] more...
    • capture-packet - Enable/disable capture packets. type: str choices: [disable, enable] more...
    • comments - No description for the parameter type: str
    • custom-log-fields - Custom fields to append to log messages for this policy. type: str more...
    • delay-tcp-npu-session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str choices: [disable, enable] more...
    • devices - Names of devices or device groups that can be matched by the policy. type: str more...
    • diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...
    • diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...
    • diffservcode-forward - Change packets DiffServ to this value. type: str more...
    • diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str more...
    • disclaimer - Enable/disable user authentication disclaimer. type: str choices: [disable, enable, user, domain, policy] more...
    • dlp-sensor - Name of an existing DLP sensor. type: str more...
    • dnsfilter-profile - Name of an existing DNS filter profile. type: str more...
    • dscp-match - Enable DSCP check. type: str choices: [disable, enable] more...
    • dscp-negate - Enable negated DSCP match. type: str choices: [disable, enable] more...
    • dscp-value - DSCP value. type: str more...
    • dsri - Enable DSRI to ignore HTTP server responses. type: str choices: [disable, enable] more...
    • dstaddr - Destination address and address group names. type: str more...
    • dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: [disable, enable] more...
    • dstintf - Outgoing (egress) interface. 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 sessions source port. type: str choices: [disable, enable] more...
    • fsso - Enable/disable Fortinet Single Sign-On. type: str choices: [disable, enable] more...
    • fsso-agent-for-ntlm - FSSO agent to use for NTLM authentication. type: str 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: str more...
    • gtp-profile - GTP profile. type: str more...
    • icap-profile - Name of an existing ICAP profile. type: str more...
    • identity-based-route - Name of identity-based routing rule. type: str more...
    • inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: [disable, enable] more...
    • internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...
    • internet-service-custom - Custom Internet Service Name. type: str more...
    • internet-service-id - Internet Service ID. type: str more...
    • internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • ippool - Enable to use IP Pools for source NAT. type: str choices: [disable, enable] more...
    • ips-sensor - Name of an existing IPS sensor. 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. type: str choices: [disable, enable] more...
    • logtraffic - Enable or disable logging. type: str choices: [disable, enable, all, utm] more...
    • logtraffic-start - Record logs when a session starts and ends. type: str choices: [disable, enable] more...
    • match-vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str choices: [disable, enable] more...
    • mms-profile - Name of an existing MMS profile. type: str more...
    • name - Policy name. type: str more...
    • nat - Enable/disable source NAT. type: str choices: [disable, enable] more...
    • natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: [disable, enable] 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: [disable, enable] more...
    • ntlm - Enable/disable NTLM authentication. type: str choices: [disable, enable] more...
    • ntlm-enabled-browsers - HTTP-User-Agent value of supported browsers. type: str more...
    • ntlm-guest - Enable/disable NTLM guest user access. type: str choices: [disable, enable] more...
    • outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: [disable, enable] more...
    • per-ip-shaper - Per-IP traffic shaper. type: str more...
    • permit-any-host - Accept UDP packets from any host. type: str choices: [disable, enable] more...
    • permit-stun-host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str choices: [disable, enable] more...
    • policyid - Policy ID. type: int more...
    • poolname - IP Pool names. type: str more...
    • profile-group - Name of profile group. type: str more...
    • profile-protocol-options - Name of an existing Protocol options profile. 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. type: str choices: [disable, enable] 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. type: str more...
    • rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: [disable, enable] more...
    • rtp-addr - Address names if this is an RTP NAT policy. type: str 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. type: str more...
    • schedule-timeout - Enable to force current sessions to end when the schedule object times out. type: str choices: [disable, enable] 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: str more...
    • service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • session-ttl - Session TTL in seconds for sessions accepted by this policy. type: int more...
    • spamfilter-profile - Name of an existing Spam filter profile. type: str more...
    • srcaddr - Source address and address group names. type: str more...
    • srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: [disable, enable] more...
    • srcintf - Incoming (ingress) interface. type: str more...
    • ssl-mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: [disable, enable] more...
    • ssl-mirror-intf - SSL mirror interface name. type: str more...
    • ssl-ssh-profile - Name of an existing SSL SSH profile. type: str more...
    • status - Enable or disable this policy. type: str choices: [disable, enable] more...
    • tags - Names of object-tags applied to this policy. type: str 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: [disable, enable] more...
    • traffic-shaper - Traffic shaper. type: str more...
    • traffic-shaper-reverse - Reverse traffic shaper. type: str more...
    • url-category - URL category ID list. type: str more...
    • users - Names of individual users that can authenticate with this policy. type: str more...
    • utm-status - Enable to add one or more security profiles (AV, IPS, etc. type: str choices: [disable, enable] more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). 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...
    • voip-profile - Name of an existing VoIP profile. type: str more...
    • vpn_dst_node - Vpn_Dst_Node. type: array more...
      • host - Host. type: str more...
      • seq - Seq. type: int more...
      • subnet - Subnet. type: str more...
    • vpn_src_node - Vpn_Src_Node. type: array more...
      • host - Host. type: str more...
      • seq - Seq. type: int more...
      • subnet - Subnet. type: str more...
    • vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str more...
    • waf-profile - Name of an existing Web application firewall profile. type: str more...
    • wanopt - Enable/disable WAN optimization. type: str choices: [disable, enable] more...
    • wanopt-detection - WAN optimization auto-detection mode. type: str choices: [active, passive, off] more...
    • wanopt-passive-opt - WAN optimization passive mode options. type: str choices: [default, transparent, non-transparent] more...
    • wanopt-peer - WAN optimization peer. type: str more...
    • wanopt-profile - WAN optimization profile. type: str more...
    • wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str choices: [disable, enable] more...
    • webcache - Enable/disable web cache. type: str choices: [disable, enable] more...
    • webcache-https - Enable/disable web cache for HTTPS. type: str choices: [disable, ssl-server, any, enable] more...
    • webfilter-profile - Name of an existing Web filter profile. type: str more...
    • wsso - Enable/disable WiFi Single Sign On (WSSO). type: str choices: [disable, enable] more...
    • anti-replay - Enable/disable anti-replay check. type: str choices: [disable, enable] more...
    • app-group - Application group names. type: str more...
    • cifs-profile - Name of an existing CIFS profile. type: str more...
    • email-collect - Enable/disable email collection. type: str choices: [disable, enable] more...
    • emailfilter-profile - Name of an existing email filter profile. type: str more...
    • fsso-groups - Names of FSSO groups. type: str more...
    • geoip-anycast - Enable/disable recognition of anycast IP addresses using the geography IP database. type: str choices: [disable, enable] more...
    • http-policy-redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] more...
    • inspection-mode - Policy inspection mode (Flow/proxy). type: str choices: [proxy, flow] more...
    • internet-service-custom-group - Custom Internet Service group name. type: str more...
    • internet-service-group - Internet Service group name. type: str more...
    • internet-service-src - Enable/disable use of Internet Services in source for this policy. type: str choices: [disable, enable] more...
    • internet-service-src-custom - Custom Internet Service source name. type: str more...
    • internet-service-src-custom-group - Custom Internet Service source group name. type: str more...
    • internet-service-src-group - Internet Service source group name. type: str more...
    • internet-service-src-id - Internet Service source ID. type: str more...
    • internet-service-src-negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • match-vip-only - Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. type: str choices: [disable, enable] more...
    • np-acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable] more...
    • reputation-direction - Direction of the initial traffic for reputation to take effect. type: str choices: [source, destination] more...
    • reputation-minimum - Minimum Reputation to take action. type: int more...
    • ssh-filter-profile - Name of an existing SSH filter profile. type: str more...
    • ssh-policy-redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: [disable, enable] 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: [disable, enable] more...
    • vlan-filter - Set VLAN filters. type: str more...
    • webproxy-forward-server - Webproxy forward server name. type: str more...
    • webproxy-profile - Webproxy profile name. type: str more...
    • np-accelation - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable] more...
    • delay-tcp-npu-sessoin - Enable/disable TCP NPU session delay in order to guarantee packet order of 3-way handshake. type: str choices: [disable, enable] more...
    • casi-profile - CASI profile. type: str more...
    • best-route - Enable/disable the use of best route. type: str choices: [disable, enable] more...
    • decrypted-traffic-mirror - Decrypted traffic mirror. type: str more...
    • dstaddr6 - Destination IPv6 address name and address group names. type: str more...
    • geoip-match - Match geography address based either on its physical location or registered location. type: str choices: [physical-location, registered-location] more...
    • internet-service-name - Internet Service name. type: str more...
    • internet-service-src-name - Internet Service source name. type: str more...
    • poolname6 - IPv6 pool names. type: str more...
    • src-vendor-mac - Vendor MAC source ID. type: str more...
    • srcaddr6 - Source IPv6 address name and address group names. type: str more...
    • file-filter-profile - Name of an existing file-filter profile. type: str more...
    • policy-offload - Enable/Disable hardware session setup for CGNAT. type: str choices: [disable, enable] more...
    • cgn-session-quota - session quota type: int more...
    • cgn-eif - Enable/Disable CGN endpoint independent filtering. type: str choices: [disable, enable] more...
    • cgn-log-server-grp - NP log server group name type: str more...
    • cgn-eim - Enable/Disable CGN endpoint independent mapping type: str choices: [disable, enable] more...
    • cgn-resource-quota - resource quota type: int more...
    • dynamic-shaping - Enable/disable dynamic RADIUS defined traffic shaping. type: str choices: [disable, enable] more...
    • passive-wan-health-measurement - Enable/disable passive WAN health measurement. type: str choices: [disable, enable] more...
    • videofilter-profile - Name of an existing VideoFilter profile. type: str more...
    • ztna-ems-tag - Source ztna-ems-tag names. type: str more...
    • ztna-geo-tag - Source ztna-geo-tag names. type: str more...
    • ztna-status - Enable/disable zero trust access. type: str choices: [disable, enable] more...
    • _policy_block - Assigned policy block. type: int more...
    • dlp-profile - Name of an existing DLP profile. type: str more...
    • fec - Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. type: str choices: [disable, enable] more...
    • nat46 - Enable/disable NAT46. type: str choices: [disable, enable] more...
    • nat64 - Enable/disable NAT64. type: str choices: [disable, enable] more...
    • pfcp-profile - PFCP profile. type: str more...
    • policy-expiry - Enable/disable policy expiry. type: str choices: [disable, enable] more...
    • policy-expiry-date - Policy expiry date (YYYY-MM-DD HH:MM:SS). type: str more...
    • sctp-filter-profile - Name of an existing SCTP filter profile. type: str more...
    • sgt - No description for the parameter type: int more...
    • sgt-check - Enable/disable security group tags (SGT) check. type: str choices: [disable, enable] more...
    • tcp-timeout-pid - TCP timeout profile ID type: str more...
    • udp-timeout-pid - UDP timeout profile ID type: str more...
    • diffserv-copy - Enable to copy packets DiffServ values from sessions original direction to its reply direction. type: str choices: [disable, enable] more...
    • dstaddr6-negate - When enabled dstaddr6 specifies what the destination address must NOT be. type: str choices: [disable, enable] more...
    • internet-service6 - Enable/disable use of IPv6 Internet Services for this policy. type: str choices: [disable, enable] more...
    • internet-service6-custom - No description for the parameter type: str more...
    • internet-service6-custom-group - No description for the parameter type: str more...
    • internet-service6-group - No description for the parameter type: str more...
    • internet-service6-name - No description for the parameter type: str more...
    • internet-service6-negate - When enabled internet-service6 specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • internet-service6-src - Enable/disable use of IPv6 Internet Services in source for this policy. type: str choices: [disable, enable] more...
    • internet-service6-src-custom - No description for the parameter type: str more...
    • internet-service6-src-custom-group - No description for the parameter type: str more...
    • internet-service6-src-group - No description for the parameter type: str more...
    • internet-service6-src-name - No description for the parameter type: str more...
    • internet-service6-src-negate - When enabled internet-service6-src specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • network-service-dynamic - No description for the parameter type: str more...
    • network-service-src-dynamic - No description for the parameter type: str more...
    • reputation-direction6 - Direction of the initial traffic for IPv6 reputation to take effect. type: str choices: [source, destination] more...
    • reputation-minimum6 - IPv6 Minimum Reputation to take action. type: int more...
    • srcaddr6-negate - When enabled srcaddr6 specifies what the source address must NOT be. type: str choices: [disable, enable] more...
    • ip-version-type - IP version of the policy. type: str more...
    • ips-voip-filter - Name of an existing VoIP (ips) profile. type: str more...
    • pcp-inbound - Enable/disable PCP inbound DNAT. type: str choices: [disable, enable] more...
    • pcp-outbound - Enable/disable PCP outbound SNAT. type: str choices: [disable, enable] more...
    • pcp-poolname - No description for the parameter type: str more...
    • policy-behaviour-type - Behaviour of the policy. type: str more...
    • policy-expiry-date-utc - Policy expiry date and time, in epoch format. type: str more...
    • ztna-device-ownership - Enable/disable zero trust device ownership. type: str choices: [disable, enable] more...
    • ztna-ems-tag-secondary - No description for the parameter type: str more...
    • ztna-policy-redirect - Redirect ZTNA traffic to matching Access-Proxy proxy-policy. type: str choices: [disable, enable] more...
    • ztna-tags-match-logic - ZTNA tag matching logic. type: str choices: [or, and] more...
    • object position - No description for the parameter type: list

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 policies.
     fmgr_pkg_firewall_policy:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy:
           action: accept #<value in [deny, accept, ipsec, ...]>
           comments: ansible-comment
           dstaddr: all
           dstintf: any
           #name: ansible-test-policy
           nat: disable
           policyid: 1
           schedule: always
           service: ALL
           srcaddr: all
           srcintf: any
           status: disable

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_policy'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               policy: 'your_value'

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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