fortios_firewall_policy46 – Configure IPv4 to IPv6 policies in Fortinet’s FortiOS and FortiGate

New in version 2.8.

Synopsis

  • This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and policy46 category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

The below requirements are needed on the host that executes this module.

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments
firewall_policy46
-
Default:
null
Configure IPv4 to IPv6 policies.
action
-
    Choices:
  • accept
  • deny
Accept or deny traffic matching the policy.
comments
-
Comment.
dstaddr
-
Destination address objects.
name
- / required
Address name. Source firewall.vip46.name firewall.vipgrp46.name.
dstintf
-
Destination interface name. Source system.interface.name system.zone.name.
fixedport
-
    Choices:
  • enable
  • disable
Enable/disable fixed port for this policy.
ippool
-
    Choices:
  • enable
  • disable
Enable/disable use of IP Pools for source NAT.
logtraffic
-
    Choices:
  • enable
  • disable
Enable/disable traffic logging for this policy.
per-ip-shaper
-
Per IP traffic shaper. Source firewall.shaper.per-ip-shaper.name.
permit-any-host
-
    Choices:
  • enable
  • disable
Enable/disable allowing any host.
policyid
- / required
Policy ID.
poolname
-
IP Pool names.
name
- / required
IP pool name. Source firewall.ippool6.name.
schedule
-
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name.
service
-
Service name.
name
- / required
Service name. Source firewall.service.custom.name firewall.service.group.name.
srcaddr
-
Source address objects.
name
- / required
Address name. Source firewall.address.name firewall.addrgrp.name.
srcintf
-
Source interface name. Source system.zone.name system.interface.name.
state
-
    Choices:
  • present
  • absent
Indicates whether to create or remove the object
status
-
    Choices:
  • enable
  • disable
Enable/disable this policy.
tcp-mss-receiver
-
TCP Maximum Segment Size value of receiver (0 - 65535, default = 0)
tcp-mss-sender
-
TCP Maximum Segment Size value of sender (0 - 65535, default = 0).
traffic-shaper
-
Traffic shaper. Source firewall.shaper.traffic-shaper.name.
traffic-shaper-reverse
-
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name.
uuid
-
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
host
- / required
FortiOS or FortiGate ip address.
https
boolean
    Choices:
  • no ←
  • yes
Indicates if the requests towards FortiGate must use HTTPS protocol
password
-
Default:
""
FortiOS or FortiGate password.
username
- / required
FortiOS or FortiGate username.
vdom
-
Default:
"root"
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

  • Requires fortiosapi library developed by Fortinet
  • Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv4 to IPv6 policies.
    fortios_firewall_policy46:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_policy46:
        state: "present"
        action: "accept"
        comments: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_6 (source firewall.vip46.name firewall.vipgrp46.name)"
        dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
        fixedport: "enable"
        ippool: "enable"
        logtraffic: "enable"
        per-ip-shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        permit-any-host: "enable"
        policyid: "13"
        poolname:
         -
            name: "default_name_15 (source firewall.ippool6.name)"
        schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
        service:
         -
            name: "default_name_18 (source firewall.service.custom.name firewall.service.group.name)"
        srcaddr:
         -
            name: "default_name_20 (source firewall.address.name firewall.addrgrp.name)"
        srcintf: "<your_own_value> (source system.zone.name system.interface.name)"
        status: "enable"
        tcp-mss-receiver: "23"
        tcp-mss-sender: "24"
        traffic-shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        traffic-shaper-reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        uuid: "<your_own_value>"

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
key1
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.