fmgr_pm_config_pblock_firewall_policy – Configure IPv4/IPv6 policies.

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


7.2.0
pm_config_pblock_firewall_policy yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • pblock - The parameter in requested url type: str required: true
  • pm_config_pblock_firewall_policy - no description type: dict
    • _policy_block - Assigned policy block. type: int more...
    • action - Policy action (accept/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn, redirect, isolate] more...
    • anti-replay - Enable/disable anti-replay check. type: str choices: [disable, enable] 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 policy traffic ASIC offloading. 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...
    • cifs-profile - Name of an existing CIFS profile. type: str more...
    • comments - Comment. type: str more...
    • custom-log-fields - No description for the parameter type: str more...
    • decrypted-traffic-mirror - Decrypted traffic mirror. 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...
    • 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-profile - Name of an existing DLP profile. type: str more...
    • dnsfilter-profile - Name of an existing DNS filter profile. type: str more...
    • dsri - Enable DSRI to ignore HTTP server responses. type: str choices: [disable, enable] more...
    • dstaddr - No description for the parameter type: str more...
    • dstaddr-negate - When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. type: str choices: [disable, enable] more...
    • dstaddr6 - No description for the parameter type: str more...
    • dstintf - No description for the parameter type: str more...
    • dynamic-shaping - Enable/disable dynamic RADIUS defined traffic shaping. type: str choices: [disable, enable] 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...
    • fec - Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. type: str choices: [disable, enable] more...
    • file-filter-profile - Name of an existing file-filter profile. 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-agent-for-ntlm - FSSO agent to use for NTLM authentication. type: str more...
    • fsso-groups - No description for the parameter type: str more...
    • geoip-anycast - Enable/disable recognition of anycast IP addresses using the geography IP database. type: str choices: [disable, enable] 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 - No description for the parameter type: str more...
    • gtp-profile - GTP profile. type: str more...
    • http-policy-redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] 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...
    • inspection-mode - Policy inspection mode (Flow/proxy). type: str choices: [proxy, flow] more...
    • internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...
    • internet-service-custom - No description for the parameter type: str more...
    • internet-service-custom-group - No description for the parameter type: str more...
    • internet-service-group - No description for the parameter type: str more...
    • internet-service-name - No description for the parameter type: str more...
    • internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str choices: [disable, enable] 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 - No description for the parameter type: str more...
    • internet-service-src-custom-group - No description for the parameter type: str more...
    • internet-service-src-group - No description for the parameter type: str more...
    • internet-service-src-name - No description for the parameter 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...
    • 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...
    • logtraffic - Enable or disable logging. type: str choices: [disable, enable, all, utm] more...
    • logtraffic-start - Record logs when a session starts. 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...
    • 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...
    • name - Policy name. type: str more...
    • nat - Enable/disable source NAT. 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...
    • 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...
    • np-acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable] more...
    • ntlm - Enable/disable NTLM authentication. type: str choices: [disable, enable] more...
    • ntlm-enabled-browsers - No description for the parameter 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...
    • passive-wan-health-measurement - Enable/disable passive WAN health measurement. 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...
    • 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...
    • policyid - Policy ID (0 - 4294967294). type: int more...
    • poolname - No description for the parameter type: str more...
    • poolname6 - No description for the parameter 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...
    • 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...
    • rtp-addr - No description for the parameter type: str more...
    • rtp-nat - Enable Real Time Protocol (RTP) NAT. type: str choices: [disable, enable] 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...
    • sctp-filter-profile - Name of an existing SCTP filter profile. 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 - No description for the parameter type: str more...
    • service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • session-ttl - TTL in seconds for sessions accepted by this policy (0 means use the system default session TTL). type: int 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...
    • src-vendor-mac - No description for the parameter type: str more...
    • srcaddr - No description for the parameter type: str more...
    • srcaddr-negate - When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. type: str choices: [disable, enable] more...
    • srcaddr6 - No description for the parameter type: str more...
    • srcintf - No description for the parameter type: str 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...
    • 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...
    • 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...
    • 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...
    • traffic-shaper - Traffic shaper. type: str more...
    • traffic-shaper-reverse - Reverse traffic shaper. type: str more...
    • users - No description for the parameter 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...
    • videofilter-profile - Name of an existing VideoFilter profile. 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 - Set VLAN filters. type: str more...
    • voip-profile - Name of an existing VoIP profile. 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...
    • webproxy-forward-server - Webproxy forward server name. type: str more...
    • webproxy-profile - Webproxy profile name. type: str more...
    • ztna-ems-tag - No description for the parameter type: str more...
    • ztna-geo-tag - No description for the parameter type: str more...
    • ztna-status - Enable/disable zero trust access. type: str choices: [disable, enable] more...

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: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_pm_config_pblock_firewall_policy:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        pblock: <your own value>
        state: <value in [present, absent]>
        pm_config_pblock_firewall_policy:
           _policy_block: <value of integer>
           action: <value in [deny, accept, ipsec, ...]>
           anti-replay: <value in [disable, enable]>
           application-list: <value of string>
           auth-cert: <value of string>
           auth-path: <value in [disable, enable]>
           auth-redirect-addr: <value of string>
           auto-asic-offload: <value in [disable, enable]>
           av-profile: <value of string>
           block-notification: <value in [disable, enable]>
           captive-portal-exempt: <value in [disable, enable]>
           capture-packet: <value in [disable, enable]>
           cifs-profile: <value of string>
           comments: <value of string>
           custom-log-fields: <value of string>
           decrypted-traffic-mirror: <value of string>
           delay-tcp-npu-session: <value in [disable, enable]>
           diffserv-forward: <value in [disable, enable]>
           diffserv-reverse: <value in [disable, enable]>
           diffservcode-forward: <value of string>
           diffservcode-rev: <value of string>
           disclaimer: <value in [disable, enable, user, ...]>
           dlp-profile: <value of string>
           dnsfilter-profile: <value of string>
           dsri: <value in [disable, enable]>
           dstaddr: <value of string>
           dstaddr-negate: <value in [disable, enable]>
           dstaddr6: <value of string>
           dstintf: <value of string>
           dynamic-shaping: <value in [disable, enable]>
           email-collect: <value in [disable, enable]>
           emailfilter-profile: <value of string>
           fec: <value in [disable, enable]>
           file-filter-profile: <value of string>
           firewall-session-dirty: <value in [check-all, check-new]>
           fixedport: <value in [disable, enable]>
           fsso-agent-for-ntlm: <value of string>
           fsso-groups: <value of string>
           geoip-anycast: <value in [disable, enable]>
           geoip-match: <value in [physical-location, registered-location]>
           global-label: <value of string>
           groups: <value of string>
           gtp-profile: <value of string>
           http-policy-redirect: <value in [disable, enable]>
           icap-profile: <value of string>
           identity-based-route: <value of string>
           inbound: <value in [disable, enable]>
           inspection-mode: <value in [proxy, flow]>
           internet-service: <value in [disable, enable]>
           internet-service-custom: <value of string>
           internet-service-custom-group: <value of string>
           internet-service-group: <value of string>
           internet-service-name: <value of string>
           internet-service-negate: <value in [disable, enable]>
           internet-service-src: <value in [disable, enable]>
           internet-service-src-custom: <value of string>
           internet-service-src-custom-group: <value of string>
           internet-service-src-group: <value of string>
           internet-service-src-name: <value of string>
           internet-service-src-negate: <value in [disable, enable]>
           ippool: <value in [disable, enable]>
           ips-sensor: <value of string>
           label: <value of string>
           logtraffic: <value in [disable, enable, all, ...]>
           logtraffic-start: <value in [disable, enable]>
           match-vip: <value in [disable, enable]>
           match-vip-only: <value in [disable, enable]>
           name: <value of string>
           nat: <value in [disable, enable]>
           nat46: <value in [disable, enable]>
           nat64: <value in [disable, enable]>
           natinbound: <value in [disable, enable]>
           natip: <value of string>
           natoutbound: <value in [disable, enable]>
           np-acceleration: <value in [disable, enable]>
           ntlm: <value in [disable, enable]>
           ntlm-enabled-browsers: <value of string>
           ntlm-guest: <value in [disable, enable]>
           outbound: <value in [disable, enable]>
           passive-wan-health-measurement: <value in [disable, enable]>
           per-ip-shaper: <value of string>
           permit-any-host: <value in [disable, enable]>
           permit-stun-host: <value in [disable, enable]>
           pfcp-profile: <value of string>
           policy-expiry: <value in [disable, enable]>
           policy-expiry-date: <value of string>
           policyid: <value of integer>
           poolname: <value of string>
           poolname6: <value of string>
           profile-group: <value of string>
           profile-protocol-options: <value of string>
           profile-type: <value in [single, group]>
           radius-mac-auth-bypass: <value in [disable, enable]>
           redirect-url: <value of string>
           replacemsg-override-group: <value of string>
           reputation-direction: <value in [source, destination]>
           reputation-minimum: <value of integer>
           rtp-addr: <value of string>
           rtp-nat: <value in [disable, enable]>
           schedule: <value of string>
           schedule-timeout: <value in [disable, enable]>
           sctp-filter-profile: <value of string>
           send-deny-packet: <value in [disable, enable]>
           service: <value of string>
           service-negate: <value in [disable, enable]>
           session-ttl: <value of integer>
           sgt: <value of integer>
           sgt-check: <value in [disable, enable]>
           src-vendor-mac: <value of string>
           srcaddr: <value of string>
           srcaddr-negate: <value in [disable, enable]>
           srcaddr6: <value of string>
           srcintf: <value of string>
           ssh-filter-profile: <value of string>
           ssh-policy-redirect: <value in [disable, enable]>
           ssl-ssh-profile: <value of string>
           status: <value in [disable, enable]>
           tcp-mss-receiver: <value of integer>
           tcp-mss-sender: <value of integer>
           tcp-session-without-syn: <value in [all, data-only, disable]>
           timeout-send-rst: <value in [disable, enable]>
           tos: <value of string>
           tos-mask: <value of string>
           tos-negate: <value in [disable, enable]>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           users: <value of string>
           utm-status: <value in [disable, enable]>
           uuid: <value of string>
           videofilter-profile: <value of string>
           vlan-cos-fwd: <value of integer>
           vlan-cos-rev: <value of integer>
           vlan-filter: <value of string>
           voip-profile: <value of string>
           vpntunnel: <value of string>
           waf-profile: <value of string>
           wanopt: <value in [disable, enable]>
           wanopt-detection: <value in [active, passive, off]>
           wanopt-passive-opt: <value in [default, transparent, non-transparent]>
           wanopt-peer: <value of string>
           wanopt-profile: <value of string>
           wccp: <value in [disable, enable]>
           webcache: <value in [disable, enable]>
           webcache-https: <value in [disable, ssl-server, any, ...]>
           webfilter-profile: <value of string>
           webproxy-forward-server: <value of string>
           webproxy-profile: <value of string>
           ztna-ems-tag: <value of string>
           ztna-geo-tag: <value of string>
           ztna-status: <value in [disable, enable]>

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • 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.