:source: fortios_firewall_policy.py
:orphan:
.. fortios_firewall_policy:
fortios_firewall_policy -- Configure IPv4/IPv6 policies in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- action - the action indiactor to move an object in the list type: str choices: move
- self - mkey of self identifier type: str
- after - mkey of target identifier type: str
- before - mkey of target identifier type: str
- state - Indicates whether to create or remove the object. type: str required: false choices: present, absent
- firewall_policy - Configure IPv4/IPv6 policies. type: dict
more...
| Supported Version Ranges |
| firewall_policy |
v6.0.0 -> 7.6.6 |
- action - Policy action (accept/deny/ipsec). type: str choices: accept, deny, ipsec
more...
|
Supported Version Ranges |
| action |
v6.0.0 -> 7.6.6 |
| [accept] |
v6.0.0 -> 7.6.6 |
| [deny] |
v6.0.0 -> 7.6.6 |
| [ipsec] |
v6.0.0 -> 7.6.6 |
- anti_replay - Enable/disable anti-replay check. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| anti_replay |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- app_category - Application category ID list. type: list member_path: app_category:id
more...
| Supported Version Ranges |
| app_category |
v6.0.0 -> v6.2.7 |
- id - Category IDs. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> v6.2.7 |
- app_group - Application group names. type: list member_path: app_group:name
more...
| Supported Version Ranges |
| app_group |
v6.0.0 -> v6.2.7 |
- name - Application group names. Source application.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- app_monitor - Enable/disable application TCP metrics in session logs.When enabled, auto-asic-offload is disabled. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| app_monitor |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- application - Application ID list. type: list member_path: application:id
more...
| Supported Version Ranges |
| application |
v6.0.0 -> v6.2.7 |
- id - Application IDs. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> v6.2.7 |
- application_list - Name of an existing Application list. Source application.list.name. type: str
more...
|
Supported Version Ranges |
| application_list |
v6.0.0 -> 7.6.6 |
- auth_cert - HTTPS server certificate for policy authentication. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| auth_cert |
v6.0.0 -> 7.6.6 |
- auth_path - Enable/disable authentication-based routing. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auth_path |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- auth_redirect_addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str
more...
|
Supported Version Ranges |
| auth_redirect_addr |
v6.0.0 -> 7.6.6 |
- auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_asic_offload |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str
more...
|
Supported Version Ranges |
| av_profile |
v6.0.0 -> 7.6.6 |
- block_notification - Enable/disable block notification. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| block_notification |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- captive_portal_exempt - Enable to exempt some users from the captive portal. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| captive_portal_exempt |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- capture_packet - Enable/disable capture packets. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| capture_packet |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- casb_profile - Name of an existing CASB profile. Source casb.profile.name. type: str
more...
|
Supported Version Ranges |
| casb_profile |
v7.4.1 -> 7.6.6 |
- cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str
more...
|
Supported Version Ranges |
| cifs_profile |
v6.2.0 -> v7.6.0 |
- comments - Comment. type: str
more...
|
Supported Version Ranges |
| comments |
v6.0.0 -> 7.6.6 |
- custom_log_fields - Custom fields to append to log messages for this policy. type: list member_path: custom_log_fields:field_id
more...
| Supported Version Ranges |
| custom_log_fields |
v6.0.0 -> 7.6.6 |
- field_id - Custom log field. Source log.custom-field.id. type: str required: true
more...
|
Supported Version Ranges |
| field_id |
v6.0.0 -> 7.6.6 |
- decrypted_traffic_mirror - Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. type: str
more...
|
Supported Version Ranges |
| decrypted_traffic_mirror |
v6.4.0 -> 7.6.6 |
- delay_tcp_npu_session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| delay_tcp_npu_session |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- devices - Names of devices or device groups that can be matched by the policy. type: list member_path: devices:name
more...
| Supported Version Ranges |
| devices |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- name - Device or group name. Source user.device.alias user.device-group.name user.device-category.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- diameter_filter_profile - Name of an existing Diameter filter profile. Source diameter-filter.profile.name. type: str
more...
|
Supported Version Ranges |
| diameter_filter_profile |
v7.4.2 -> 7.6.6 |
- diffserv_copy - Enable to copy packet"s DiffServ values from session"s original direction to its reply direction. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| diffserv_copy |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| diffserv_forward |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| diffserv_reverse |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- diffservcode_forward - Change packet"s DiffServ to this value. type: str
more...
|
Supported Version Ranges |
| diffservcode_forward |
v6.0.0 -> 7.6.6 |
- diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str
more...
|
Supported Version Ranges |
| diffservcode_rev |
v6.0.0 -> 7.6.6 |
- disclaimer - Enable/disable user authentication disclaimer. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| disclaimer |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dlp_profile - Name of an existing DLP profile. Source dlp.profile.name. type: str
more...
|
Supported Version Ranges |
| dlp_profile |
v7.2.0 -> 7.6.6 |
- dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str
more...
|
Supported Version Ranges |
| dlp_sensor |
v6.0.0 -> v7.0.12 |
- dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| dnsfilter_profile |
v6.0.0 -> 7.6.6 |
- dscp_match - Enable DSCP check. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dscp_match |
v6.0.0 -> v6.0.11 |
| [enable] |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
- dscp_negate - Enable negated DSCP match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dscp_negate |
v6.0.0 -> v6.0.11 |
| [enable] |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
- dscp_value - DSCP value. type: str
more...
|
Supported Version Ranges |
| dscp_value |
v6.0.0 -> v6.0.11 |
- dsri - Enable DSRI to ignore HTTP server responses. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dsri |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dstaddr - Destination IPv4 address and address group names. type: list member_path: dstaddr:name
more...
| Supported Version Ranges |
| dstaddr |
v6.0.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource .name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dstaddr_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dstaddr6 - Destination IPv6 address name and address group names. type: list member_path: dstaddr6:name
more...
| Supported Version Ranges |
| dstaddr6 |
v6.4.0 -> 7.6.6 |
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.4.0 -> 7.6.6 |
- dstaddr6_negate - When enabled dstaddr6 specifies what the destination address must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dstaddr6_negate |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- dstintf - Outgoing (egress) interface. type: list member_path: dstintf:name
more...
| Supported Version Ranges |
| dstintf |
v6.0.0 -> 7.6.6 |
- name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- dynamic_shaping - Enable/disable dynamic RADIUS defined traffic shaping. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dynamic_shaping |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- email_collect - Enable/disable email collection. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| email_collect |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| emailfilter_profile |
v6.2.0 -> 7.6.6 |
- fec - Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fec |
v7.0.2 -> 7.6.6 |
| [enable] |
v7.0.2 -> 7.6.6 |
| [disable] |
v7.0.2 -> 7.6.6 |
- file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str
more...
|
Supported Version Ranges |
| file_filter_profile |
v6.4.0 -> 7.6.6 |
- firewall_session_dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: check-all, check-new
more...
|
Supported Version Ranges |
| firewall_session_dirty |
v6.0.0 -> 7.6.6 |
| [check-all] |
v6.0.0 -> 7.6.6 |
| [check-new] |
v6.0.0 -> 7.6.6 |
- fixedport - Enable to prevent source NAT from changing a session"s source port. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fixedport |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- fsso - Enable/disable Fortinet Single Sign-On. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fsso |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- fsso_agent_for_ntlm - FSSO agent to use for NTLM authentication. Source user.fsso.name. type: str
more...
|
Supported Version Ranges |
| fsso_agent_for_ntlm |
v6.0.0 -> 7.6.6 |
- fsso_groups - Names of FSSO groups. type: list member_path: fsso_groups:name
more...
| Supported Version Ranges |
| fsso_groups |
v6.2.0 -> 7.6.6 |
- name - Names of FSSO groups. Source user.adgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- geoip_anycast - Enable/disable recognition of anycast IP addresses using the geography IP database. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| geoip_anycast |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- geoip_match - Match geography address based either on its physical location or registered location. type: str choices: physical-location, registered-location
more...
|
Supported Version Ranges |
| geoip_match |
v6.4.0 -> 7.6.6 |
| [physical-location] |
v6.4.0 -> 7.6.6 |
| [registered-location] |
v6.4.0 -> 7.6.6 |
- global_label - Label for the policy that appears when the GUI is in Global View mode. type: str
more...
|
Supported Version Ranges |
| global_label |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- groups - Names of user groups that can authenticate with this policy. type: list member_path: groups:name
more...
| Supported Version Ranges |
| groups |
v6.0.0 -> 7.6.6 |
- name - Group name. Source user.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- gtp_profile - GTP profile. Source firewall.gtp.name. type: str
more...
|
Supported Version Ranges |
| gtp_profile |
v6.0.0 -> v7.0.8 |
v7.2.0 -> v7.2.4 |
v7.4.3 -> 7.6.6 |
- http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable, legacy
more...
|
Supported Version Ranges |
| http_policy_redirect |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [legacy] |
v7.6.3 -> 7.6.6 |
- icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str
more...
|
Supported Version Ranges |
| icap_profile |
v6.0.0 -> 7.6.6 |
- identity_based_route - Name of identity-based routing rule. Source firewall.identity-based-route.name. type: str
more...
|
Supported Version Ranges |
| identity_based_route |
v6.0.0 -> 7.6.6 |
- inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| inbound |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- inspection_mode - Policy inspection mode (Flow/proxy). Default is Flow mode. type: str choices: proxy, flow
more...
|
Supported Version Ranges |
| inspection_mode |
v6.2.0 -> 7.6.6 |
| [proxy] |
v6.2.0 -> 7.6.6 |
| [flow] |
v6.2.0 -> 7.6.6 |
- 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
more...
|
Supported Version Ranges |
| internet_service |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- internet_service_custom - Custom Internet Service name. type: list member_path: internet_service_custom:name
more...
| Supported Version Ranges |
| internet_service_custom |
v6.0.0 -> 7.6.6 |
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- internet_service_custom_group - Custom Internet Service group name. type: list member_path: internet_service_custom_group:name
more...
| Supported Version Ranges |
| internet_service_custom_group |
v6.2.0 -> 7.6.6 |
- name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- internet_service_fortiguard - FortiGuard Internet Service name. type: list member_path: internet_service_fortiguard:name
more...
| Supported Version Ranges |
| internet_service_fortiguard |
v7.6.4 -> 7.6.6 |
- name - FortiGuard Internet Service name. Source firewall.internet-service-fortiguard.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.4 -> 7.6.6 |
- internet_service_group - Internet Service group name. type: list member_path: internet_service_group:name
more...
| Supported Version Ranges |
| internet_service_group |
v6.2.0 -> 7.6.6 |
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- internet_service_id - Internet Service ID. type: list member_path: internet_service_id:id
more...
| Supported Version Ranges |
| internet_service_id |
v6.0.0 -> v6.2.7 |
- id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> v6.2.7 |
- internet_service_name - Internet Service name. type: list member_path: internet_service_name:name
more...
| Supported Version Ranges |
| internet_service_name |
v6.4.0 -> 7.6.6 |
- name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.4.0 -> 7.6.6 |
- internet_service_negate - When enabled internet-service specifies what the service must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| internet_service_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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
more...
|
Supported Version Ranges |
| internet_service_src |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- internet_service_src_custom - Custom Internet Service source name. type: list member_path: internet_service_src_custom:name
more...
| Supported Version Ranges |
| internet_service_src_custom |
v6.0.0 -> 7.6.6 |
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- internet_service_src_custom_group - Custom Internet Service source group name. type: list member_path: internet_service_src_custom_group:name
more...
| Supported Version Ranges |
| internet_service_src_custom_group |
v6.2.0 -> 7.6.6 |
- name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- internet_service_src_fortiguard - FortiGuard Internet Service source name. type: list member_path: internet_service_src_fortiguard:name
more...
| Supported Version Ranges |
| internet_service_src_fortiguard |
v7.6.4 -> 7.6.6 |
- name - FortiGuard Internet Service name. Source firewall.internet-service-fortiguard.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.4 -> 7.6.6 |
- internet_service_src_group - Internet Service source group name. type: list member_path: internet_service_src_group:name
more...
| Supported Version Ranges |
| internet_service_src_group |
v6.2.0 -> 7.6.6 |
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- internet_service_src_id - Internet Service source ID. type: list member_path: internet_service_src_id:id
more...
| Supported Version Ranges |
| internet_service_src_id |
v6.0.0 -> v6.2.7 |
- id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> v6.2.7 |
- internet_service_src_name - Internet Service source name. type: list member_path: internet_service_src_name:name
more...
| Supported Version Ranges |
| internet_service_src_name |
v6.4.0 -> 7.6.6 |
- name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.4.0 -> 7.6.6 |
- internet_service_src_negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| internet_service_src_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- internet_service6 - Enable/disable use of IPv6 Internet Services for this policy. If enabled, destination address and service are not used. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| internet_service6 |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- internet_service6_custom - Custom IPv6 Internet Service name. type: list member_path: internet_service6_custom:name
more...
| Supported Version Ranges |
| internet_service6_custom |
v7.2.1 -> 7.6.6 |
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_custom_group - Custom Internet Service6 group name. type: list member_path: internet_service6_custom_group:name
more...
| Supported Version Ranges |
| internet_service6_custom_group |
v7.2.1 -> 7.6.6 |
- name - Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_fortiguard - FortiGuard IPv6 Internet Service name. type: list member_path: internet_service6_fortiguard:name
more...
| Supported Version Ranges |
| internet_service6_fortiguard |
v7.6.4 -> 7.6.6 |
- name - FortiGuard Internet Service name. Source firewall.internet-service-fortiguard.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.4 -> 7.6.6 |
- internet_service6_group - Internet Service group name. type: list member_path: internet_service6_group:name
more...
| Supported Version Ranges |
| internet_service6_group |
v7.2.1 -> 7.6.6 |
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_name - IPv6 Internet Service name. type: list member_path: internet_service6_name:name
more...
| Supported Version Ranges |
| internet_service6_name |
v7.2.1 -> 7.6.6 |
- name - IPv6 Internet Service name. Source firewall.internet-service-name.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_negate - When enabled internet-service6 specifies what the service must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| internet_service6_negate |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- internet_service6_src - Enable/disable use of IPv6 Internet Services in source for this policy. If enabled, source address is not used. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| internet_service6_src |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- internet_service6_src_custom - Custom IPv6 Internet Service source name. type: list member_path: internet_service6_src_custom:name
more...
| Supported Version Ranges |
| internet_service6_src_custom |
v7.2.1 -> 7.6.6 |
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_src_custom_group - Custom Internet Service6 source group name. type: list member_path: internet_service6_src_custom_group:name
more...
| Supported Version Ranges |
| internet_service6_src_custom_group |
v7.2.1 -> 7.6.6 |
- name - Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_src_fortiguard - FortiGuard IPv6 Internet Service source name. type: list member_path: internet_service6_src_fortiguard:name
more...
| Supported Version Ranges |
| internet_service6_src_fortiguard |
v7.6.4 -> 7.6.6 |
- name - FortiGuard Internet Service name. Source firewall.internet-service-fortiguard.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.4 -> 7.6.6 |
- internet_service6_src_group - Internet Service6 source group name. type: list member_path: internet_service6_src_group:name
more...
| Supported Version Ranges |
| internet_service6_src_group |
v7.2.1 -> 7.6.6 |
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_src_name - IPv6 Internet Service source name. type: list member_path: internet_service6_src_name:name
more...
| Supported Version Ranges |
| internet_service6_src_name |
v7.2.1 -> 7.6.6 |
- name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- internet_service6_src_negate - When enabled internet-service6-src specifies what the service must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| internet_service6_src_negate |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ippool |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str
more...
|
Supported Version Ranges |
| ips_sensor |
v6.0.0 -> 7.6.6 |
- ips_voip_filter - Name of an existing VoIP (ips) profile. Source voip.profile.name. type: str
more...
|
Supported Version Ranges |
| ips_voip_filter |
v7.4.0 -> 7.6.6 |
- label - Label for the policy that appears when the GUI is in Section View mode. type: str
more...
|
Supported Version Ranges |
| label |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- learning_mode - Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| learning_mode |
v6.0.0 -> v6.0.11 |
| [enable] |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
- log_http_transaction - Enable/disable HTTP transaction log. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| log_http_transaction |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable
more...
|
Supported Version Ranges |
| logtraffic |
v6.0.0 -> 7.6.6 |
| [all] |
v6.0.0 -> 7.6.6 |
| [utm] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- logtraffic_start - Record logs when a session starts. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| logtraffic_start |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- match_vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| match_vip |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- match_vip_only - Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| match_vip_only |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str
more...
|
Supported Version Ranges |
| mms_profile |
v6.0.0 -> v6.2.7 |
- name - Policy name. type: str
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- nat - Enable/disable source NAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nat |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- nat46 - Enable/disable NAT46. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nat46 |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- nat64 - Enable/disable NAT64. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nat64 |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| natinbound |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- natip - Policy-based IPsec VPN: source NAT IP address for outgoing traffic. type: str
more...
|
Supported Version Ranges |
| natip |
v6.0.0 -> 7.6.6 |
- natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| natoutbound |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- network_service_dynamic - Dynamic Network Service name. type: list member_path: network_service_dynamic:name
more...
| Supported Version Ranges |
| network_service_dynamic |
v7.2.1 -> 7.6.6 |
- name - Dynamic Network Service name. Source firewall.network-service-dynamic.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- network_service_src_dynamic - Dynamic Network Service source name. type: list member_path: network_service_src_dynamic:name
more...
| Supported Version Ranges |
| network_service_src_dynamic |
v7.2.1 -> 7.6.6 |
- name - Dynamic Network Service name. Source firewall.network-service-dynamic.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- np_acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| np_acceleration |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ntlm - Enable/disable NTLM authentication. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ntlm |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ntlm_enabled_browsers - HTTP-User-Agent value of supported browsers. type: list member_path: ntlm_enabled_browsers:user_agent_string
more...
| Supported Version Ranges |
| ntlm_enabled_browsers |
v6.0.0 -> 7.6.6 |
- user_agent_string - User agent string. type: str required: true
more...
|
Supported Version Ranges |
| user_agent_string |
v6.0.0 -> 7.6.6 |
- ntlm_guest - Enable/disable NTLM guest user access. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ntlm_guest |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| outbound |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- passive_wan_health_measurement - Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| passive_wan_health_measurement |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- pcp_inbound - Enable/disable PCP inbound DNAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| pcp_inbound |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
- pcp_outbound - Enable/disable PCP outbound SNAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| pcp_outbound |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
- pcp_poolname - PCP pool names. type: list member_path: pcp_poolname:name
more...
| Supported Version Ranges |
| pcp_poolname |
v7.4.0 -> 7.6.6 |
- name - PCP pool name. Source system.pcp-server.pools.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.4.0 -> 7.6.6 |
- per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str
more...
|
Supported Version Ranges |
| per_ip_shaper |
v6.0.0 -> 7.6.6 |
- permit_any_host - Enable/disable fullcone NAT. Accept UDP packets from any host. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| permit_any_host |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- permit_stun_host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| permit_stun_host |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- pfcp_profile - PFCP profile. Source firewall.pfcp.name. type: str
more...
|
Supported Version Ranges |
| pfcp_profile |
v7.0.1 -> v7.0.8 |
v7.2.0 -> v7.2.4 |
v7.4.3 -> 7.6.6 |
- policy_expiry - Enable/disable policy expiry. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| policy_expiry |
v7.2.0 -> 7.6.6 |
| [enable] |
v7.2.0 -> 7.6.6 |
| [disable] |
v7.2.0 -> 7.6.6 |
- policy_expiry_date - Policy expiry date (YYYY-MM-DD HH:MM:SS). type: str
more...
|
Supported Version Ranges |
| policy_expiry_date |
v7.2.0 -> 7.6.6 |
- policy_expiry_date_utc - Policy expiry date and time, in epoch format. type: str
more...
|
Supported Version Ranges |
| policy_expiry_date_utc |
v7.2.4 -> 7.6.6 |
- policyid - Policy ID (0 - 4294967294). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| policyid |
v6.0.0 -> 7.6.6 |
- poolname - IP Pool names. type: list member_path: poolname:name
more...
| Supported Version Ranges |
| poolname |
v6.0.0 -> 7.6.6 |
- name - IP pool name. Source firewall.ippool.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- poolname6 - IPv6 pool names. type: list member_path: poolname6:name
more...
| Supported Version Ranges |
| poolname6 |
v6.4.0 -> 7.6.6 |
- name - IPv6 pool name. Source firewall.ippool6.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.4.0 -> 7.6.6 |
- port_preserve - Enable/disable preservation of the original source port from source NAT if it has not been used. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| port_preserve |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
- port_random - Enable/disable random source port selection for source NAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| port_random |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- profile_group - Name of profile group. Source firewall.profile-group.name. type: str
more...
|
Supported Version Ranges |
| profile_group |
v6.0.0 -> 7.6.6 |
- profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str
more...
|
Supported Version Ranges |
| profile_protocol_options |
v6.0.0 -> 7.6.6 |
- profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group
more...
|
Supported Version Ranges |
| profile_type |
v6.0.0 -> 7.6.6 |
| [single] |
v6.0.0 -> 7.6.6 |
| [group] |
v6.0.0 -> 7.6.6 |
- radius_ip_auth_bypass - Enable IP authentication bypass. The bypassed IP address must be received from RADIUS server. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| radius_ip_auth_bypass |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- radius_mac_auth_bypass - Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| radius_mac_auth_bypass |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- redirect_url - URL users are directed to after seeing and accepting the disclaimer or authenticating. type: str
more...
|
Supported Version Ranges |
| redirect_url |
v6.0.0 -> 7.6.6 |
- replacemsg_override_group - Override the default replacement message group for this policy. Source system.replacemsg-group.name. type: str
more...
|
Supported Version Ranges |
| replacemsg_override_group |
v6.0.0 -> 7.6.6 |
- reputation_direction - Direction of the initial traffic for reputation to take effect. type: str choices: source, destination
more...
|
Supported Version Ranges |
| reputation_direction |
v6.2.0 -> 7.6.6 |
| [source] |
v6.2.0 -> 7.6.6 |
| [destination] |
v6.2.0 -> 7.6.6 |
- reputation_direction6 - Direction of the initial traffic for IPv6 reputation to take effect. type: str choices: source, destination
more...
|
Supported Version Ranges |
| reputation_direction6 |
v7.2.1 -> 7.6.6 |
| [source] |
v7.2.1 -> 7.6.6 |
| [destination] |
v7.2.1 -> 7.6.6 |
- reputation_minimum - Minimum Reputation to take action. Source firewall.internet-service-reputation.id. type: int
more...
|
Supported Version Ranges |
| reputation_minimum |
v6.2.0 -> 7.6.6 |
- reputation_minimum6 - IPv6 Minimum Reputation to take action. Source firewall.internet-service-reputation.id. type: int
more...
|
Supported Version Ranges |
| reputation_minimum6 |
v7.2.1 -> 7.6.6 |
- rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rsso |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- rtp_addr - Address names if this is an RTP NAT policy. type: list member_path: rtp_addr:name
more...
| Supported Version Ranges |
| rtp_addr |
v6.0.0 -> 7.6.6 |
- name - Address name. Source firewall.internet-service-custom-group.name firewall.addrgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- rtp_nat - Enable Real Time Protocol (RTP) NAT. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| rtp_nat |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- saml_server - SAML server name. Source user.saml.name. type: str
more...
|
Supported Version Ranges |
| saml_server |
v7.6.4 -> v7.6.4 |
- scan_botnet_connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str choices: disable, block, monitor
more...
|
Supported Version Ranges |
| scan_botnet_connections |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
| [block] |
v6.0.0 -> v6.0.11 |
| [monitor] |
v6.0.0 -> v6.0.11 |
- schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str
more...
|
Supported Version Ranges |
| schedule |
v6.0.0 -> 7.6.6 |
- schedule_timeout - Enable to force current sessions to end when the schedule object times out. Disable allows them to end from inactivity. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| schedule_timeout |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- scim - Enable/disable SCIM . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| scim |
v7.6.4 -> v7.6.4 |
| [enable] |
v7.6.4 -> v7.6.4 |
| [disable] |
v7.6.4 -> v7.6.4 |
- scim_groups - Names of SCIM groups. type: list member_path: scim_groups:name
more...
| Supported Version Ranges |
| scim_groups |
v7.6.4 -> v7.6.4 |
- name - Names of SCIM groups. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.4 -> v7.6.4 |
- scim_users - Names of SCIM users. type: list member_path: scim_users:name
more...
| Supported Version Ranges |
| scim_users |
v7.6.4 -> v7.6.4 |
- name - Names of SCIM users. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.4 -> v7.6.4 |
- sctp_filter_profile - Name of an existing SCTP filter profile. Source sctp-filter.profile.name. type: str
more...
|
Supported Version Ranges |
| sctp_filter_profile |
v7.0.1 -> 7.6.6 |
- send_deny_packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| send_deny_packet |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- service - Service and service group names. type: list member_path: service:name
more...
| Supported Version Ranges |
| service |
v6.0.0 -> 7.6.6 |
- name - Service and service group names. Source firewall.service.custom.name firewall.service.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| service_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: str
more...
|
Supported Version Ranges |
| session_ttl |
v6.0.0 -> 7.6.6 |
- sgt - Security group tags. type: list member_path: sgt:id
more...
| Supported Version Ranges |
| sgt |
v7.0.1 -> 7.6.6 |
- id - Security group tag (1 - 65535). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v7.0.1 -> 7.6.6 |
- sgt_check - Enable/disable security group tags (SGT) check. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sgt_check |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- spamfilter_profile - Name of an existing Spam filter profile. Source spamfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| spamfilter_profile |
v6.0.0 -> v6.0.11 |
- src_vendor_mac - Vendor MAC source ID. type: list member_path: src_vendor_mac:id
more...
| Supported Version Ranges |
| src_vendor_mac |
v6.4.0 -> 7.6.6 |
- id - Vendor MAC ID. see Notes. Source firewall.vendor-mac.id. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.4.0 -> 7.6.6 |
- srcaddr - Source IPv4 address and address group names. type: list member_path: srcaddr:name
more...
| Supported Version Ranges |
| srcaddr |
v6.0.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| srcaddr_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- srcaddr6 - Source IPv6 address name and address group names. type: list member_path: srcaddr6:name
more...
| Supported Version Ranges |
| srcaddr6 |
v6.4.0 -> 7.6.6 |
- name - Address name. Source firewall.address6.name system.external-resource.name firewall.addrgrp6.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.4.0 -> 7.6.6 |
- srcaddr6_negate - When enabled srcaddr6 specifies what the source address must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| srcaddr6_negate |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name
more...
| Supported Version Ranges |
| srcintf |
v6.0.0 -> 7.6.6 |
- name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str
more...
|
Supported Version Ranges |
| ssh_filter_profile |
v6.0.0 -> 7.6.6 |
- ssh_policy_redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ssh_policy_redirect |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- ssl_mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ssl_mirror |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- ssl_mirror_intf - SSL mirror interface name. type: list member_path: ssl_mirror_intf:name
more...
| Supported Version Ranges |
| ssl_mirror_intf |
v6.0.0 -> v6.2.7 |
- name - Mirror Interface name. Source system.interface.name system.zone.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str
more...
|
Supported Version Ranges |
| ssl_ssh_profile |
v6.0.0 -> 7.6.6 |
- status - Enable or disable this policy. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int
more...
|
Supported Version Ranges |
| tcp_mss_receiver |
v6.0.0 -> 7.6.6 |
- tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int
more...
|
Supported Version Ranges |
| tcp_mss_sender |
v6.0.0 -> 7.6.6 |
- tcp_session_without_syn - Enable/disable creation of TCP session without SYN flag. type: str choices: all, data-only, disable
more...
|
Supported Version Ranges |
| tcp_session_without_syn |
v6.0.0 -> 7.6.6 |
| [all] |
v6.0.0 -> 7.6.6 |
| [data-only] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- telemetry_profile - Name of an existing telemetry profile. Source telemetry-controller.profile.name. type: str
more...
|
Supported Version Ranges |
| telemetry_profile |
v7.6.3 -> 7.6.6 |
- timeout_send_rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| timeout_send_rst |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- tos - ToS (Type of Service) value used for comparison. type: str
more...
|
Supported Version Ranges |
| tos |
v6.2.0 -> 7.6.6 |
- tos_mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str
more...
|
Supported Version Ranges |
| tos_mask |
v6.2.0 -> 7.6.6 |
- tos_negate - Enable negated TOS match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tos_negate |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- traffic_shaper - Traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
more...
|
Supported Version Ranges |
| traffic_shaper |
v6.0.0 -> 7.6.6 |
- traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
more...
|
Supported Version Ranges |
| traffic_shaper_reverse |
v6.0.0 -> 7.6.6 |
- url_category - URL category ID list. type: list member_path: url_category:id
more...
| Supported Version Ranges |
| url_category |
v6.0.0 -> v6.2.7 |
- id - URL category ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> v6.2.7 |
- users - Names of individual users that can authenticate with this policy. type: list member_path: users:name
more...
| Supported Version Ranges |
| users |
v6.0.0 -> 7.6.6 |
- name - Names of individual users that can authenticate with this policy. Source user.local.name user.certificate.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- utm_status - Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| utm_status |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
more...
|
Supported Version Ranges |
| uuid |
v6.0.0 -> 7.6.6 |
- videofilter_profile - Name of an existing VideoFilter profile. Source videofilter.profile.name. type: str
more...
|
Supported Version Ranges |
| videofilter_profile |
v7.0.0 -> 7.6.6 |
- virtual_patch_profile - Name of an existing virtual-patch profile. Source virtual-patch.profile.name. type: str
more...
|
Supported Version Ranges |
| virtual_patch_profile |
v7.4.1 -> 7.6.6 |
- vlan_cos_fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int
more...
|
Supported Version Ranges |
| vlan_cos_fwd |
v6.0.0 -> 7.6.6 |
- vlan_cos_rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int
more...
|
Supported Version Ranges |
| vlan_cos_rev |
v6.0.0 -> 7.6.6 |
- vlan_filter - VLAN ranges to allow type: str
more...
|
Supported Version Ranges |
| vlan_filter |
v6.0.0 -> 7.6.6 |
- voip_profile - Name of an existing VoIP (voipd) profile. Source voip.profile.name. type: str
more...
|
Supported Version Ranges |
| voip_profile |
v6.0.0 -> 7.6.6 |
- vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. type: str
more...
|
Supported Version Ranges |
| vpntunnel |
v6.0.0 -> 7.6.6 |
- waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str
more...
|
Supported Version Ranges |
| waf_profile |
v6.0.0 -> 7.6.6 |
- wanopt - Enable/disable WAN optimization. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| wanopt |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- wanopt_detection - WAN optimization auto-detection mode. type: str choices: active, passive, off
more...
|
Supported Version Ranges |
| wanopt_detection |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
| [active] |
v6.0.0 -> 7.6.6 |
| [passive] |
v6.0.0 -> 7.6.6 |
| [off] |
v6.0.0 -> 7.6.6 |
- wanopt_passive_opt - WAN optimization passive mode options. This option decides what IP address will be used to connect server. type: str choices: default, transparent, non-transparent
more...
|
Supported Version Ranges |
| wanopt_passive_opt |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [transparent] |
v6.0.0 -> 7.6.6 |
| [non-transparent] |
v6.0.0 -> 7.6.6 |
- wanopt_peer - WAN optimization peer. Source wanopt.peer.peer-host-id. type: str
more...
|
Supported Version Ranges |
| wanopt_peer |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
- wanopt_profile - WAN optimization profile. Source wanopt.profile.name. type: str
more...
|
Supported Version Ranges |
| wanopt_profile |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
- wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| wccp |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- webcache - Enable/disable web cache. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| webcache |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- webcache_https - Enable/disable web cache for HTTPS. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| webcache_https |
v6.0.0 -> v7.4.1 |
v7.4.3 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| webfilter_profile |
v6.0.0 -> 7.6.6 |
- webproxy_forward_server - Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str
more...
|
Supported Version Ranges |
| webproxy_forward_server |
v6.2.0 -> 7.6.6 |
- webproxy_profile - Webproxy profile name. Source web-proxy.profile.name. type: str
more...
|
Supported Version Ranges |
| webproxy_profile |
v6.2.0 -> 7.6.6 |
- wsso - Enable/disable WiFi Single Sign On (WSSO). type: str choices: enable, disable
more...
|
Supported Version Ranges |
| wsso |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- ztna_device_ownership - Enable/disable zero trust device ownership. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ztna_device_ownership |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
- ztna_ems_tag - Source ztna-ems-tag names. type: list member_path: ztna_ems_tag:name
more...
| Supported Version Ranges |
| ztna_ems_tag |
v7.0.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.0.0 -> 7.6.6 |
- ztna_ems_tag_negate - When enabled ztna-ems-tag specifies what the tags must NOT be. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ztna_ems_tag_negate |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- ztna_ems_tag_secondary - Source ztna-ems-tag-secondary names. type: list member_path: ztna_ems_tag_secondary:name
more...
| Supported Version Ranges |
| ztna_ems_tag_secondary |
v7.4.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.4.0 -> 7.6.6 |
- ztna_geo_tag - Source ztna-geo-tag names. type: list member_path: ztna_geo_tag:name
more...
| Supported Version Ranges |
| ztna_geo_tag |
v7.0.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.0.0 -> 7.6.6 |
- ztna_policy_redirect - Redirect ZTNA traffic to matching Access-Proxy proxy-policy. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ztna_policy_redirect |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
- ztna_status - Enable/disable zero trust access. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ztna_status |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- ztna_tags_match_logic - ZTNA tag matching logic. type: str choices: or, and
more...
|
Supported Version Ranges |
| ztna_tags_match_logic |
v7.2.4 -> 7.6.6 |
| [or] |
v7.2.4 -> 7.6.6 |
| [and] |
v7.2.4 -> 7.6.6 |
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
--------
.. code-block:: yaml+jinja
- name: Configure IPv4/IPv6 policies.
fortinet.fortios.fortios_firewall_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
firewall_policy:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8 (source application.group.name)"
app_monitor: "enable"
application:
-
id: "11"
application_list: " (source application.list.name)"
auth_cert: " (source vpn.certificate.local.name)"
auth_path: "enable"
auth_redirect_addr: ""
auto_asic_offload: "enable"
av_profile: " (source antivirus.profile.name)"
block_notification: "enable"
captive_portal_exempt: "enable"
capture_packet: "enable"
casb_profile: " (source casb.profile.name)"
cifs_profile: " (source cifs.profile.name)"
comments: ""
custom_log_fields:
-
field_id: " (source log.custom-field.id)"
decrypted_traffic_mirror: " (source firewall.decrypted-traffic-mirror.name)"
delay_tcp_npu_session: "enable"
devices:
-
name: "default_name_29 (source user.device.alias user.device-group.name user.device-category.name)"
diameter_filter_profile: " (source diameter-filter.profile.name)"
diffserv_copy: "enable"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: ""
diffservcode_rev: ""
disclaimer: "enable"
dlp_profile: " (source dlp.profile.name)"
dlp_sensor: " (source dlp.sensor.name)"
dnsfilter_profile: " (source dnsfilter.profile.name)"
dscp_match: "enable"
dscp_negate: "enable"
dscp_value: ""
dsri: "enable"
dstaddr:
-
name: "default_name_45 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource
.name)"
dstaddr_negate: "enable"
dstaddr6:
-
name: "default_name_48 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
.external-resource.name)"
dstaddr6_negate: "enable"
dstintf:
-
name: "default_name_51 (source system.interface.name system.zone.name system.sdwan.zone.name)"
dynamic_shaping: "enable"
email_collect: "enable"
emailfilter_profile: " (source emailfilter.profile.name)"
fec: "enable"
file_filter_profile: " (source file-filter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso: "enable"
fsso_agent_for_ntlm: " (source user.fsso.name)"
fsso_groups:
-
name: "default_name_62 (source user.adgrp.name)"
geoip_anycast: "enable"
geoip_match: "physical-location"
global_label: ""
groups:
-
name: "default_name_67 (source user.group.name)"
gtp_profile: " (source firewall.gtp.name)"
http_policy_redirect: "enable"
icap_profile: " (source icap.profile.name)"
identity_based_route: " (source firewall.identity-based-route.name)"
inbound: "enable"
inspection_mode: "proxy"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_76 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_78 (source firewall.internet-service-custom-group.name)"
internet_service_fortiguard:
-
name: "default_name_80 (source firewall.internet-service-fortiguard.name)"
internet_service_group:
-
name: "default_name_82 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "84 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_86 (source firewall.internet-service-name.name)"
internet_service_negate: "enable"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_90 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_92 (source firewall.internet-service-custom-group.name)"
internet_service_src_fortiguard:
-
name: "default_name_94 (source firewall.internet-service-fortiguard.name)"
internet_service_src_group:
-
name: "default_name_96 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "98 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_100 (source firewall.internet-service-name.name)"
internet_service_src_negate: "enable"
internet_service6: "enable"
internet_service6_custom:
-
name: "default_name_104 (source firewall.internet-service-custom.name)"
internet_service6_custom_group:
-
name: "default_name_106 (source firewall.internet-service-custom-group.name)"
internet_service6_fortiguard:
-
name: "default_name_108 (source firewall.internet-service-fortiguard.name)"
internet_service6_group:
-
name: "default_name_110 (source firewall.internet-service-group.name)"
internet_service6_name:
-
name: "default_name_112 (source firewall.internet-service-name.name)"
internet_service6_negate: "enable"
internet_service6_src: "enable"
internet_service6_src_custom:
-
name: "default_name_116 (source firewall.internet-service-custom.name)"
internet_service6_src_custom_group:
-
name: "default_name_118 (source firewall.internet-service-custom-group.name)"
internet_service6_src_fortiguard:
-
name: "default_name_120 (source firewall.internet-service-fortiguard.name)"
internet_service6_src_group:
-
name: "default_name_122 (source firewall.internet-service-group.name)"
internet_service6_src_name:
-
name: "default_name_124 (source firewall.internet-service-name.name)"
internet_service6_src_negate: "enable"
ippool: "enable"
ips_sensor: " (source ips.sensor.name)"
ips_voip_filter: " (source voip.profile.name)"
label: ""
learning_mode: "enable"
log_http_transaction: "enable"
logtraffic: "all"
logtraffic_start: "enable"
match_vip: "enable"
match_vip_only: "enable"
mms_profile: " (source firewall.mms-profile.name)"
name: "default_name_137"
nat: "enable"
nat46: "enable"
nat64: "enable"
natinbound: "enable"
natip: ""
natoutbound: "enable"
network_service_dynamic:
-
name: "default_name_145 (source firewall.network-service-dynamic.name)"
network_service_src_dynamic:
-
name: "default_name_147 (source firewall.network-service-dynamic.name)"
np_acceleration: "enable"
ntlm: "enable"
ntlm_enabled_browsers:
-
user_agent_string: ""
ntlm_guest: "enable"
outbound: "enable"
passive_wan_health_measurement: "enable"
pcp_inbound: "enable"
pcp_outbound: "enable"
pcp_poolname:
-
name: "default_name_158 (source system.pcp-server.pools.name)"
per_ip_shaper: " (source firewall.shaper.per-ip-shaper.name)"
permit_any_host: "enable"
permit_stun_host: "enable"
pfcp_profile: " (source firewall.pfcp.name)"
policy_expiry: "enable"
policy_expiry_date: ""
policy_expiry_date_utc: ""
policyid: ""
poolname:
-
name: "default_name_168 (source firewall.ippool.name)"
poolname6:
-
name: "default_name_170 (source firewall.ippool6.name)"
port_preserve: "enable"
port_random: "enable"
profile_group: " (source firewall.profile-group.name)"
profile_protocol_options: " (source firewall.profile-protocol-options.name)"
profile_type: "single"
radius_ip_auth_bypass: "enable"
radius_mac_auth_bypass: "enable"
redirect_url: ""
replacemsg_override_group: " (source system.replacemsg-group.name)"
reputation_direction: "source"
reputation_direction6: "source"
reputation_minimum: "0"
reputation_minimum6: "0"
rsso: "enable"
rtp_addr:
-
name: "default_name_186 (source firewall.internet-service-custom-group.name firewall.addrgrp.name)"
rtp_nat: "disable"
saml_server: " (source user.saml.name)"
scan_botnet_connections: "disable"
schedule: " (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
schedule_timeout: "enable"
scim: "enable"
scim_groups:
-
name: "default_name_194"
scim_users:
-
name: "default_name_196"
sctp_filter_profile: " (source sctp-filter.profile.name)"
send_deny_packet: "disable"
service:
-
name: "default_name_200 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: ""
sgt:
-
id: "204"
sgt_check: "enable"
spamfilter_profile: " (source spamfilter.profile.name)"
src_vendor_mac:
-
id: "208 (source firewall.vendor-mac.id)"
srcaddr:
-
name: "default_name_210 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
srcaddr_negate: "enable"
srcaddr6:
-
name: "default_name_213 (source firewall.address6.name system.external-resource.name firewall.addrgrp6.name)"
srcaddr6_negate: "enable"
srcintf:
-
name: "default_name_216 (source system.interface.name system.zone.name system.sdwan.zone.name)"
ssh_filter_profile: " (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_mirror: "enable"
ssl_mirror_intf:
-
name: "default_name_221 (source system.interface.name system.zone.name)"
ssl_ssh_profile: " (source firewall.ssl-ssh-profile.name)"
status: "enable"
tcp_mss_receiver: "0"
tcp_mss_sender: "0"
tcp_session_without_syn: "all"
telemetry_profile: " (source telemetry-controller.profile.name)"
timeout_send_rst: "enable"
tos: ""
tos_mask: ""
tos_negate: "enable"
traffic_shaper: " (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: " (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "235"
users:
-
name: "default_name_237 (source user.local.name user.certificate.name)"
utm_status: "enable"
uuid: ""
videofilter_profile: " (source videofilter.profile.name)"
virtual_patch_profile: " (source virtual-patch.profile.name)"
vlan_cos_fwd: "255"
vlan_cos_rev: "255"
vlan_filter: ""
voip_profile: " (source voip.profile.name)"
vpntunnel: " (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
waf_profile: " (source waf.profile.name)"
wanopt: "enable"
wanopt_detection: "active"
wanopt_passive_opt: "default"
wanopt_peer: " (source wanopt.peer.peer-host-id)"
wanopt_profile: " (source wanopt.profile.name)"
wccp: "enable"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: " (source webfilter.profile.name)"
webproxy_forward_server: " (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: " (source web-proxy.profile.name)"
wsso: "enable"
ztna_device_ownership: "enable"
ztna_ems_tag:
-
name: "default_name_262 (source firewall.address.name firewall.addrgrp.name)"
ztna_ems_tag_negate: "enable"
ztna_ems_tag_secondary:
-
name: "default_name_265 (source firewall.address.name firewall.addrgrp.name)"
ztna_geo_tag:
-
name: "default_name_267 (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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- 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.