W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_pkg_firewall_policy6 – Configure IPv6 policies.

Note

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

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

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

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
pkg string / required			the parameter (pkg) in requested url
pkg_firewall_policy6 dictionary			the top level parameters set
	action string	Choices: deny accept ipsec ssl-vpn	Policy action (allow/deny/ipsec).
	app-category string		Application category ID list.
	application integer		no description
	application-list string		Name of an existing Application list.
	auto-asic-offload string	Choices: disable enable	Enable/disable policy traffic ASIC offloading.
	av-profile string		Name of an existing Antivirus profile.
	comments string		Comment.
	custom-log-fields string		Log field index numbers to append custom log fields to log messages for this policy.
	devices string		Names of devices or device groups that can be matched by the policy.
	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.
	dscp-match string	Choices: disable enable	Enable DSCP check.
	dscp-negate string	Choices: disable enable	Enable negated DSCP match.
	dscp-value string		DSCP value.
	dsri string	Choices: disable enable	Enable DSRI to ignore HTTP server responses.
	dstaddr string		Destination address and address group names.
	dstaddr-negate string	Choices: disable enable	When enabled dstaddr specifies what the destination address must NOT be.
	dstintf string		Outgoing (egress) interface.
	firewall-session-dirty string	Choices: check-all check-new	How to handle sessions if the configuration of this firewall policy changes.
	fixedport string	Choices: disable enable	Enable to prevent source NAT from changing a sessions source port.
	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.
	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.
	ippool string	Choices: disable enable	Enable to use IP Pools for source NAT.
	ips-sensor string		Name of an existing IPS sensor.
	label string		Label for the policy that appears when the GUI is in Section View mode.
	logtraffic string	Choices: disable enable 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 and ends.
	mms-profile string		Name of an existing MMS profile.
	name string		Policy name.
	nat string	Choices: disable enable	Enable/disable source NAT.
	natinbound string	Choices: disable enable	Policy-based IPsec VPN: apply destination NAT to inbound traffic.
	natoutbound string	Choices: disable enable	Policy-based IPsec VPN: apply source NAT to outbound traffic.
	np-accelation string	Choices: disable enable	Enable/disable UTM Network Processor acceleration.
	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.
	poolname string		IP 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.
	replacemsg-override-group string		Override the default replacement message group for this policy.
	rsso string	Choices: disable enable	Enable/disable RADIUS single sign-on (RSSO).
	schedule string		Schedule name.
	send-deny-packet string	Choices: disable enable	Enable/disable return of deny-packet.
	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		Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL.
	spamfilter-profile string		Name of an existing Spam filter profile.
	srcaddr string		Source address and address group names.
	srcaddr-negate string	Choices: disable enable	When enabled srcaddr specifies what the source address must NOT be.
	srcintf string		Incoming (ingress) interface.
	ssl-mirror string	Choices: disable enable	Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring).
	ssl-mirror-intf string		SSL mirror interface name.
	ssl-ssh-profile string		Name of an existing SSL SSH profile.
	status string	Choices: disable enable	Enable or disable this policy.
	tags string		Names of object-tags applied to this policy.
	tcp-mss-receiver integer		Receiver TCP maximum segment size (MSS).
	tcp-mss-sender integer		Sender TCP maximum segment size (MSS).
	tcp-session-without-syn string	Choices: all data-only disable	Enable/disable creation of TCP session without SYN flag.
	timeout-send-rst string	Choices: disable enable	Enable/disable sending RST packets when TCP sessions expire.
	traffic-shaper string		Reverse 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 AV/web/ips protection profile.
	uuid string		Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
	vlan-cos-fwd integer		VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest
	vlan-cos-rev integer		VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest
	voip-profile string		Name of an existing VoIP profile.
	vpntunnel string		Policy-based IPsec VPN: name of the IPsec VPN Phase 1.
	webfilter-profile string		Name of an existing Web filter profile.
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 IPv6 policies.
     fmgr_pkg_firewall_policy6:
        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_policy6:
           action: <value in [deny, accept, ipsec, ...]>
           app-category: <value of string>
           application: <value of integer>
           application-list: <value of string>
           auto-asic-offload: <value in [disable, enable]>
           av-profile: <value of string>
           comments: <value of string>
           custom-log-fields: <value of string>
           devices: <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>
           dscp-match: <value in [disable, enable]>
           dscp-negate: <value in [disable, enable]>
           dscp-value: <value of string>
           dsri: <value in [disable, enable]>
           dstaddr: <value of string>
           dstaddr-negate: <value in [disable, enable]>
           dstintf: <value of string>
           firewall-session-dirty: <value in [check-all, check-new]>
           fixedport: <value in [disable, enable]>
           global-label: <value of string>
           groups: <value of string>
           icap-profile: <value of string>
           inbound: <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]>
           mms-profile: <value of string>
           name: <value of string>
           nat: <value in [disable, enable]>
           natinbound: <value in [disable, enable]>
           natoutbound: <value in [disable, enable]>
           np-accelation: <value in [disable, enable]>
           outbound: <value in [disable, enable]>
           per-ip-shaper: <value of string>
           policyid: <value of integer>
           poolname: <value of string>
           profile-group: <value of string>
           profile-protocol-options: <value of string>
           profile-type: <value in [single, group]>
           replacemsg-override-group: <value of string>
           rsso: <value in [disable, enable]>
           schedule: <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>
           spamfilter-profile: <value of string>
           srcaddr: <value of string>
           srcaddr-negate: <value in [disable, enable]>
           srcintf: <value of string>
           ssl-mirror: <value in [disable, enable]>
           ssl-mirror-intf: <value of string>
           ssl-ssh-profile: <value of string>
           status: <value in [disable, enable]>
           tags: <value of string>
           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]>
           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>
           vlan-cos-fwd: <value of integer>
           vlan-cos-rev: <value of integer>
           voip-profile: <value of string>
           vpntunnel: <value of string>
           webfilter-profile: <value of string>

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/2.11/collections/fortinet/fortimanager/fmgr_pkg_firewall_policy6_module.html