fmgr_pkg_firewall_consolidated_policy – Configure consolidated 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

	6.2.1	6.2.3	6.2.5
pkg_firewall_consolidated_policy	yes	yes	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
• pkg - The parameter in requested url type: str required: true
• pkg_firewall_consolidated_policy - no description type: dict
• action - Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  action	True	True	True	False	False	False	False	False

• app-category - Application category ID list. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  app-category	True	True	True	False	False	False	False	False

• app-group - Application group names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  app-group	True	True	True	False	False	False	False	False

• application - Application. type: int more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  application	True	True	True	False	False	False	False	False

• application-list - Name of an existing Application list. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  application-list	True	True	True	False	False	False	False	False

• auto-asic-offload - Enable/disable offloading security profile processing to CP processors. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  auto-asic-offload	True	True	True	False	False	False	False	False

• av-profile - Name of an existing Antivirus profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  av-profile	True	True	True	False	False	False	False	False

• cifs-profile - Name of an existing CIFS profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  cifs-profile	True	True	True	False	False	False	False	False

• comments - Comment. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  comments	True	True	True	False	False	False	False	False

• diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  diffserv-forward	True	True	True	False	False	False	False	False

• diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  diffserv-reverse	True	True	True	False	False	False	False	False

• diffservcode-forward - Change packets DiffServ to this value. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  diffservcode-forward	True	True	True	False	False	False	False	False

• diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  diffservcode-rev	True	True	True	False	False	False	False	False

• dlp-sensor - Name of an existing DLP sensor. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  dlp-sensor	True	True	True	False	False	False	False	False

• dnsfilter-profile - Name of an existing DNS filter profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  dnsfilter-profile	True	True	True	False	False	False	False	False

• dstaddr4 - Destination IPv4 address name and address group names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  dstaddr4	True	True	True	False	False	False	False	False

• dstaddr6 - Destination IPv6 address name and address group names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  dstaddr6	True	True	True	False	False	False	False	False

• dstintf - Outgoing (egress) interface. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  dstintf	True	True	True	False	False	False	False	False

• emailfilter-profile - Name of an existing email filter profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  emailfilter-profile	True	True	True	False	False	False	False	False

• fixedport - Enable to prevent source NAT from changing a sessions source port. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  fixedport	True	True	True	False	False	False	False	False

• groups - Names of user groups that can authenticate with this policy. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  groups	True	True	True	False	False	False	False	False

• http-policy-redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  http-policy-redirect	True	True	True	False	False	False	False	False

• icap-profile - Name of an existing ICAP profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  icap-profile	True	True	True	False	False	False	False	False

• inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  inbound	True	True	True	False	False	False	False	False

• inspection-mode - Policy inspection mode (Flow/proxy). type: str choices: [proxy, flow] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  inspection-mode	True	True	True	False	False	False	False	False

• internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service	True	True	True	False	False	False	False	False

• internet-service-custom - Custom Internet Service name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-custom	True	True	True	False	False	False	False	False

• internet-service-custom-group - Custom Internet Service group name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-custom-group	True	True	True	False	False	False	False	False

• internet-service-group - Internet Service group name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-group	True	True	True	False	False	False	False	False

• internet-service-id - Internet Service ID. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-id	True	True	True	False	False	False	False	False

• internet-service-src - Enable/disable use of Internet Services in source for this policy. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-src	True	True	True	False	False	False	False	False

• internet-service-src-custom - Custom Internet Service source name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-src-custom	True	True	True	False	False	False	False	False

• internet-service-src-custom-group - Custom Internet Service source group name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-src-custom-group	True	True	True	False	False	False	False	False

• internet-service-src-group - Internet Service source group name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-src-group	True	True	True	False	False	False	False	False

• internet-service-src-id - Internet Service source ID. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-src-id	True	True	True	False	False	False	False	False

• ippool - Enable to use IP Pools for source NAT. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ippool	True	True	True	False	False	False	False	False

• ips-sensor - Name of an existing IPS sensor. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ips-sensor	True	True	True	False	False	False	False	False

