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 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_policy6
dictionary
the top level parameters set
action
string
    Choices:
  • deny
  • accept
  • ipsec
  • ssl-vpn
Policy action (allow/deny/ipsec).
anti-replay
string
    Choices:
  • disable
  • enable
Enable/disable anti-replay check.
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
    Choices:
  • disable
  • enable
Enable/disable policy traffic ASIC offloading.
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
    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.
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.
emailfilter-profile
string
Name of an existing email filter profile.
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.
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.
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.
np-acceleration
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.
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-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.
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
    Choices:
  • disable
  • enable
Enable negated TOS match.
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
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
    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
Web proxy 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: 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 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)