:source: fortios_firewall_policy6.py
:orphan:
.. fortios_firewall_policy6:
fortios_firewall_policy6 -- Configure 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 policy6 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
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v6.2.7
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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_policy6 - Configure IPv6 policies. type: dict
more...
| Supported Version Ranges |
| firewall_policy6 |
v6.0.0 -> v6.2.7 |
- action - Policy action (allow/deny/ipsec). type: str choices: accept, deny, ipsec
more...
|
Supported Version Ranges |
| action |
v6.0.0 -> v6.2.7 |
| [accept] |
v6.0.0 -> v6.2.7 |
| [deny] |
v6.0.0 -> v6.2.7 |
| [ipsec] |
v6.0.0 -> v6.2.7 |
- anti_replay - Enable/disable anti-replay check. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| anti_replay |
v6.2.0 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- 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 |
- 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 -> v6.2.7 |
- auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_asic_offload |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str
more...
|
Supported Version Ranges |
| av_profile |
v6.0.0 -> v6.2.7 |
- cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str
more...
|
Supported Version Ranges |
| cifs_profile |
v6.2.0 -> v6.2.7 |
- comments - Comment. type: str
more...
|
Supported Version Ranges |
| comments |
v6.0.0 -> v6.2.7 |
- custom_log_fields - Log field index numbers to append custom log fields 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 -> v6.2.7 |
- field_id - Custom log field. Source log.custom-field.id. type: str required: true
more...
|
Supported Version Ranges |
| field_id |
v6.0.0 -> v6.2.7 |
- 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 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- diffservcode_forward - Change packet"s DiffServ to this value. type: str
more...
|
Supported Version Ranges |
| diffservcode_forward |
v6.0.0 -> v6.2.7 |
- diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str
more...
|
Supported Version Ranges |
| diffservcode_rev |
v6.0.0 -> v6.2.7 |
- dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str
more...
|
Supported Version Ranges |
| dlp_sensor |
v6.0.0 -> v6.2.7 |
- dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| dnsfilter_profile |
v6.2.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- dstaddr - Destination address and address group names. type: list member_path: dstaddr:name
more...
| Supported Version Ranges |
| dstaddr |
v6.0.0 -> v6.2.7 |
- 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.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- dstintf - Outgoing (egress) interface. type: list member_path: dstintf:name
more...
| Supported Version Ranges |
| dstintf |
v6.0.0 -> v6.2.7 |
- name - Interface name. Source system.interface.name system.zone.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| emailfilter_profile |
v6.2.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [check-all] |
v6.0.0 -> v6.2.7 |
| [check-new] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- fsso_groups - Names of FSSO groups. type: list member_path: fsso_groups:name
more...
| Supported Version Ranges |
| fsso_groups |
v6.2.0 -> v6.2.7 |
- name - Names of FSSO groups. Source user.adgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- name - Group name. Source user.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| http_policy_redirect |
v6.2.0 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str
more...
|
Supported Version Ranges |
| icap_profile |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [proxy] |
v6.2.0 -> v6.2.7 |
| [flow] |
v6.2.0 -> v6.2.7 |
- ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ippool |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str
more...
|
Supported Version Ranges |
| ips_sensor |
v6.0.0 -> v6.2.7 |
- 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 |
- 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 -> v6.2.7 |
| [all] |
v6.0.0 -> v6.2.7 |
| [utm] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- logtraffic_start - Record logs when a session starts. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| logtraffic_start |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- nat - Enable/disable source NAT. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nat |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| natinbound |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| natoutbound |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- np_acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| np_acceleration |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- policyid - Policy ID (0 - 4294967294). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| policyid |
v6.0.0 -> v6.2.7 |
- poolname - IP Pool names. type: list member_path: poolname:name
more...
| Supported Version Ranges |
| poolname |
v6.0.0 -> v6.2.7 |
- name - IP pool name. Source firewall.ippool6.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- profile_group - Name of profile group. Source firewall.profile-group.name. type: str
more...
|
Supported Version Ranges |
| profile_group |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- 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 -> v6.2.7 |
| [single] |
v6.0.0 -> v6.2.7 |
| [group] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- 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 |
- 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 -> v6.2.7 |
- send_deny_packet - Enable/disable return of deny-packet. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| send_deny_packet |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- service - Service and service group names. type: list member_path: service:name
more...
| Supported Version Ranges |
| service |
v6.0.0 -> v6.2.7 |
- name - Address name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- session_ttl - Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. type: str
more...
|
Supported Version Ranges |
| session_ttl |
v6.0.0 -> v6.2.7 |
- 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 |
- srcaddr - Source address and address group names. type: list member_path: srcaddr:name
more...
| Supported Version Ranges |
| srcaddr |
v6.0.0 -> v6.2.7 |
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name
more...
| Supported Version Ranges |
| srcintf |
v6.0.0 -> v6.2.7 |
- name - Interface name. Source system.zone.name system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- 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 - Interface name. Source system.zone.name system.interface.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 -> v6.2.7 |
- status - Enable or disable this policy. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int
more...
|
Supported Version Ranges |
| tcp_mss_receiver |
v6.0.0 -> v6.2.7 |
- tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int
more...
|
Supported Version Ranges |
| tcp_mss_sender |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [all] |
v6.0.0 -> v6.2.7 |
| [data-only] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- tos - ToS (Type of Service) value used for comparison. type: str
more...
|
Supported Version Ranges |
| tos |
v6.2.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- tos_negate - Enable negated TOS match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tos_negate |
v6.2.0 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- traffic_shaper - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
more...
|
Supported Version Ranges |
| traffic_shaper |
v6.0.0 -> v6.2.7 |
- traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
more...
|
Supported Version Ranges |
| traffic_shaper_reverse |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- name - Names of individual users that can authenticate with this policy. Source user.local.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v6.2.7 |
- utm_status - Enable AV/web/ips protection profile. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| utm_status |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
more...
|
Supported Version Ranges |
| uuid |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- 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 -> v6.2.7 |
- vlan_filter - Set VLAN filters. type: str
more...
|
Supported Version Ranges |
| vlan_filter |
v6.0.0 -> v6.2.7 |
- voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str
more...
|
Supported Version Ranges |
| voip_profile |
v6.0.0 -> v6.2.7 |
- 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 -> v6.2.7 |
- waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str
more...
|
Supported Version Ranges |
| waf_profile |
v6.2.0 -> v6.2.7 |
- webcache - Enable/disable web cache. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| webcache |
v6.2.0 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- webcache_https - Enable/disable web cache for HTTPS. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| webcache_https |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
- webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| webfilter_profile |
v6.0.0 -> v6.2.7 |
- webproxy_forward_server - Web proxy 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 -> v6.2.7 |
- webproxy_profile - Webproxy profile name. Source web-proxy.profile.name. type: str
more...
|
Supported Version Ranges |
| webproxy_profile |
v6.2.0 -> v6.2.7 |
Notes
-----
.. note::
- We highly recommend using your own value as the policyid instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure IPv6 policies.
fortinet.fortios.fortios_firewall_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
firewall_policy6:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8 (source application.group.name)"
application:
-
id: "10"
application_list: " (source application.list.name)"
auto_asic_offload: "enable"
av_profile: " (source antivirus.profile.name)"
cifs_profile: " (source cifs.profile.name)"
comments: ""
custom_log_fields:
-
field_id: " (source log.custom-field.id)"
devices:
-
name: "default_name_19 (source user.device.alias user.device-group.name user.device-category.name)"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: ""
diffservcode_rev: ""
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_31 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
.external-resource.name)"
dstaddr_negate: "enable"
dstintf:
-
name: "default_name_34 (source system.interface.name system.zone.name)"
emailfilter_profile: " (source emailfilter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso_groups:
-
name: "default_name_39 (source user.adgrp.name)"
global_label: ""
groups:
-
name: "default_name_42 (source user.group.name)"
http_policy_redirect: "enable"
icap_profile: " (source icap.profile.name)"
inbound: "enable"
inspection_mode: "proxy"
ippool: "enable"
ips_sensor: " (source ips.sensor.name)"
label: ""
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: " (source firewall.mms-profile.name)"
name: "default_name_53"
nat: "enable"
natinbound: "enable"
natoutbound: "enable"
np_acceleration: "enable"
outbound: "enable"
per_ip_shaper: " (source firewall.shaper.per-ip-shaper.name)"
policyid: ""
poolname:
-
name: "default_name_62 (source firewall.ippool6.name)"
profile_group: " (source firewall.profile-group.name)"
profile_protocol_options: " (source firewall.profile-protocol-options.name)"
profile_type: "single"
replacemsg_override_group: " (source system.replacemsg-group.name)"
rsso: "enable"
schedule: " (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
send_deny_packet: "enable"
service:
-
name: "default_name_71 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: ""
spamfilter_profile: " (source spamfilter.profile.name)"
srcaddr:
-
name: "default_name_76 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcaddr_negate: "enable"
srcintf:
-
name: "default_name_79 (source system.zone.name system.interface.name)"
ssh_filter_profile: " (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_mirror: "enable"
ssl_mirror_intf:
-
name: "default_name_84 (source system.zone.name system.interface.name)"
ssl_ssh_profile: " (source firewall.ssl-ssh-profile.name)"
status: "enable"
tcp_mss_receiver: "32767"
tcp_mss_sender: "32767"
tcp_session_without_syn: "all"
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: "97"
users:
-
name: "default_name_99 (source user.local.name)"
utm_status: "enable"
uuid: ""
vlan_cos_fwd: "3"
vlan_cos_rev: "3"
vlan_filter: ""
voip_profile: " (source voip.profile.name)"
vpntunnel: " (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
waf_profile: " (source waf.profile.name)"
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)"
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.