• logtraffic - Enable or disable logging. type: str choices: [disable, all, utm] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  logtraffic	True	True	True	False	False	False	False	False

• logtraffic-start - Record logs when a session starts. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  logtraffic-start	True	True	True	False	False	False	False	False

• mms-profile - Name of an existing MMS profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  mms-profile	True	True	True	False	False	False	False	False

• name - Policy name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  name	True	True	True	False	False	False	False	False

• nat - Enable/disable source NAT. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  nat	True	True	True	False	False	False	False	False

• outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  outbound	True	True	True	False	False	False	False	False

• per-ip-shaper - Per-IP traffic shaper. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  per-ip-shaper	True	True	True	False	False	False	False	False

• policyid - Policy ID (0 - 4294967294). type: int more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  policyid	True	True	True	False	False	False	False	False

• poolname4 - IPv4 pool names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  poolname4	True	True	True	False	False	False	False	False

• poolname6 - IPv6 pool names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  poolname6	True	True	True	False	False	False	False	False

• profile-group - Name of profile group. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  profile-group	True	True	True	False	False	False	False	False

• profile-protocol-options - Name of an existing Protocol options profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  profile-protocol-options	True	True	True	False	False	False	False	False

• profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  profile-type	True	True	True	False	False	False	False	False

• schedule - Schedule name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  schedule	True	True	True	False	False	False	False	False

• service - Service and service group names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  service	True	True	True	False	False	False	False	False

• session-ttl - TTL in seconds for sessions accepted by this policy (0 means use the system default session TTL). type: int more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  session-ttl	True	True	True	False	False	False	False	False

• srcaddr4 - Source IPv4 address name and address group names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  srcaddr4	True	True	True	False	False	False	False	False

• srcaddr6 - Source IPv6 address name and address group names. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  srcaddr6	True	True	True	False	False	False	False	False

• srcintf - Incoming (ingress) interface. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  srcintf	True	True	True	False	False	False	False	False

• ssh-filter-profile - Name of an existing SSH filter profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ssh-filter-profile	True	True	True	False	False	False	False	False

• ssh-policy-redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ssh-policy-redirect	True	True	True	False	False	False	False	False

• ssl-ssh-profile - Name of an existing SSL SSH profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ssl-ssh-profile	True	True	True	False	False	False	False	False

• status - Enable or disable this policy. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  status	True	True	True	False	False	False	False	False

• tcp-mss-receiver - Receiver TCP maximum segment size (MSS). type: int more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  tcp-mss-receiver	True	True	True	False	False	False	False	False

• tcp-mss-sender - Sender TCP maximum segment size (MSS). type: int more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  tcp-mss-sender	True	True	True	False	False	False	False	False

• traffic-shaper - Traffic shaper. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  traffic-shaper	True	True	True	False	False	False	False	False

• traffic-shaper-reverse - Reverse traffic shaper. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  traffic-shaper-reverse	True	True	True	False	False	False	False	False

• url-category - URL category ID list. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  url-category	True	True	True	False	False	False	False	False

• users - Names of individual users that can authenticate with this policy. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  users	True	True	True	False	False	False	False	False

