Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_firewall_interface_policy_module.html

fortinet.fortios.fortios_firewall_interface_policy – Configure IPv4 interface policies in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_interface_policy.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and interface_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_interface_policy
dictionary
Configure IPv4 interface policies.
address_type
string
    Choices:
  • ipv4
  • ipv6
Policy address type (IPv4 or IPv6).
application_list
string
Application list name. Source application.list.name.
application_list_status
string
    Choices:
  • enable
  • disable
Enable/disable application control.
av_profile
string
Antivirus profile. Source antivirus.profile.name.
av_profile_status
string
    Choices:
  • enable
  • disable
Enable/disable antivirus.
comments
string
Comments.
dlp_sensor
string
DLP sensor name. Source dlp.sensor.name.
dlp_sensor_status
string
    Choices:
  • enable
  • disable
Enable/disable DLP.
dsri
string
    Choices:
  • enable
  • disable
Enable/disable DSRI.
dstaddr
list / elements=string
Address object to limit traffic monitoring to network traffic sent to the specified address or range.
name
string / required
Address name. Source firewall.address.name firewall.addrgrp.name.
emailfilter_profile
string
Email filter profile. Source emailfilter.profile.name.
emailfilter_profile_status
string
    Choices:
  • enable
  • disable
Enable/disable email filter.
interface
string
Monitored interface name from available interfaces. Source system.zone.name system.interface.name.
ips_sensor
string
IPS sensor name. Source ips.sensor.name.
ips_sensor_status
string
    Choices:
  • enable
  • disable
Enable/disable IPS.
label
string
Label.
logtraffic
string
    Choices:
  • all
  • utm
  • disable
Logging type to be used in this policy (Options: all | utm | disable).
policyid
integer / required
Policy ID.
scan_botnet_connections
string
    Choices:
  • disable
  • block
  • monitor
Enable/disable scanning for connections to Botnet servers.
service
list / elements=string
Service object from available options.
name
string / required
Service name. Source firewall.service.custom.name firewall.service.group.name.
spamfilter_profile
string
Antispam profile. Source spamfilter.profile.name.
spamfilter_profile_status
string
    Choices:
  • enable
  • disable
Enable/disable antispam.
srcaddr
list / elements=string
Address object to limit traffic monitoring to network traffic sent from the specified address or range.
name
string / required
Address name. Source firewall.address.name firewall.addrgrp.name.
status
string
    Choices:
  • enable
  • disable
Enable/disable this policy.
webfilter_profile
string
Web filter profile. Source webfilter.profile.name.
webfilter_profile_status
string
    Choices:
  • enable
  • disable
Enable/disable web filtering.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
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

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPv4 interface policies.
    fortios_firewall_interface_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_interface_policy:
        address_type: "ipv4"
        application_list: "<your_own_value> (source application.list.name)"
        application_list_status: "enable"
        av_profile: "<your_own_value> (source antivirus.profile.name)"
        av_profile_status: "enable"
        comments: "<your_own_value>"
        dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
        dlp_sensor_status: "enable"
        dsri: "enable"
        dstaddr:
         -
            name: "default_name_13 (source firewall.address.name firewall.addrgrp.name)"
        emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
        emailfilter_profile_status: "enable"
        interface: "<your_own_value> (source system.zone.name system.interface.name)"
        ips_sensor: "<your_own_value> (source ips.sensor.name)"
        ips_sensor_status: "enable"
        label: "<your_own_value>"
        logtraffic: "all"
        policyid: "21"
        scan_botnet_connections: "disable"
        service:
         -
            name: "default_name_24 (source firewall.service.custom.name firewall.service.group.name)"
        spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
        spamfilter_profile_status: "enable"
        srcaddr:
         -
            name: "default_name_28 (source firewall.address.name firewall.addrgrp.name)"
        status: "enable"
        webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
        webfilter_profile_status: "enable"

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:
id
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


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 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/fortios/fortios_firewall_interface_policy_module.html