fortinet.fortios.fortios_firewall_consolidated_policy module – Configure consolidated IPv4/IPv6 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_consolidated_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_consolidated feature and 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 consolidated IPv4/IPv6 policies. |
|
Policy action (allow/deny/ipsec). Choices:
|
|
Name of an existing Application list. Source application.list.name. |
|
Enable/disable policy traffic ASIC offloading. Choices:
|
|
Name of an existing Antivirus profile. Source antivirus.profile.name. |
|
Enable exemption of some users from the captive portal. Choices:
|
|
Name of an existing CIFS profile. Source cifs.profile.name. |
|
Comment. |
|
Enable to change packet”s DiffServ values to the specified diffservcode-forward value. Choices:
|
|
Enable to change packet”s reverse (reply) DiffServ values to the specified diffservcode-rev value. Choices:
|
|
Change packet”s DiffServ to this value. |
|
Change packet”s reverse (reply) DiffServ to this value. |
|
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 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 dstaddr specifies what the destination address must NOT be. Choices:
|
|
Outgoing (egress) interface. |
|
Interface name. Source system.interface.name system.zone.name. |
|
Name of an existing email filter profile. Source emailfilter.profile.name. |
|
Enable to prevent source NAT from changing a session”s source port. Choices:
|
|
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. |
|
Group name. Source user.group.name. |
|
Redirect HTTP(S) traffic to matching transparent web proxy policy. Choices:
|
|
Name of an existing ICAP profile. Source icap.profile.name. |
|
Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. Choices:
|
|
Policy inspection mode (Flow/proxy). Default is Flow mode. Choices:
|
|
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. 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. |
|
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. |
|
When enabled internet-service-src specifies what the service must NOT be. Choices:
|
|
Enable to use IP Pools for source NAT. Choices:
|
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
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 source NAT. Choices:
|
|
Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. Choices:
|
|
Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
|
Policy ID (0 - 4294967294). see <a href=’#notes’>Notes</a>. |
|
IPv4 pool names. |
|
IPv4 pool name. Source firewall.ippool.name. |
|
IPv6 pool names. |
|
IPv6 pool name. Source firewall.ippool6.name. |
|
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. |
|
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:
|
|
TTL in seconds for sessions accepted by this policy (0 means use the system ). |
|
Source IPv4 address name and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. |
|
Source IPv6 address name and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. |
|
When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
Incoming (ingress) interface. |
|
Interface name. Source system.interface.name system.zone.name. |
|
Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
|
Redirect SSH traffic to matching transparent proxy policy. Choices:
|
|
Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
|
Enable or disable this policy. Choices:
|
|
Receiver TCP maximum segment size (MSS). |
|
Sender TCP maximum segment size (MSS). |
|
Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
Names of individual users that can authenticate with this policy. |
|
User name. Source user.local.name. |
|
Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Name of an existing VoIP profile. Source voip.profile.name. |
|
Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. |
|
Name of an existing Web application firewall profile. Source waf.profile.name. |
|
Enable/disable WAN optimization. Choices:
|
|
WAN optimization auto-detection mode. Choices:
|
|
WAN optimization passive mode options. This option decides what IP address will be used to connect to server. Choices:
|
|
WAN optimization peer. Source wanopt.peer.peer-host-id. |
|
WAN optimization profile. Source wanopt.profile.name. |
|
Enable/disable web cache. Choices:
|
|
Enable/disable web cache for HTTPS. Choices:
|
|
Name of an existing Web filter profile. Source webfilter.profile.name. |
|
Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. |
|
Webproxy profile name. Source web-proxy.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 consolidated IPv4/IPv6 policies.
fortinet.fortios.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)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_29 (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_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_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_46 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_48 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_50 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "52 (source firewall.internet-service.id)"
internet_service_src_negate: "enable"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_59"
nat: "enable"
outbound: "enable"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
policyid: "<you_own_value>"
poolname4:
-
name: "default_name_65 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_67 (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_73 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "1382400"
srcaddr_negate: "enable"
srcaddr4:
-
name: "default_name_78 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr6:
-
name: "default_name_80 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcintf:
-
name: "default_name_82 (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: "32767"
tcp_mss_sender: "32767"
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_92 (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 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: |