ansible.builtin.fortios_firewall_interface_policy6 (v2.8.20) — module

Configure IPv6 interface policies in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv6 interface policies.
    fortios_firewall_interface_policy6:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_interface_policy6:
        state: "present"
        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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - 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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_interface_policy6:
    default: null
    description:
    - Configure IPv6 interface policies.
    suboptions:
      address-type:
        choices:
        - ipv4
        - ipv6
        description:
        - Policy address type (IPv4 or IPv6).
      application-list:
        description:
        - Application list name. Source application.list.name.
      application-list-status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable application control.
      av-profile:
        description:
        - Antivirus profile. Source antivirus.profile.name.
      av-profile-status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable antivirus.
      comments:
        description:
        - Comments.
      dlp-sensor:
        description:
        - DLP sensor name. Source dlp.sensor.name.
      dlp-sensor-status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DLP.
      dsri:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DSRI.
      dstaddr6:
        description:
        - IPv6 address object to limit traffic monitoring to network traffic sent to the
          specified address or range.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address6.name firewall.addrgrp6.name.
            required: true
      interface:
        description:
        - Monitored interface name from available interfaces. Source system.zone.name
          system.interface.name.
      ips-sensor:
        description:
        - IPS sensor name. Source ips.sensor.name.
      ips-sensor-status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPS.
      label:
        description:
        - Label.
      logtraffic:
        choices:
        - all
        - utm
        - disable
        description:
        - 'Logging type to be used in this policy (Options: all | utm | disable, Default:
          utm).'
      policyid:
        description:
        - Policy ID.
        required: true
      scan-botnet-connections:
        choices:
        - disable
        - block
        - monitor
        description:
        - Enable/disable scanning for connections to Botnet servers.
      service6:
        description:
        - Service name.
        suboptions:
          name:
            description:
            - Address name. Source firewall.service.custom.name firewall.service.group.name.
            required: true
      spamfilter-profile:
        description:
        - Antispam profile. Source spamfilter.profile.name.
      spamfilter-profile-status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable antispam.
      srcaddr6:
        description:
        - IPv6 address object to limit traffic monitoring to network traffic sent from
          the specified address or range.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address6.name firewall.addrgrp6.name.
            required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy.
      webfilter-profile:
        description:
        - Web filter profile. Source webfilter.profile.name.
      webfilter-profile-status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable web filtering.

Outputs

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