Skip to content

Latest commit

 

History

History
3991 lines (3946 loc) · 142 KB

fortios_firewall_policy6.rst

File metadata and controls

3991 lines (3946 loc) · 142 KB
Raw
source:fortios_firewall_policy6.py
orphan:

fortios_firewall_policy6 -- Configure IPv6 policies in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and 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.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
fortios_firewall_policy6 yes yes yes yes yes yes yes

Parameters

  • 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...
    v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
    firewall_policy6 yes yes yes yes yes yes yes
    • action - Policy action (allow/deny/ipsec). type: str choices: accept, deny, ipsec more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      action yes yes yes yes yes yes yes
      [accept] yes yes yes yes yes yes yes
      [deny] yes yes yes yes yes yes yes
      [ipsec] yes yes yes yes yes yes yes
    • anti_replay - Enable/disable anti-replay check. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      anti_replay no no no yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
    • app_category - Application category ID list. type: list member_path: app_category:id more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      app_category yes yes yes yes yes yes yes
      • id - Category IDs. type: int required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        id yes yes yes yes yes yes yes
    • app_group - Application group names. type: list member_path: app_group:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      app_group yes yes yes yes yes yes yes
      • name - Application group names. Source application.group.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • application - Application ID list. type: list member_path: application:id more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      application yes yes yes yes yes yes yes
      • id - Application IDs. type: int required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        id yes yes yes yes yes yes yes
    • application_list - Name of an existing Application list. Source application.list.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      application_list yes yes yes yes yes yes yes
    • auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      auto_asic_offload yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      av_profile yes yes yes yes yes yes yes
    • cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      cifs_profile no no no yes yes yes yes
    • comments - Comment. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      comments yes yes yes yes yes yes yes
    • 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...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      custom_log_fields yes yes yes yes yes yes yes
      • field_id - Custom log field. Source log.custom-field.id. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        field_id yes yes yes yes yes yes yes
    • devices - Names of devices or device groups that can be matched by the policy. type: list member_path: devices:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3
      devices yes yes yes no yes
      • name - Device or group name. Source user.device.alias user.device-group.name user.device-category.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.3
        name yes yes yes yes
    • diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      diffserv_forward yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      diffserv_reverse yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • diffservcode_forward - Change packet"s DiffServ to this value. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      diffservcode_forward yes yes yes yes yes yes yes
    • diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      diffservcode_rev yes yes yes yes yes yes yes
    • dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dlp_sensor yes yes yes yes yes yes yes
    • dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dnsfilter_profile no no no yes yes yes yes
    • dscp_match - Enable DSCP check. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11
      dscp_match yes yes yes
      [enable] yes yes yes
      [disable] yes yes yes
    • dscp_negate - Enable negated DSCP match. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11
      dscp_negate yes yes yes
      [enable] yes yes yes
      [disable] yes yes yes
    • dscp_value - DSCP value. type: str more...
      v6.0.0 v6.0.5 v6.0.11
      dscp_value yes yes yes
    • dsri - Enable DSRI to ignore HTTP server responses. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dsri yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • dstaddr - Destination address and address group names. type: list member_path: dstaddr:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstaddr yes yes yes yes yes yes yes
      • 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...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstaddr_negate yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • dstintf - Outgoing (egress) interface. type: list member_path: dstintf:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstintf yes yes yes yes yes yes yes
      • name - Interface name. Source system.interface.name system.zone.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      emailfilter_profile no no no yes yes yes yes
    • firewall_session_dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: check-all, check-new more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      firewall_session_dirty yes yes yes yes yes yes yes
      [check-all] yes yes yes yes yes yes yes
      [check-new] yes yes yes yes yes yes yes
    • fixedport - Enable to prevent source NAT from changing a session"s source port. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      fixedport yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • fsso_groups - Names of FSSO groups. type: list member_path: fsso_groups:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      fsso_groups no no no yes yes yes yes
      • name - Names of FSSO groups. Source user.adgrp.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • global_label - Label for the policy that appears when the GUI is in Global View mode. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3
      global_label yes yes yes no yes
    • groups - Names of user groups that can authenticate with this policy. type: list member_path: groups:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      groups yes yes yes yes yes yes yes
      • name - Group name. Source user.group.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      http_policy_redirect no no no yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
    • icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      icap_profile yes yes yes yes yes yes yes
    • inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      inbound yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • inspection_mode - Policy inspection mode (Flow/proxy). Default is Flow mode. type: str choices: proxy, flow more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      inspection_mode no no no yes yes yes yes
      [proxy] n/a n/a n/a yes yes yes yes
      [flow] n/a n/a n/a yes yes yes yes
    • ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ippool yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ips_sensor yes yes yes yes yes yes yes
    • label - Label for the policy that appears when the GUI is in Section View mode. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3
      label yes yes yes no yes
    • logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      logtraffic yes yes yes yes yes yes yes
      [all] yes yes yes yes yes yes yes
      [utm] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • logtraffic_start - Record logs when a session starts. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      logtraffic_start yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      mms_profile yes yes yes yes yes yes yes
    • name - Policy name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      name yes yes yes yes yes yes yes
    • nat - Enable/disable source NAT. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      nat yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      natinbound yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      natoutbound yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • np_acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      np_acceleration yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      outbound yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      per_ip_shaper yes yes yes yes yes yes yes
    • policyid - Policy ID (0 - 4294967294). type: int required: true more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      policyid yes yes yes yes yes yes yes
    • poolname - IP Pool names. type: list member_path: poolname:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      poolname yes yes yes yes yes yes yes
      • name - IP pool name. Source firewall.ippool6.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • profile_group - Name of profile group. Source firewall.profile-group.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      profile_group yes yes yes yes yes yes yes
    • profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      profile_protocol_options yes yes yes yes yes yes yes
    • profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      profile_type yes yes yes yes yes yes yes
      [single] yes yes yes yes yes yes yes
      [group] yes yes yes yes yes yes yes
    • replacemsg_override_group - Override the default replacement message group for this policy. Source system.replacemsg-group.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      replacemsg_override_group yes yes yes yes yes yes yes
    • rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      rsso yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      schedule yes yes yes yes yes yes yes
    • send_deny_packet - Enable/disable return of deny-packet. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      send_deny_packet yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • service - Service and service group names. type: list member_path: service:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      service yes yes yes yes yes yes yes
      • name - Address name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      service_negate yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • session_ttl - Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      session_ttl yes yes yes yes yes yes yes
    • spamfilter_profile - Name of an existing Spam filter profile. Source spamfilter.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11
      spamfilter_profile yes yes yes
    • srcaddr - Source address and address group names. type: list member_path: srcaddr:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcaddr yes yes yes yes yes yes yes
      • name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcaddr_negate yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcintf yes yes yes yes yes yes yes
      • name - Interface name. Source system.zone.name system.interface.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssh_filter_profile yes yes yes yes yes yes yes
    • ssh_policy_redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssh_policy_redirect no no no yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
    • ssl_mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssl_mirror yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • ssl_mirror_intf - SSL mirror interface name. type: list member_path: ssl_mirror_intf:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssl_mirror_intf yes yes yes yes yes yes yes
      • name - Interface name. Source system.zone.name system.interface.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssl_ssh_profile yes yes yes yes yes yes yes
    • status - Enable or disable this policy. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      status yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tcp_mss_receiver yes yes yes yes yes yes yes
    • tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tcp_mss_sender yes yes yes yes yes yes yes
    • tcp_session_without_syn - Enable/disable creation of TCP session without SYN flag. type: str choices: all, data-only, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tcp_session_without_syn yes yes yes yes yes yes yes
      [all] yes yes yes yes yes yes yes
      [data-only] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • timeout_send_rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      timeout_send_rst yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • tos - ToS (Type of Service) value used for comparison. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tos no no no yes yes yes yes
    • tos_mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tos_mask no no no yes yes yes yes
    • tos_negate - Enable negated TOS match. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tos_negate no no no yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
    • traffic_shaper - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      traffic_shaper yes yes yes yes yes yes yes
    • traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      traffic_shaper_reverse yes yes yes yes yes yes yes
    • url_category - URL category ID list. type: list member_path: url_category:id more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      url_category yes yes yes yes yes yes yes
      • id - URL category ID. type: int required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        id yes yes yes yes yes yes yes
    • users - Names of individual users that can authenticate with this policy. type: list member_path: users:name more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      users yes yes yes yes yes yes yes
      • name - Names of individual users that can authenticate with this policy. Source user.local.name. type: str required: true more...
        v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes yes yes yes
    • utm_status - Enable AV/web/ips protection profile. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      utm_status yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      uuid yes yes yes yes yes yes yes
    • vlan_cos_fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest type: int more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      vlan_cos_fwd yes yes yes yes yes yes yes
    • vlan_cos_rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest type: int more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      vlan_cos_rev yes yes yes yes yes yes yes
    • vlan_filter - Set VLAN filters. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      vlan_filter yes yes yes yes yes yes yes
    • voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      voip_profile yes yes yes yes yes yes yes
    • vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      vpntunnel yes yes yes yes yes yes yes
    • waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      waf_profile no no no yes yes yes yes
    • webcache - Enable/disable web cache. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webcache no no no yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
    • webcache_https - Enable/disable web cache for HTTPS. type: str choices: disable, enable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webcache_https no no no yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
    • webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webfilter_profile yes yes yes yes yes yes yes
    • webproxy_forward_server - Web proxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webproxy_forward_server no no no yes yes yes yes
    • webproxy_profile - Webproxy profile name. Source web-proxy.profile.name. type: str more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webproxy_profile no no no yes yes yes yes

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPv6 policies.
    fortios_firewall_policy6:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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: "<your_own_value> (source application.list.name)"
        auto_asic_offload: "enable"
        av_profile: "<your_own_value> (source antivirus.profile.name)"
        cifs_profile: "<your_own_value> (source cifs.profile.name)"
        comments: "<your_own_value>"
        custom_log_fields:
         -
            field_id: "<your_own_value> (source log.custom-field.id)"
        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: "<your_own_value>"
        diffservcode_rev: "<your_own_value>"
        dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
        dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
        dscp_match: "enable"
        dscp_negate: "enable"
        dscp_value: "<your_own_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: "<your_own_value> (source emailfilter.profile.name)"
        firewall_session_dirty: "check-all"
        fixedport: "enable"
        fsso_groups:
         -
            name: "default_name_39 (source user.adgrp.name)"
        global_label: "<your_own_value>"
        groups:
         -
            name: "default_name_42 (source user.group.name)"
        http_policy_redirect: "enable"
        icap_profile: "<your_own_value> (source icap.profile.name)"
        inbound: "enable"
        inspection_mode: "proxy"
        ippool: "enable"
        ips_sensor: "<your_own_value> (source ips.sensor.name)"
        label: "<your_own_value>"
        logtraffic: "all"
        logtraffic_start: "enable"
        mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
        name: "default_name_53"
        nat: "enable"
        natinbound: "enable"
        natoutbound: "enable"
        np_acceleration: "enable"
        outbound: "enable"
        per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        policyid: "2147483647"
        poolname:
         -
            name: "default_name_62 (source firewall.ippool6.name)"
        profile_group: "<your_own_value> (source firewall.profile-group.name)"
        profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
        profile_type: "single"
        replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
        rsso: "enable"
        schedule: "<your_own_value> (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: "<your_own_value>"
        spamfilter_profile: "<your_own_value> (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: "<your_own_value> (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: "<your_own_value> (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: "<your_own_value>"
        tos_mask: "<your_own_value>"
        tos_negate: "enable"
        traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        url_category:
         -
            id:  "97"
        users:
         -
            name: "default_name_99 (source user.local.name)"
        utm_status: "enable"
        uuid: "<your_own_value>"
        vlan_cos_fwd: "3"
        vlan_cos_rev: "3"
        vlan_filter: "<your_own_value>"
        voip_profile: "<your_own_value> (source voip.profile.name)"
        vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
        waf_profile: "<your_own_value> (source waf.profile.name)"
        webcache: "enable"
        webcache_https: "disable"
        webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
        webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
        webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.