fortios_firewall_interface_policy6 – Configure IPv6 interface policies in Fortinet’s FortiOS and FortiGate.

New in version 2.8.

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

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • vdom - 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. type: str default: root
  • state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
  • firewall_interface_policy6 - Configure IPv6 interface policies. type: dict
    • state - B(Deprecated) type: str required: False choices: present, absent
    • address_type - Policy address type (IPv4 or IPv6). type: str choices: ipv4, ipv6
    • application_list - Application list name. Source application.list.name. type: str
    • application_list_status - Enable/disable application control. type: str choices: enable, disable
    • av_profile - Antivirus profile. Source antivirus.profile.name. type: str
    • av_profile_status - Enable/disable antivirus. type: str choices: enable, disable
    • comments - Comments. type: str
    • dlp_sensor - DLP sensor name. Source dlp.sensor.name. type: str
    • dlp_sensor_status - Enable/disable DLP. type: str choices: enable, disable
    • dsri - Enable/disable DSRI. type: str choices: enable, disable
    • dstaddr6 - IPv6 address object to limit traffic monitoring to network traffic sent to the specified address or range. type: list
      • name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True
    • interface - Monitored interface name from available interfaces. Source system.zone.name system.interface.name. type: str
    • ips_sensor - IPS sensor name. Source ips.sensor.name. type: str
    • ips_sensor_status - Enable/disable IPS. type: str choices: enable, disable
    • label - Label. type: str
    • logtraffic - Logging type to be used in this policy (Options: all | utm | disable). type: str choices: all, utm, disable
    • policyid - Policy ID. type: int required: True
    • scan_botnet_connections - Enable/disable scanning for connections to Botnet servers. type: str choices: disable, block, monitor
    • service6 - Service name. type: list
      • name - Address name. Source firewall.service.custom.name firewall.service.group.name. type: str required: True
    • spamfilter_profile - Antispam profile. Source spamfilter.profile.name. type: str
    • spamfilter_profile_status - Enable/disable antispam. type: str choices: enable, disable
    • srcaddr6 - IPv6 address object to limit traffic monitoring to network traffic sent from the specified address or range. type: list
      • name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True
    • status - Enable/disable this policy. type: str choices: enable, disable
    • webfilter_profile - Web filter profile. Source webfilter.profile.name. type: str
    • webfilter_profile_status - Enable/disable web filtering. type: str choices: enable, disable

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 IPv6 interface policies.
    fortios_firewall_interface_policy6:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_interface_policy6:
        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"
        dstaddr6:
         -
            name: "default_name_13 (source firewall.address6.name firewall.addrgrp6.name)"
        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: "19"
        scan_botnet_connections: "disable"
        service6:
         -
            name: "default_name_22 (source firewall.service.custom.name firewall.service.group.name)"
        spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
        spamfilter_profile_status: "enable"
        srcaddr6:
         -
            name: "default_name_26 (source firewall.address6.name firewall.addrgrp6.name)"
        status: "enable"
        webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
        webfilter_profile_status: "enable"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.