fortios_firewall_security_policy – Configure NGFW IPv4/IPv6 application policies in Fortinet’s FortiOS and FortiGate.

New in version 2.10.

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

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
• 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
• action - Policy action (accept/deny). type: str choices: accept, deny
• app_category - Application category ID list. type: list
• id - Category IDs. type: int required: True
• app_group - Application group names. type: list
• name - Application group names. Source application.group.name. type: str required: True
• application - Application ID list. type: list
• id - Application IDs. type: int required: True
• application_list - Name of an existing Application list. Source application.list.name. type: str
• av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str
• cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str
• comments - Comment. type: str
• dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str
• dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str
• dstaddr - Destination IPv4 address name and address group names. type: list
• name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. type: str required: True
• dstaddr6 - Destination IPv6 address name and address group names. type: list
• name - Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name. type: str required: True
• dstintf - Outgoing (egress) interface. type: list
• name - Interface name. Source system.interface.name system.zone.name. type: str required: True
• emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str
• enforce_default_app_port - Enable/disable default application port enforcement for allowed applications. type: str choices: enable, disable
• fsso_groups - Names of FSSO groups. type: list
• name - Names of FSSO groups. Source user.adgrp.name. type: str required: True
• groups - Names of user groups that can authenticate with this policy. type: list
• name - User group name. Source user.group.name. type: str required: True
• icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str
• internet_service - Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. type: str choices: enable, disable
• internet_service_custom - Custom Internet Service name. type: list
• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: True
• internet_service_custom_group - Custom Internet Service group name. type: list
• name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: True
• internet_service_group - Internet Service group name. type: list
• name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: True
• internet_service_name - Internet Service name. type: list
• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: True
• internet_service_negate - When enabled internet-service specifies what the service must NOT be. type: str choices: enable, disable
• 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
• internet_service_src_custom - Custom Internet Service source name. type: list
• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: True
• internet_service_src_custom_group - Custom Internet Service source group name. type: list
• name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: True
• internet_service_src_group - Internet Service source group name. type: list
• name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: True
• internet_service_src_name - Internet Service source name. type: list
• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: True
• internet_service_src_negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: enable, disable
• ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str
• logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable
• name - Policy name. type: str
• policyid - Policy ID. type: int required: True
• profile_group - Name of profile group. Source firewall.profile-group.name. type: str
• profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str
• profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group
• schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str
• send_deny_packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: disable, enable
• service - Service and service group names. type: list
• name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: True
• service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable
• srcaddr - Source IPv4 address name and address group names. type: list
• name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: True
• srcaddr6 - Source IPv6 address name and address group names. type: list
• name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: True
• srcintf - Incoming (ingress) interface. type: list
• name - Interface name. Source system.interface.name system.zone.name. type: str required: True
• ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str
• ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str
• status - Enable or disable this policy. type: str choices: enable, disable
• url_category - URL category ID list. type: list
• id - URL category ID. type: int required: True
• users - Names of individual users that can authenticate with this policy. type: list
• name - User name. Source user.local.name. type: str required: True
• uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
• voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str
• webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str

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)"
        dstaddr6:
         -
            name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system.external-resource
              .name)"
        dstintf:
         -
            name: "default_name_21 (source system.interface.name system.zone.name)"
        emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
        enforce_default_app_port: "enable"
        fsso_groups:
         -
            name: "default_name_25 (source user.adgrp.name)"
        groups:
         -
            name: "default_name_27 (source user.group.name)"
        icap_profile: "<your_own_value> (source icap.profile.name)"
        internet_service: "enable"
        internet_service_custom:
         -
            name: "default_name_31 (source firewall.internet-service-custom.name)"
        internet_service_custom_group:
         -
            name: "default_name_33 (source firewall.internet-service-custom-group.name)"
        internet_service_group:
         -
            name: "default_name_35 (source firewall.internet-service-group.name)"
        internet_service_name:
         -
            name: "default_name_37 (source firewall.internet-service-name.name)"
        internet_service_negate: "enable"
        internet_service_src: "enable"
        internet_service_src_custom:
         -
            name: "default_name_41 (source firewall.internet-service-custom.name)"
        internet_service_src_custom_group:
         -
            name: "default_name_43 (source firewall.internet-service-custom-group.name)"
        internet_service_src_group:
         -
            name: "default_name_45 (source firewall.internet-service-group.name)"
        internet_service_src_name:
         -
            name: "default_name_47 (source firewall.internet-service-name.name)"
        internet_service_src_negate: "enable"
        ips_sensor: "<your_own_value> (source ips.sensor.name)"
        logtraffic: "all"
        name: "default_name_51"
        policyid: "52"
        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_59 (source firewall.service.custom.name firewall.service.group.name)"
        service_negate: "enable"
        srcaddr:
         -
            name: "default_name_62 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
        srcaddr6:
         -
            name: "default_name_64 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
        srcintf:
         -
            name: "default_name_66 (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:  "71"
        users:
         -
            name: "default_name_73 (source user.local.name)"
        uuid: "<your_own_value>"
        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.