fortinet.fortios.fortios_firewall_interface_policy (2.3.6) — module

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

| "added in version" 2.0.0 of fortinet.fortios"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure IPv4 interface policies.
  fortinet.fortios.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"
          casb_profile: "<your_own_value> (source casb.profile.name)"
          casb_profile_status: "enable"
          comments: "<your_own_value>"
          dlp_profile: "<your_own_value> (source dlp.profile.name)"
          dlp_profile_status: "enable"
          dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
          dlp_sensor_status: "enable"
          dsri: "enable"
          dstaddr:
              -
                  name: "default_name_17 (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: "<you_own_value>"
          scan_botnet_connections: "disable"
          service:
              -
                  name: "default_name_28 (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_32 (source firewall.address.name firewall.addrgrp.name)"
          status: "enable"
          uuid: "<your_own_value>"
          webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
          webfilter_profile_status: "enable"

Inputs

    
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.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

firewall_interface_policy:
    default: null
    description:
    - Configure IPv4 interface policies.
    suboptions:
      address_type:
        choices:
        - ipv4
        - ipv6
        description:
        - Policy address type (IPv4 or IPv6).
        type: str
      application_list:
        description:
        - Application list name. Source application.list.name.
        type: str
      application_list_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable application control.
        type: str
      av_profile:
        description:
        - Antivirus profile. Source antivirus.profile.name.
        type: str
      av_profile_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable antivirus.
        type: str
      casb_profile:
        description:
        - CASB profile. Source casb.profile.name.
        type: str
      casb_profile_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable CASB.
        type: str
      comments:
        description:
        - Comments.
        type: str
      dlp_profile:
        description:
        - DLP profile name. Source dlp.profile.name.
        type: str
      dlp_profile_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DLP.
        type: str
      dlp_sensor:
        description:
        - DLP sensor name. Source dlp.sensor.name.
        type: str
      dlp_sensor_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DLP.
        type: str
      dsri:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DSRI.
        type: str
      dstaddr:
        description:
        - Address object to limit traffic monitoring to network traffic sent to the specified
          address or range.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
            type: str
        type: list
      emailfilter_profile:
        description:
        - Email filter profile. Source emailfilter.profile.name.
        type: str
      emailfilter_profile_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable email filter.
        type: str
      interface:
        description:
        - Monitored interface name from available interfaces. Source system.zone.name
          system.interface.name.
        type: str
      ips_sensor:
        description:
        - IPS sensor name. Source ips.sensor.name.
        type: str
      ips_sensor_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPS.
        type: str
      label:
        description:
        - Label.
        type: str
      logtraffic:
        choices:
        - all
        - utm
        - disable
        description:
        - 'Logging type to be used in this policy (Options: all | utm | disable).'
        type: str
      policyid:
        description:
        - Policy ID (0 - 4294967295). see <a href='#notes'>Notes</a>.
        required: true
        type: int
      scan_botnet_connections:
        choices:
        - disable
        - block
        - monitor
        description:
        - Enable/disable scanning for connections to Botnet servers.
        type: str
      service:
        description:
        - Service object from available options.
        elements: dict
        suboptions:
          name:
            description:
            - Service name. Source firewall.service.custom.name firewall.service.group.name.
            required: true
            type: str
        type: list
      spamfilter_profile:
        description:
        - Antispam profile. Source spamfilter.profile.name.
        type: str
      spamfilter_profile_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable antispam.
        type: str
      srcaddr:
        description:
        - Address object to limit traffic monitoring to network traffic sent from the
          specified address or range.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
            type: str
        type: list
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy.
        type: str
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
      webfilter_profile:
        description:
        - Web filter profile. Source webfilter.profile.name.
        type: str
      webfilter_profile_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable web filtering.
        type: str
    type: dict

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