fortinet.fortimanager.fmgr_pkg_firewall_policy6 – Configure IPv6 policies.

Note

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

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_policy6.

New in version 2.10: of fortinet.fortimanager

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

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

pkg

string / required

the parameter (pkg) in requested url

pkg_firewall_policy6

dictionary

the top level parameters set

action

string

Policy action (allow/deny/ipsec).

Choices:

  • deny

  • accept

  • ipsec

  • ssl-vpn

anti-replay

string

Enable/disable anti-replay check.

Choices:

  • disable

  • enable

app-category

string

Application category ID list.

app-group

string

Application group names.

application

integer

Application ID list.

application-list

string

Name of an existing Application list.

auto-asic-offload

string

Enable/disable policy traffic ASIC offloading.

Choices:

  • disable

  • enable

av-profile

string

Name of an existing Antivirus profile.

cifs-profile

string

Name of an existing CIFS profile.

comments

string

Comment.

custom-log-fields

string

Log field index numbers to append custom log fields to log messages for this policy.

decrypted-traffic-mirror

string

Decrypted traffic mirror.

devices

string

Names of devices or device groups that can be matched by the policy.

diffserv-forward

string

Enable to change packets DiffServ values to the specified diffservcode-forward value.

Choices:

  • disable

  • enable

diffserv-reverse

string

Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value.

Choices:

  • disable

  • enable

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.

dscp-match

string

Enable DSCP check.

Choices:

  • disable

  • enable

dscp-negate

string

Enable negated DSCP match.

Choices:

  • disable

  • enable

dscp-value

string

DSCP value.

dsri

string

Enable DSRI to ignore HTTP server responses.

Choices:

  • disable

  • enable

dstaddr

string

Destination address and address group names.

dstaddr-negate

string

When enabled dstaddr specifies what the destination address must NOT be.

Choices:

  • disable

  • enable

dstintf

string

Outgoing (egress) interface.

emailfilter-profile

string

Name of an existing email filter profile.

firewall-session-dirty

string

How to handle sessions if the configuration of this firewall policy changes.

Choices:

  • check-all

  • check-new

fixedport

string

Enable to prevent source NAT from changing a sessions source port.

Choices:

  • disable

  • enable

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

Redirect HTTP(S) traffic to matching transparent web proxy policy.

Choices:

  • disable

  • enable

icap-profile

string

Name of an existing ICAP profile.

inbound

string

Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN.

Choices:

  • disable

  • enable

inspection-mode

string

Policy inspection mode (Flow/proxy). Default is Flow mode.

Choices:

  • proxy

  • flow

ippool

string

Enable to use IP Pools for source NAT.

Choices:

  • disable

  • enable

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

Enable or disable logging. Log all sessions or security profile sessions.

Choices:

  • disable

  • enable

  • all

  • utm

logtraffic-start

string

Record logs when a session starts and ends.

Choices:

  • disable

  • enable

mms-profile

string

Name of an existing MMS profile.

name

string

Policy name.

nat

string

Enable/disable source NAT.

Choices:

  • disable

  • enable

natinbound

string

Policy-based IPsec VPN: apply destination NAT to inbound traffic.

Choices:

  • disable

  • enable

natoutbound

string

Policy-based IPsec VPN: apply source NAT to outbound traffic.

Choices:

  • disable

  • enable

np-accelation

string

Enable/disable UTM Network Processor acceleration.

Choices:

  • disable

  • enable

np-acceleration

string

Enable/disable UTM Network Processor acceleration.

Choices:

  • disable

  • enable

outbound

string

Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN.

Choices:

  • disable

  • enable

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

Determine whether the firewall policy allows security profile groups or single profiles only.

Choices:

  • single

  • group

replacemsg-override-group

string

Override the default replacement message group for this policy.

rsso

string

Enable/disable RADIUS single sign-on (RSSO).

Choices:

  • disable

  • enable

schedule

string

Schedule name.

send-deny-packet

string

Enable/disable return of deny-packet.

Choices:

  • disable

  • enable

service

string

Service and service group names.

service-negate

string

When enabled service specifies what the service must NOT be.

Choices:

  • disable

  • enable

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

When enabled srcaddr specifies what the source address must NOT be.

Choices:

  • disable

  • enable

srcintf

string

Incoming (ingress) interface.

ssh-filter-profile

string

Name of an existing SSH filter profile.

ssh-policy-redirect

string

Redirect SSH traffic to matching transparent proxy policy.

Choices:

  • disable

  • enable

ssl-mirror

string

Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring).

Choices:

  • disable

  • enable

ssl-mirror-intf

string

SSL mirror interface name.

ssl-ssh-profile

string

Name of an existing SSL SSH profile.

status

string

Enable or disable this policy.

Choices:

  • disable

  • enable

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

Enable/disable creation of TCP session without SYN flag.

Choices:

  • all

  • data-only

  • disable

timeout-send-rst

string

Enable/disable sending RST packets when TCP sessions expire.

Choices:

  • disable

  • enable

tos

string

ToS (Type of Service) value used for comparison.

tos-mask

string

Non-zero bit positions are used for comparison while zero bit positions are ignored.

tos-negate

string

Enable negated TOS match.

Choices:

  • disable

  • enable

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

Enable AV/web/ips protection profile.

Choices:

  • disable

  • enable

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

vlan-filter

string

Set VLAN filters.

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.

webcache

string

Enable/disable web cache.

Choices:

  • disable

  • enable

webcache-https

string

Enable/disable web cache for HTTPS.

Choices:

  • disable

  • enable

webfilter-profile

string

Name of an existing Web filter profile.

webproxy-forward-server

string

Web proxy forward server name.

webproxy-profile

string

Webproxy profile name.

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

the directive to create, update or delete an object

Choices:

  • present

  • absent

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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 IPv6 policies.
     fmgr_pkg_firewall_policy6:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy6:
           action: accept #<value in [deny, accept, ipsec, ...]>
           comments: ansible-comment
           dstaddr: all
           dstintf: any
           name: ansible-test-policy6
           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 IPv6 policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_policy6'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               policy6: ''

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)