• utm-status - Enable to add one or more security profiles (AV, IPS, etc. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  utm-status	True	True	True	False	False	False	False	False

• uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  uuid	True	True	True	False	False	False	False	False

• voip-profile - Name of an existing VoIP profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  voip-profile	True	True	True	False	False	False	False	False

• vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  vpntunnel	True	True	True	False	False	False	False	False

• waf-profile - Name of an existing Web application firewall profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  waf-profile	True	True	True	False	False	False	False	False

• wanopt - Enable/disable WAN optimization. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  wanopt	True	True	True	False	False	False	False	False

• wanopt-detection - WAN optimization auto-detection mode. type: str choices: [active, passive, off] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  wanopt-detection	True	True	True	False	False	False	False	False

• wanopt-passive-opt - WAN optimization passive mode options. type: str choices: [default, transparent, non-transparent] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  wanopt-passive-opt	True	True	True	False	False	False	False	False

• wanopt-peer - WAN optimization peer. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  wanopt-peer	True	True	True	False	False	False	False	False

• wanopt-profile - WAN optimization profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  wanopt-profile	True	True	True	False	False	False	False	False

• webcache - Enable/disable web cache. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  webcache	True	True	True	False	False	False	False	False

• webcache-https - Enable/disable web cache for HTTPS. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  webcache-https	True	True	True	False	False	False	False	False

• webfilter-profile - Name of an existing Web filter profile. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  webfilter-profile	True	True	True	False	False	False	False	False

• webproxy-forward-server - Webproxy forward server name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  webproxy-forward-server	True	True	True	False	False	False	False	False

• webproxy-profile - Webproxy profile name. type: str more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  webproxy-profile	True	True	True	False	False	False	False	False

• captive-portal-exempt - Enable exemption of some users from the captive portal. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  captive-portal-exempt	True	True	False	False	False	False	False

• dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  dstaddr-negate	True	True	False	False	False	False	False

• fsso-groups - Names of FSSO groups. type: str more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  fsso-groups	True	True	False	False	False	False	False

• global-label - Label for the policy that appears when the GUI is in Global View mode. type: str more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  global-label	True	True	False	False	False	False	False

• internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-negate	True	True	False	False	False	False	False

• internet-service-src-negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  internet-service-src-negate	True	True	False	False	False	False	False

• service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  service-negate	True	True	False	False	False	False	False

• srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  srcaddr-negate	True	True	False	False	False	False	False

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_pkg_firewall_consolidated_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>
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_firewall_consolidated_policy:
           action: <value in [deny, accept, ipsec]>
           app-category: <value of string>
           app-group: <value of string>
           application: <value of integer>
           application-list: <value of string>
           auto-asic-offload: <value in [disable, enable]>
           av-profile: <value of string>
           cifs-profile: <value of string>
           comments: <value of string>
           diffserv-forward: <value in [disable, enable]>
           diffserv-reverse: <value in [disable, enable]>
           diffservcode-forward: <value of string>
           diffservcode-rev: <value of string>
           dlp-sensor: <value of string>
           dnsfilter-profile: <value of string>
           dstaddr4: <value of string>
           dstaddr6: <value of string>
           dstintf: <value of string>
           emailfilter-profile: <value of string>
           fixedport: <value in [disable, enable]>
           groups: <value of string>
           http-policy-redirect: <value in [disable, enable]>
           icap-profile: <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-id: <value of string>
           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-id: <value of string>
           ippool: <value in [disable, enable]>
           ips-sensor: <value of string>
           logtraffic: <value in [disable, all, utm]>
           logtraffic-start: <value in [disable, enable]>
           mms-profile: <value of string>
           name: <value of string>
           nat: <value in [disable, enable]>
           outbound: <value in [disable, enable]>
           per-ip-shaper: <value of string>
           policyid: <value of integer>
           poolname4: <value of string>
           poolname6: <value of string>
           profile-group: <value of string>
           profile-protocol-options: <value of string>
           profile-type: <value in [single, group]>
           schedule: <value of string>
           service: <value of string>
           session-ttl: <value of integer>
           srcaddr4: <value of string>
           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>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           url-category: <value of string>
           users: <value of string>
           utm-status: <value in [disable, enable]>
           uuid: <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>
           webcache: <value in [disable, enable]>
           webcache-https: <value in [disable, enable]>
           webfilter-profile: <value of string>
           webproxy-forward-server: <value of string>
           webproxy-profile: <value of string>
           captive-portal-exempt: <value in [disable, enable]>
           dstaddr-negate: <value in [disable, enable]>
           fsso-groups: <value of string>
           global-label: <value of string>
           internet-service-negate: <value in [disable, enable]>
           internet-service-src-negate: <value in [disable, enable]>
           service-negate: <value in [disable, enable]>
           srcaddr-negate: <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.