fortios_firewall_security_policy.rst

source:	fortios_firewall_security_policy.py
orphan:

fortios_firewall_security_policy -- Configure NGFW IPv4/IPv6 application 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 security_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_security_policy	v6.2.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_security_policy - Configure NGFW IPv4/IPv6 application policies. type: dict more...

  	Supported Version Ranges
  firewall_security_policy	v6.2.0 -> latest

• action - Policy action (accept/deny). type: str choices: accept, deny more...

  	Supported Version Ranges
  action	v6.2.0 -> latest
  [accept]	v6.0.0 -> latest
  [deny]	v6.0.0 -> latest

• app_category - Application category ID list. type: list member_path: app_category:id more...

  	Supported Version Ranges
  app_category	v6.2.0 -> latest

• id - Category IDs. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.2.0 -> latest

• app_group - Application group names. type: list member_path: app_group:name more...

  	Supported Version Ranges
  app_group	v6.2.0 -> latest

• name - Application group names. Source application.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• application - Application ID list. type: list member_path: application:id more...

  	Supported Version Ranges
  application	v6.2.0 -> latest

• id - Application IDs. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.2.0 -> latest

• application_list - Name of an existing Application list. Source application.list.name. type: str more...

  	Supported Version Ranges
  application_list	v6.2.0 -> latest

• av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...

  	Supported Version Ranges
  av_profile	v6.2.0 -> latest

• casb_profile - Name of an existing CASB profile. Source casb.profile.name. type: str more...

  	Supported Version Ranges
  casb_profile	v7.4.1 -> latest

• cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...

  	Supported Version Ranges
  cifs_profile	v6.2.0 -> latest

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

  	Supported Version Ranges
  comments	v6.2.0 -> latest

• dlp_profile - Name of an existing DLP profile. Source dlp.profile.name. type: str more...

  	Supported Version Ranges
  dlp_profile	v7.2.0 -> latest

• dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...

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

• dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str more...

  	Supported Version Ranges
  dnsfilter_profile	v6.2.0 -> latest

• dstaddr - Destination IPv4 address name and address group names. type: list member_path: dstaddr:name more...

  	Supported Version Ranges
  dstaddr	v6.4.0 -> latest

• name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. type: str required: true more...

  	Supported Version Ranges
  name	v6.4.0 -> latest

• dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable more...

  	Supported Version Ranges
  dstaddr_negate	v6.4.0 -> v6.4.0	v6.4.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• dstaddr4 - Destination IPv4 address name and address group names. type: list member_path: dstaddr4:name more...

  	Supported Version Ranges
  dstaddr4	v6.2.0 -> v6.2.7

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

  	Supported Version Ranges
  name	v6.2.0 -> v6.2.7

• dstaddr6 - Destination IPv6 address name and address group names. type: list member_path: dstaddr6:name more...

  	Supported Version Ranges
  dstaddr6	v6.2.0 -> latest

• name - Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• dstaddr6_negate - When enabled dstaddr6 specifies what the destination address must NOT be. type: str choices: enable, disable more...

  	Supported Version Ranges
  dstaddr6_negate	v7.2.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• dstintf - Outgoing (egress) interface. type: list member_path: dstintf:name more...

  	Supported Version Ranges
  dstintf	v6.2.0 -> latest

• name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...

  	Supported Version Ranges
  emailfilter_profile	v6.2.0 -> latest

• enforce_default_app_port - Enable/disable default application port enforcement for allowed applications. type: str choices: enable, disable more...

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

• file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str more...

  	Supported Version Ranges
  file_filter_profile	v6.4.0 -> latest

• fsso_groups - Names of FSSO groups. type: list member_path: fsso_groups:name more...

  	Supported Version Ranges
  fsso_groups	v6.2.0 -> latest

• name - Names of FSSO groups. Source user.adgrp.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• global_label - Label for the policy that appears when the GUI is in Global View mode. type: str more...

  	Supported Version Ranges
  global_label	v6.2.3 -> v6.2.3

• groups - Names of user groups that can authenticate with this policy. type: list member_path: groups:name more...

  	Supported Version Ranges
  groups	v6.2.0 -> latest

• name - User group name. Source user.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...

  	Supported Version Ranges
  icap_profile	v6.2.0 -> latest

• internet_service - Enable/disable use of Internet Services for this policy. If enabled, destination address, service and default application port enforcement are not used. type: str choices: enable, disable more...

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

• internet_service_custom - Custom Internet Service name. type: list member_path: internet_service_custom:name more...

  	Supported Version Ranges
  internet_service_custom	v6.2.0 -> latest

• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_custom_group - Custom Internet Service group name. type: list member_path: internet_service_custom_group:name more...

  	Supported Version Ranges
  internet_service_custom_group	v6.2.0 -> latest

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

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_group - Internet Service group name. type: list member_path: internet_service_group:name more...

  	Supported Version Ranges
  internet_service_group	v6.2.0 -> latest

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

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_id - Internet Service ID. type: list member_path: internet_service_id:id more...

  	Supported Version Ranges
  internet_service_id	v6.2.0 -> v6.2.7

• id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...

  	Supported Version Ranges
  id	v6.2.0 -> v6.2.7

• internet_service_name - Internet Service name. type: list member_path: internet_service_name:name more...

  	Supported Version Ranges
  internet_service_name	v6.4.0 -> latest

• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.4.0 -> latest

• internet_service_negate - When enabled internet-service specifies what the service must NOT be. type: str choices: enable, disable more...

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

• internet_service_src - Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. type: str choices: enable, disable more...

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

• internet_service_src_custom - Custom Internet Service source name. type: list member_path: internet_service_src_custom:name more...

  	Supported Version Ranges
  internet_service_src_custom	v6.2.0 -> latest

• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_src_custom_group - Custom Internet Service source group name. type: list member_path: internet_service_src_custom_group:name more...

  	Supported Version Ranges
  internet_service_src_custom_group	v6.2.0 -> latest

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

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_src_group - Internet Service source group name. type: list member_path: internet_service_src_group:name more...

  	Supported Version Ranges
  internet_service_src_group	v6.2.0 -> latest

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

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_src_id - Internet Service source ID. type: list member_path: internet_service_src_id:id more...

  	Supported Version Ranges
  internet_service_src_id	v6.2.0 -> v6.2.7

• id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...

  	Supported Version Ranges
  id	v6.2.0 -> v6.2.7

• internet_service_src_name - Internet Service source name. type: list member_path: internet_service_src_name:name more...

  	Supported Version Ranges
  internet_service_src_name	v6.4.0 -> latest

• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.4.0 -> latest

• internet_service_src_negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: enable, disable more...

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

• internet_service6 - Enable/disable use of IPv6 Internet Services for this policy. If enabled, destination address, service and default application port enforcement are not used. type: str choices: enable, disable more...

  	Supported Version Ranges
  internet_service6	v7.2.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• internet_service6_custom - Custom IPv6 Internet Service name. type: list member_path: internet_service6_custom:name more...

  	Supported Version Ranges
  internet_service6_custom	v7.2.1 -> latest

• name - Custom IPv6 Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_custom_group - Custom IPv6 Internet Service group name. type: list member_path: internet_service6_custom_group:name more...

  	Supported Version Ranges
  internet_service6_custom_group	v7.2.1 -> latest

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

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_group - Internet Service group name. type: list member_path: internet_service6_group:name more...

  	Supported Version Ranges
  internet_service6_group	v7.2.1 -> latest

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

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_name - IPv6 Internet Service name. type: list member_path: internet_service6_name:name more...

  	Supported Version Ranges
  internet_service6_name	v7.2.1 -> latest

• name - IPv6 Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_negate - When enabled internet-service6 specifies what the service must NOT be. type: str choices: enable, disable more...

  	Supported Version Ranges
  internet_service6_negate	v7.2.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• internet_service6_src - Enable/disable use of IPv6 Internet Services in source for this policy. If enabled, source address is not used. type: str choices: enable, disable more...

  	Supported Version Ranges
  internet_service6_src	v7.2.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• internet_service6_src_custom - Custom IPv6 Internet Service source name. type: list member_path: internet_service6_src_custom:name more...

  	Supported Version Ranges
  internet_service6_src_custom	v7.2.1 -> latest

• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_src_custom_group - Custom Internet Service6 source group name. type: list member_path: internet_service6_src_custom_group:name more...

  	Supported Version Ranges
  internet_service6_src_custom_group	v7.2.1 -> latest

• name - Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_src_group - Internet Service6 source group name. type: list member_path: internet_service6_src_group:name more...

  	Supported Version Ranges
  internet_service6_src_group	v7.2.1 -> latest

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

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_src_name - IPv6 Internet Service source name. type: list member_path: internet_service6_src_name:name more...

  	Supported Version Ranges
  internet_service6_src_name	v7.2.1 -> latest

• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.1 -> latest

• internet_service6_src_negate - When enabled internet-service6-src specifies what the service must NOT be. type: str choices: enable, disable more...

  	Supported Version Ranges
  internet_service6_src_negate	v7.2.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...

  	Supported Version Ranges
  ips_sensor	v6.2.0 -> latest

• ips_voip_filter - Name of an existing VoIP (ips) profile. Source voip.profile.name. type: str more...

  	Supported Version Ranges
  ips_voip_filter	v7.4.0 -> latest

