fortinet.fortios.fortios_firewall_security_policy – Configure NGFW IPv4/IPv6 application policies in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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
.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_security_policy
.
New in version 2.10: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
firewall_security_policy dictionary | Configure NGFW IPv4/IPv6 application policies. | |||
action string |
| Policy action (accept/deny). | ||
app_category list / elements=string | Application category ID list. | |||
id integer / required | Category IDs. | |||
app_group list / elements=string | Application group names. | |||
name string / required | Application group names. Source application.group.name. | |||
application list / elements=string | Application ID list. | |||
id integer / required | Application IDs. | |||
application_list string | Name of an existing Application list. Source application.list.name. | |||
av_profile string | Name of an existing Antivirus profile. Source antivirus.profile.name. | |||
cifs_profile string | Name of an existing CIFS profile. Source cifs.profile.name. | |||
comments string | Comment. | |||
dlp_sensor string | Name of an existing DLP sensor. Source dlp.sensor.name. | |||
dnsfilter_profile string | Name of an existing DNS filter profile. Source dnsfilter.profile.name. | |||
dstaddr list / elements=string | Destination IPv4 address name and address group names. | |||
name string / required | Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. | |||
dstaddr4 list / elements=string | Destination IPv4 address name and address group names. | |||
name string / required | Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name. | |||
dstaddr6 list / elements=string | Destination IPv6 address name and address group names. | |||
name string / required | Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name. | |||
dstaddr_negate string |
| When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. | ||
dstintf list / elements=string | Outgoing (egress) interface. | |||
name string / required | Interface name. Source system.interface.name system.zone.name. | |||
emailfilter_profile string | Name of an existing email filter profile. Source emailfilter.profile.name. | |||
enforce_default_app_port string |
| Enable/disable default application port enforcement for allowed applications. | ||
file_filter_profile string | Name of an existing file-filter profile. Source file-filter.profile.name. | |||
fsso_groups list / elements=string | Names of FSSO groups. | |||
name string / required | Names of FSSO groups. Source user.adgrp.name. | |||
global_label string | Label for the policy that appears when the GUI is in Global View mode. | |||
groups list / elements=string | Names of user groups that can authenticate with this policy. | |||
name string / required | User group name. Source user.group.name. | |||
icap_profile string | Name of an existing ICAP profile. Source icap.profile.name. | |||
internet_service string |
| Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. | ||
internet_service_custom list / elements=string | Custom Internet Service name. | |||
name string / required | Custom Internet Service name. Source firewall.internet-service-custom.name. | |||
internet_service_custom_group list / elements=string | Custom Internet Service group name. | |||
name string / required | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. | |||
internet_service_group list / elements=string | Internet Service group name. | |||
name string / required | Internet Service group name. Source firewall.internet-service-group.name. | |||
internet_service_id list / elements=string | Internet Service ID. | |||
id integer / required | Internet Service ID. Source firewall.internet-service.id. | |||
internet_service_name list / elements=string | Internet Service name. | |||
name string / required | Internet Service name. Source firewall.internet-service-name.name. | |||
internet_service_negate string |
| When enabled internet-service specifies what the service must NOT be. | ||
internet_service_src string |
| Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. | ||
internet_service_src_custom list / elements=string | Custom Internet Service source name. | |||
name string / required | Custom Internet Service name. Source firewall.internet-service-custom.name. | |||
internet_service_src_custom_group list / elements=string | Custom Internet Service source group name. | |||
name string / required | Custom Internet Service group name. Source firewall.internet-service-custom-group.name. | |||
internet_service_src_group list / elements=string | Internet Service source group name. | |||
name string / required | Internet Service group name. Source firewall.internet-service-group.name. | |||
internet_service_src_id list / elements=string | Internet Service source ID. | |||
id integer / required | Internet Service ID. Source firewall.internet-service.id. | |||
internet_service_src_name list / elements=string | Internet Service source name. | |||
name string / required | Internet Service name. Source firewall.internet-service-name.name. | |||
internet_service_src_negate string |
| When enabled internet-service-src specifies what the service must NOT be. | ||
ips_sensor string | Name of an existing IPS sensor. Source ips.sensor.name. | |||
learning_mode string |
| Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. | ||
logtraffic string |
| Enable or disable logging. Log all sessions or security profile sessions. | ||
logtraffic_start string |
| Record logs when a session starts. | ||
mms_profile string | Name of an existing MMS profile. Source firewall.mms-profile.name. | |||
name string | Policy name. | |||
policyid integer / required | Policy ID. | |||
profile_group string | Name of profile group. Source firewall.profile-group.name. | |||
profile_protocol_options string | Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. | |||
profile_type string |
| Determine whether the firewall policy allows security profile groups or single profiles only. | ||
schedule string | Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. | |||
send_deny_packet string |
| Enable to send a reply when a session is denied or blocked by a firewall policy. | ||
service list / elements=string | Service and service group names. | |||
name string / required | Service name. Source firewall.service.custom.name firewall.service.group.name. | |||
service_negate string |
| When enabled service specifies what the service must NOT be. | ||
srcaddr list / elements=string | Source IPv4 address name and address group names. | |||
name string / required | Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. | |||
srcaddr4 list / elements=string | Source IPv4 address name and address group names. | |||
name string / required | Address name. Source firewall.address.name firewall.addrgrp.name. | |||
srcaddr6 list / elements=string | Source IPv6 address name and address group names. | |||
name string / required | Address name. Source firewall.address6.name firewall.addrgrp6.name. | |||
srcaddr_negate string |
| When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. | ||
srcintf list / elements=string | Incoming (ingress) interface. | |||
name string / required | Interface name. Source system.interface.name system.zone.name. | |||
ssh_filter_profile string | Name of an existing SSH filter profile. Source ssh-filter.profile.name. | |||
ssl_ssh_profile string | Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. | |||
status string |
| Enable or disable this policy. | ||
url_category list / elements=string | URL category ID list. | |||
id integer / required | URL category ID. | |||
users list / elements=string | Names of individual users that can authenticate with this policy. | |||
name string / required | User name. Source user.local.name. | |||
utm_status string |
| Enable security profiles. | ||
uuid string | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). | |||
uuid_idx integer | uuid-idx | |||
videofilter_profile string | Name of an existing VideoFilter profile. Source videofilter.profile.name. | |||
voip_profile string | Name of an existing VoIP profile. Source voip.profile.name. | |||
webfilter_profile string | Name of an existing Web filter profile. Source webfilter.profile.name. | |||
state string / required |
| Indicates whether to create or remove the object. | ||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure NGFW IPv4/IPv6 application policies. 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)" cifs_profile: "<your_own_value> (source cifs.profile.name)" comments: "<your_own_value>" dlp_sensor: "<your_own_value> (source dlp.sensor.name)" dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)" dstaddr: - name: "default_name_17 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name)" dstaddr_negate: "enable" dstaddr4: - name: "default_name_20 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name)" dstaddr6: - name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name)" dstintf: - name: "default_name_24 (source system.interface.name system.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_29 (source user.adgrp.name)" global_label: "<your_own_value>" groups: - name: "default_name_32 (source user.group.name)" icap_profile: "<your_own_value> (source icap.profile.name)" internet_service: "enable" internet_service_custom: - name: "default_name_36 (source firewall.internet-service-custom.name)" internet_service_custom_group: - name: "default_name_38 (source firewall.internet-service-custom-group.name)" internet_service_group: - name: "default_name_40 (source firewall.internet-service-group.name)" internet_service_id: - id: "42 (source firewall.internet-service.id)" internet_service_name: - name: "default_name_44 (source firewall.internet-service-name.name)" internet_service_negate: "enable" internet_service_src: "enable" internet_service_src_custom: - name: "default_name_48 (source firewall.internet-service-custom.name)" internet_service_src_custom_group: - name: "default_name_50 (source firewall.internet-service-custom-group.name)" internet_service_src_group: - name: "default_name_52 (source firewall.internet-service-group.name)" internet_service_src_id: - id: "54 (source firewall.internet-service.id)" internet_service_src_name: - name: "default_name_56 (source firewall.internet-service-name.name)" internet_service_src_negate: "enable" ips_sensor: "<your_own_value> (source ips.sensor.name)" learning_mode: "enable" logtraffic: "all" logtraffic_start: "enable" mms_profile: "<your_own_value> (source firewall.mms-profile.name)" name: "default_name_63" policyid: "64" 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)" send_deny_packet: "disable" service: - name: "default_name_71 (source firewall.service.custom.name firewall.service.group.name)" service_negate: "enable" srcaddr: - name: "default_name_74 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)" srcaddr_negate: "enable" srcaddr4: - name: "default_name_77 (source firewall.address.name firewall.addrgrp.name)" srcaddr6: - name: "default_name_79 (source firewall.address6.name firewall.addrgrp6.name)" srcintf: - name: "default_name_81 (source system.interface.name system.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: - id: "86" users: - name: "default_name_88 (source user.local.name)" utm_status: "enable" uuid: "<your_own_value>" uuid_idx: "91" videofilter_profile: "<your_own_value> (source videofilter.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 | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_security_policy_module.html