You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.3).

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	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
firewall_interface_policy dictionary	Configure IPv4 interface policies.
address_type string	Policy address type (IPv4 or IPv6). Choices: ipv4 ipv6
application_list string	Application list name. Source application.list.name.
application_list_status string	Enable/disable application control. Choices: enable disable
av_profile string	Antivirus profile. Source antivirus.profile.name.
av_profile_status string	Enable/disable antivirus. Choices: enable disable
comments string	Comments.
dlp_sensor string	DLP sensor name. Source dlp.sensor.name.
dlp_sensor_status string	Enable/disable DLP. Choices: enable disable
dsri string	Enable/disable DSRI. Choices: enable disable
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	Enable/disable email filter. Choices: enable disable
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	Enable/disable IPS. Choices: enable disable
label string	Label.
logtraffic string	Logging type to be used in this policy (Options: all | utm | disable). Choices: all utm disable
policyid integer / required	Policy ID.
scan_botnet_connections string	Enable/disable scanning for connections to Botnet servers. Choices: disable block monitor
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	Enable/disable antispam. Choices: enable disable
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	Enable/disable this policy. Choices: enable disable
webfilter_profile string	Web filter profile. Source webfilter.profile.name.
webfilter_profile_status string	Enable/disable web filtering. Choices: enable disable
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	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. Default: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_firewall_interface_policy
    fortios_firewall_interface_policy:
      vdom: root
      state: present
      firewall_interface_policy:
        address_type: ipv4
        application_list_status: disable
        av_profile_status: disable
        dlp_sensor_status: disable
        dsri: disable
        dstaddr:
        - name: all
        emailfilter_profile_status: disable
        interface: port4
        ips_sensor_status: disable
        logtraffic: all
        policyid: 1
        service:
        - name: ALL
        srcaddr:
        - name: all
        status: enable
        webfilter_profile_status: disable

Return Values

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

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always 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)