fortinet.fortimanager.fmgr_pkg_firewall_consolidated_policy – Configure consolidated IPv4/IPv6 policies.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_consolidated_policy.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task
pkg string / required			the parameter (pkg) in requested url
pkg_firewall_consolidated_policy dictionary			the top level parameters set
	action string	Choices: deny accept ipsec	Policy action (allow/deny/ipsec).
	app-category string		Application category ID list.
	app-group string		Application group names.
	application integer		no description
	application-list string		Name of an existing Application list.
	auto-asic-offload string	Choices: disable enable	Enable/disable offloading security profile processing to CP processors.
	av-profile string		Name of an existing Antivirus profile.
	captive-portal-exempt string	Choices: disable enable	Enable exemption of some users from the captive portal.
	cifs-profile string		Name of an existing CIFS profile.
	comments string		Comment.
	diffserv-forward string	Choices: disable enable	Enable to change packets DiffServ values to the specified diffservcode-forward value.
	diffserv-reverse string	Choices: disable enable	Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value.
	diffservcode-forward string		Change packets DiffServ to this value.
	diffservcode-rev string		Change packets reverse (reply) DiffServ to this value.
	dlp-sensor string		Name of an existing DLP sensor.
	dnsfilter-profile string		Name of an existing DNS filter profile.
	dstaddr-negate string	Choices: disable enable	When enabled dstaddr specifies what the destination address must NOT be.
	dstaddr4 string		Destination IPv4 address name and address group names.
	dstaddr6 string		Destination IPv6 address name and address group names.
	dstintf string		Outgoing (egress) interface.
	emailfilter-profile string		Name of an existing email filter profile.
	fixedport string	Choices: disable enable	Enable to prevent source NAT from changing a sessions source port.
	fsso-groups string		Names of FSSO groups.
	global-label string		Label for the policy that appears when the GUI is in Global View mode.
	groups string		Names of user groups that can authenticate with this policy.
	http-policy-redirect string	Choices: disable enable	Redirect HTTP(S) traffic to matching transparent web proxy policy.
	icap-profile string		Name of an existing ICAP profile.
	inbound string	Choices: disable enable	Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN.
	inspection-mode string	Choices: proxy flow	Policy inspection mode (Flow/proxy). Default is Flow mode.
	internet-service string	Choices: disable enable	Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used.
	internet-service-custom string		Custom Internet Service name.
	internet-service-custom-group string		Custom Internet Service group name.
	internet-service-group string		Internet Service group name.
	internet-service-id string		Internet Service ID.
	internet-service-negate string	Choices: disable enable	When enabled internet-service specifies what the service must NOT be.
	internet-service-src string	Choices: disable enable	Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used.
	internet-service-src-custom string		Custom Internet Service source name.
	internet-service-src-custom-group string		Custom Internet Service source group name.
	internet-service-src-group string		Internet Service source group name.
	internet-service-src-id string		Internet Service source ID.
	internet-service-src-negate string	Choices: disable enable	When enabled internet-service-src specifies what the service must NOT be.
	ippool string	Choices: disable enable	Enable to use IP Pools for source NAT.
	ips-sensor string		Name of an existing IPS sensor.
	logtraffic string	Choices: disable all utm	Enable or disable logging. Log all sessions or security profile sessions.
	logtraffic-start string	Choices: disable enable	Record logs when a session starts.
	mms-profile string		Name of an existing MMS profile.
	name string		Policy name.
	nat string	Choices: disable enable	Enable/disable source NAT.
	outbound string	Choices: disable enable	Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN.
	per-ip-shaper string		Per-IP traffic shaper.
	policyid integer		Policy ID (0 - 4294967294).
	poolname4 string		IPv4 pool names.
	poolname6 string		IPv6 pool names.
	profile-group string		Name of profile group.
	profile-protocol-options string		Name of an existing Protocol options profile.
	profile-type string	Choices: single group	Determine whether the firewall policy allows security profile groups or single profiles only.
	schedule string		Schedule name.
	service string		Service and service group names.
	service-negate string	Choices: disable enable	When enabled service specifies what the service must NOT be.
	session-ttl integer		TTL in seconds for sessions accepted by this policy (0 means use the system default session TTL).
	srcaddr-negate string	Choices: disable enable	When enabled srcaddr specifies what the source address must NOT be.
	srcaddr4 string		Source IPv4 address name and address group names.
	srcaddr6 string		Source IPv6 address name and address group names.
	srcintf string		Incoming (ingress) interface.
	ssh-filter-profile string		Name of an existing SSH filter profile.
	ssh-policy-redirect string	Choices: disable enable	Redirect SSH traffic to matching transparent proxy policy.
	ssl-ssh-profile string		Name of an existing SSL SSH profile.
	status string	Choices: disable enable	Enable or disable this policy.
	tcp-mss-receiver integer		Receiver TCP maximum segment size (MSS).
	tcp-mss-sender integer		Sender TCP maximum segment size (MSS).
	traffic-shaper string		Traffic shaper.
	traffic-shaper-reverse string		Reverse traffic shaper.
	url-category string		URL category ID list.
	users string		Names of individual users that can authenticate with this policy.
	utm-status string	Choices: disable enable	Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy.
	uuid string		Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
	voip-profile string		Name of an existing VoIP profile.
	vpntunnel string		Policy-based IPsec VPN: name of the IPsec VPN Phase 1.
	waf-profile string		Name of an existing Web application firewall profile.
	wanopt string	Choices: disable enable	Enable/disable WAN optimization.
	wanopt-detection string	Choices: active passive off	WAN optimization auto-detection mode.
	wanopt-passive-opt string	Choices: default transparent non-transparent	WAN optimization passive mode options. This option decides what IP address will be used to connect to server.
	wanopt-peer string		WAN optimization peer.
	wanopt-profile string		WAN optimization profile.
	webcache string	Choices: disable enable	Enable/disable web cache.
	webcache-https string	Choices: disable enable	Enable/disable web cache for HTTPS.
	webfilter-profile string		Name of an existing Web filter profile.
	webproxy-forward-server string		Webproxy forward server name.
	webproxy-profile string		Webproxy profile name.
proposed_method string		Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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: Configure consolidated IPv4/IPv6 policies.
     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 here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_pkg_firewall_consolidated_policy_module.html