fortinet.fortios.fortios_firewall_policy module – Configure 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_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 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. |
|
the action indiactor to move an object in the list Choices:
|
|
mkey of target identifier |
|
mkey of target identifier |
|
Enable/Disable logging for task. Choices:
|
|
Configure IPv4/IPv6 policies. |
|
Policy action (accept/deny/ipsec). Choices:
|
|
Enable/disable anti-replay check. 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. |
|
HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. |
|
Enable/disable authentication-based routing. Choices:
|
|
HTTP-to-HTTPS redirect address for firewall authentication. |
|
Enable/disable policy traffic ASIC offloading. Choices:
|
|
Name of an existing Antivirus profile. Source antivirus.profile.name. |
|
Enable/disable block notification. Choices:
|
|
Enable to exempt some users from the captive portal. Choices:
|
|
Enable/disable capture packets. Choices:
|
|
Name of an existing CASB profile. Source casb.profile.name. |
|
Name of an existing CIFS profile. Source cifs.profile.name. |
|
Comment. |
|
Custom fields to append to log messages for this policy. |
|
Custom log field. Source log.custom-field.id. |
|
Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. |
|
Enable TCP NPU session delay to guarantee packet order of 3-way handshake. Choices:
|
|
Names of devices or device groups that can be matched by the policy. |
|
Device or group name. Source user.device.alias user.device-group.name user.device-category.name. |
|
Name of an existing Diameter filter profile. Source diameter-filter.profile.name. |
|
Enable to copy packet”s DiffServ values from session”s original direction to its reply direction. Choices:
|
|
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. |
|
Enable/disable user authentication disclaimer. Choices:
|
|
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. |
|
Enable DSCP check. Choices:
|
|
Enable negated DSCP match. Choices:
|
|
DSCP value. |
|
Enable DSRI to ignore HTTP server responses. Choices:
|
|
Destination IPv4 address 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 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. |
|
Enable/disable dynamic RADIUS defined traffic shaping. Choices:
|
|
Enable/disable email collection. Choices:
|
|
Name of an existing email filter profile. Source emailfilter.profile.name. |
|
Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. Choices:
|
|
Name of an existing file-filter profile. Source file-filter.profile.name. |
|
How to handle sessions if the configuration of this firewall policy changes. Choices:
|
|
Enable to prevent source NAT from changing a session”s source port. Choices:
|
|
Enable/disable Fortinet Single Sign-On. Choices:
|
|
FSSO agent to use for NTLM authentication. Source user.fsso.name. |
|
Names of FSSO groups. |
|
Names of FSSO groups. Source user.adgrp.name. |
|
Enable/disable recognition of anycast IP addresses using the geography IP database. Choices:
|
|
Match geography address based either on its physical location or registered location. Choices:
|
|
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. |
|
GTP profile. Source firewall.gtp.name. |
|
Redirect HTTP(S) traffic to matching transparent web proxy policy. Choices:
|
|
Name of an existing ICAP profile. Source icap.profile.name. |
|
Name of identity-based routing rule. Source firewall.identity-based-route.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:
|
|
Enable/disable use of IPv6 Internet Services for this policy. If enabled, destination address and service are not used. Choices:
|
|
Custom IPv6 Internet Service name. |
|
Custom Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom Internet Service6 group name. |
|
Custom Internet Service6 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:
|
|
Enable to use IP Pools for source NAT. Choices:
|
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
Name of an existing VoIP (ips) profile. Source voip.profile.name. |
|
Label for the policy that appears when the GUI is in Section View mode. |
|
Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. Choices:
|
|
Enable/disable HTTP transaction log. Choices:
|
|
Enable or disable logging. Log all sessions or security profile sessions. Choices:
|
|
Record logs when a session starts. Choices:
|
|
Enable to match packets that have had their destination addresses changed by a VIP. Choices:
|
|
Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. Choices:
|
|
Name of an existing MMS profile. Source firewall.mms-profile.name. |
|
Policy name. |
|
Enable/disable source NAT. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Enable/disable NAT64. Choices:
|
|
Policy-based IPsec VPN: apply destination NAT to inbound traffic. Choices:
|
|
Policy-based IPsec VPN: source NAT IP address for outgoing traffic. |
|
Policy-based IPsec VPN: apply source NAT to outbound traffic. Choices:
|
|
Dynamic Network Service name. |
|
Dynamic Network Service name. Source firewall.network-service-dynamic.name. |
|
Dynamic Network Service source name. |
|
Dynamic Network Service name. Source firewall.network-service-dynamic.name. |
|
Enable/disable UTM Network Processor acceleration. Choices:
|
|
Enable/disable NTLM authentication. Choices:
|
|
HTTP-User-Agent value of supported browsers. |
|
User agent string. |
|
Enable/disable NTLM guest user access. Choices:
|
|
Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. Choices:
|
|
Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. Choices:
|
|
Enable/disable PCP inbound DNAT. Choices:
|
|
Enable/disable PCP outbound SNAT. Choices:
|
|
PCP pool names. |
|
PCP pool name. Source system.pcp-server.pools.name. |
|
Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
|
Accept UDP packets from any host. Choices:
|
|
Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. Choices:
|
|
PFCP profile. Source firewall.pfcp.name. |
|
Enable/disable policy expiry. Choices:
|
|
Policy expiry date (YYYY-MM-DD HH:MM:SS). |
|
Policy expiry date and time, in epoch format. |
|
Policy ID (0 - 4294967294). see <a href=’#notes’>Notes</a>. |
|
IP Pool names. |
|
IP pool name. Source firewall.ippool.name. |
|
IPv6 pool names. |
|
IPv6 pool name. Source firewall.ippool6.name. |
|
Enable/disable preservation of the original source port from source NAT if it has not been used. Choices:
|
|
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:
|
|
Enable IP authentication bypass. The bypassed IP address must be received from RADIUS server. Choices:
|
|
Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server. Choices:
|
|
URL users are directed to after seeing and accepting the disclaimer or authenticating. |
|
Override the default replacement message group for this policy. Source system.replacemsg-group.name. |
|
Direction of the initial traffic for reputation to take effect. Choices:
|
|
Direction of the initial traffic for IPv6 reputation to take effect. Choices:
|
|
Minimum Reputation to take action. Source firewall.internet-service-reputation.id. |
|
IPv6 Minimum Reputation to take action. Source firewall.internet-service-reputation.id. |
|
Enable/disable RADIUS single sign-on (RSSO). Choices:
|
|
Address names if this is an RTP NAT policy. |
|
Address name. Source firewall.internet-service-custom-group.name firewall.addrgrp.name. |
|
Enable Real Time Protocol (RTP) NAT. Choices:
|
|
Block or monitor connections to Botnet servers or disable Botnet scanning. Choices:
|
|
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
|
Enable to force current sessions to end when the schedule object times out. Disable allows them to end from inactivity. Choices:
|
|
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 and service group names. 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 ). |
|
Security group tags. |
|
Security group tag (1 - 65535). see <a href=’#notes’>Notes</a>. |
|
Enable/disable security group tags (SGT) check. Choices:
|
|
Name of an existing Spam filter profile. Source spamfilter.profile.name. |
|
Vendor MAC source ID. |
|
Vendor MAC ID. see <a href=’#notes’>Notes</a>. Source firewall.vendor-mac.id. |
|
Source IPv4 address 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 system.external-resource.name firewall.addrgrp6.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. |
|
Redirect SSH traffic to matching transparent proxy policy. Choices:
|
|
Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). Choices:
|
|
SSL mirror interface name. |
|
Mirror Interface name. Source system.interface.name system.zone.name. |
|
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). |
|
Enable/disable creation of TCP session without SYN flag. Choices:
|
|
Enable/disable sending RST packets when TCP sessions expire. Choices:
|
|
ToS (Type of Service) value used for comparison. |
|
Non-zero bit positions are used for comparison while zero bit positions are ignored. |
|
Enable negated TOS match. Choices:
|
|
Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
URL category ID list. |
|
URL category ID. see <a href=’#notes’>Notes</a>. |
|
Names of individual users that can authenticate with this policy. |
|
Names of individual users that can authenticate with this policy. Source user.local.name user.certificate.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 VideoFilter profile. Source videofilter.profile.name. |
|
Name of an existing virtual-patch profile. Source virtual-patch.profile.name. |
|
VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. |
|
VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest. |
|
VLAN ranges to allow |
|
Name of an existing VoIP (voipd) 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 server. Choices:
|
|
WAN optimization peer. Source wanopt.peer.peer-host-id. |
|
WAN optimization profile. Source wanopt.profile.name. |
|
Enable/disable forwarding traffic matching this policy to a configured WCCP server. Choices:
|
|
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. |
|
Enable/disable WiFi Single Sign On (WSSO). Choices:
|
|
Enable/disable zero trust device ownership. Choices:
|
|
Source ztna-ems-tag names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
Source ztna-ems-tag-secondary names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
Source ztna-geo-tag names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
Redirect ZTNA traffic to matching Access-Proxy proxy-policy. Choices:
|
|
Enable/disable zero trust access. Choices:
|
|
ZTNA tag matching logic. Choices:
|
|
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:
|
|
mkey of self identifier |
|
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
Adjust object order by moving self after(before) another.
Only one of [after, before] must be specified when action is moving an object.
The module supports check_mode.
Examples
- name: Configure IPv4/IPv6 policies.
fortinet.fortios.fortios_firewall_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8 (source application.group.name)"
application:
-
id: "10"
application_list: "<your_own_value> (source application.list.name)"
auth_cert: "<your_own_value> (source vpn.certificate.local.name)"
auth_path: "enable"
auth_redirect_addr: "<your_own_value>"
auto_asic_offload: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
block_notification: "enable"
captive_portal_exempt: "enable"
capture_packet: "enable"
casb_profile: "<your_own_value> (source casb.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
delay_tcp_npu_session: "enable"
devices:
-
name: "default_name_28 (source user.device.alias user.device-group.name user.device-category.name)"
diameter_filter_profile: "<your_own_value> (source diameter-filter.profile.name)"
diffserv_copy: "enable"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
disclaimer: "enable"
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)"
dscp_match: "enable"
dscp_negate: "enable"
dscp_value: "<your_own_value>"
dsri: "enable"
dstaddr:
-
name: "default_name_44 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource
.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_47 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
.external-resource.name)"
dstaddr6_negate: "enable"
dstintf:
-
name: "default_name_50 (source system.interface.name system.zone.name system.sdwan.zone.name)"
dynamic_shaping: "enable"
email_collect: "enable"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
fec: "enable"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso: "enable"
fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
fsso_groups:
-
name: "default_name_61 (source user.adgrp.name)"
geoip_anycast: "enable"
geoip_match: "physical-location"
global_label: "<your_own_value>"
groups:
-
name: "default_name_66 (source user.group.name)"
gtp_profile: "<your_own_value> (source firewall.gtp.name)"
http_policy_redirect: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
identity_based_route: "<your_own_value> (source firewall.identity-based-route.name)"
inbound: "enable"
inspection_mode: "proxy"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_75 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_77 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_79 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "81 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_83 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_87 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_89 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_91 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "93 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_95 (source firewall.internet-service-name.name)"
internet_service_src_negate: "enable"
internet_service6: "enable"
internet_service6_custom:
-
name: "default_name_99 (source firewall.internet-service-custom.name)"
internet_service6_custom_group:
-
name: "default_name_101 (source firewall.internet-service-custom-group.name)"
internet_service6_group:
-
name: "default_name_103 (source firewall.internet-service-group.name)"
internet_service6_name:
-
name: "default_name_105 (source firewall.internet-service-name.name)"
internet_service6_negate: "enable"
internet_service6_src: "enable"
internet_service6_src_custom:
-
name: "default_name_109 (source firewall.internet-service-custom.name)"
internet_service6_src_custom_group:
-
name: "default_name_111 (source firewall.internet-service-custom-group.name)"
internet_service6_src_group:
-
name: "default_name_113 (source firewall.internet-service-group.name)"
internet_service6_src_name:
-
name: "default_name_115 (source firewall.internet-service-name.name)"
internet_service6_src_negate: "enable"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
ips_voip_filter: "<your_own_value> (source voip.profile.name)"
label: "<your_own_value>"
learning_mode: "enable"
log_http_transaction: "enable"
logtraffic: "all"
logtraffic_start: "enable"
match_vip: "enable"
match_vip_only: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_128"
nat: "enable"
nat46: "enable"
nat64: "enable"
natinbound: "enable"
natip: "<your_own_value>"
natoutbound: "enable"
network_service_dynamic:
-
name: "default_name_136 (source firewall.network-service-dynamic.name)"
network_service_src_dynamic:
-
name: "default_name_138 (source firewall.network-service-dynamic.name)"
np_acceleration: "enable"
ntlm: "enable"
ntlm_enabled_browsers:
-
user_agent_string: "<your_own_value>"
ntlm_guest: "enable"
outbound: "enable"
passive_wan_health_measurement: "enable"
pcp_inbound: "enable"
pcp_outbound: "enable"
pcp_poolname:
-
name: "default_name_149 (source system.pcp-server.pools.name)"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
permit_any_host: "enable"
permit_stun_host: "enable"
pfcp_profile: "<your_own_value> (source firewall.pfcp.name)"
policy_expiry: "enable"
policy_expiry_date: "<your_own_value>"
policy_expiry_date_utc: "<your_own_value>"
policyid: "<you_own_value>"
poolname:
-
name: "default_name_159 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_161 (source firewall.ippool6.name)"
port_preserve: "enable"
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"
radius_ip_auth_bypass: "enable"
radius_mac_auth_bypass: "enable"
redirect_url: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
reputation_direction: "source"
reputation_direction6: "source"
reputation_minimum: "0"
reputation_minimum6: "0"
rsso: "enable"
rtp_addr:
-
name: "default_name_176 (source firewall.internet-service-custom-group.name firewall.addrgrp.name)"
rtp_nat: "disable"
scan_botnet_connections: "disable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
schedule_timeout: "enable"
sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.name)"
send_deny_packet: "disable"
service:
-
name: "default_name_184 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "<your_own_value>"
sgt:
-
id: "188"
sgt_check: "enable"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
src_vendor_mac:
-
id: "192 (source firewall.vendor-mac.id)"
srcaddr:
-
name: "default_name_194 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_197 (source firewall.address6.name system.external-resource.name firewall.addrgrp6.name)"
srcaddr6_negate: "enable"
srcintf:
-
name: "default_name_200 (source system.interface.name system.zone.name system.sdwan.zone.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_mirror: "enable"
ssl_mirror_intf:
-
name: "default_name_205 (source system.interface.name system.zone.name)"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
tcp_mss_receiver: "0"
tcp_mss_sender: "0"
tcp_session_without_syn: "all"
timeout_send_rst: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "218"
users:
-
name: "default_name_220 (source user.local.name user.certificate.name)"
utm_status: "enable"
uuid: "<your_own_value>"
videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
virtual_patch_profile: "<your_own_value> (source virtual-patch.profile.name)"
vlan_cos_fwd: "255"
vlan_cos_rev: "255"
vlan_filter: "<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)"
wccp: "enable"
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)"
wsso: "enable"
ztna_device_ownership: "enable"
ztna_ems_tag:
-
name: "default_name_245 (source firewall.address.name firewall.addrgrp.name)"
ztna_ems_tag_secondary:
-
name: "default_name_247 (source firewall.address.name firewall.addrgrp.name)"
ztna_geo_tag:
-
name: "default_name_249 (source firewall.address.name firewall.addrgrp.name)"
ztna_policy_redirect: "enable"
ztna_status: "enable"
ztna_tags_match_logic: "or"
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: |