fortinet.fortios.fortios_firewall_security_policy module – Configure NGFW IPv4/IPv6 application policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_security_policy
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure NGFW IPv4/IPv6 application policies. |
|
Policy action (accept/deny). Choices:
|
|
Application category ID list. |
|
Category IDs. see <a href=’#notes’>Notes</a>. |
|
Application group names. |
|
Application group names. Source application.group.name. |
|
Application ID list. |
|
Application IDs. see <a href=’#notes’>Notes</a>. |
|
Name of an existing Application list. Source application.list.name. |
|
Name of an existing Antivirus profile. Source antivirus.profile.name. |
|
Name of an existing CASB profile. Source casb.profile.name. |
|
Name of an existing CIFS profile. Source cifs.profile.name. |
|
Comment. |
|
Name of an existing Diameter filter profile. Source diameter-filter.profile.name. |
|
Name of an existing DLP profile. Source dlp.profile.name. |
|
Name of an existing DLP sensor. Source dlp.sensor.name. |
|
Name of an existing DNS filter profile. Source dnsfilter.profile.name. |
|
Destination IPv4 address name and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. |
|
Destination IPv4 address name and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name. |
|
Destination IPv6 address name and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name. |
|
When enabled dstaddr6 specifies what the destination address must NOT be. Choices:
|
|
When enabled dstaddr specifies what the destination address must NOT be. Choices:
|
|
Outgoing (egress) interface. |
|
Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. |
|
Name of an existing email filter profile. Source emailfilter.profile.name. |
|
Enable/disable default application port enforcement for allowed applications. Choices:
|
|
Name of an existing file-filter profile. Source file-filter.profile.name. |
|
Names of FSSO groups. |
|
Names of FSSO groups. Source user.adgrp.name. |
|
Label for the policy that appears when the GUI is in Global View mode. |
|
Names of user groups that can authenticate with this policy. |
|
User group name. Source user.group.name. |
|
Name of an existing ICAP profile. Source icap.profile.name. |
|
Enable/disable use of Internet Services for this policy. If enabled, destination address, service and default application port enforcement are not used. Choices:
|
|
Enable/disable use of IPv6 Internet Services for this policy. If enabled, destination address, service and default application port enforcement are not used. Choices:
|
|
Custom IPv6 Internet Service name. |
|
Custom IPv6 Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom IPv6 Internet Service group name. |
|
Custom IPv6 Internet Service group name. Source firewall.internet-service-custom-group.name. |
|
Internet Service group name. |
|
Internet Service group name. Source firewall.internet-service-group.name. |
|
IPv6 Internet Service name. |
|
IPv6 Internet Service name. Source firewall.internet-service-name.name. |
|
When enabled internet-service6 specifies what the service must NOT be. Choices:
|
|
Enable/disable use of IPv6 Internet Services in source for this policy. If enabled, source address is not used. Choices:
|
|
Custom IPv6 Internet Service source name. |
|
Custom Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom Internet Service6 source group name. |
|
Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name. |
|
Internet Service6 source group name. |
|
Internet Service group name. Source firewall.internet-service-group.name. |
|
IPv6 Internet Service source name. |
|
Internet Service name. Source firewall.internet-service-name.name. |
|
When enabled internet-service6-src specifies what the service must NOT be. Choices:
|
|
Custom Internet Service name. |
|
Custom Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom Internet Service group name. |
|
Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
|
Internet Service group name. |
|
Internet Service group name. Source firewall.internet-service-group.name. |
|
Internet Service ID. |
|
Internet Service ID. see <a href=’#notes’>Notes</a>. Source firewall.internet-service.id. |
|
Internet Service name. |
|
Internet Service name. Source firewall.internet-service-name.name. |
|
When enabled internet-service specifies what the service must NOT be. Choices:
|
|
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Choices:
|
|
Custom Internet Service source name. |
|
Custom Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom Internet Service source group name. |
|
Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
|
Internet Service source group name. |
|
Internet Service group name. Source firewall.internet-service-group.name. |
|
Internet Service source ID. |
|
Internet Service ID. see <a href=’#notes’>Notes</a>. Source firewall.internet-service.id. |
|
Internet Service source name. |
|
Internet Service name. Source firewall.internet-service-name.name. |
|
When enabled internet-service-src specifies what the service must NOT be. Choices:
|
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
Name of an existing VoIP (ips) profile. Source voip.profile.name. |
|
Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. Choices:
|
|
Enable or disable logging. Log all sessions or security profile sessions. Choices:
|
|
Record logs when a session starts. Choices:
|
|
Name of an existing MMS profile. Source firewall.mms-profile.name. |
|
Policy name. |
|
Enable/disable NAT46. Choices:
|
|
Enable/disable NAT64. Choices:
|
|
Policy ID. see <a href=’#notes’>Notes</a>. |
|
Name of profile group. Source firewall.profile-group.name. |
|
Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
|
Determine whether the firewall policy allows security profile groups or single profiles only. Choices:
|
|
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
|
Name of an existing SCTP filter profile. Source sctp-filter.profile.name. |
|
Enable to send a reply when a session is denied or blocked by a firewall policy. Choices:
|
|
Service and service group names. |
|
Service name. Source firewall.service.custom.name firewall.service.group.name. |
|
When enabled service specifies what the service must NOT be. Choices:
|
|
Source IPv4 address name and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. |
|
Source IPv4 address name and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
Source IPv6 address name and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. |
|
When enabled srcaddr6 specifies what the source address must NOT be. Choices:
|
|
When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
Incoming (ingress) interface. |
|
Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. |
|
Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
|
Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
|
Enable or disable this policy. Choices:
|
|
URL categories or groups. |
|
Names of individual users that can authenticate with this policy. |
|
User name. Source user.local.name. |
|
Enable security profiles. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
uuid-idx |
|
Name of an existing VideoFilter profile. Source videofilter.profile.name. |
|
Name of an existing virtual-patch profile. Source virtual-patch.profile.name. |
|
Name of an existing VoIP (voipd) profile. Source voip.profile.name. |
|
Name of an existing Web filter profile. Source webfilter.profile.name. |
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
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
The module supports check_mode.
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>"
diameter_filter_profile: "<your_own_value> (source diameter-filter.profile.name)"
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_20 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource
.name)"
dstaddr_negate: "enable"
dstaddr4:
-
name: "default_name_23 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name)"
dstaddr6:
-
name: "default_name_25 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
.external-resource.name)"
dstaddr6_negate: "enable"
dstintf:
-
name: "default_name_28 (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_33 (source user.adgrp.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_36 (source user.group.name)"
icap_profile: "<your_own_value> (source icap.profile.name)"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_40 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_42 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_44 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "46 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_48 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_52 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_54 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_56 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "58 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_60 (source firewall.internet-service-name.name)"
internet_service_src_negate: "enable"
internet_service6: "enable"
internet_service6_custom:
-
name: "default_name_64 (source firewall.internet-service-custom.name)"
internet_service6_custom_group:
-
name: "default_name_66 (source firewall.internet-service-custom-group.name)"
internet_service6_group:
-
name: "default_name_68 (source firewall.internet-service-group.name)"
internet_service6_name:
-
name: "default_name_70 (source firewall.internet-service-name.name)"
internet_service6_negate: "enable"
internet_service6_src: "enable"
internet_service6_src_custom:
-
name: "default_name_74 (source firewall.internet-service-custom.name)"
internet_service6_src_custom_group:
-
name: "default_name_76 (source firewall.internet-service-custom-group.name)"
internet_service6_src_group:
-
name: "default_name_78 (source firewall.internet-service-group.name)"
internet_service6_src_name:
-
name: "default_name_80 (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_88"
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_99 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
srcaddr:
-
name: "default_name_102 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr_negate: "enable"
srcaddr4:
-
name: "default_name_105 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_107 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcaddr6_negate: "enable"
srcintf:
-
name: "default_name_110 (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_116 (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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |