fortios_firewall_interface_policy.rst

source:	fortios_firewall_interface_policy.py
orphan:

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

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_firewall_interface_policy	v6.0.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: 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
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• firewall_interface_policy - Configure IPv4 interface policies. type: dict more...

  	Supported Version Ranges
  firewall_interface_policy	v6.0.0 -> latest

• address_type - Policy address type (IPv4 or IPv6). type: str choices: ipv4, ipv6 more...

  	Supported Version Ranges
  address_type	v6.0.0 -> v6.0.11	v6.2.3 -> v6.2.3
  [ipv4]	v6.0.0 -> latest
  [ipv6]	v6.0.0 -> latest

• application_list - Application list name. Source application.list.name. type: str more...

  	Supported Version Ranges
  application_list	v6.0.0 -> latest

• application_list_status - Enable/disable application control. type: str choices: enable, disable more...

  	Supported Version Ranges
  application_list_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• av_profile - Antivirus profile. Source antivirus.profile.name. type: str more...

  	Supported Version Ranges
  av_profile	v6.0.0 -> latest

• av_profile_status - Enable/disable antivirus. type: str choices: enable, disable more...

  	Supported Version Ranges
  av_profile_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• casb_profile - CASB profile. Source casb.profile.name. type: str more...

  	Supported Version Ranges
  casb_profile	v7.4.1 -> latest

• casb_profile_status - Enable/disable CASB. type: str choices: enable, disable more...

  	Supported Version Ranges
  casb_profile_status	v7.4.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• comments - Comments. type: str more...

  	Supported Version Ranges
  comments	v6.0.0 -> latest

• dlp_profile - DLP profile name. Source dlp.profile.name. type: str more...

  	Supported Version Ranges
  dlp_profile	v7.2.0 -> latest

• dlp_profile_status - Enable/disable DLP. type: str choices: enable, disable more...

  	Supported Version Ranges
  dlp_profile_status	v7.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• dlp_sensor - DLP sensor name. Source dlp.sensor.name. type: str more...

  	Supported Version Ranges
  dlp_sensor	v6.0.0 -> v7.0.12

• dlp_sensor_status - Enable/disable DLP. type: str choices: enable, disable more...

  	Supported Version Ranges
  dlp_sensor_status	v6.0.0 -> v7.0.12
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• dsri - Enable/disable DSRI. type: str choices: enable, disable more...

  	Supported Version Ranges
  dsri	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• dstaddr - Address object to limit traffic monitoring to network traffic sent to the specified address or range. type: list member_path: dstaddr:name more...

  	Supported Version Ranges
  dstaddr	v6.0.0 -> latest

• name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• emailfilter_profile - Email filter profile. Source emailfilter.profile.name. type: str more...

  	Supported Version Ranges
  emailfilter_profile	v6.2.0 -> latest

• emailfilter_profile_status - Enable/disable email filter. type: str choices: enable, disable more...

  	Supported Version Ranges
  emailfilter_profile_status	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• interface - Monitored interface name from available interfaces. Source system.zone.name system.interface.name. type: str more...

  	Supported Version Ranges
  interface	v6.0.0 -> latest

• ips_sensor - IPS sensor name. Source ips.sensor.name. type: str more...

  	Supported Version Ranges
  ips_sensor	v6.0.0 -> latest

• ips_sensor_status - Enable/disable IPS. type: str choices: enable, disable more...

  	Supported Version Ranges
  ips_sensor_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• label - Label. type: str more...

  	Supported Version Ranges
  label	v6.0.0 -> v6.0.11	v6.2.3 -> v6.2.3

• logtraffic - Logging type to be used in this policy (Options: all | utm | disable). type: str choices: all, utm, disable more...

  	Supported Version Ranges
  logtraffic	v6.0.0 -> latest
  [all]	v6.0.0 -> latest
  [utm]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• policyid - Policy ID (0 - 4294967295). see Notes. type: int required: true more...

  	Supported Version Ranges
  policyid	v6.0.0 -> latest

• scan_botnet_connections - Enable/disable scanning for connections to Botnet servers. type: str choices: disable, block, monitor more...

  	Supported Version Ranges
  scan_botnet_connections	v6.0.0 -> v6.0.11
  [disable]	v6.0.0 -> latest
  [block]	v6.0.0 -> latest
  [monitor]	v6.0.0 -> latest

• service - Service object from available options. type: list member_path: service:name more...

  	Supported Version Ranges
  service	v6.0.0 -> latest

• name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• spamfilter_profile - Antispam profile. Source spamfilter.profile.name. type: str more...

  	Supported Version Ranges
  spamfilter_profile	v6.0.0 -> v6.0.11

• spamfilter_profile_status - Enable/disable antispam. type: str choices: enable, disable more...

  	Supported Version Ranges
  spamfilter_profile_status	v6.0.0 -> v6.0.11
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• srcaddr - Address object to limit traffic monitoring to network traffic sent from the specified address or range. type: list member_path: srcaddr:name more...

  	Supported Version Ranges
  srcaddr	v6.0.0 -> latest

• name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• status - Enable/disable this policy. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• webfilter_profile - Web filter profile. Source webfilter.profile.name. type: str more...

  	Supported Version Ranges
  webfilter_profile	v6.0.0 -> latest

• webfilter_profile_status - Enable/disable web filtering. type: str choices: enable, disable more...

  	Supported Version Ranges
  webfilter_profile_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

Notes

Note

• We highly recommend using your own value as the policyid instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

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