fortios_firewall_consolidated_policy – Configure consolidated IPv4/IPv6 policies in Fortinet’s FortiOS and FortiGate.¶

New in version 2.9.

Synopsis
Requirements
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_consolidated feature and 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_consolidated_policy - Configure consolidated IPv4/IPv6 policies. type: dict

action - Policy action (allow/deny/ipsec). type: str choices: accept, deny, ipsec
application_list - Name of an existing Application list. Source application.list.name. type: str
auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable
av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str
captive_portal_exempt - Enable exemption of some users from the captive portal. type: str choices: enable, disable
cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str
comments - Comment. type: str
diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable
diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable
diffservcode_forward - Change packet"s DiffServ to this value. type: str
diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. 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_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable
dstaddr4 - 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
fixedport - Enable to prevent source NAT from changing a session"s source port. 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 - Group name. Source user.group.name. type: str required: True

http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable
icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str
inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: enable, disable
inspection_mode - Policy inspection mode (Flow/proxy). Default is Flow mode. type: str choices: proxy, flow
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
ippool - Enable to use IP Pools for source NAT. 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
logtraffic_start - Record logs when a session starts. type: str choices: enable, disable
name - Policy name. type: str
nat - Enable/disable source NAT. type: str choices: enable, disable
outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: enable, disable
per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str
policyid - Policy ID (0 - 4294967294). type: int required: True
poolname4 - IPv4 pool names. type: list

name - IPv4 pool name. Source firewall.ippool.name. type: str required: True

poolname6 - IPv6 pool names. type: list

name - IPv6 pool name. Source firewall.ippool6.name. type: str 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
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
session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: int
srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable
srcaddr4 - 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
ssh_policy_redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: enable, disable
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
tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int
tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int
traffic_shaper - Traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
users - Names of individual users that can authenticate with this policy. type: list

name - User name. Source user.local.name. type: str required: True

utm_status - Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. type: str choices: enable, disable
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
vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. type: str
waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str
wanopt - Enable/disable WAN optimization. type: str choices: enable, disable
wanopt_detection - WAN optimization auto-detection mode. type: str choices: active, passive, False
wanopt_passive_opt - WAN optimization passive mode options. This option decides what IP address will be used to connect to server. type: str choices: default, transparent, non-transparent
wanopt_peer - WAN optimization peer. Source wanopt.peer.peer-host-id. type: str
wanopt_profile - WAN optimization profile. Source wanopt.profile.name. type: str
webcache - Enable/disable web cache. type: str choices: enable, disable
webcache_https - Enable/disable web cache for HTTPS. type: str choices: disable, enable
webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str
webproxy_forward_server - Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str
webproxy_profile - Webproxy profile name. Source web-proxy.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 consolidated IPv4/IPv6 policies.
    fortios_firewall_consolidated_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_consolidated_policy:
        action: "accept"
        application_list: "<your_own_value> (source application.list.name)"
        auto_asic_offload: "enable"
        av_profile: "<your_own_value> (source antivirus.profile.name)"
        captive_portal_exempt: "enable"
        cifs_profile: "<your_own_value> (source cifs.profile.name)"
        comments: "<your_own_value>"
        diffserv_forward: "enable"
        diffserv_reverse: "enable"
        diffservcode_forward: "<your_own_value>"
        diffservcode_rev: "<your_own_value>"
        dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
        dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
        dstaddr_negate: "enable"
        dstaddr4:
         -
            name: "default_name_18 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name)"
        dstaddr6:
         -
            name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system.external-resource
              .name)"
        dstintf:
         -
            name: "default_name_22 (source system.interface.name system.zone.name)"
        emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
        fixedport: "enable"
        fsso_groups:
         -
            name: "default_name_26 (source user.adgrp.name)"
        groups:
         -
            name: "default_name_28 (source user.group.name)"
        http_policy_redirect: "enable"
        icap_profile: "<your_own_value> (source icap.profile.name)"
        inbound: "enable"
        inspection_mode: "proxy"
        internet_service: "enable"
        internet_service_custom:
         -
            name: "default_name_35 (source firewall.internet-service-custom.name)"
        internet_service_custom_group:
         -
            name: "default_name_37 (source firewall.internet-service-custom-group.name)"
        internet_service_group:
         -
            name: "default_name_39 (source firewall.internet-service-group.name)"
        internet_service_name:
         -
            name: "default_name_41 (source firewall.internet-service-name.name)"
        internet_service_negate: "enable"
        internet_service_src: "enable"
        internet_service_src_custom:
         -
            name: "default_name_45 (source firewall.internet-service-custom.name)"
        internet_service_src_custom_group:
         -
            name: "default_name_47 (source firewall.internet-service-custom-group.name)"
        internet_service_src_group:
         -
            name: "default_name_49 (source firewall.internet-service-group.name)"
        internet_service_src_name:
         -
            name: "default_name_51 (source firewall.internet-service-name.name)"
        internet_service_src_negate: "enable"
        ippool: "enable"
        ips_sensor: "<your_own_value> (source ips.sensor.name)"
        logtraffic: "all"
        logtraffic_start: "enable"
        name: "default_name_57"
        nat: "enable"
        outbound: "enable"
        per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        policyid: "61"
        poolname4:
         -
            name: "default_name_63 (source firewall.ippool.name)"
        poolname6:
         -
            name: "default_name_65 (source firewall.ippool6.name)"
        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)"
        service:
         -
            name: "default_name_71 (source firewall.service.custom.name firewall.service.group.name)"
        service_negate: "enable"
        session_ttl: "73"
        srcaddr_negate: "enable"
        srcaddr4:
         -
            name: "default_name_76 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
        srcaddr6:
         -
            name: "default_name_78 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
        srcintf:
         -
            name: "default_name_80 (source system.interface.name system.zone.name)"
        ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
        ssh_policy_redirect: "enable"
        ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
        status: "enable"
        tcp_mss_receiver: "85"
        tcp_mss_sender: "86"
        traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        users:
         -
            name: "default_name_90 (source user.local.name)"
        utm_status: "enable"
        uuid: "<your_own_value>"
        voip_profile: "<your_own_value> (source voip.profile.name)"
        vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
        waf_profile: "<your_own_value> (source waf.profile.name)"
        wanopt: "enable"
        wanopt_detection: "active"
        wanopt_passive_opt: "default"
        wanopt_peer: "<your_own_value> (source wanopt.peer.peer-host-id)"
        wanopt_profile: "<your_own_value> (source wanopt.profile.name)"
        webcache: "enable"
        webcache_https: "disable"
        webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
        webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
        webproxy_profile: "<your_own_value> (source web-proxy.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.