• learning_mode - Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. type: str choices: enable, disable more...

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

• logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable more...

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

• logtraffic_start - Record logs when a session starts. type: str choices: enable, disable more...

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

• mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str more...

  	Supported Version Ranges
  mms_profile	v6.2.0 -> v6.2.7

• name - Policy name. type: str more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• nat46 - Enable/disable NAT46. type: str choices: enable, disable more...

  	Supported Version Ranges
  nat46	v7.0.2 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• nat64 - Enable/disable NAT64. type: str choices: enable, disable more...

  	Supported Version Ranges
  nat64	v7.0.2 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• policyid - Policy ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  policyid	v6.2.0 -> latest

• profile_group - Name of profile group. Source firewall.profile-group.name. type: str more...

  	Supported Version Ranges
  profile_group	v6.2.0 -> latest

• profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str more...

  	Supported Version Ranges
  profile_protocol_options	v6.2.0 -> latest

• profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group more...

  	Supported Version Ranges
  profile_type	v6.2.0 -> latest
  [single]	v6.0.0 -> latest
  [group]	v6.0.0 -> latest

• schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...

  	Supported Version Ranges
  schedule	v6.2.0 -> latest

• sctp_filter_profile - Name of an existing SCTP filter profile. Source sctp-filter.profile.name. type: str more...

  	Supported Version Ranges
  sctp_filter_profile	v7.0.1 -> latest

• send_deny_packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: disable, enable more...

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

• service - Service and service group names. type: list member_path: service:name more...

  	Supported Version Ranges
  service	v6.2.0 -> latest

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

  	Supported Version Ranges
  name	v6.2.0 -> latest

• service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable more...

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

• srcaddr - Source IPv4 address name and address group names. type: list member_path: srcaddr:name more...

  	Supported Version Ranges
  srcaddr	v6.4.0 -> latest

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

  	Supported Version Ranges
  name	v6.4.0 -> latest

• srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable more...

  	Supported Version Ranges
  srcaddr_negate	v6.4.0 -> v6.4.0	v6.4.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• srcaddr4 - Source IPv4 address name and address group names. type: list member_path: srcaddr4:name more...

  	Supported Version Ranges
  srcaddr4	v6.2.0 -> v6.2.7

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

  	Supported Version Ranges
  name	v6.2.0 -> v6.2.7

• srcaddr6 - Source IPv6 address name and address group names. type: list member_path: srcaddr6:name more...

  	Supported Version Ranges
  srcaddr6	v6.2.0 -> latest

• name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• srcaddr6_negate - When enabled srcaddr6 specifies what the source address must NOT be. type: str choices: enable, disable more...

  	Supported Version Ranges
  srcaddr6_negate	v7.2.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name more...

  	Supported Version Ranges
  srcintf	v6.2.0 -> latest

• name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str more...

  	Supported Version Ranges
  ssh_filter_profile	v6.2.0 -> latest

• ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str more...

  	Supported Version Ranges
  ssl_ssh_profile	v6.2.0 -> latest

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

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

• url_category - URL categories or groups. type: list
• users - Names of individual users that can authenticate with this policy. type: list member_path: users:name more...

  	Supported Version Ranges
  users	v6.2.0 -> latest

• name - User name. Source user.local.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• utm_status - Enable security profiles. type: str choices: enable, disable more...

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

• uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

  	Supported Version Ranges
  uuid	v6.2.0 -> latest

• uuid_idx - uuid-idx type: int more...

  	Supported Version Ranges
  uuid_idx	v6.2.3 -> v6.2.3

• videofilter_profile - Name of an existing VideoFilter profile. Source videofilter.profile.name. type: str more...

  	Supported Version Ranges
  videofilter_profile	v7.0.0 -> latest

• virtual_patch_profile - Name of an existing virtual-patch profile. Source virtual-patch.profile.name. type: str more...

  	Supported Version Ranges
  virtual_patch_profile	v7.4.1 -> latest

• voip_profile - Name of an existing VoIP (voipd) profile. Source voip.profile.name. type: str more...

  	Supported Version Ranges
  voip_profile	v6.2.0 -> latest

• webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str more...

  	Supported Version Ranges
  webfilter_profile	v6.2.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 NGFW IPv4/IPv6 application policies.
  fortinet.fortios.fortios_firewall_security_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_security_policy:
          action: "accept"
          app_category:
              -
                  id: "5"
          app_group:
              -
                  name: "default_name_7 (source application.group.name)"
          application:
              -
                  id: "9"
          application_list: "<your_own_value> (source application.list.name)"
          av_profile: "<your_own_value> (source antivirus.profile.name)"
          casb_profile: "<your_own_value> (source casb.profile.name)"
          cifs_profile: "<your_own_value> (source cifs.profile.name)"
          comments: "<your_own_value>"
          dlp_profile: "<your_own_value> (source dlp.profile.name)"
          dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
          dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
          dstaddr:
              -
                  name: "default_name_19 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource
                    .name)"
          dstaddr_negate: "enable"
          dstaddr4:
              -
                  name: "default_name_22 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name)"
          dstaddr6:
              -
                  name: "default_name_24 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
                    .external-resource.name)"
          dstaddr6_negate: "enable"
          dstintf:
              -
                  name: "default_name_27 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
          enforce_default_app_port: "enable"
          file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
          fsso_groups:
              -
                  name: "default_name_32 (source user.adgrp.name)"
          global_label: "<your_own_value>"
          groups:
              -
                  name: "default_name_35 (source user.group.name)"
          icap_profile: "<your_own_value> (source icap.profile.name)"
          internet_service: "enable"
          internet_service_custom:
              -
                  name: "default_name_39 (source firewall.internet-service-custom.name)"
          internet_service_custom_group:
              -
                  name: "default_name_41 (source firewall.internet-service-custom-group.name)"
          internet_service_group:
              -
                  name: "default_name_43 (source firewall.internet-service-group.name)"
          internet_service_id:
              -
                  id: "45 (source firewall.internet-service.id)"
          internet_service_name:
              -
                  name: "default_name_47 (source firewall.internet-service-name.name)"
          internet_service_negate: "enable"
          internet_service_src: "enable"
          internet_service_src_custom:
              -
                  name: "default_name_51 (source firewall.internet-service-custom.name)"
          internet_service_src_custom_group:
              -
                  name: "default_name_53 (source firewall.internet-service-custom-group.name)"
          internet_service_src_group:
              -
                  name: "default_name_55 (source firewall.internet-service-group.name)"
          internet_service_src_id:
              -
                  id: "57 (source firewall.internet-service.id)"
          internet_service_src_name:
              -
                  name: "default_name_59 (source firewall.internet-service-name.name)"
          internet_service_src_negate: "enable"
          internet_service6: "enable"
          internet_service6_custom:
              -
                  name: "default_name_63 (source firewall.internet-service-custom.name)"
          internet_service6_custom_group:
              -
                  name: "default_name_65 (source firewall.internet-service-custom-group.name)"
          internet_service6_group:
              -
                  name: "default_name_67 (source firewall.internet-service-group.name)"
          internet_service6_name:
              -
                  name: "default_name_69 (source firewall.internet-service-name.name)"
          internet_service6_negate: "enable"
          internet_service6_src: "enable"
          internet_service6_src_custom:
              -
                  name: "default_name_73 (source firewall.internet-service-custom.name)"
          internet_service6_src_custom_group:
              -
                  name: "default_name_75 (source firewall.internet-service-custom-group.name)"
          internet_service6_src_group:
              -
                  name: "default_name_77 (source firewall.internet-service-group.name)"
          internet_service6_src_name:
              -
                  name: "default_name_79 (source firewall.internet-service-name.name)"
          internet_service6_src_negate: "enable"
          ips_sensor: "<your_own_value> (source ips.sensor.name)"
          ips_voip_filter: "<your_own_value> (source voip.profile.name)"
          learning_mode: "enable"
          logtraffic: "all"
          logtraffic_start: "enable"
          mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
          name: "default_name_87"
          nat46: "enable"
          nat64: "enable"
          policyid: "<you_own_value>"
          profile_group: "<your_own_value> (source firewall.profile-group.name)"
          profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
          profile_type: "single"
          schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
          sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.name)"
          send_deny_packet: "disable"
          service:
              -
                  name: "default_name_98 (source firewall.service.custom.name firewall.service.group.name)"
          service_negate: "enable"
          srcaddr:
              -
                  name: "default_name_101 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
          srcaddr_negate: "enable"
          srcaddr4:
              -
                  name: "default_name_104 (source firewall.address.name firewall.addrgrp.name)"
          srcaddr6:
              -
                  name: "default_name_106 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
          srcaddr6_negate: "enable"
          srcintf:
              -
                  name: "default_name_109 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
          ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
          status: "enable"
          url_category: "<your_own_value>"
          users:
              -
                  name: "default_name_115 (source user.local.name)"
          utm_status: "enable"
          uuid: "<your_own_value>"
          uuid_idx: "2147483647"
          videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
          virtual_patch_profile: "<your_own_value> (source virtual-patch.profile.name)"
          voip_profile: "<your_own_value> (source voip.profile.name)"
          webfilter_profile: "<your_own_value> (source webfilter.profile.name)"

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.